audio_manager_get_handle_for_runtime()

#include <audio/audio_manager_routing.h>
 

int audio_manager_get_handle_for_runtime(audio_manager_runtime_t runtime, audio_manager_audio_type_t type, pid_t caller_pid, bool start_suspended, unsigned int *audioman_handle)

Since:

BlackBerry 10.2.0

Arguments:

type

The type of the audio manager handle to query.

caller_pid

The ID of the process that the audio manager handle is allocated for. The value of zero represents the current process ID.

start_suspended

Whether the handle is to be suspended after allocation. A value of true to suspend the audio source after allocation while a value of false indicates otherwise.

audioman_handle

The handle to the audio source that's allocated.

Library:

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

Description:

An audio manager handle is used to track each audio source. Use audio_manager_get_handle_runtime() to return a handle to the audio source based on the specified audio type and flag to indicate whether the handle to the audio source is immediately activated.

Only use this function when you use audio runtimes that implement their own ducking rules. Applications should not use this function directly.

Returns:

EOK upon success, a negative errno upon failure. The errno values are available in the errno.h file.