Package org.freedesktop.gstreamer.base

Class BaseParseFrame

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.freedesktop.gstreamer.base.BaseParseFrame

All Implemented Interfaces:

Proxy

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

Frame (context) data passed to each frame parsing virtual methods. In addition to providing the data to be checked for a valid frame or an already identified frame, it conveys additional metadata or control information from and to the subclass w.r.t. the particular frame in question (rather than global parameters). Some of these may apply to each parsing stage, others only to some a particular one. These parameters are effectively zeroed at start of each frame's processing, i.e. parsing virtual method invocation sequence.

Constructor Summary

Constructors

Constructor	Description
BaseParseFrame(MemorySegment address)	Create a BaseParseFrame proxy instance for the provided memory address.
BaseParseFrame(Buffer buffer, Set<BaseParseFrameFlags> flags, int overhead)	Allocates a new GstBaseParseFrame.
BaseParseFrame(Buffer buffer, BaseParseFrameFlags flags, int overhead)	Allocates a new GstBaseParseFrame.

Method Summary

Modifier and Type	Method	Description
BaseParseFrame	copy()	Copies a GstBaseParseFrame.
void	free()	Frees the provided this BaseParseFrame.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the BaseParseFrame class
void	init()	Sets a GstBaseParseFrame to initial state.
Buffer	readBuffer()	Read the value of the field buffer.
int	readFlags()	Read the value of the field flags.
long	readOffset()	Read the value of the field offset.
Buffer	readOutBuffer()	Read the value of the field out_buffer.
int	readOverhead()	Read the value of the field overhead.
int	readPrivateFlags()	Read the value of the field _private_flags.
int	readSize()	Read the value of the field size.
void	writeBuffer(Buffer buffer)	Write a value in the field buffer.
void	writeFlags(int flags)	Write a value in the field flags.
void	writeOffset(long offset)	Write a value in the field offset.
void	writeOutBuffer(Buffer outBuffer)	Write a value in the field out_buffer.
void	writeOverhead(int overhead)	Write a value in the field overhead.
void	writePrivateFlags(int PrivateFlags)	Write a value in the field _private_flags.
void	writeSize(int size)	Write a value in the field size.

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

BaseParseFrame

public BaseParseFrame(MemorySegment address)

Create a BaseParseFrame proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

BaseParseFrame

public BaseParseFrame(Buffer buffer,
 Set<BaseParseFrameFlags> flags,
 int overhead)

Allocates a new GstBaseParseFrame. This function is mainly for bindings, elements written in C should usually allocate the frame on the stack and then use gst_base_parse_frame_init() to initialise it.

Parameters:

buffer - a GstBuffer

flags - the flags

overhead - number of bytes in this frame which should be counted as metadata overhead, ie. not used to calculate the average bitrate. Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.

BaseParseFrame

public BaseParseFrame(Buffer buffer,
 BaseParseFrameFlags flags,
 int overhead)

Allocates a new GstBaseParseFrame. This function is mainly for bindings, elements written in C should usually allocate the frame on the stack and then use gst_base_parse_frame_init() to initialise it.

Parameters:

buffer - a GstBuffer

flags - the flags

overhead - number of bytes in this frame which should be counted as metadata overhead, ie. not used to calculate the average bitrate. Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.

Method Details

getType

public static Type getType()

Get the GType of the BaseParseFrame class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readBuffer

public Buffer readBuffer()

Read the value of the field buffer.

Returns:

The value of the field buffer

writeBuffer

public void writeBuffer(Buffer buffer)

Write a value in the field buffer.

Parameters:

buffer - The new value for the field buffer

readOutBuffer

public Buffer readOutBuffer()

Read the value of the field out_buffer.

Returns:

The value of the field out_buffer

writeOutBuffer

public void writeOutBuffer(Buffer outBuffer)

Write a value in the field out_buffer.

Parameters:

outBuffer - The new value for the field out_buffer

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

readOffset

public long readOffset()

Read the value of the field offset.

Returns:

The value of the field offset

writeOffset

public void writeOffset(long offset)

Write a value in the field offset.

Parameters:

offset - The new value for the field offset

readOverhead

public int readOverhead()

Read the value of the field overhead.

Returns:

The value of the field overhead

writeOverhead

public void writeOverhead(int overhead)

Write a value in the field overhead.

Parameters:

overhead - The new value for the field overhead

readSize

public int readSize()

Read the value of the field size.

Returns:

The value of the field size

writeSize

public void writeSize(int size)

Write a value in the field size.

Parameters:

size - The new value for the field size

readPrivateFlags

public int readPrivateFlags()

Read the value of the field _private_flags.

Returns:

The value of the field _private_flags

writePrivateFlags

public void writePrivateFlags(int PrivateFlags)

Write a value in the field _private_flags.

Parameters:

PrivateFlags - The new value for the field _private_flags

copy

public BaseParseFrame copy()

Copies a GstBaseParseFrame.

Returns:

A copy of this BaseParseFrame

free

public void free()

Frees the provided this BaseParseFrame.

init

public void init()

Sets a GstBaseParseFrame to initial state. Currently this means all public fields are zero-ed and a private flag is set to make sure gst_base_parse_frame_free() only frees the contents but not the actual frame. Use this function to initialise a GstBaseParseFrame allocated on the stack.