Functions |
int | sound_manager_get_current_device_list (sound_device_mask_e device_mask, sound_device_list_h *device_list) |
| Gets the list consisting of connected devices.
|
int | sound_manager_get_next_device (sound_device_list_h device_list, sound_device_h *device) |
| Gets the next item of the device list.
|
int | sound_manager_get_prev_device (sound_device_list_h device_list, sound_device_h *device) |
| Gets the previous item of the device list.
|
int | sound_manager_get_device_type (sound_device_h device, sound_device_type_e *type) |
| Gets the type of the device.
|
int | sound_manager_get_device_io_direction (sound_device_h device, sound_device_io_direction_e *io_direction) |
| Gets the io direction of the device.
|
int | sound_manager_get_device_id (sound_device_h device, int *id) |
| Gets the id of the device.
|
int | sound_manager_get_device_name (sound_device_h device, char **name) |
| Gets the name of the device.
|
int | sound_manager_get_device_state (sound_device_h device, sound_device_state_e *state) |
| Gets the state of the device.
|
int | sound_manager_set_device_connected_cb (sound_device_mask_e device_mask, sound_device_connected_cb callback, void *user_data) |
| Registers a callback function to be invoked when the state of connection of a sound device was changed.
|
int | sound_manager_unset_device_connected_cb (void) |
| Unregisters the callback function which is called when the state of connection of a sound device was changed.
|
int | sound_manager_set_device_information_changed_cb (sound_device_mask_e device_mask, sound_device_information_changed_cb callback, void *user_data) |
| Registers a callback function to be invoked when the information of a sound device was changed.
|
int | sound_manager_unset_device_information_changed_cb (void) |
| Unregisters the callback function which is called when the information of a sound device was changed.
|
Typedefs |
typedef void * | sound_device_h |
| sound device handle
|
typedef void * | sound_device_list_h |
| sound device list handle
|
typedef void(* | sound_device_connected_cb )(sound_device_h device, bool is_connected, void *user_data) |
| Called when the state of connection of a sound device was changed.
|
typedef void(* | sound_device_information_changed_cb )(sound_device_h device, sound_device_changed_info_e changed_info, void *user_data) |
| Called when the information of a sound device was changed.
|
The Device API provides functions to query the information of sound devices.
Required Header
#include <sound_manager.h>
Overview
The Sound Manager Device API allows you to:
- query the basic information of connected sound devices.
- handle the sound device's connection and information change notification.
The list of currently connected sound device can be obtained by calling sound_manager_get_current_device_list(). To get the handle of each sound device, call sound_manager_get_next_device() and sound_manager_get_prev_device().
Device information, such as "type", "IO direction", "state", "ID", "name", can be obtained by calling corresponding APIs.
Typedef Documentation
sound device handle
- Since :
- 2.3
sound device list handle
- Since :
- 2.3
Enumeration Type Documentation
Enumeration for changed information of sound device.
- Since :
- 2.3
- Enumerator:
SOUND_DEVICE_CHANGED_INFO_STATE |
State of the device was changed
|
SOUND_DEVICE_CHANGED_INFO_IO_DIRECTION |
IO direction of the device was changed
|
Enumeration for sound device direction.
- Since :
- 2.3
- Enumerator:
SOUND_DEVICE_IO_DIRECTION_IN |
Input device
|
SOUND_DEVICE_IO_DIRECTION_OUT |
Output device
|
SOUND_DEVICE_IO_DIRECTION_BOTH |
Input/output device (both directions are available)
|
Enumeration for sound device mask.
- Since :
- 2.3
- Enumerator:
SOUND_DEVICE_IO_DIRECTION_IN_MASK |
Mask for input devices
|
SOUND_DEVICE_IO_DIRECTION_OUT_MASK |
Mask for output devices
|
SOUND_DEVICE_IO_DIRECTION_BOTH_MASK |
Mask for input/output devices (both directions are available)
|
SOUND_DEVICE_TYPE_INTERNAL_MASK |
Mask for built-in devices
|
SOUND_DEVICE_TYPE_EXTERNAL_MASK |
Mask for external devices
|
SOUND_DEVICE_STATE_DEACTIVATED_MASK |
Mask for deactivated devices
|
SOUND_DEVICE_STATE_ACTIVATED_MASK |
Mask for activated devices
|
SOUND_DEVICE_ALL_MASK |
Mask for all devices
|
Enumeration for sound device state.
- Since :
- 2.3
- Enumerator:
SOUND_DEVICE_STATE_DEACTIVATED |
Deactivated state
|
SOUND_DEVICE_STATE_ACTIVATED |
Activated state
|
Enumeration for sound device type.
- Since :
- 2.3
- Enumerator:
SOUND_DEVICE_BUILTIN_SPEAKER |
Built-in speaker
|
SOUND_DEVICE_BUILTIN_RECEIVER |
Built-in receiver
|
SOUND_DEVICE_BUILTIN_MIC |
Built-in mic
|
SOUND_DEVICE_AUDIO_JACK |
Audio jack that can be connected to wired accessory such as headphone, headset, and so on
|
SOUND_DEVICE_BLUETOOTH |
Bluetooth
|
SOUND_DEVICE_HDMI |
HDMI
|
SOUND_DEVICE_MIRRORING |
MIRRORING
|
SOUND_DEVICE_USB_AUDIO |
USB Audio
|
Function Documentation
Registers a callback function to be invoked when the state of connection of a sound device was changed.
- Since :
- 2.3
- Parameters:
-
[in] | device_mask | The mask value |
[in] | callback | The interrupted callback function |
[in] | user_data | The user data to be passed to the callback function |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- Postcondition:
- sound_device_connected_cb() will be invoked.
- See also:
- sound_manager_unset_device_connected_cb()
-
sound_device_connected_cb()
Unregisters the callback function which is called when the state of connection of a sound device was changed.
- Since :
- 2.3
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- sound_manager_set_device_connected_cb()