mediaplayer_release()

Release the status of the active media player in the system.

Synopsis:

#include <bps/mediaplayer.h>

BPS_API int mediaplayer_release(char **id)

Since:

BlackBerry 10.0.0

Arguments:

id: If not NULL, the ID used in the release 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_RELEASE_RESULT event.

Library:

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

Description:

The mediaplayer_release() function notifies the system that the calling player is relinquishing its status as the active media player in the system. If the calling player is a higher priority player than any previously active media player that is currently paused, then the higher priority player is acquired and given active status.

Returns:

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