playsink

playsink

Synopsis

                    GstPlaySink;

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GstObject
               +----GstElement
                     +----GstBin
                           +----GstPlaySink

Implemented Interfaces

GstPlaySink implements GstChildProxy, GstStreamVolume, GstVideoOverlay, GstNavigation and GstColorBalance.

Properties

  "audio-sink"               GstElement*           : Read / Write
  "av-offset"                gint64                : Read / Write
  "flags"                    GstPlayFlags          : Read / Write
  "force-aspect-ratio"       gboolean              : Read / Write
  "mute"                     gboolean              : Read / Write
  "sample"                   GstSample*            : Read
  "send-event-mode"          GstPlaySinkSendEventMode  : Read / Write
  "subtitle-encoding"        gchar*                : Read / Write
  "subtitle-font-desc"       gchar*                : Write
  "text-sink"                GstElement*           : Read / Write
  "video-sink"               GstElement*           : Read / Write
  "vis-plugin"               GstElement*           : Read / Write
  "volume"                   gdouble               : Read / Write
  "audio-filter"             GstElement*           : Read / Write
  "video-filter"             GstElement*           : Read / Write

Signals

  "convert-sample"                                 : Action
  "reconfigure"                                    : Action

Description

Synopsis

Element Information

plugin

playback

author

Wim Taymans <wim.taymans@gmail.com>

class

Generic/Bin/Sink

Element Pads

name

audio_raw_sink

direction

sink

presence

request

details

ANY

name

audio_sink

direction

sink

presence

request

details

ANY

name

text_sink

direction

sink

presence

request

details

ANY

name

video_raw_sink

direction

sink

presence

request

details

ANY

name

video_sink

direction

sink

presence

request

details

ANY

Details

GstPlaySink

typedef struct _GstPlaySink GstPlaySink;

Property Details

The "audio-sink" property

  "audio-sink"               GstElement*           : Read / Write

Set the used audio sink element. NULL will use the default sink. playsink must be in GST_STATE_NULL


The "av-offset" property

  "av-offset"                gint64                : Read / Write

Control the synchronisation offset between the audio and video streams. Positive values make the audio ahead of the video and negative values make the audio go behind the video.

Default value: 0


The "flags" property

  "flags"                    GstPlayFlags          : Read / Write

Control the behaviour of playsink.

Default value: Render the video stream|Render the audio stream|Render subtitles|Use software volume|Use software color balance


The "force-aspect-ratio" property

  "force-aspect-ratio"       gboolean              : Read / Write

When enabled, scaling will respect original aspect ratio.

Default value: TRUE


The "mute" property

  "mute"                     gboolean              : Read / Write

Mute the audio channel without changing the volume.

Default value: FALSE


The "sample" property

  "sample"                   GstSample*            : Read

Get the currently rendered or prerolled sample in the video sink. The GstCaps in the sample will describe the format of the buffer.


The "send-event-mode" property

  "send-event-mode"          GstPlaySinkSendEventMode  : Read / Write

How to send events received in send_event function.

Default value: Default GstBin's send_event handling (default)


The "subtitle-encoding" property

  "subtitle-encoding"        gchar*                : Read / Write

Encoding to assume if input subtitles are not in UTF-8 encoding. If not set, the GST_SUBTITLE_ENCODING environment variable will be checked for an encoding to use. If that is not set either, ISO-8859-15 will be assumed.

Default value: NULL


The "subtitle-font-desc" property

  "subtitle-font-desc"       gchar*                : Write

Pango font description of font to be used for subtitle rendering.

Default value: NULL


The "text-sink" property

  "text-sink"                GstElement*           : Read / Write

Set the used text sink element. NULL will use the default sink. playsink must be in GST_STATE_NULL


The "video-sink" property

  "video-sink"               GstElement*           : Read / Write

Set the used video sink element. NULL will use the default sink. playsink must be in GST_STATE_NULL


The "vis-plugin" property

  "vis-plugin"               GstElement*           : Read / Write

the visualization element to use (NULL = default).


The "volume" property

  "volume"                   gdouble               : Read / Write

Get or set the current audio stream volume. 1.0 means 100%, 0.0 means mute. This uses a linear volume scale.

Allowed values: [0,10]

Default value: 1


The "audio-filter" property

  "audio-filter"             GstElement*           : Read / Write

Set the audio filter element/bin to use. Will apply on a best-effort basis unless GST_PLAY_FLAG_FORCE_FILTERS is set. playsink must be in GST_STATE_NULL


The "video-filter" property

  "video-filter"             GstElement*           : Read / Write

Set the video filter element/bin to use. Will apply on a best-effort basis unless GST_PLAY_FLAG_FORCE_FILTERS is set. playsink must be in GST_STATE_NULL

Signal Details

The "convert-sample" signal

GstSample*          user_function                      (GstPlaySink *playsink,
                                                        GstCaps     *caps,
                                                        gpointer     user_data)      : Action

Action signal to retrieve the currently playing video sample in the format specified by caps. If caps is NULL, no conversion will be performed and this function is equivalent to the "sample" property.

playsink :

a GstPlaySink

caps :

the target format of the sample

user_data :

user data set when the signal handler was connected.

Returns :

a GstSample of the current video sample converted to caps. The caps in the sample will describe the final layout of the buffer data. NULL is returned when no current sample can be retrieved or when the conversion failed.

The "reconfigure" signal

gboolean            user_function                      (GstPlaySink *gstplaysink,
                                                        gpointer     user_data)        : Action