Tizen Native API
5.0
|
The Player API provides functions for media playback and controlling media playback attributes.
#include <player.h>
The Player API provides a way to play multimedia content. Content can be played from a file, from the network, or from memory. It gives the ability to start/stop/pause/mute, set the playback position (that is, seek), perform various status queries, and control the display.
Additional functions allow registering notifications via callback functions for various state change events.
This API also enables collaboration with the GUI service to present a video.
Playback of multimedia content is controlled by a state machine. The following diagram shows the life cycle and states of the Player.
FUNCTION | PRE-STATE | POST-STATE | SYNC TYPE |
---|---|---|---|
player_create() | NONE | IDLE | SYNC |
player_destroy() | IDLE | NONE | SYNC |
player_prepare() | IDLE | READY | SYNC |
player_prepare_async() | IDLE | READY | ASYNC |
player_unprepare() | READY, PLAYING or PAUSED | IDLE | SYNC |
player_start() | READY or PAUSED | PLAYING | SYNC |
player_stop() | PLAYING | READY | SYNC |
player_pause() | PLAYING | PAUSED | SYNC |
The following table shows state-dependent function calls. It is forbidden to call the functions listed below in wrong states. Violation of this rule may result in unpredictable behavior.
All functions that change the player state are synchronous except player_prepare_async(), player_set_play_position(), and player_capture_video(). Thus the result is passed to the application via the callback mechanism.
This API is related with the following features:
Functions | |
int | player_create (player_h *player) |
Creates a player handle for playing multimedia content. | |
int | player_destroy (player_h player) |
Destroys the media player handle and releases all its resources. | |
int | player_prepare (player_h player) |
Prepares the media player for playback. | |
int | player_prepare_async (player_h player, player_prepared_cb callback, void *user_data) |
Prepares the media player for playback, asynchronously. | |
int | player_unprepare (player_h player) |
Resets the media player. | |
int | player_set_uri (player_h player, const char *uri) |
Sets the data source (file-path, HTTP or RTSP URI) to use. | |
int | player_set_memory_buffer (player_h player, const void *data, int size) |
Sets memory as the data source. | |
int | player_get_state (player_h player, player_state_e *state) |
Gets the player's current state. | |
int | player_set_volume (player_h player, float left, float right) |
Sets the player's volume. | |
int | player_get_volume (player_h player, float *left, float *right) |
Gets the player's current volume factor. | |
int | player_set_sound_stream_info (player_h player, sound_stream_info_h stream_info) |
Sets the player's sound manager stream information. | |
int | player_set_audio_latency_mode (player_h player, audio_latency_mode_e latency_mode) |
Sets the audio latency mode. | |
int | player_get_audio_latency_mode (player_h player, audio_latency_mode_e *latency_mode) |
Gets the current audio latency mode. | |
int | player_start (player_h player) |
Starts or resumes playback. | |
int | player_stop (player_h player) |
Stops playing media content. | |
int | player_pause (player_h player) |
Pauses the player. | |
int | player_set_play_position (player_h player, int milliseconds, bool accurate, player_seek_completed_cb callback, void *user_data) |
Sets the seek position for playback, asynchronously. | |
int | player_set_play_position_nsec (player_h player, int64_t nanoseconds, bool accurate, player_seek_completed_cb callback, void *user_data) |
Sets the seek position in nanoseconds for playback, asynchronously. | |
int | player_get_play_position (player_h player, int *milliseconds) |
Gets the current position in milliseconds. | |
int | player_get_play_position_nsec (player_h player, int64_t *nanoseconds) |
Gets the current position in nanoseconds. | |
int | player_set_mute (player_h player, bool muted) |
Sets the player's mute status. | |
int | player_is_muted (player_h player, bool *muted) |
Gets the player's mute status. | |
int | player_set_looping (player_h player, bool looping) |
Sets the player's looping status. | |
int | player_is_looping (player_h player, bool *looping) |
Gets the player's looping status. | |
int | player_set_display (player_h player, player_display_type_e type, player_display_h display) |
Sets the video display. | |
int | player_set_media_packet_video_frame_decoded_cb (player_h player, player_media_packet_video_decoded_cb callback, void *user_data) |
Sets a media packet video callback function to be called once per frame. | |
int | player_unset_media_packet_video_frame_decoded_cb (player_h player) |
Unsets the media packet video frame callback function. | |
int | player_push_media_stream (player_h player, media_packet_h packet) |
Pushes elementary stream to decode audio or video. | |
int | player_set_media_stream_info (player_h player, player_stream_type_e type, media_format_h format) |
Sets contents information for media stream. | |
int | player_set_media_stream_buffer_status_cb (player_h player, player_stream_type_e type, player_media_stream_buffer_status_cb callback, void *user_data) |
Sets a callback function to be invoked when buffer underrun or overflow is occurred. | |
int | player_unset_media_stream_buffer_status_cb (player_h player, player_stream_type_e type) |
Unsets the buffer status callback function. | |
int | player_set_media_stream_seek_cb (player_h player, player_stream_type_e type, player_media_stream_seek_cb callback, void *user_data) |
Sets a callback function to be invoked when seeking is occurred. | |
int | player_unset_media_stream_seek_cb (player_h player, player_stream_type_e type) |
Unsets the seek callback function. | |
int | player_set_media_stream_buffer_max_size (player_h player, player_stream_type_e type, unsigned long long max_size) |
Sets the max size bytes of buffer. | |
int | player_get_media_stream_buffer_max_size (player_h player, player_stream_type_e type, unsigned long long *max_size) |
Gets the max size bytes of buffer. | |
int | player_set_media_stream_buffer_min_threshold (player_h player, player_stream_type_e type, unsigned int percent) |
Sets the buffer threshold percent of buffer. | |
int | player_get_media_stream_buffer_min_threshold (player_h player, player_stream_type_e type, unsigned int *percent) |
Gets the buffer threshold percent of buffer. | |
int | player_capture_video (player_h player, player_video_captured_cb callback, void *user_data) |
Captures the video frame, asynchronously. | |
int | player_set_completed_cb (player_h player, player_completed_cb callback, void *user_data) |
Sets a callback function to be invoked when the playback is finished. | |
int | player_unset_completed_cb (player_h player) |
Unsets the playback completed callback function. | |
int | player_set_interrupted_cb (player_h player, player_interrupted_cb callback, void *user_data) |
Sets a callback function to be invoked when the playback is interrupted or the interrupt is completed. | |
int | player_unset_interrupted_cb (player_h player) |
Unsets the interrupted callback function. | |
int | player_set_error_cb (player_h player, player_error_cb callback, void *user_data) |
Sets a callback function to be invoked when an error occurs. | |
int | player_unset_error_cb (player_h player) |
Unsets the error callback function. | |
int | player_set_playback_rate (player_h player, float rate) |
Sets the playback rate. | |
int | player_get_current_track (player_h player, player_stream_type_e type, int *index) |
Gets current track index. | |
int | player_get_track_language_code (player_h player, player_stream_type_e type, int index, char **code) |
Gets language code of a track. | |
int | player_get_track_count (player_h player, player_stream_type_e type, int *count) |
Gets the track count. | |
int | player_select_track (player_h player, player_stream_type_e type, int index) |
Selects a track to play. | |
int | player_set_audio_only (player_h player, bool audio_only) |
Sets the audio only mode. | |
int | player_is_audio_only (player_h player, bool *audio_only) |
Gets the audio only mode status. | |
int | player_set_replaygain_enabled (player_h player, bool enabled) |
Sets the player's replaygain status. | |
int | player_is_replaygain_enabled (player_h player, bool *enabled) |
Gets the player's replaygain status. | |
int | player_set_video_roi_area (player_h player, double x_scale, double y_scale, double w_scale, double h_scale) |
Sets the ROI (Region Of Interest) area of the content video source. | |
int | player_get_video_roi_area (player_h player, double *x_scale, double *y_scale, double *w_scale, double *h_scale) |
Gets the ROI (Region Of Interest) area of the content video source. | |
Typedefs | |
typedef struct player_s * | player_h |
The media player's type handle. | |
typedef void(* | player_prepared_cb )(void *user_data) |
Called when the media player is prepared. | |
typedef void(* | player_completed_cb )(void *user_data) |
Called when the media player is completed. | |
typedef void(* | player_seek_completed_cb )(void *user_data) |
Called when the seek operation is completed. | |
typedef void(* | player_interrupted_cb )(player_interrupted_code_e code, void *user_data) |
Called when the media player is interrupted. | |
typedef void(* | player_error_cb )(int error_code, void *user_data) |
Called when an error occurs in the media player. | |
typedef void(* | player_video_captured_cb )(unsigned char *captured_data, int width, int height, unsigned int size, void *user_data) |
Called when the video is captured. | |
typedef void(* | player_media_packet_video_decoded_cb )(media_packet_h packet, void *user_data) |
Called to register for notifications about delivering media packet when every video frame is decoded. | |
typedef void(* | player_media_stream_buffer_status_cb )(player_media_stream_buffer_status_e status, void *user_data) |
Called when the buffer level drops below the threshold of max size or no free space in buffer. | |
typedef void(* | player_media_stream_seek_cb )(unsigned long long offset, void *user_data) |
Called to notify the next push-buffer offset when seeking is occurred. |
typedef void(* player_completed_cb)(void *user_data) |
Called when the media player is completed.
It will be invoked when player has reached the end of the stream.
[in] | user_data | The user data passed from the callback registration function |
typedef void(* player_error_cb)(int error_code, void *user_data) |
Called when an error occurs in the media player.
Following error codes can be delivered. PLAYER_ERROR_INVALID_OPERATION PLAYER_ERROR_INVALID_STATE PLAYER_ERROR_INVALID_URI PLAYER_ERROR_CONNECTION_FAILED PLAYER_ERROR_DRM_NOT_PERMITTED PLAYER_ERROR_FILE_NO_SPACE_ON_DEVICE PLAYER_ERROR_NOT_SUPPORTED_FILE PLAYER_ERROR_SEEK_FAILED PLAYER_ERROR_SERVICE_DISCONNECTED PLAYER_ERROR_NOT_SUPPORTED_AUDIO_CODEC (Since 4.0) PLAYER_ERROR_NOT_SUPPORTED_VIDEO_CODEC (Since 4.0) PLAYER_ERROR_NOT_SUPPORTED_SUBTITLE (Since 4.0)
[in] | error_code | The error code |
[in] | user_data | The user data passed from the callback registration function |
typedef struct player_s* player_h |
The media player's type handle.
typedef void(* player_interrupted_cb)(player_interrupted_code_e code, void *user_data) |
Called when the media player is interrupted.
If the code is PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT, the player state will be one of PLAYER_STATE_IDLE, PLAYER_STATE_READY, or PLAYER_STATE_PAUSED. Application should get exact state by calling player_get_state().
[in] | code | The interrupted error code |
[in] | user_data | The user data passed from the callback registration function |
typedef void(* player_media_packet_video_decoded_cb)(media_packet_h packet, void *user_data) |
Called to register for notifications about delivering media packet when every video frame is decoded.
[in] | packet | Reference pointer to the media packet |
[in] | user_data | The user data passed from the callback registration function |
typedef void(* player_media_stream_buffer_status_cb)(player_media_stream_buffer_status_e status, void *user_data) |
Called when the buffer level drops below the threshold of max size or no free space in buffer.
[in] | status | The buffer status |
[in] | user_data | The user data passed from the callback registration function |
typedef void(* player_media_stream_seek_cb)(unsigned long long offset, void *user_data) |
Called to notify the next push-buffer offset when seeking is occurred.
The next push-buffer should produce buffers from the new offset.
[in] | offset | The new byte position to seek |
[in] | user_data | The user data passed from the callback registration function |
typedef void(* player_prepared_cb)(void *user_data) |
Called when the media player is prepared.
It will be invoked when player has reached the begin of stream.
[in] | user_data | The user data passed from the callback registration function |
typedef void(* player_seek_completed_cb)(void *user_data) |
Called when the seek operation is completed.
[in] | user_data | The user data passed from the callback registration function |
typedef void(* player_video_captured_cb)(unsigned char *captured_data, int width, int height, unsigned int size, void *user_data) |
Called when the video is captured.
[in] | captured_data | The captured image buffer |
[in] | width | The width of the captured image |
[in] | height | The height of the captured image |
[in] | size | The size of the captured image |
[in] | user_data | The user data passed from the callback registration function |
enum audio_latency_mode_e |
Enumeration for display type.
PLAYER_DISPLAY_TYPE_OVERLAY |
Overlay surface display |
PLAYER_DISPLAY_TYPE_OBSOLETE_EVAS_WNONE |
Obsolete. Acts as PLAYER_DISPLAY_TYPE_NONE on Wearable, PLAYER_DISPLAY_TYPE_EVAS in all other cases. This symbol was added for backward compatibility reasons. It should not be used. (Deprecated since 4.0) |
PLAYER_DISPLAY_TYPE_OBSOLETE_NONE_WEVAS |
Obsolete. Acts as PLAYER_DISPLAY_TYPE_EVAS on Wearable 3.0 and later, PLAYER_DISPLAY_TYPE_NONE in all other cases. This symbol was added for backward compatibility reasons. It should not be used. (Deprecated since 4.0) |
PLAYER_DISPLAY_TYPE_EVAS |
Evas image object surface display (Since 4.0) |
PLAYER_DISPLAY_TYPE_NONE |
This disposes of buffers (Since 4.0) |
enum player_error_e |
Enumeration for media player's error codes.
Enumeration of media stream buffer status.
enum player_state_e |
Enumeration for media player state.
enum player_stream_type_e |
int player_capture_video | ( | player_h | player, |
player_video_captured_cb | callback, | ||
void * | user_data | ||
) |
Captures the video frame, asynchronously.
[in] | player | The handle to the media player |
[in] | callback | The callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_create | ( | player_h * | player | ) |
Creates a player handle for playing multimedia content.
[out] | player | A new handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_OUT_OF_MEMORY | Out of memory |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_RESOURCE_LIMIT | Cannot create more instance due to resource(socket, thread, etc) limitation on system. |
int player_destroy | ( | player_h | player | ) |
Destroys the media player handle and releases all its resources.
[in] | player | The handle to the media player to be destroyed |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_get_audio_latency_mode | ( | player_h | player, |
audio_latency_mode_e * | latency_mode | ||
) |
Gets the current audio latency mode.
[in] | player | The handle to the media player |
[out] | latency_mode | The latency mode to get from the audio |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_get_current_track | ( | player_h | player, |
player_stream_type_e | type, | ||
int * | index | ||
) |
Gets current track index.
Index starts from 0.
[in] | player | The handle to the media player |
[in] | type | The type of target stream which is PLAYER_STREAM_TYPE_AUDIO or PLAYER_STREAM_TYPE_TEXT |
[out] | index | The index of track |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_get_media_stream_buffer_max_size | ( | player_h | player, |
player_stream_type_e | type, | ||
unsigned long long * | max_size | ||
) |
Gets the max size bytes of buffer.
[in] | player | The handle to the media player |
[in] | type | The type of target stream |
[out] | max_size | The max bytes of buffer |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_get_media_stream_buffer_min_threshold | ( | player_h | player, |
player_stream_type_e | type, | ||
unsigned int * | percent | ||
) |
Gets the buffer threshold percent of buffer.
[in] | player | The handle to the media player |
[in] | type | The type of target stream |
[out] | percent | The minimum threshold(0~100) of buffer |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_get_play_position | ( | player_h | player, |
int * | milliseconds | ||
) |
Gets the current position in milliseconds.
[in] | player | The handle to the media player |
[out] | milliseconds | The current position in milliseconds |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_SEEK_FAILED | Seek operation failure |
int player_get_play_position_nsec | ( | player_h | player, |
int64_t * | nanoseconds | ||
) |
Gets the current position in nanoseconds.
[in] | player | The handle to the media player |
[out] | nanoseconds | The current position in nanoseconds |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_SEEK_FAILED | Seek operation failure |
int player_get_state | ( | player_h | player, |
player_state_e * | state | ||
) |
Gets the player's current state.
[in] | player | The handle to the media player |
[out] | state | The current state of the player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_get_track_count | ( | player_h | player, |
player_stream_type_e | type, | ||
int * | count | ||
) |
Gets the track count.
[in] | player | The handle to the media player |
[in] | type | The type of target stream which is PLAYER_STREAM_TYPE_AUDIO or PLAYER_STREAM_TYPE_TEXT |
[out] | count | The number of track |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_get_track_language_code | ( | player_h | player, |
player_stream_type_e | type, | ||
int | index, | ||
char ** | code | ||
) |
Gets language code of a track.
free()
by caller [in] | player | The handle to the media player |
[in] | type | The type of target stream which is PLAYER_STREAM_TYPE_AUDIO or PLAYER_STREAM_TYPE_TEXT |
[in] | index | The index of track |
[out] | code | A language code in ISO 639-1. "und" will be returned if the language is undefined. |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_get_video_roi_area | ( | player_h | player, |
double * | x_scale, | ||
double * | y_scale, | ||
double * | w_scale, | ||
double * | h_scale | ||
) |
Gets the ROI (Region Of Interest) area of the content video source.
[in] | player | The handle to the media player |
[out] | x_scale | The current X coordinate ratio value of the video source area based on the video width size |
[out] | y_scale | The current Y coordinate ratio value of the video source area based on the video height size |
[out] | w_scale | The current width ratio value of the video source area based on the video width size |
[out] | h_scale | The current height ratio value of the video source area based on the video height size |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_get_volume | ( | player_h | player, |
float * | left, | ||
float * | right | ||
) |
Gets the player's current volume factor.
The range of left and right is from 0
to 1.0
, inclusive (1.0 = 100%). This function gets the player volume, not the system volume. To get the system volume, use the Sound Manager API.
[in] | player | The handle to the media player |
[out] | left | The current left volume scalar |
[out] | right | The current right volume scalar |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_is_audio_only | ( | player_h | player, |
bool * | audio_only | ||
) |
Gets the audio only mode status.
[in] | player | The handle to the media player |
[out] | audio_only | The current audio only status: (true = audio only enabled, false = audio only disabled) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_is_looping | ( | player_h | player, |
bool * | looping | ||
) |
Gets the player's looping status.
If the looping status is true
, playback automatically restarts upon finishing. If it is false
, it won't.
[in] | player | The handle to the media player |
[out] | looping | The looping status: (true = looping, false = non-looping ) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_is_muted | ( | player_h | player, |
bool * | muted | ||
) |
Gets the player's mute status.
If the mute status is true
, no sounds are played. If it is false
, sounds are played at the previously set volume level.
[in] | player | The handle to the media player |
[out] | muted | The current mute status: (true = mute, false = not muted) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_is_replaygain_enabled | ( | player_h | player, |
bool * | enabled | ||
) |
Gets the player's replaygain status.
[in] | player | The handle to the media player |
[out] | enabled | Pointer to store current replaygain status: (true = enabled replaygain, false = disabled replaygain) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_pause | ( | player_h | player | ) |
Pauses the player.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid state |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_SOUND_POLICY | Sound policy error |
int player_prepare | ( | player_h | player | ) |
Prepares the media player for playback.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_URI | Invalid URI |
PLAYER_ERROR_NO_SUCH_FILE | File not found |
PLAYER_ERROR_NOT_SUPPORTED_FILE | File not supported |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_PERMISSION_DENIED | Permission denied |
PLAYER_ERROR_NOT_SUPPORTED_AUDIO_CODEC | Not support audio codec format (Since 4.0) |
PLAYER_ERROR_NOT_SUPPORTED_VIDEO_CODEC | Not support video codec format (Since 4.0) |
int player_prepare_async | ( | player_h | player, |
player_prepared_cb | callback, | ||
void * | user_data | ||
) |
Prepares the media player for playback, asynchronously.
[in] | player | The handle to the media player |
[in] | callback | The callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_URI | Invalid URI |
PLAYER_ERROR_NO_SUCH_FILE | File not found |
PLAYER_ERROR_NOT_SUPPORTED_FILE | File not supported |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_PERMISSION_DENIED | Permission denied |
int player_push_media_stream | ( | player_h | player, |
media_packet_h | packet | ||
) |
Pushes elementary stream to decode audio or video.
[in] | player | The handle to media player |
[in] | packet | The media packet to decode |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_STATE | Invalid state |
PLAYER_ERROR_NOT_SUPPORTED_FILE | File not supported |
PLAYER_ERROR_BUFFER_SPACE | No buffer space available (since 3.0) |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation (since 3.0) |
int player_select_track | ( | player_h | player, |
player_stream_type_e | type, | ||
int | index | ||
) |
Selects a track to play.
[in] | player | The handle to the media player |
[in] | type | The type of target stream which is PLAYER_STREAM_TYPE_AUDIO or PLAYER_STREAM_TYPE_TEXT |
[in] | index | The index of track |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_set_audio_latency_mode | ( | player_h | player, |
audio_latency_mode_e | latency_mode | ||
) |
Sets the audio latency mode.
[in] | player | The handle to the media player |
[in] | latency_mode | The latency mode to be applied to the audio |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_set_audio_only | ( | player_h | player, |
bool | audio_only | ||
) |
Sets the audio only mode.
This function is used to disable or enable video rendering during playback.
[in] | player | The handle to the media player |
[in] | audio_only | The new audio only status: (true = enable audio only, false = disable audio only) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_set_completed_cb | ( | player_h | player, |
player_completed_cb | callback, | ||
void * | user_data | ||
) |
Sets a callback function to be invoked when the playback is finished.
[in] | player | The handle to the media player |
[in] | callback | The callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_set_display | ( | player_h | player, |
player_display_type_e | type, | ||
player_display_h | display | ||
) |
Sets the video display.
[in] | player | The handle to the media player |
[in] | type | The display type |
[in] | display | The handle to display |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_set_error_cb | ( | player_h | player, |
player_error_cb | callback, | ||
void * | user_data | ||
) |
Sets a callback function to be invoked when an error occurs.
[in] | player | The handle to the media player |
[in] | callback | The callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_set_interrupted_cb | ( | player_h | player, |
player_interrupted_cb | callback, | ||
void * | user_data | ||
) |
Sets a callback function to be invoked when the playback is interrupted or the interrupt is completed.
[in] | player | The handle to the media player |
[in] | callback | The callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_set_looping | ( | player_h | player, |
bool | looping | ||
) |
Sets the player's looping status.
If the looping status is true
, playback automatically restarts upon finishing. If it is false
, it won't. The default value is false
.
[in] | player | The handle to the media player |
[in] | looping | The new looping status: (true = looping, false = non-looping ) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_set_media_packet_video_frame_decoded_cb | ( | player_h | player, |
player_media_packet_video_decoded_cb | callback, | ||
void * | user_data | ||
) |
Sets a media packet video callback function to be called once per frame.
[in] | player | The handle to the media player |
[in] | callback | The callback function to be registered |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_STATE | Invalid state |
int player_set_media_stream_buffer_max_size | ( | player_h | player, |
player_stream_type_e | type, | ||
unsigned long long | max_size | ||
) |
Sets the max size bytes of buffer.
[in] | player | The handle to the media player |
[in] | type | The type of target stream |
[in] | max_size | The max bytes of buffer, it has to be bigger than zero. (default: 200000) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_set_media_stream_buffer_min_threshold | ( | player_h | player, |
player_stream_type_e | type, | ||
unsigned int | percent | ||
) |
Sets the buffer threshold percent of buffer.
[in] | player | The handle to the media player |
[in] | type | The type of target stream |
[in] | percent | The minimum threshold(0~100) of buffer (default: 0) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_set_media_stream_buffer_status_cb | ( | player_h | player, |
player_stream_type_e | type, | ||
player_media_stream_buffer_status_cb | callback, | ||
void * | user_data | ||
) |
Sets a callback function to be invoked when buffer underrun or overflow is occurred.
[in] | player | The handle to the media player |
[in] | type | The type of target stream |
[in] | callback | The buffer status callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_set_media_stream_info | ( | player_h | player, |
player_stream_type_e | type, | ||
media_format_h | format | ||
) |
Sets contents information for media stream.
[in] | player | The handle to media player |
[in] | type | The type of target stream |
[in] | format | The media format to set audio information |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_STATE | Invalid state |
int player_set_media_stream_seek_cb | ( | player_h | player, |
player_stream_type_e | type, | ||
player_media_stream_seek_cb | callback, | ||
void * | user_data | ||
) |
Sets a callback function to be invoked when seeking is occurred.
[in] | player | The handle to the media player |
[in] | type | The type of target stream |
[in] | callback | The callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_set_memory_buffer | ( | player_h | player, |
const void * | data, | ||
int | size | ||
) |
Sets memory as the data source.
Associates media content, cached in memory, with the player. Unlike the case of player_set_uri(), the media resides in memory. If the function call is successful, subsequent calls to player_prepare() and player_start() will start playing the media.
[in] | player | The handle to the media player |
[in] | data | The memory pointer of media data |
[in] | size | The size of media data |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_set_mute | ( | player_h | player, |
bool | muted | ||
) |
Sets the player's mute status.
If the mute status is true
, no sounds are played. If it is false
, sounds are played at the previously set volume level. Until this function is called, by default the player is not muted.
[in] | player | The handle to the media player |
[in] | muted | The new mute status: (true = mute, false = not muted) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_set_play_position | ( | player_h | player, |
int | milliseconds, | ||
bool | accurate, | ||
player_seek_completed_cb | callback, | ||
void * | user_data | ||
) |
Sets the seek position for playback, asynchronously.
[in] | player | The handle to the media player |
[in] | milliseconds | The position in milliseconds from the start to the seek point |
[in] | accurate | If true the selected position is returned, but this might be considerably slow, if false the nearest key frame position is returned, this might be faster but less accurate. |
[in] | callback | The callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_SEEK_FAILED | Seek operation failure |
int player_set_play_position_nsec | ( | player_h | player, |
int64_t | nanoseconds, | ||
bool | accurate, | ||
player_seek_completed_cb | callback, | ||
void * | user_data | ||
) |
Sets the seek position in nanoseconds for playback, asynchronously.
[in] | player | The handle to the media player |
[in] | nanoseconds | The position in nanoseconds from the start to the seek point |
[in] | accurate | If true the selected position is returned, but this might be considerably slow, if false the nearest key frame position is returned, this might be faster but less accurate. |
[in] | callback | The callback function to register |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_SEEK_FAILED | Seek operation failure |
int player_set_playback_rate | ( | player_h | player, |
float | rate | ||
) |
Sets the playback rate.
The default value is 1.0
.
0
. 0.0
and over 2.0
. [in] | player | The handle to the media player |
[in] | rate | The playback rate (-5.0x ~ 5.0x) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_set_replaygain_enabled | ( | player_h | player, |
bool | enabled | ||
) |
Sets the player's replaygain status.
If the replaygain status is true
, replaygain is applied (if contents has a replaygain tag). If it is false
, the replaygain isn't affected by tag and properties.
[in] | player | The handle to the media player |
[in] | enabled | The new replaygain status: (true = enable, false = disable) |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_set_sound_stream_info | ( | player_h | player, |
sound_stream_info_h | stream_info | ||
) |
Sets the player's sound manager stream information.
[in] | player | The handle to the media player |
[in] | stream_info | The sound manager info type |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE | Unsupported feature |
#include <player.h> #include <sound_manager.h> ... player_h player = NULL; sound_stream_info_h stream_info = NULL; sound_stream_type_e stream_type = SOUND_STREAM_TYPE_MEDIA; ... sound_manager_create_stream_information (stream_type, _focus_callback, use_data, &stream_info); player_create (&player); player_set_sound_stream_info (player, stream_info); ... player_prepare_async (player, _prepared_cb, udata); ...
int player_set_uri | ( | player_h | player, |
const char * | uri | ||
) |
Sets the data source (file-path, HTTP or RTSP URI) to use.
Associates media contents, referred to by the URI, with the player. If the function call is successful, subsequent calls to player_prepare() and player_start() will start playing the media.
[in] | player | The handle to the media player |
[in] | uri | The content location, such as the file path, the URI of the HTTP or RTSP stream you want to play |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_PERMISSION_DENIED | Permission denied |
int player_set_video_roi_area | ( | player_h | player, |
double | x_scale, | ||
double | y_scale, | ||
double | w_scale, | ||
double | h_scale | ||
) |
Sets the ROI (Region Of Interest) area of the content video source.
This function is to set the ROI area of video content to render it on PLAYER_DISPLAY_TYPE_OVERLAY display with current display mode. It can be regarded as zooming operation because the selected video area will be rendered fit to the display.
[in] | player | The handle to the media player |
[in] | x_scale | X coordinate ratio value of the video source area based on the video width size Valid range is 0.0~1.0. |
[in] | y_scale | Y coordinate ratio value of the video source area based on the video height size Valid range is 0.0~1.0. |
[in] | w_scale | Width ratio value of the video source area based on the video width size Valid range is from greater than 0.0 to 1.0. |
[in] | h_scale | Height ratio value of the video source area based on the video height size Valid range is from greater than 0.0 to 1.0. |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
#include <player.h> ... player_h player = NULL; player_display_h display = NULL; int width = 0, height = 0; ... player_set_display (player, PLAYER_DISPLAY_TYPE_OVERLAY, display); player_get_video_size (player, &width, &height); ... player_set_video_roi_area (30/(double)width, 30/(double)height, 480/(double)width, 270/(double)height); ...
int player_set_volume | ( | player_h | player, |
float | left, | ||
float | right | ||
) |
Sets the player's volume.
Setting this volume adjusts the player's instance volume, not the system volume. The valid range is from 0 to 1.0, inclusive (1.0 = 100%). Default value is 1.0. To change system volume, use the Sound Manager API. Finally, it does not support to set other value into each channel currently.
[in] | player | The handle to the media player |
[in] | left | The left volume scalar |
[in] | right | The right volume scalar |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_start | ( | player_h | player | ) |
Starts or resumes playback.
Plays current media content, or resumes playback if the player is paused or buffering during HTTP streaming play.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_CONNECTION_FAILED | Network connection failed |
PLAYER_ERROR_SOUND_POLICY | Sound policy error |
int player_stop | ( | player_h | player | ) |
Stops playing media content.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid state |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
PLAYER_ERROR_SOUND_POLICY | Sound policy error |
int player_unprepare | ( | player_h | player | ) |
Resets the media player.
The most recently used media is reset and no longer associated with the player. Playback is no longer possible. If you want to use the player again, you must set the data URI and call player_prepare() again.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
PLAYER_ERROR_INVALID_STATE | Invalid player state |
int player_unset_completed_cb | ( | player_h | player | ) |
Unsets the playback completed callback function.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_unset_error_cb | ( | player_h | player | ) |
Unsets the error callback function.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_unset_interrupted_cb | ( | player_h | player | ) |
Unsets the interrupted callback function.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
PLAYER_ERROR_INVALID_OPERATION | Invalid operation |
int player_unset_media_packet_video_frame_decoded_cb | ( | player_h | player | ) |
Unsets the media packet video frame callback function.
[in] | player | The handle to the media player |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_unset_media_stream_buffer_status_cb | ( | player_h | player, |
player_stream_type_e | type | ||
) |
Unsets the buffer status callback function.
[in] | player | The handle to the media player |
[in] | type | The type of target stream |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |
int player_unset_media_stream_seek_cb | ( | player_h | player, |
player_stream_type_e | type | ||
) |
Unsets the seek callback function.
[in] | player | The handle to the media player |
[in] | type | The type of target stream |
0
on success, otherwise a negative error value PLAYER_ERROR_NONE | Successful |
PLAYER_ERROR_INVALID_PARAMETER | Invalid parameter |