Class: ClutterGst::VideoSink

Inherits:
GstVideo::VideoSink
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ClutterGst::VideoSink

Creates a new Clutter::GstVideoSink

Instance Method Details

#frame ⇒ ClutterGst::Frame

Returns a Clutter::GstFrame object suitable to render the current frame of the given video sink. An application is free to make a copy of this pipeline and modify it for custom rendering.

Returns:

  • (ClutterGst::Frame) —

    A Clutter::GstFrame or NULL if there isn't a frame to be displayed yet.

#is_ready ⇒ Boolean

Returns whether the pipeline is ready and so clutter_gst_video_sink_get_pipeline() and clutter_gst_video_sink_setup_pipeline() can be called without causing error.

Note: Normally an application will wait until the Clutter::GstVideoSink::pipeline-ready signal is emitted instead of polling the ready status with this api, but sometimes when a sink is passed between components that didn't have an opportunity to connect a signal handler this can be useful.

Returns:

  • (Boolean) —

    true if the sink is ready, else false

#overlays ⇒ ClutterGst::Overlays

Returns:

  • (ClutterGst::Overlays)

#pipeline ⇒ ClutterGst::

Returns a pipeline suitable for rendering the current frame of the given video sink. The pipeline will already have the textures for the frame attached. For simple rendering, an application will typically call this function immediately before it paints the video. It can then just paint a rectangle using the returned pipeline.

An application is free to make a copy of this pipeline and modify it for custom rendering.

Note: it is considered an error to call this function before the Clutter::GstVideoSink::pipeline-ready signal is emitted.

Returns:

  • (ClutterGst::) —

    the pipeline for rendering the current frame

#setup_pipeline(pipeline) ⇒ nil

Configures the given pipeline so that will be able to render the video for the sink. This should only be used if the application wants to perform some custom rendering using its own pipeline. Typically an application will call this in response to the Clutter::GstVideoSink::pipeline-ready signal.

Note: it is considered an error to call this function before the Clutter::GstVideoSink::pipeline-ready signal is emitted.

Parameters:

Returns:

  • (nil)

#update_priority ⇒ Integer

Returns update-priority.

Returns:

  • (Integer) —

    update-priority

#update_priority=(update_priority) ⇒ Integer

Parameters:

  • update_priority (Integer)

Returns:

  • (Integer) —

    update-priority

  • (Integer) —

    update-priority