Lines Matching +full:instance +full:- +full:id

7  * Copyright (c) 2019 - 2024 Nordic Semiconductor ASA
9 * SPDX-License-Identifier: Apache-2.0
66 /** A 32-bit signed parameter. The parameter value depends on the @ref mpl_cmd.opcode */
95 /** Concatenated search control items - (type, length, param) */
102 * All values from -128 to 127 allowed, only some defined
106 #define MEDIA_PROXY_PLAYBACK_SPEED_MIN -128
108 #define MEDIA_PROXY_PLAYBACK_SPEED_QUARTER -128
110 #define MEDIA_PROXY_PLAYBACK_SPEED_HALF -64
122 * The allowed values for seeking speed are the range -64 to -4
127 /** Maximum seeking speed - Can be negated */
129 /** Minimum seeking speed - Can be negated */
401 * @brief Opaque media player instance
415 * @brief Media Player Instance callback
417 * Called when the local Media Player instance is registered or read (TODO).
418 * Also called if the local player instance is already registered when
420 * Provides the controller with the pointer to the local player instance.
422 * @param player Media player instance pointer
429 * @brief Discover Player Instance callback
431 * Called when a remote player instance has been discovered.
432 * The instance has been discovered, and will be accessed, using Bluetooth,
435 * @param player Instance pointer to the remote player
448 * @param player Media player instance pointer
456 * @brief Media Player Icon Object ID receive callback
458 * Called when the Media Player Icon Object ID is read
461 * @param player Media player instance pointer
464 * @param id The ID of the Icon object in the Object Transfer Service (48 bits)
466 void (*icon_id_recv)(struct media_player *player, int err, uint64_t id);
474 * @param player Media player instance pointer
486 * @param player Media player instance pointer
498 * @param player Media player instance pointer
511 * @param player Media player instance pointer
525 * @param player Media player instance pointer
538 * @param player Media player instance pointer
552 * @param player Media player instance pointer
565 * @param player Media player instance pointer
578 * @param player Media player instance pointer
586 * @brief Track Segments Object ID receive callback
588 * Called when the Track Segments Object ID is read
591 * @param player Media player instance pointer
594 * @param id The ID of the track segments object in Object Transfer Service (48 bits)
596 void (*track_segments_id_recv)(struct media_player *player, int err, uint64_t id);
599 * @brief Current Track Object ID receive callback
601 * Called when the Current Track Object ID is read or changed
605 * @param player Media player instance pointer
608 * @param id The ID of the current track object in Object Transfer Service (48 bits)
610 void (*current_track_id_recv)(struct media_player *player, int err, uint64_t id);
613 * @brief Current Track Object ID write callback
615 * Called when the Current Track Object ID is written
618 * @param player Media player instance pointer
621 * @param id The ID (48 bits) attempted to write
623 void (*current_track_id_write)(struct media_player *player, int err, uint64_t id);
626 * @brief Next Track Object ID receive callback
628 * Called when the Next Track Object ID is read or changed
632 * @param player Media player instance pointer
635 * @param id The ID of the next track object in Object Transfer Service (48 bits)
637 void (*next_track_id_recv)(struct media_player *player, int err, uint64_t id);
640 * @brief Next Track Object ID write callback
642 * Called when the Next Track Object ID is written
645 * @param player Media player instance pointer
648 * @param id The ID (48 bits) attempted to write
650 void (*next_track_id_write)(struct media_player *player, int err, uint64_t id);
653 * @brief Parent Group Object ID receive callback
655 * Called when the Parent Group Object ID is read or changed
658 * @param player Media player instance pointer
661 * @param id The ID of the parent group object in Object Transfer Service (48 bits)
663 void (*parent_group_id_recv)(struct media_player *player, int err, uint64_t id);
666 * @brief Current Group Object ID receive callback
668 * Called when the Current Group Object ID is read or changed
672 * @param player Media player instance pointer
675 * @param id The ID of the current group object in Object Transfer Service (48 bits)
677 void (*current_group_id_recv)(struct media_player *player, int err, uint64_t id);
680 * @brief Current Group Object ID write callback
682 * Called when the Current Group Object ID is written
685 * @param player Media player instance pointer
688 * @param id The ID (48 bits) attempted to write
690 void (*current_group_id_write)(struct media_player *player, int err, uint64_t id);
699 * @param player Media player instance pointer
712 * @param player Media player instance pointer
725 * @param player Media player instance pointer
740 * @param player Media player instance pointer
753 * @param player Media player instance pointer
766 * @param player Media player instance pointer
780 * @param player Media player instance pointer
793 * @param player Media player instance pointer
808 * as a result of the search)can be accessed using the Search Results Object ID.
809 * The Search Results Object ID has a separate callback - search_results_id_recv().
811 * @param player Media player instance pointer
819 * @brief Search Results Object ID receive callback
822 * Called when the Search Results Object ID is read or changed
824 * @param player Media player instance pointer
827 * @param id The ID of the search results object in Object Transfer Service (48 bits)
829 void (*search_results_id_recv)(struct media_player *player, int err, uint64_t id);
832 * @brief Content Control ID receive callback
834 * Called when the Content Control ID is read
837 * @param player Media player instance pointer
840 * @param ccid The content control ID
857 * Discover a remote media player instance.
858 * The remote player instance will be discovered, and accessed, using Bluetooth,
864 * remote player. The remote player instance will be returned in the
876 * @param player Media player instance pointer
883 * @brief Read Icon Object ID
885 * Get an ID (48 bit) that can be used to retrieve the Icon
893 * @param player Media player instance pointer
904 * @param player Media player instance pointer
911 * @param player Media player instance pointer
923 * @param player Media player instance pointer
936 * @param player Media player instance pointer
951 * @param player Media player instance pointer
967 * -128 corresponds to playback at one fourth of normal speed,
971 * @param player Media player instance pointer
991 * @param player Media player instance pointer
1002 * seeking. It is a factor, relative to real-time playback
1003 * speed - a factor four means seeking happens at four times
1004 * the real-time playback speed. Positive values are for
1007 * The seeking speed is not settable - a non-zero seeking speed
1010 * @param player Media player instance pointer
1017 * @brief Read Current Track Segments Object ID
1019 * Get an ID (48 bit) that can be used to retrieve the Current
1027 * @param player Media player instance pointer
1034 * @brief Read Current Track Object ID
1036 * Get an ID (48 bit) that can be used to retrieve the Current
1044 * @param player Media player instance pointer
1051 * @brief Set Current Track Object ID
1053 * Change the player's current track to the track given by the ID.
1058 * @param player Media player instance pointer
1059 * @param id The ID of a track object
1063 int media_proxy_ctrl_set_current_track_id(struct media_player *player, uint64_t id);
1066 * @brief Read Next Track Object ID
1068 * Get an ID (48 bit) that can be used to retrieve the Next
1073 * @param player Media player instance pointer
1080 * @brief Set Next Track Object ID
1082 * Change the player's next track to the track given by the ID.
1086 * @param player Media player instance pointer
1087 * @param id The ID of a track object
1091 int media_proxy_ctrl_set_next_track_id(struct media_player *player, uint64_t id);
1094 * @brief Read Parent Group Object ID
1096 * Get an ID (48 bit) that can be used to retrieve the Parent
1106 * @param player Media player instance pointer
1113 * @brief Read Current Group Object ID
1115 * Get an ID (48 bit) that can be used to retrieve the Current
1123 * @param player Media player instance pointer
1130 * @brief Set Current Group Object ID
1133 * ID, and the current track to the first track in that group.
1137 * @param player Media player instance pointer
1138 * @param id The ID of a group object
1142 int media_proxy_ctrl_set_current_group_id(struct media_player *player, uint64_t id);
1147 * @param player Media player instance pointer
1158 * @param player Media player instance pointer
1171 * @param player Media player instance pointer
1182 * @param player Media player instance pointer
1193 * May result in two callbacks - one for the actual sending of the command to the
1196 * @param player Media player instance pointer
1209 * @param player Media player instance pointer
1223 * - one for the actual sending of the search to the player
1224 * - one for the result code for the search from the player
1225 * - if the search is successful, one for the search results object ID in the OTs
1229 * @param player Media player instance pointer
1237 * @brief Read Search Results Object ID
1239 * Get an ID (48 bit) that can be used to retrieve the Search
1248 * @param player Media player instance pointer
1255 * @brief Read Content Control ID
1257 * The content control ID identifies a content control service
1261 * @param player Media player instance pointer
1282 * @brief Read Icon Object ID
1284 * Get an ID (48 bit) that can be used to retrieve the Icon
1290 * @return The Icon Object ID
1353 * -128 corresponds to playback at one fourth of normal speed,
1383 * seeking. It is a factor, relative to real-time playback
1384 * speed - a factor four means seeking happens at four times
1385 * the real-time playback speed. Positive values are for
1388 * The seeking speed is not settable - a non-zero seeking speed
1396 * @brief Read Current Track Segments Object ID
1398 * Get an ID (48 bit) that can be used to retrieve the Current
1404 * @return Current The Track Segments Object ID
1409 * @brief Read Current Track Object ID
1411 * Get an ID (48 bit) that can be used to retrieve the Current
1417 * @return The Current Track Object ID
1422 * @brief Set Current Track Object ID
1424 * Change the player's current track to the track given by the ID.
1427 * @param id The ID of a track object
1429 void (*set_current_track_id)(uint64_t id);
1432 * @brief Read Next Track Object ID
1434 * Get an ID (48 bit) that can be used to retrieve the Next
1437 * @return The Next Track Object ID
1442 * @brief Set Next Track Object ID
1444 * Change the player's next track to the track given by the ID.
1446 * @param id The ID of a track object
1448 void (*set_next_track_id)(uint64_t id);
1451 * @brief Read Parent Group Object ID
1453 * Get an ID (48 bit) that can be used to retrieve the Parent
1461 * @return The Current Group Object ID
1466 * @brief Read Current Group Object ID
1468 * Get an ID (48 bit) that can be used to retrieve the Current
1474 * @return The Current Group Object ID
1479 * @brief Set Current Group Object ID
1482 * ID, and the current track to the first track in that group.
1484 * @param id The ID of a group object
1486 void (*set_current_group_id)(uint64_t id);
1530 * For command opcodes (play, pause, ...) - see the MEDIA_PROXY_OP_*
1560 * @brief Read Search Results Object ID
1562 * Get an ID (48 bit) that can be used to retrieve the Search
1569 * @return The Search Results Object ID
1574 * @brief Read Content Control ID
1576 * The content control ID identifies a content control service
1580 * @return The content control ID for the media player
1591 * The media proxy may call any non-NULL function pointers in the
1696 * @brief Current track object ID callback
1698 * To be called when the ID of the current track is changed (e.g. due
1701 * @param id The ID of the current track object in the OTS
1703 void media_proxy_pl_current_track_id_cb(uint64_t id);
1706 * @brief Next track object ID callback
1708 * To be called when the ID of the current track is changes
1710 * @param id The ID of the next track object in the OTS
1712 void media_proxy_pl_next_track_id_cb(uint64_t id);
1715 * @brief Parent group object ID callback
1717 * To be called when the ID of the parent group is changed
1719 * @param id The ID of the parent group object in the OTS
1721 void media_proxy_pl_parent_group_id_cb(uint64_t id);
1724 * @brief Current group object ID callback
1726 * To be called when the ID of the current group is changed
1728 * @param id The ID of the current group object in the OTS
1730 void media_proxy_pl_current_group_id_cb(uint64_t id);
1785 * @brief Search Results object ID callback
1787 * To be called when the ID of the search results is changed
1790 * @param id The ID of the search results object in the OTS
1792 void media_proxy_pl_search_results_id_cb(uint64_t id);