gst_player_new ()

GstPlayer *
gst_player_new (GstPlayerVideoRenderer *video_renderer,
                GstPlayerSignalDispatcher *signal_dispatcher);

Creates a new GstPlayer instance that uses signal_dispatcher to dispatch signals to some event loop system, or emits signals directly if NULL is passed. See gst_player_g_main_context_signal_dispatcher_new().

Video is going to be rendered by video_renderer , or if NULL is provided no special video set up will be done and some default handling will be performed.

gst_player_play ()

void
gst_player_play (GstPlayer *player);

Request to play the loaded stream.

gst_player_pause ()

void
gst_player_pause (GstPlayer *player);

Pauses the current stream.

gst_player_stop ()

void
gst_player_stop (GstPlayer *player);

Stops playing the current stream and resets to the first position in the stream.

gst_player_seek ()

void
gst_player_seek (GstPlayer *player,
                 GstClockTime position);

Seeks the currently-playing stream to the absolute position time in nanoseconds.

gst_player_set_uri ()

void
gst_player_set_uri (GstPlayer *player,
                    const gchar *uri);

Sets the next URI to play.

gst_player_get_uri ()

gchar *
gst_player_get_uri (GstPlayer *player);

Gets the URI of the currently-playing stream.

gst_player_get_duration ()

GstClockTime
gst_player_get_duration (GstPlayer *player);

Retrieves the duration of the media stream that self represents.

gst_player_get_position ()

GstClockTime
gst_player_get_position (GstPlayer *player);

gst_player_set_volume ()

void
gst_player_set_volume (GstPlayer *player,
                       gdouble val);

Sets the volume level of the stream as a percentage between 0 and 1.

gst_player_set_mute ()

void
gst_player_set_mute (GstPlayer *player,
                     gboolean val);

TRUE if the currently-playing stream should be muted.

gst_player_get_volume ()

gdouble
gst_player_get_volume (GstPlayer *player);

Returns the current volume level, as a percentage between 0 and 1.

gst_player_get_mute ()

gboolean
gst_player_get_mute (GstPlayer *player);

gst_player_get_pipeline ()

GstElement *
gst_player_get_pipeline (GstPlayer *player);

gst_player_set_config ()

gboolean
gst_player_set_config (GstPlayer *player,
                       GstStructure *config);

Set the configuration of the player. If the player is already configured, and the configuration haven't change, this function will return TRUE. If the player is not in the GST_PLAYER_STATE_STOPPED, this method will return FALSE and active configuration will remain.

config is a GstStructure that contains the configuration parameters for the player.

This function takes ownership of config .

Since: 1.10

gst_player_get_config ()

GstStructure *
gst_player_get_config (GstPlayer *player);

Get a copy of the current configuration of the player. This configuration can either be modified and used for the gst_player_set_config() call or it must be freed after usage.

Since: 1.10

gst_player_state_get_name ()

const gchar *
gst_player_state_get_name (GstPlayerState state);

Gets a string representing the given state.

gst_player_error_get_name ()

const gchar *
gst_player_error_get_name (GstPlayerError error);

Gets a string representing the given error.

gst_player_get_media_info ()

GstPlayerMediaInfo *
gst_player_get_media_info (GstPlayer *player);

A Function to get the current media info GstPlayerMediaInfo instance.

gst_player_set_audio_track ()

gboolean
gst_player_set_audio_track (GstPlayer *player,
                            gint stream_index);

gst_player_set_video_track ()

gboolean
gst_player_set_video_track (GstPlayer *player,
                            gint stream_index);

gst_player_set_subtitle_track ()

gboolean
gst_player_set_subtitle_track (GstPlayer *player,
                               gint stream_index);

gst_player_get_current_audio_track ()

GstPlayerAudioInfo *
gst_player_get_current_audio_track (GstPlayer *player);

A Function to get current audio GstPlayerAudioInfo instance.

gst_player_get_current_video_track ()

GstPlayerVideoInfo *
gst_player_get_current_video_track (GstPlayer *player);

A Function to get current video GstPlayerVideoInfo instance.

gst_player_get_current_subtitle_track ()

GstPlayerSubtitleInfo *
gst_player_get_current_subtitle_track (GstPlayer *player);

A Function to get current subtitle GstPlayerSubtitleInfo instance.

gst_player_set_audio_track_enabled ()

void
gst_player_set_audio_track_enabled (GstPlayer *player,
                                    gboolean enabled);

Enable or disable the current audio track.

gst_player_set_video_track_enabled ()

void
gst_player_set_video_track_enabled (GstPlayer *player,
                                    gboolean enabled);

Enable or disable the current video track.

gst_player_set_subtitle_track_enabled ()

void
gst_player_set_subtitle_track_enabled (GstPlayer *player,
                                       gboolean enabled);

Enable or disable the current subtitle track.

gst_player_set_subtitle_uri ()

void
gst_player_set_subtitle_uri (GstPlayer *player,
                             const gchar *uri);

Sets the external subtitle URI. This should be combined with a call to gst_player_set_subtitle_track_enabled(player , TRUE) so the subtitles are actually rendered.

gst_player_get_subtitle_uri ()

gchar *
gst_player_get_subtitle_uri (GstPlayer *player);

current subtitle URI

gst_player_set_visualization ()

gboolean
gst_player_set_visualization (GstPlayer *player,
                              const gchar *name);

gst_player_set_visualization_enabled ()

void
gst_player_set_visualization_enabled (GstPlayer *player,
                                      gboolean enabled);

Enable or disable the visualization.

gst_player_get_current_visualization ()

gchar *
gst_player_get_current_visualization (GstPlayer *player);

gst_player_color_balance_type_get_name ()

const gchar *
gst_player_color_balance_type_get_name
                               (GstPlayerColorBalanceType type);

Gets a string representing the given color balance type.

gst_player_has_color_balance ()

gboolean
gst_player_has_color_balance (GstPlayer *player);

Checks whether the player has color balance support available.

gst_player_set_color_balance ()

void
gst_player_set_color_balance (GstPlayer *player,
                              GstPlayerColorBalanceType type,
                              gdouble value);

Sets the current value of the indicated channel type to the passed value.

gst_player_get_color_balance ()

gdouble
gst_player_get_color_balance (GstPlayer *player,
                              GstPlayerColorBalanceType type);

Retrieve the current value of the indicated type .

gst_player_get_multiview_mode ()

GstVideoMultiviewFramePacking
gst_player_get_multiview_mode (GstPlayer *player);

Retrieve the current value of the indicated type .

Since: 1.10

gst_player_set_multiview_mode ()

void
gst_player_set_multiview_mode (GstPlayer *player,
                               GstVideoMultiviewFramePacking mode);

Sets the current value of the indicated mode type to the passed value.

Since: 1.10

gst_player_get_multiview_flags ()

GstVideoMultiviewFlags
gst_player_get_multiview_flags (GstPlayer *player);

Retrieve the current value of the indicated type .

Since: 1.10

gst_player_set_multiview_flags ()

void
gst_player_set_multiview_flags (GstPlayer *player,
                                GstVideoMultiviewFlags flags);

Sets the current value of the indicated mode type to the passed value.

Since: 1.10

gst_player_get_audio_video_offset ()

gint64
gst_player_get_audio_video_offset (GstPlayer *player);

Retrieve the current value of audio-video-offset property

Since: 1.10

gst_player_set_audio_video_offset ()

void
gst_player_set_audio_video_offset (GstPlayer *player,
                                   gint64 offset);

Sets audio-video-offset property by value of offset

Since: 1.10

gst_player_get_subtitle_video_offset ()

gint64
gst_player_get_subtitle_video_offset (GstPlayer *player);

Retrieve the current value of subtitle-video-offset property

Since: 1.16

gst_player_set_subtitle_video_offset ()

void
gst_player_set_subtitle_video_offset (GstPlayer *player,
                                      gint64 offset);

Sets subtitle-video-offset property by value of offset

Since: 1.16

gst_player_get_rate ()

gdouble
gst_player_get_rate (GstPlayer *player);

gst_player_set_rate ()

void
gst_player_set_rate (GstPlayer *player,
                     gdouble rate);

Playback at specified rate

gst_player_get_video_snapshot ()

GstSample *
gst_player_get_video_snapshot (GstPlayer *player,
                               GstPlayerSnapshotFormat format,
                               const GstStructure *config);

Get a snapshot of the currently selected video stream, if any. The format can be selected with format and optional configuration is possible with config Currently supported settings are:

Since: 1.12

gst_player_config_set_position_update_interval ()

void
gst_player_config_set_position_update_interval
                               (GstStructure *config,
                                guint interval);

set interval in milliseconds between two position-updated signals. pass 0 to stop updating the position.

Since: 1.10

gst_player_config_get_position_update_interval ()

guint
gst_player_config_get_position_update_interval
                               (const GstStructure *config);

Since: 1.10

gst_player_config_set_user_agent ()

void
gst_player_config_set_user_agent (GstStructure *config,
                                  const gchar *agent);

Set the user agent to pass to the server if player needs to connect to a server during playback. This is typically used when playing HTTP or RTSP streams.

Since: 1.10

gst_player_config_get_user_agent ()

gchar *
gst_player_config_get_user_agent (const GstStructure *config);

Return the user agent which has been configured using gst_player_config_set_user_agent() if any.

Since: 1.10

gst_player_config_set_seek_accurate ()

void
gst_player_config_set_seek_accurate (GstStructure *config,
                                     gboolean accurate);

Enable or disable accurate seeking. When enabled, elements will try harder to seek as accurately as possible to the requested seek position. Generally it will be slower especially for formats that don't have any indexes or timestamp markers in the stream.

If accurate seeking is disabled, elements will seek as close as the request position without slowing down seeking too much.

Accurate seeking is disabled by default.

Since: 1.12

gst_player_config_get_seek_accurate ()

gboolean
gst_player_config_get_seek_accurate (const GstStructure *config);

Since: 1.12

GstPlayer

typedef struct _GstPlayer GstPlayer;

enum GstPlayerState

GST_PLAYER_ERROR

#define      GST_PLAYER_ERROR                         (gst_player_error_quark ())

enum GstPlayerError

enum GstPlayerColorBalanceType

enum GstPlayerSnapshotFormat

GstPlayerSignalDispatcher

typedef struct _GstPlayerSignalDispatcher GstPlayerSignalDispatcher;

struct GstPlayerSignalDispatcherInterface

struct GstPlayerSignalDispatcherInterface {
  GTypeInterface parent_iface;

  void (*dispatch) (GstPlayerSignalDispatcher * self,
                    GstPlayer * player,
                    GstPlayerSignalDispatcherFunc emitter,
                    gpointer data,
                    GDestroyNotify destroy);
};

GstPlayerVideoRenderer

typedef struct _GstPlayerVideoRenderer GstPlayerVideoRenderer;

struct GstPlayerVideoRendererInterface

struct GstPlayerVideoRendererInterface {
  GTypeInterface parent_iface;

  GstElement * (*create_video_sink) (GstPlayerVideoRenderer * self, GstPlayer * player);
};

The “audio-video-offset” property

  “audio-video-offset”       gint64

The synchronisation offset between audio and video in nanoseconds.

Flags: Read / Write

Default value: 0

The “current-audio-track” property

  “current-audio-track”      GstPlayerAudioInfo *

Current audio track information.

Flags: Read

The “current-subtitle-track” property

  “current-subtitle-track”   GstPlayerSubtitleInfo *

Current audio subtitle information.

Flags: Read

The “current-video-track” property

  “current-video-track”      GstPlayerVideoInfo *

Current video track information.

Flags: Read

The “duration” property

  “duration”                 guint64

Duration.

Flags: Read

Default value: 18446744073709551615

The “media-info” property

  “media-info”               GstPlayerMediaInfo *

Current media information.

Flags: Read

The “mute” property

  “mute”                     gboolean

Mute.

Flags: Read / Write

Default value: FALSE

The “pipeline” property

  “pipeline”                 GstElement *

GStreamer pipeline that is used.

Flags: Read

The “position” property

  “position”                 guint64

Current Position.

Flags: Read

Default value: 18446744073709551615

The “rate” property

  “rate”                     gdouble

Playback rate.

Flags: Read / Write

Allowed values: [-64,64]

Default value: 1

The “signal-dispatcher” property

  “signal-dispatcher”        GstPlayerSignalDispatcher *

Dispatcher for the signals to e.g. event loops.

Flags: Write / Construct Only

The “subtitle-video-offset” property

  “subtitle-video-offset”    gint64

The synchronisation offset between text and video in nanoseconds.

Flags: Read / Write

Default value: 0

The “suburi” property

  “suburi”                   gchar *

Current Subtitle URI.

Flags: Read / Write

Default value: NULL

The “uri” property

  “uri”                      gchar *

Current URI.

Flags: Read / Write

Default value: NULL

The “video-multiview-flags” property

  “video-multiview-flags”    GstVideoMultiviewFlags

Override details of the multiview frame layout.

Flags: Read / Write

The “video-multiview-mode” property

  “video-multiview-mode”     GstVideoMultiviewFramePacking

Re-interpret a video stream as one of several frame-packed stereoscopic modes.

Flags: Read / Write

Default value: GST_VIDEO_MULTIVIEW_FRAME_PACKING_NONE

The “video-renderer” property

  “video-renderer”           GstPlayerVideoRenderer *

Video renderer to use for rendering videos.

Flags: Write / Construct Only

The “volume” property

  “volume”                   gdouble

Volume.

Flags: Read / Write

Allowed values: [0,10]

Default value: 1

The “buffering” signal

void
user_function (GstPlayer *gstplayer,
               gint       arg1,
               gpointer   user_data)

Flags: No Hooks

The “duration-changed” signal

void
user_function (GstPlayer *gstplayer,
               guint64    arg1,
               gpointer   user_data)

Flags: No Hooks

The “end-of-stream” signal

void
user_function (GstPlayer *gstplayer,
               gpointer   user_data)

Flags: No Hooks

The “error” signal

void
user_function (GstPlayer *gstplayer,
               GError    *arg1,
               gpointer   user_data)

Flags: No Hooks

The “media-info-updated” signal

void
user_function (GstPlayer          *gstplayer,
               GstPlayerMediaInfo *arg1,
               gpointer            user_data)

Flags: No Hooks

The “mute-changed” signal

void
user_function (GstPlayer *gstplayer,
               gpointer   user_data)

Flags: No Hooks

The “position-updated” signal

void
user_function (GstPlayer *gstplayer,
               guint64    arg1,
               gpointer   user_data)

Flags: No Hooks

The “seek-done” signal

void
user_function (GstPlayer *gstplayer,
               guint64    arg1,
               gpointer   user_data)

Flags: No Hooks

The “state-changed” signal

void
user_function (GstPlayer     *gstplayer,
               GstPlayerState arg1,
               gpointer       user_data)

Flags: No Hooks

The “uri-loaded” signal

void
user_function (GstPlayer *gstplayer,
               gchar     *arg1,
               gpointer   user_data)

Flags: No Hooks

The “video-dimensions-changed” signal

void
user_function (GstPlayer *gstplayer,
               gint       arg1,
               gint       arg2,
               gpointer   user_data)

Flags: No Hooks

The “volume-changed” signal

void
user_function (GstPlayer *gstplayer,
               gpointer   user_data)

Flags: No Hooks

The “warning” signal

void
user_function (GstPlayer *gstplayer,
               GError    *arg1,
               gpointer   user_data)

Flags: No Hooks