ClutterGst.VideoSink

g ClutterGst.VideoSink ClutterGst.VideoSink GObject.GInterface GObject.GInterface GstVideo.ColorBalance GstVideo.ColorBalance GObject.GInterface->GstVideo.ColorBalance GstVideo.Navigation GstVideo.Navigation GObject.GInterface->GstVideo.Navigation GObject.InitiallyUnowned GObject.InitiallyUnowned Gst.Object Gst.Object GObject.InitiallyUnowned->Gst.Object GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gst.Element Gst.Element GstBase.BaseSink GstBase.BaseSink Gst.Element->GstBase.BaseSink Gst.Object->Gst.Element GstVideo.VideoSink GstVideo.VideoSink GstBase.BaseSink->GstVideo.VideoSink GstVideo.ColorBalance->ClutterGst.VideoSink GstVideo.Navigation->ClutterGst.VideoSink GstVideo.VideoSink->ClutterGst.VideoSink

Subclasses:None

Properties

Inherited:GstVideo.VideoSink (1), GstBase.BaseSink (12), Gst.Object (2)
Name Type Flags Short Description
update-priority int r/w Priority of video updates in the thread

Signals

Inherited:Gst.Element (3), Gst.Object (1), GObject.Object (1), GstVideo.ColorBalance (1)
Name Short Description
new-frame The sink will emit this signal whenever there are new textures available for a new frame of the video.
new-overlays The sink will emit this signal whenever there are new textures available for set of overlays on the video.
pipeline-ready The sink will emit this signal as soon as it has gathered enough information from the video to configure a pipeline.

Fields

Inherited:Gst.Element (3), Gst.Object (1), GObject.Object (1), GstVideo.ColorBalance (1)
Name Type Access Description
parent GstVideo.VideoSink r  

Class Details

class ClutterGst.VideoSink(**kwargs)
Bases:GstVideo.VideoSink, GstVideo.ColorBalance, GstVideo.Navigation
Abstract:No
Structure:ClutterGst.VideoSinkClass

The ClutterGst.VideoSink structure contains only private data and should be accessed using the provided API.

New in version 3.0.

classmethod new()
Returns:a new ClutterGst.VideoSink
Return type:ClutterGst.VideoSink

Creates a new ClutterGst.VideoSink

New in version 3.0.

get_frame()
Returns:A ClutterGst.Frame or None if there isn’t a frame to be displayed yet.
Return type:ClutterGst.Frame

Returns a ClutterGst.Frame 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.

New in version 3.0.

get_overlays()
Return type:ClutterGst.Overlays
is_ready()
Returns:True if the sink is ready, else False
Return type:bool

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 ClutterGst.VideoSink ::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.

New in version 3.0.

do_new_frame() virtual
do_new_overlays() virtual
do_pipeline_ready() virtual

Signal Details

ClutterGst.VideoSink.signals.new_frame(video_sink)
Signal Name:new-frame
Flags:RUN_LAST
Parameters:video_sink (ClutterGst.VideoSink) – The object which received the signal

The sink will emit this signal whenever there are new textures available for a new frame of the video. After this signal is emitted, an application can call clutter_gst_video_sink_get_pipeline() to get a pipeline suitable for rendering the frame. If the application is using a custom pipeline it can alternatively call clutter_gst_video_sink_attach_frame() to attach the textures.

New in version 3.0.

ClutterGst.VideoSink.signals.new_overlays(video_sink)
Signal Name:new-overlays
Flags:RUN_LAST
Parameters:video_sink (ClutterGst.VideoSink) – The object which received the signal

The sink will emit this signal whenever there are new textures available for set of overlays on the video. After this signal is emitted, an application can call ClutterGst.VideoSink.get_overlays() to get a set of pipelines suitable for rendering overlays on a video frame.

New in version 3.0.

ClutterGst.VideoSink.signals.pipeline_ready(video_sink)
Signal Name:pipeline-ready
Flags:RUN_LAST
Parameters:video_sink (ClutterGst.VideoSink) – The object which received the signal

The sink will emit this signal as soon as it has gathered enough information from the video to configure a pipeline. If the application wants to do some customized rendering, it can setup its pipeline after this signal is emitted. The application’s pipeline will typically either be a copy of the one returned by clutter_gst_video_sink_get_pipeline() or it can be a completely custom pipeline which is setup using clutter_gst_video_sink_setup_pipeline().

Note that it is an error to call either of those functions before this signal is emitted. The ClutterGst.VideoSink ::new-frame signal will only be emitted after the pipeline is ready so the application could also create its pipeline in the handler for that.

New in version 3.0.

Property Details

ClutterGst.VideoSink.props.update_priority
Name:update-priority
Type:int
Default Value:150
Flags:READABLE, WRITABLE

Priority of video updates in the thread