audiodevice_get()

Retrieve the current audio device and path.

Synopsis:

#include <bps/audiodevice.h>
 
BPS_API int audiodevice_get(audiodevice_device_t *device,
                            char **path)

Since:

BlackBerry 10.0.0

Arguments:

device

A pointer to an audiodevice_device_t value that is populated with the current audio device.

path

The char* value that is populated with the current audio device's path if the function returns BPS_SUCCESS. Upon success the caller is responsible for freeing the buffer using the bps_free() function.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

The audiodevice_get() function gets the current audio device and the path of that device. Note that this will fetch values that are valid at the time this function is called.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.