Package org.freedesktop.gstreamer.video

Class VideoCodecFrame

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.freedesktop.gstreamer.video.VideoCodecFrame

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class VideoCodecFrame
extends ProxyInstance

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

Constructor Summary

Constructors

Constructor	Description
VideoCodecFrame()	Allocate a new VideoCodecFrame.
VideoCodecFrame(int refCount, int flags, int systemFrameNumber, int decodeFrameNumber, int presentationFrameNumber, ClockTime dts, ClockTime pts, ClockTime duration, int distanceFromSync, Buffer inputBuffer, Buffer outputBuffer, ClockTime deadline, MemorySegment userData, DestroyNotify userDataDestroyNotify)	Allocate a new VideoCodecFrame with the fields set to the provided values.
VideoCodecFrame(int refCount, int flags, int systemFrameNumber, int decodeFrameNumber, int presentationFrameNumber, ClockTime dts, ClockTime pts, ClockTime duration, int distanceFromSync, Buffer inputBuffer, Buffer outputBuffer, ClockTime deadline, MemorySegment userData, DestroyNotify userDataDestroyNotify, Arena arena)	Allocate a new VideoCodecFrame with the fields set to the provided values.
VideoCodecFrame(Arena arena)	Allocate a new VideoCodecFrame.
VideoCodecFrame(MemorySegment address)	Create a VideoCodecFrame proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the VideoCodecFrame class
MemorySegment	getUserData()	Gets private data set on the frame by the subclass via gst_video_codec_frame_set_user_data() previously.
ClockTime	readDeadline()	Read the value of the field deadline.
int	readDecodeFrameNumber()	Read the value of the field decode_frame_number.
int	readDistanceFromSync()	Read the value of the field distance_from_sync.
ClockTime	readDts()	Read the value of the field dts.
ClockTime	readDuration()	Read the value of the field duration.
int	readFlags()	Read the value of the field flags.
Buffer	readInputBuffer()	Read the value of the field input_buffer.
Buffer	readOutputBuffer()	Read the value of the field output_buffer.
int	readPresentationFrameNumber()	Read the value of the field presentation_frame_number.
ClockTime	readPts()	Read the value of the field pts.
int	readRefCount()	Read the value of the field ref_count.
int	readSystemFrameNumber()	Read the value of the field system_frame_number.
MemorySegment	readUserData()	Read the value of the field user_data.
DestroyNotify	readUserDataDestroyNotify()	Read the value of the field user_data_destroy_notify.
VideoCodecFrame	ref()	Increases the refcount of the given frame by one.
void	setUserData()	Sets userData on the frame and the GDestroyNotify that will be called when the frame is freed.
void	unref()	Decreases the refcount of the frame.
void	writeDeadline(ClockTime deadline)	Write a value in the field deadline.
void	writeDecodeFrameNumber(int decodeFrameNumber)	Write a value in the field decode_frame_number.
void	writeDistanceFromSync(int distanceFromSync)	Write a value in the field distance_from_sync.
void	writeDts(ClockTime dts)	Write a value in the field dts.
void	writeDuration(ClockTime duration)	Write a value in the field duration.
void	writeFlags(int flags)	Write a value in the field flags.
void	writeInputBuffer(Buffer inputBuffer)	Write a value in the field input_buffer.
void	writeOutputBuffer(Buffer outputBuffer)	Write a value in the field output_buffer.
void	writePresentationFrameNumber(int presentationFrameNumber)	Write a value in the field presentation_frame_number.
void	writePts(ClockTime pts)	Write a value in the field pts.
void	writeRefCount(int refCount)	Write a value in the field ref_count.
void	writeSystemFrameNumber(int systemFrameNumber)	Write a value in the field system_frame_number.
void	writeUserData(MemorySegment userData)	Write a value in the field user_data.
void	writeUserDataDestroyNotify(DestroyNotify userDataDestroyNotify, Arena _arena)	Write a value in the field user_data_destroy_notify.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VideoCodecFrame

public VideoCodecFrame(MemorySegment address)

Create a VideoCodecFrame proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

VideoCodecFrame

public VideoCodecFrame(Arena arena)

Allocate a new VideoCodecFrame.

Parameters:

arena - to control the memory allocation scope

VideoCodecFrame

public VideoCodecFrame()

Allocate a new VideoCodecFrame. The memory is allocated with Arena.ofAuto().

VideoCodecFrame

public VideoCodecFrame(int refCount,
 int flags,
 int systemFrameNumber,
 int decodeFrameNumber,
 int presentationFrameNumber,
 ClockTime dts,
 ClockTime pts,
 ClockTime duration,
 int distanceFromSync,
 Buffer inputBuffer,
 Buffer outputBuffer,
 ClockTime deadline,
 MemorySegment userData,
 DestroyNotify userDataDestroyNotify,
 Arena arena)

Allocate a new VideoCodecFrame with the fields set to the provided values.

Parameters:

refCount - value for the field refCount

flags - value for the field flags

systemFrameNumber - value for the field systemFrameNumber

decodeFrameNumber - value for the field decodeFrameNumber

presentationFrameNumber - value for the field presentationFrameNumber

dts - value for the field dts

pts - value for the field pts

duration - value for the field duration

distanceFromSync - value for the field distanceFromSync

inputBuffer - value for the field inputBuffer

outputBuffer - value for the field outputBuffer

deadline - value for the field deadline

userData - value for the field userData

userDataDestroyNotify - value for the field userDataDestroyNotify

arena - to control the memory allocation scope

VideoCodecFrame

public VideoCodecFrame(int refCount,
 int flags,
 int systemFrameNumber,
 int decodeFrameNumber,
 int presentationFrameNumber,
 ClockTime dts,
 ClockTime pts,
 ClockTime duration,
 int distanceFromSync,
 Buffer inputBuffer,
 Buffer outputBuffer,
 ClockTime deadline,
 MemorySegment userData,
 DestroyNotify userDataDestroyNotify)

Allocate a new VideoCodecFrame with the fields set to the provided values. The memory is allocated with Arena.ofAuto().

Parameters:

refCount - value for the field refCount

flags - value for the field flags

systemFrameNumber - value for the field systemFrameNumber

decodeFrameNumber - value for the field decodeFrameNumber

presentationFrameNumber - value for the field presentationFrameNumber

dts - value for the field dts

pts - value for the field pts

duration - value for the field duration

distanceFromSync - value for the field distanceFromSync

inputBuffer - value for the field inputBuffer

outputBuffer - value for the field outputBuffer

deadline - value for the field deadline

userData - value for the field userData

userDataDestroyNotify - value for the field userDataDestroyNotify

Method Details

getType

public static Type getType()

Get the GType of the VideoCodecFrame class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readRefCount

public int readRefCount()

Read the value of the field ref_count.

Returns:

The value of the field ref_count

writeRefCount

public void writeRefCount(int refCount)

Write a value in the field ref_count.

Parameters:

refCount - The new value for the field ref_count

readFlags

public int readFlags()

Read the value of the field flags.

Returns:

The value of the field flags

writeFlags

public void writeFlags(int flags)

Write a value in the field flags.

Parameters:

flags - The new value for the field flags

readSystemFrameNumber

public int readSystemFrameNumber()

Read the value of the field system_frame_number.

Returns:

The value of the field system_frame_number

writeSystemFrameNumber

public void writeSystemFrameNumber(int systemFrameNumber)

Write a value in the field system_frame_number.

Parameters:

systemFrameNumber - The new value for the field system_frame_number

readDecodeFrameNumber

public int readDecodeFrameNumber()

Read the value of the field decode_frame_number.

Returns:

The value of the field decode_frame_number

writeDecodeFrameNumber

public void writeDecodeFrameNumber(int decodeFrameNumber)

Write a value in the field decode_frame_number.

Parameters:

decodeFrameNumber - The new value for the field decode_frame_number

readPresentationFrameNumber

public int readPresentationFrameNumber()

Read the value of the field presentation_frame_number.

Returns:

The value of the field presentation_frame_number

writePresentationFrameNumber

public void writePresentationFrameNumber(int presentationFrameNumber)

Write a value in the field presentation_frame_number.

Parameters:

presentationFrameNumber - The new value for the field presentation_frame_number

readDts

public ClockTime readDts()

Read the value of the field dts.

Returns:

The value of the field dts

writeDts

public void writeDts(ClockTime dts)

Write a value in the field dts.

Parameters:

dts - The new value for the field dts

readPts

public ClockTime readPts()

Read the value of the field pts.

Returns:

The value of the field pts

writePts

public void writePts(ClockTime pts)

Write a value in the field pts.

Parameters:

pts - The new value for the field pts

readDuration

public ClockTime readDuration()

Read the value of the field duration.

Returns:

The value of the field duration

writeDuration

public void writeDuration(ClockTime duration)

Write a value in the field duration.

Parameters:

duration - The new value for the field duration

readDistanceFromSync

public int readDistanceFromSync()

Read the value of the field distance_from_sync.

Returns:

The value of the field distance_from_sync

writeDistanceFromSync

public void writeDistanceFromSync(int distanceFromSync)

Write a value in the field distance_from_sync.

Parameters:

distanceFromSync - The new value for the field distance_from_sync

readInputBuffer

public Buffer readInputBuffer()

Read the value of the field input_buffer.

Returns:

The value of the field input_buffer

writeInputBuffer

public void writeInputBuffer(Buffer inputBuffer)

Write a value in the field input_buffer.

Parameters:

inputBuffer - The new value for the field input_buffer

readOutputBuffer

public Buffer readOutputBuffer()

Read the value of the field output_buffer.

Returns:

The value of the field output_buffer

writeOutputBuffer

public void writeOutputBuffer(Buffer outputBuffer)

Write a value in the field output_buffer.

Parameters:

outputBuffer - The new value for the field output_buffer

readDeadline

public ClockTime readDeadline()

Read the value of the field deadline.

Returns:

The value of the field deadline

writeDeadline

public void writeDeadline(ClockTime deadline)

Write a value in the field deadline.

Parameters:

deadline - The new value for the field deadline

readUserData

public MemorySegment readUserData()

Read the value of the field user_data.

Returns:

The value of the field user_data

writeUserData

public void writeUserData(MemorySegment userData)

Write a value in the field user_data.

Parameters:

userData - The new value for the field user_data

readUserDataDestroyNotify

public DestroyNotify readUserDataDestroyNotify()

Read the value of the field user_data_destroy_notify.

Returns:

The value of the field user_data_destroy_notify

writeUserDataDestroyNotify

public void writeUserDataDestroyNotify(DestroyNotify userDataDestroyNotify,
 Arena _arena)

Write a value in the field user_data_destroy_notify.

Parameters:

userDataDestroyNotify - The new value for the field user_data_destroy_notify

_arena - to control the memory allocation scope

getUserData

public MemorySegment getUserData()

Gets private data set on the frame by the subclass via gst_video_codec_frame_set_user_data() previously.

Returns:

The previously set user_data

ref

public VideoCodecFrame ref()

Increases the refcount of the given frame by one.

Returns:

buf

setUserData

public void setUserData()

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

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

unref

public void unref()

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