mediaplayer_deregister_button()

Deregister a button to a forwarding action.

Synopsis:

#include <bps/mediaplayer.h>

BPS_API int mediaplayer_deregister_button(int button1,
                                          int button2,
                                          int length,
                                          char **id)

Since:

BlackBerry 10.2.0

Arguments:

button1: The first button. This must be one of the values of the media_button_t enumeration. This value cannot be MEDIA_BUTTON_NONE.

button2: The optional second button. This must be one of the values of the media_button_t enumeration. If the value is not MEDIA_BUTTON_NONE, the function registers the action to be taken when the user presses button1 and button2 simultaneously.

length: The length of the button press. Use one of the values of the media_button_length_t enumeration.

id: When this is not a NULL value, the ID used in the button request is returned when the function completes. The caller must free this buffer using the bps_free() function. The same ID is also delivered in the corresponding MEDIAPLAYER_BUTTON_RESULT event.

Library:

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

Description:

The mediaplayer_deregister_button() function deregisters a previously registered button from forwarding a MEDIAPLAYER_BUTTON event to the application.

Returns:

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