Starting from GStreamer 1.20, application developers are strongly advised to migrate to #GstPlay.
#GstPlayer will be deprecated in 1.20 and most likely removed by 1.24.
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.
This also initializes GStreamer via `gst_init()` on the first call if this
didn't happen before.
a new #GstPlayer instance
GstPlayerVideoRenderer to use
GstPlayerSignalDispatcher to use
current position update interval in milliseconds
a #GstPlayer configuration
%TRUE if accurate seeking is enabled
a #GstPlayer configuration
Return the user agent which has been configured using
gst_player_config_set_user_agent() if any.
the configured agent, or %NULL
a #GstPlayer configuration
set interval in milliseconds between two position-updated signals.
pass 0 to stop updating the position.
a #GstPlayer configuration
interval in ms
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.
a #GstPlayer configuration
accurate seek or not
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.
a #GstPlayer configuration
the string to use as user agent
A #GList of
matching #GstPlayerAudioInfo.
a #GstPlayerMediaInfo
A #GList of
matching #GstPlayerSubtitleInfo.
a #GstPlayerMediaInfo
A #GList of
matching #GstPlayerVideoInfo.
a #GstPlayerMediaInfo
Frees a %NULL terminated array of #GstPlayerVisualization.
a %NULL terminated array of #GstPlayerVisualization to free
a %NULL terminated array containing all available
visualizations. Use gst_player_visualizations_free() after
usage.
Retrieve the current value of audio-video-offset property
The current value of audio-video-offset in nanoseconds
#GstPlayer instance
Retrieve the current value of the indicated @type.
The current value of @type, between [0,1]. In case of
error -1 is returned.
#GstPlayer instance
#GstPlayerColorBalanceType
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.
a copy of the current configuration of @player. Use
gst_structure_free() after usage or gst_player_set_config().
#GstPlayer instance
A Function to get current audio #GstPlayerAudioInfo instance.
current audio track.
The caller should free it with g_object_unref()
#GstPlayer instance
A Function to get current subtitle #GstPlayerSubtitleInfo instance.
current subtitle track.
The caller should free it with g_object_unref()
#GstPlayer instance
A Function to get current video #GstPlayerVideoInfo instance.
current video track.
The caller should free it with g_object_unref()
#GstPlayer instance
Name of the currently enabled
visualization.
g_free() after usage.
#GstPlayer instance
Retrieves the duration of the media stream that self represents.
the duration of the currently-playing media stream, in
nanoseconds.
#GstPlayer instance
A Function to get the current media info #GstPlayerMediaInfo instance.
media info instance.
The caller should free it with g_object_unref()
#GstPlayer instance
Retrieve the current value of the indicated @type.
The current value of @type, Default: 0x00000000 "none
#GstPlayer instance
Retrieve the current value of the indicated @type.
The current value of @type, Default: -1 "none"
#GstPlayer instance
%TRUE if the currently-playing stream is muted.
#GstPlayer instance
The internal playbin instance.
The caller should free it with g_object_unref()
#GstPlayer instance
the absolute position time, in nanoseconds, of the
currently-playing stream.
#GstPlayer instance
current playback rate
#GstPlayer instance
current subtitle URI
URI of the current external subtitle.
g_free() after usage.
#GstPlayer instance
Retrieve the current value of subtitle-video-offset property
The current value of subtitle-video-offset in nanoseconds
#GstPlayer instance
Gets the URI of the currently-playing stream.
a string containing the URI of the
currently-playing stream. g_free() after usage.
#GstPlayer instance
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:
- width, height of type G_TYPE_INT
- pixel-aspect-ratio of type GST_TYPE_FRACTION
Except for GST_PLAYER_THUMBNAIL_RAW_NATIVE format, if no config is set, pixel-aspect-ratio would be 1/1
Current video snapshot sample or %NULL on failure
#GstPlayer instance
output format of the video snapshot
Additional configuration
Returns the current volume level, as a percentage between 0 and 1.
the volume as percentage between 0 and 1.
#GstPlayer instance
Checks whether the @player has color balance support available.
%TRUE if @player has color balance support. Otherwise,
%FALSE.
#GstPlayer instance
Pauses the current stream.
#GstPlayer instance
Request to play the loaded stream.
#GstPlayer instance
Seeks the currently-playing stream to the absolute @position time
in nanoseconds.
#GstPlayer instance
position to seek in nanoseconds
%TRUE or %FALSE
Sets the audio track @stream_idex.
#GstPlayer instance
stream index
Enable or disable the current audio track.
#GstPlayer instance
TRUE or FALSE
Sets audio-video-offset property by value of @offset
#GstPlayer instance
#gint64 in nanoseconds
Sets the current value of the indicated channel @type to the passed
value.
#GstPlayer instance
#GstPlayerColorBalanceType
The new value for the @type, ranged [0,1]
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.
%TRUE when the configuration could be set.
#GstPlayer instance
a #GstStructure
Sets the current value of the indicated mode @type to the passed
value.
#GstPlayer instance
The new value for the @type
Sets the current value of the indicated mode @type to the passed
value.
#GstPlayer instance
The new value for the @type
%TRUE if the currently-playing stream should be muted.
#GstPlayer instance
Mute state the should be set
Playback at specified rate
#GstPlayer instance
playback rate
%TRUE or %FALSE
Sets the subtitle stack @stream_index.
#GstPlayer instance
stream index
Enable or disable the current subtitle track.
#GstPlayer instance
TRUE or FALSE
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.
#GstPlayer instance
subtitle URI
Sets subtitle-video-offset property by value of @offset
#GstPlayer instance
#gint64 in nanoseconds
Sets the next URI to play.
#GstPlayer instance
next URI to play.
%TRUE or %FALSE
Sets the video track @stream_index.
#GstPlayer instance
stream index
Enable or disable the current video track.
#GstPlayer instance
TRUE or FALSE
%TRUE if the visualizations was set correctly. Otherwise,
%FALSE.
#GstPlayer instance
visualization element obtained from
#gst_player_visualizations_get()
Enable or disable the visualization.
#GstPlayer instance
TRUE or FALSE
Sets the volume level of the stream as a percentage between 0 and 1.
This volume is a linear factor. For showing the volume in a GUI it
might make sense to first convert from a different format. Volume sliders
should usually use a cubic volume. See gst_stream_volume_convert_volume().
#GstPlayer instance
the new volume level, as a percentage between 0 and 1
Stops playing the current stream and resets to the first position
in the stream.
#GstPlayer instance
#GstPlayerStreamInfo specific to audio streams.
the audio bitrate in #GstPlayerAudioInfo or -1 if unknown.
a #GstPlayerAudioInfo
the number of audio channels in #GstPlayerAudioInfo or 0 if
unknown.
a #GstPlayerAudioInfo
the language of the stream, or NULL if unknown.
a #GstPlayerAudioInfo
the audio maximum bitrate in #GstPlayerAudioInfo or -1 if unknown.
a #GstPlayerAudioInfo
the audio sample rate in #GstPlayerAudioInfo or 0 if unknown.
a #GstPlayerAudioInfo
hue or color balance.
brightness or black level.
color saturation or chroma
gain.
contrast or luma gain.
Gets a string representing the given color balance type.
a string with the name of the color
balance type.
a #GstPlayerColorBalanceType
generic error.
Gets a string representing the given error.
a string with the given error.
a #GstPlayerError
Creates a new GstPlayerSignalDispatcher that uses @application_context,
or the thread default one if %NULL is used. See gst_player_new().
the new GstPlayerSignalDispatcher
GMainContext to use or %NULL
Structure containing the media information of a URI.
A #GList of
matching #GstPlayerAudioInfo.
a #GstPlayerMediaInfo
the container format or %NULL if unknown.
a #GstPlayerMediaInfo
duration of the media or %GST_CLOCK_TIME_NONE if unknown.
a #GstPlayerMediaInfo
Function to get the image (or preview-image) stored in taglist.
Application can use `gst_sample_*_()` API's to get caps, buffer etc.
GstSample or %NULL.
a #GstPlayerMediaInfo
number of audio streams or 0 if unknown.
a #GstPlayerMediaInfo
number of total streams or 0 if unknown.
a #GstPlayerMediaInfo
number of subtitle streams or 0 if unknown.
a #GstPlayerMediaInfo
number of video streams or 0 if unknown.
a #GstPlayerMediaInfo
A #GList of
matching #GstPlayerStreamInfo.
a #GstPlayerMediaInfo
A #GList of
matching #GstPlayerSubtitleInfo.
a #GstPlayerMediaInfo
the tags contained in media info.
a #GstPlayerMediaInfo
the media title or %NULL if unknown.
a #GstPlayerMediaInfo
the URI associated with #GstPlayerMediaInfo.
a #GstPlayerMediaInfo
A #GList of
matching #GstPlayerVideoInfo.
a #GstPlayerMediaInfo
%TRUE if the media is live.
a #GstPlayerMediaInfo
%TRUE if the media is seekable.
a #GstPlayerMediaInfo
the player is stopped.
the player is buffering.
the player is paused.
the player is currently playing a
stream.
Gets a string representing the given state.
a string with the name of the state.
a #GstPlayerState
Base structure for information concerning a media stream. Depending on
the stream type, one can find more media-specific information in
#GstPlayerVideoInfo, #GstPlayerAudioInfo, #GstPlayerSubtitleInfo.
the #GstCaps of the stream.
a #GstPlayerStreamInfo
A string describing codec used in #GstPlayerStreamInfo.
codec string or %NULL on unknown.
a #GstPlayerStreamInfo
Function to get stream index from #GstPlayerStreamInfo instance or -1 if
unknown.
the stream index of this stream.
a #GstPlayerStreamInfo
Function to return human readable name for the stream type
of the given @info (ex: "audio", "video", "subtitle")
a human readable name
a #GstPlayerStreamInfo
the tags contained in this stream.
a #GstPlayerStreamInfo
#GstPlayerStreamInfo specific to subtitle streams.
the language of the stream, or %NULL if unknown.
a #GstPlayerSubtitleInfo
#GstPlayerStreamInfo specific to video streams.
the current bitrate of video in #GstPlayerVideoInfo or -1 if
unknown.
a #GstPlayerVideoInfo
a #GstPlayerVideoInfo
Numerator of frame rate
Denominator of frame rate
the height of video in #GstPlayerVideoInfo or -1 if unknown.
a #GstPlayerVideoInfo
the maximum bitrate of video in #GstPlayerVideoInfo or -1 if
unknown.
a #GstPlayerVideoInfo
Returns the pixel aspect ratio in @par_n and @par_d
a #GstPlayerVideoInfo
numerator
denominator
the width of video in #GstPlayerVideoInfo or -1 if unknown.
a #GstPlayerVideoInfo
Window handle to use or %NULL
Window handle to use or %NULL
the custom video_sink element to be set for the video renderer
Tell an overlay that it has been exposed. This will redraw the current frame
in the drawable even if the pipeline is PAUSED.
a #GstPlayerVideoOverlayVideoRenderer instance.
Return the currently configured render rectangle. See gst_player_video_overlay_video_renderer_set_render_rectangle()
for details.
a #GstPlayerVideoOverlayVideoRenderer instance
the horizontal offset of the render area inside the window
the vertical offset of the render area inside the window
the width of the render area inside the window
the height of the render area inside the window
The currently set, platform specific window
handle
#GstPlayerVideoRenderer instance
Configure a subregion as a video target within the window set by
gst_player_video_overlay_video_renderer_set_window_handle(). If this is not
used or not supported the video will fill the area of the window set as the
overlay to 100%. By specifying the rectangle, the video can be overlaid to
a specific region of that window only. After setting the new rectangle one
should call gst_player_video_overlay_video_renderer_expose() to force a
redraw. To unset the region pass -1 for the @width and @height parameters.
This method is needed for non fullscreen video overlay in UI toolkits that
do not support subwindows.
a #GstPlayerVideoOverlayVideoRenderer instance
the horizontal offset of the render area inside the window
the vertical offset of the render area inside the window
the width of the render area inside the window
the height of the render area inside the window
Sets the platform specific window handle into which the video
should be rendered
#GstPlayerVideoRenderer instance
handle referencing to the platform specific window
A #GstPlayerVisualization descriptor.
name of the visualization.
description of the visualization.
Makes a copy of the #GstPlayerVisualization. The result must be
freed using gst_player_visualization_free().
an allocated copy of @vis.
#GstPlayerVisualization instance
Frees a #GstPlayerVisualization.
#GstPlayerVisualization instance
Gets a string representing the given color balance type.
a string with the name of the color
balance type.
a #GstPlayerColorBalanceType
Gets a string representing the given error.
a string with the given error.
a #GstPlayerError
Gets a string representing the given state.
a string with the name of the state.
a #GstPlayerState