audiodevice_get_info()

#include <bps/audiodevice.h>
 

BPS_API int audiodevice_get_info(audiodevice_device_t device,
                                 audiodevice_info_t **info)

Since:

BlackBerry 10.0.0

Arguments:

device

The audio device to get the information on. If this value is AUDIODEVICE_DEVICE_UNRECOGNIZED or an audio device that's not supported by the device, BPS_FAILURE is returned.

info

This will be populated with the information on the specified audio device. The caller must call audiodevice_free_info() when done with this structure.

Library:

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

Description:

The audiodevice_get_info() function gets the information on the specified audio device.

If the specified audio device does not exist on the platform, this function returns BPS_FAILURE, *info is not updated, and using the unavailable audio device type or accessing *info may result in program error or termination.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.