GstVideo.VideoCodecFrame

Fields

Name	Type	Access	Description
deadline	int	r/w	Running time when the frame will be used.
decode_frame_number	int	r
distance_from_sync	int	r/w	Distance in frames from the last synchronization point.
dts	int	r/w	Decoding timestamp
duration	int	r/w	Duration of the frame
events	[object]	r
flags	int	r
input_buffer	Gst.Buffer	r/w	the input Gst.Buffer that created this frame. The buffer is owned by the frame and references to the frame instead of the buffer should be kept.
output_buffer	Gst.Buffer	r/w	the output Gst.Buffer. Implementations should set this either directly, or by using the GstVideo.VideoDecoder.allocate_output_frame() or GstVideo.VideoDecoder.allocate_output_buffer() methods. The buffer is owned by the frame and references to the frame instead of the buffer should be kept.
presentation_frame_number	int	r
pts	int	r/w	Presentation timestamp
ref_count	int	r
system_frame_number	int	r/w	Unique identifier for the frame. Use this if you need to get hold of the frame later (like when data is being decoded). Typical usage in decoders is to set this on the opaque value provided to the library and get back the frame using GstVideo.VideoDecoder.get_frame()
user_data	object	r
user_data_destroy_notify	GLib.DestroyNotify	r

Methods

	get_user_data ()
	ref ()
	set_user_data (user_data, notify)
	unref ()

Details

class GstVideo.VideoCodecFrame

A GstVideo.VideoCodecFrame represents a video frame both in raw and encoded form.

get_user_data()

Returns:

The previously set user_data

Return type:

object or None

Gets private data set on the frame by the subclass via GstVideo.VideoCodecFrame.set_user_data() previously.

ref()

Returns:

buf

Return type:

GstVideo.VideoCodecFrame

Increases the refcount of the given frame by one.

set_user_data(user_data, notify)

Parameters:

• user_data (object or None) – private data

• notify (GLib.DestroyNotify) – a GLib.DestroyNotify

Sets user_data on the frame and the GLib.DestroyNotify that will be called when the frame is freed. Allows to attach private data by the subclass to frames.

If a user_data was previously set, then the previous set notify will be called before the user_data is replaced.

unref()

Decreases the refcount of the frame. If the refcount reaches 0, the frame will be freed.