mediaplayer_register()

Register the media player.

Synopsis:

#include <bps/mediaplayer.h>

BPS_API int mediaplayer_register(const char *name,
                                 int priority,
                                 int audio_type,
                                 int volume_overlay,
                                 char **id)

Since:

BlackBerry 10.0.0

Arguments:

name: The descriptive name.

priority: The priority, one of the values of the media_priority_t enumeration.

audio_type: The audio type, one of the values of the media_audio_type_t enumeration.

volume_overlay: The volume overlay, one of the values of the media_volume_overlay_t enumeration.

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

Library:

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

Description:

The mediaplayer_register() function registers the media player.

Returns:

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