Package org.freedesktop.gstreamer.audio

Class AudioFormatInfo

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.audio.AudioFormatInfo

All Implemented Interfaces:

Proxy

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

Information for an audio format.

Constructor Summary

Constructors

Constructor	Description
AudioFormatInfo()	Allocate a new AudioFormatInfo.
AudioFormatInfo(Arena arena)	Allocate a new AudioFormatInfo.
AudioFormatInfo(MemorySegment address)	Create a AudioFormatInfo proxy instance for the provided memory address.
AudioFormatInfo(AudioFormat format, String name, String description, Set<AudioFormatFlags> flags, int endianness, int width, int depth, byte[] silence, AudioFormat unpackFormat, AudioFormatUnpack unpackFunc, AudioFormatPack packFunc)	Allocate a new AudioFormatInfo with the fields set to the provided values.
AudioFormatInfo(AudioFormat format, String name, String description, Set<AudioFormatFlags> flags, int endianness, int width, int depth, byte[] silence, AudioFormat unpackFormat, AudioFormatUnpack unpackFunc, AudioFormatPack packFunc, Arena arena)	Allocate a new AudioFormatInfo with the fields set to the provided values.

Method Summary

Modifier and Type	Method	Description
void	fillSilence(@org.jspecify.annotations.Nullable byte @Nullable [] dest)	Fill length bytes in dest with silence samples for info.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the AudioFormatInfo class
int	readDepth()	Read the value of the field depth.
String	readDescription()	Read the value of the field description.
int	readEndianness()	Read the value of the field endianness.
Set<AudioFormatFlags>	readFlags()	Read the value of the field flags.
AudioFormat	readFormat()	Read the value of the field format.
String	readName()	Read the value of the field name.
@Nullable AudioFormatPack	readPackFunc()	Read the value of the field pack_func.
@org.jspecify.annotations.Nullable byte @Nullable []	readSilence()	Read the value of the field silence.
AudioFormat	readUnpackFormat()	Read the value of the field unpack_format.
@Nullable AudioFormatUnpack	readUnpackFunc()	Read the value of the field unpack_func.
int	readWidth()	Read the value of the field width.
void	writeDepth(int depth)	Write a value in the field depth.
void	writeDescription(String description, Arena _arena)	Write a value in the field description.
void	writeEndianness(int endianness)	Write a value in the field endianness.
void	writeFlags(Set<AudioFormatFlags> flags)	Write a value in the field flags.
void	writeFormat(AudioFormat format)	Write a value in the field format.
void	writeName(String name, Arena _arena)	Write a value in the field name.
void	writePackFunc(@Nullable AudioFormatPack packFunc, Arena _arena)	Write a value in the field pack_func.
void	writeSilence(@org.jspecify.annotations.Nullable byte @Nullable [] silence, Arena _arena)	Write a value in the field silence.
void	writeUnpackFormat(AudioFormat unpackFormat)	Write a value in the field unpack_format.
void	writeUnpackFunc(@Nullable AudioFormatUnpack unpackFunc, Arena _arena)	Write a value in the field unpack_func.
void	writeWidth(int width)	Write a value in the field width.

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

AudioFormatInfo

public AudioFormatInfo(MemorySegment address)

Create a AudioFormatInfo proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

AudioFormatInfo

public AudioFormatInfo(Arena arena)

Allocate a new AudioFormatInfo.

Parameters:

arena - to control the memory allocation scope

AudioFormatInfo

public AudioFormatInfo()

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

AudioFormatInfo

public AudioFormatInfo(AudioFormat format,
 String name,
 String description,
 Set<AudioFormatFlags> flags,
 int endianness,
 int width,
 int depth,
 byte[] silence,
 AudioFormat unpackFormat,
 AudioFormatUnpack unpackFunc,
 AudioFormatPack packFunc,
 Arena arena)

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

Parameters:

format - value for the field format

name - value for the field name

description - value for the field description

flags - value for the field flags

endianness - value for the field endianness

width - value for the field width

depth - value for the field depth

silence - value for the field silence

unpackFormat - value for the field unpackFormat

unpackFunc - value for the field unpackFunc

packFunc - value for the field packFunc

arena - to control the memory allocation scope

AudioFormatInfo

public AudioFormatInfo(AudioFormat format,
 String name,
 String description,
 Set<AudioFormatFlags> flags,
 int endianness,
 int width,
 int depth,
 byte[] silence,
 AudioFormat unpackFormat,
 AudioFormatUnpack unpackFunc,
 AudioFormatPack packFunc)

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

Parameters:

format - value for the field format

name - value for the field name

description - value for the field description

flags - value for the field flags

endianness - value for the field endianness

width - value for the field width

depth - value for the field depth

silence - value for the field silence

unpackFormat - value for the field unpackFormat

unpackFunc - value for the field unpackFunc

packFunc - value for the field packFunc

Method Details

getType

public static @Nullable Type getType()

Get the GType of the AudioFormatInfo class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readFormat

public AudioFormat readFormat()

Read the value of the field format.

Returns:

The value of the field format

writeFormat

public void writeFormat(AudioFormat format)

Write a value in the field format.

Parameters:

format - The new value for the field format

readName

public String readName()

Read the value of the field name.

Returns:

The value of the field name

writeName

public void writeName(String name,
 Arena _arena)

Write a value in the field name.

Parameters:

name - The new value for the field name

_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

readFlags

public Set<AudioFormatFlags> readFlags()

Read the value of the field flags.

Returns:

The value of the field flags

writeFlags

public void writeFlags(Set<AudioFormatFlags> flags)

Write a value in the field flags.

Parameters:

flags - The new value for the field flags

readEndianness

public int readEndianness()

Read the value of the field endianness.

Returns:

The value of the field endianness

writeEndianness

public void writeEndianness(int endianness)

Write a value in the field endianness.

Parameters:

endianness - The new value for the field endianness

readWidth

public int readWidth()

Read the value of the field width.

Returns:

The value of the field width

writeWidth

public void writeWidth(int width)

Write a value in the field width.

Parameters:

width - The new value for the field width

readDepth

public int readDepth()

Read the value of the field depth.

Returns:

The value of the field depth

writeDepth

public void writeDepth(int depth)

Write a value in the field depth.

Parameters:

depth - The new value for the field depth

readSilence

public @org.jspecify.annotations.Nullable byte @Nullable [] readSilence()

Read the value of the field silence.

Returns:

The value of the field silence

writeSilence

public void writeSilence(@org.jspecify.annotations.Nullable byte @Nullable [] silence,
 Arena _arena)

Write a value in the field silence.

Parameters:

silence - The new value for the field silence

readUnpackFormat

public AudioFormat readUnpackFormat()

Read the value of the field unpack_format.

Returns:

The value of the field unpack_format

writeUnpackFormat

public void writeUnpackFormat(AudioFormat unpackFormat)

Write a value in the field unpack_format.

Parameters:

unpackFormat - The new value for the field unpack_format

readUnpackFunc

public @Nullable AudioFormatUnpack readUnpackFunc()

Read the value of the field unpack_func.

Returns:

The value of the field unpack_func

writeUnpackFunc

public void writeUnpackFunc(@Nullable AudioFormatUnpack unpackFunc,
 Arena _arena)

Write a value in the field unpack_func.

Parameters:

unpackFunc - The new value for the field unpack_func

_arena - to control the memory allocation scope

readPackFunc

public @Nullable AudioFormatPack readPackFunc()

Read the value of the field pack_func.

Returns:

The value of the field pack_func

writePackFunc

public void writePackFunc(@Nullable AudioFormatPack packFunc,
 Arena _arena)

Write a value in the field pack_func.

Parameters:

packFunc - The new value for the field pack_func

_arena - to control the memory allocation scope

fillSilence

public void fillSilence(@org.jspecify.annotations.Nullable byte @Nullable [] dest)

Fill length bytes in dest with silence samples for info.

Parameters:

dest - a destination to fill

Since:

1.20