mediaplayer_acquire()

Acquire the status of active media player in the system.

Synopsis:

#include <bps/mediaplayer.h>

BPS_API int mediaplayer_acquire(char **id)

Since:

BlackBerry 10.0.0

Arguments:

id: If not NULL, the ID used in the acquire request will be returned in id. The caller must free this buffer using bps_free(). This same ID will be delivered in the corresponding MEDIAPLAYER_ACQUIRE_RESULT event.

Library:

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

Description:

The mediaplayer_acquire() function requests that the system establish the calling player as the active media player in the system. The previous active media player (if any) will have its active state revoked. To support the cooperative rules of engagement, media players must send acquire before they begin media playback, to allow other players to stop playback. Media players should only do this on an explicit action by the user (the user pressed the play button or just launched the player).

Returns:

BPS_SUCCESS when the function completes successfully, BPS_FAILURE with errno value set otherwise.