Package org.freedesktop.gstreamer.gst

Class FormatDefinition

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.gst.FormatDefinition

All Implemented Interfaces:

Proxy

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

A format definition

Constructor Summary

Constructors

Constructor	Description
FormatDefinition()	Allocate a new FormatDefinition.
FormatDefinition(Arena arena)	Allocate a new FormatDefinition.
FormatDefinition(MemorySegment address)	Create a FormatDefinition proxy instance for the provided memory address.
FormatDefinition(Format value, String nick, String description, Quark quark)	Allocate a new FormatDefinition with the fields set to the provided values.
FormatDefinition(Format value, String nick, String description, Quark quark, Arena arena)	Allocate a new FormatDefinition with the fields set to the provided values.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	readDescription()	Read the value of the field description.
String	readNick()	Read the value of the field nick.
Quark	readQuark()	Read the value of the field quark.
Format	readValue()	Read the value of the field value.
void	writeDescription(String description, Arena _arena)	Write a value in the field description.
void	writeNick(String nick, Arena _arena)	Write a value in the field nick.
void	writeQuark(Quark quark)	Write a value in the field quark.
void	writeValue(Format value)	Write a value in the field value.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

FormatDefinition

public FormatDefinition(MemorySegment address)

Create a FormatDefinition proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FormatDefinition

public FormatDefinition(Arena arena)

Allocate a new FormatDefinition.

Parameters:

arena - to control the memory allocation scope

FormatDefinition

public FormatDefinition()

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

FormatDefinition

public FormatDefinition(Format value,
 String nick,
 String description,
 Quark quark,
 Arena arena)

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

Parameters:

value - value for the field value

nick - value for the field nick

description - value for the field description

quark - value for the field quark

arena - to control the memory allocation scope

FormatDefinition

public FormatDefinition(Format value,
 String nick,
 String description,
 Quark quark)

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

Parameters:

value - value for the field value

nick - value for the field nick

description - value for the field description

quark - value for the field quark

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readValue

public Format readValue()

Read the value of the field value.

Returns:

The value of the field value

writeValue

public void writeValue(Format value)

Write a value in the field value.

Parameters:

value - The new value for the field value

readNick

public String readNick()

Read the value of the field nick.

Returns:

The value of the field nick

writeNick

public void writeNick(String nick,
 Arena _arena)

Write a value in the field nick.

Parameters:

nick - The new value for the field nick

_arena - to control the memory allocation scope

readDescription

public String readDescription()

Read the value of the field description.

Returns:

The value of the field description

writeDescription

public void writeDescription(String description,
 Arena _arena)

Write a value in the field description.

Parameters:

description - The new value for the field description

_arena - to control the memory allocation scope

readQuark

public Quark readQuark()

Read the value of the field quark.

Returns:

The value of the field quark

writeQuark

public void writeQuark(Quark quark)

Write a value in the field quark.

Parameters:

quark - The new value for the field quark