Tizen Native API
7.0
|
Bluetooth AVRCP(Audio/Video Remote Control Profile) API provides functions for notifying the change of target device to the control device(Target role) and functions for controlling the remote device(Controller role).
Required Header
#include <bluetooth.h>
Overview
AVRCP profile let users send AV control signals and information between two devices.
Functions | |
int | bt_avrcp_set_equalizer_state_changed_cb (bt_avrcp_equalizer_state_changed_cb callback, void *user_data) |
Registers a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_unset_equalizer_state_changed_cb (void) |
Unregisters a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_set_repeat_mode_changed_cb (bt_avrcp_repeat_mode_changed_cb callback, void *user_data) |
Registers a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_unset_repeat_mode_changed_cb (void) |
Unregisters a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_set_shuffle_mode_changed_cb (bt_avrcp_shuffle_mode_changed_cb callback, void *user_data) |
Registers a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_unset_shuffle_mode_changed_cb (void) |
Unregisters a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_set_scan_mode_changed_cb (bt_avrcp_scan_mode_changed_cb callback, void *user_data) |
Registers a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_unset_scan_mode_changed_cb (void) |
Unregisters a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_set_position_changed_cb (bt_avrcp_position_changed_cb callback, void *user_data) |
Registers a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_unset_position_changed_cb (void) |
Unregisters a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_set_play_status_changed_cb (bt_avrcp_play_status_changed_cb callback, void *user_data) |
Registers a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_unset_play_status_changed_cb (void) |
Unregisters a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_set_track_info_changed_cb (bt_avrcp_track_info_changed_cb callback, void *user_data) |
Registers a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices). | |
int | bt_avrcp_unset_track_info_changed_cb (void) |
Unregisters a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices). | |
Typedefs | |
typedef void(* | bt_avrcp_control_connection_state_changed_cb )(bool connected, const char *remote_address, void *user_data) |
Called when the connection state is changed. | |
typedef void(* | bt_avrcp_position_changed_cb )(unsigned int position, void *user_data) |
Called when the Song position mode is changed by the remote target device. | |
typedef void(* | bt_avrcp_track_info_changed_cb )(bt_avrcp_metadata_attributes_info_s *track, void *user_data) |
Called when the Song metadata information is changed by the remote target device. | |
typedef void(* | bt_avrcp_play_status_changed_cb )(bt_avrcp_player_state_e play_state, void *user_data) |
Called when the Song Play status mode is changed by the remote target device. | |
typedef void(* | bt_avrcp_target_connection_state_changed_cb )(bool connected, const char *remote_address, void *user_data) |
Called when the connection state is changed. | |
typedef void(* | bt_avrcp_equalizer_state_changed_cb )(bt_avrcp_equalizer_state_e equalizer, void *user_data) |
Called when the equalizer state is changed by the remote control device. | |
typedef void(* | bt_avrcp_repeat_mode_changed_cb )(bt_avrcp_repeat_mode_e repeat, void *user_data) |
Called when the repeat mode is changed by the remote control device. | |
typedef void(* | bt_avrcp_shuffle_mode_changed_cb )(bt_avrcp_shuffle_mode_e shuffle, void *user_data) |
Called when the shuffle mode is changed by the remote control device. | |
typedef void(* | bt_avrcp_scan_mode_changed_cb )(bt_avrcp_scan_mode_e scan, void *user_data) |
Called when the scan mode is changed by the remote control device. |
Typedef Documentation
typedef void(* bt_avrcp_control_connection_state_changed_cb)(bool connected, const char *remote_address, void *user_data) |
Called when the connection state is changed.
- Since :
- 3.0
- Parameters:
-
[in] connected The state to be changed. true means connected state, Otherwise, false. [in] remote_address The remote address [in] user_data The user data passed from the callback registration function
typedef void(* bt_avrcp_equalizer_state_changed_cb)(bt_avrcp_equalizer_state_e equalizer, void *user_data) |
Called when the equalizer state is changed by the remote control device.
- Since :
- 2.3.1
- Parameters:
-
[in] equalizer The equalizer state [in] user_data The user data passed from the callback registration function
typedef void(* bt_avrcp_play_status_changed_cb)(bt_avrcp_player_state_e play_state, void *user_data) |
Called when the Song Play status mode is changed by the remote target device.
- Since :
- 3.0
- Parameters:
-
[in] play_state The song play status [in] user_data The user data passed from the callback registration function
typedef void(* bt_avrcp_position_changed_cb)(unsigned int position, void *user_data) |
Called when the Song position mode is changed by the remote target device.
- Since :
- 3.0
- Parameters:
-
[in] position Playback position in milliseconds. When position is 0 it means the track is starting and when it's greater than or equal to track's duration the track has ended. [in] user_data The user data passed from the callback registration function
typedef void(* bt_avrcp_repeat_mode_changed_cb)(bt_avrcp_repeat_mode_e repeat, void *user_data) |
Called when the repeat mode is changed by the remote control device.
- Since :
- 2.3.1
- Parameters:
-
[in] repeat The repeat mode [in] user_data The user data passed from the callback registration function
typedef void(* bt_avrcp_scan_mode_changed_cb)(bt_avrcp_scan_mode_e scan, void *user_data) |
Called when the scan mode is changed by the remote control device.
- Since :
- 2.3.1
- Parameters:
-
[in] scan The scan mode [in] user_data The user data passed from the callback registration function
typedef void(* bt_avrcp_shuffle_mode_changed_cb)(bt_avrcp_shuffle_mode_e shuffle, void *user_data) |
Called when the shuffle mode is changed by the remote control device.
- Since :
- 2.3.1
- Parameters:
-
[in] shuffle The shuffle mode [in] user_data The user data passed from the callback registration function
typedef void(* bt_avrcp_target_connection_state_changed_cb)(bool connected, const char *remote_address, void *user_data) |
Called when the connection state is changed.
- Since :
- 2.3.1
- Parameters:
-
[in] connected The state to be changed. true means connected state, Otherwise, false. [in] remote_address The remote address [in] user_data The user data passed from the callback registration function
typedef void(* bt_avrcp_track_info_changed_cb)(bt_avrcp_metadata_attributes_info_s *track, void *user_data) |
Called when the Song metadata information is changed by the remote target device.
- Since :
- 3.0
- Parameters:
-
[in] track The song metadata information [in] user_data The user data passed from the callback registration function
Enumeration Type Documentation
enum bt_avrcp_scan_mode_e |
Function Documentation
int bt_avrcp_set_equalizer_state_changed_cb | ( | bt_avrcp_equalizer_state_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_INVALID_PARAMETER Invalid parameter BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_set_play_status_changed_cb | ( | bt_avrcp_play_status_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_INVALID_PARAMETER Invalid parameter BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_set_position_changed_cb | ( | bt_avrcp_position_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_INVALID_PARAMETER Invalid parameter BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_set_repeat_mode_changed_cb | ( | bt_avrcp_repeat_mode_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_INVALID_PARAMETER Invalid parameter BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_set_scan_mode_changed_cb | ( | bt_avrcp_scan_mode_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_INVALID_PARAMETER Invalid parameter BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_set_shuffle_mode_changed_cb | ( | bt_avrcp_shuffle_mode_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_INVALID_PARAMETER Invalid parameter BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_set_track_info_changed_cb | ( | bt_avrcp_track_info_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Parameters:
-
[in] callback The callback function to register [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_INVALID_PARAMETER Invalid parameter BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_unset_equalizer_state_changed_cb | ( | void | ) |
Unregisters a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_unset_play_status_changed_cb | ( | void | ) |
Unregisters a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_unset_position_changed_cb | ( | void | ) |
Unregisters a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_unset_repeat_mode_changed_cb | ( | void | ) |
Unregisters a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_unset_scan_mode_changed_cb | ( | void | ) |
Unregisters a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_unset_shuffle_mode_changed_cb | ( | void | ) |
Unregisters a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().
int bt_avrcp_unset_track_info_changed_cb | ( | void | ) |
Unregisters a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices).
- Since :
- 3.0
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
BT_ERROR_NONE Successful BT_ERROR_NOT_INITIALIZED Not initialized BT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- The AVRCP service must be initialized with bt_avrcp_target_initialize() or bt_avrcp_control_initialize().