Package org.freedesktop.gstreamer.gst

Class StaticCaps

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.gst.StaticCaps

All Implemented Interfaces:

Proxy

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

Data structure to initialize GstCaps from a string description usually used in conjunction with GST_STATIC_CAPS() and gst_static_caps_get() to instantiate a GstCaps.

Constructor Summary

Constructors

Constructor	Description
StaticCaps()	Allocate a new StaticCaps.
StaticCaps(Arena arena)	Allocate a new StaticCaps.
StaticCaps(MemorySegment address)	Create a StaticCaps proxy instance for the provided memory address.
StaticCaps(Caps caps, String string)	Allocate a new StaticCaps with the fields set to the provided values.
StaticCaps(Caps caps, String string, Arena arena)	Allocate a new StaticCaps with the fields set to the provided values.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Cleans up the cached caps contained in staticCaps.
@Nullable Caps	get()	Converts a GstStaticCaps to a GstCaps.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the StaticCaps class
Caps	readCaps()	Read the value of the field caps.
String	readString()	Read the value of the field string.
void	writeCaps(Caps caps)	Write a value in the field caps.
void	writeString(String string, Arena _arena)	Write a value in the field string.

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

StaticCaps

public StaticCaps(MemorySegment address)

Create a StaticCaps proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

StaticCaps

public StaticCaps(Arena arena)

Allocate a new StaticCaps.

Parameters:

arena - to control the memory allocation scope

StaticCaps

public StaticCaps()

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

StaticCaps

public StaticCaps(Caps caps,
 String string,
 Arena arena)

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

Parameters:

caps - value for the field caps

string - value for the field string

arena - to control the memory allocation scope

StaticCaps

public StaticCaps(Caps caps,
 String string)

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

Parameters:

caps - value for the field caps

string - value for the field string

Method Details

getType

public static @Nullable Type getType()

Get the GType of the StaticCaps class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readCaps

public Caps readCaps()

Read the value of the field caps.

Returns:

The value of the field caps

writeCaps

public void writeCaps(Caps caps)

Write a value in the field caps.

Parameters:

caps - The new value for the field caps

readString

public String readString()

Read the value of the field string.

Returns:

The value of the field string

writeString

public void writeString(String string,
 Arena _arena)

Write a value in the field string.

Parameters:

string - The new value for the field string

_arena - to control the memory allocation scope

cleanup

public void cleanup()

Cleans up the cached caps contained in staticCaps.

get

public @Nullable Caps get()

Converts a GstStaticCaps to a GstCaps.

Returns:

a pointer to the GstCaps. Since the core holds an additional ref to the returned caps, use gst_caps_make_writable() on the returned caps to modify it.