Package org.lwjgl.fmod

Class FMOD_CODEC_DESCRIPTION

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<FMOD_CODEC_DESCRIPTION>

org.lwjgl.fmod.FMOD_CODEC_DESCRIPTION

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class FMOD_CODEC_DESCRIPTION
extends Struct<FMOD_CODEC_DESCRIPTION>
implements NativeResource

 struct FMOD_CODEC_DESCRIPTION {
     unsigned int apiversion;
     char const * name;
     unsigned int version;
     int defaultasstream;
     FMOD_TIMEUNIT timeunits;
     {@link FMOD_CODEC_OPEN_CALLBACKI FMOD_CODEC_OPEN_CALLBACK} open;
     {@link FMOD_CODEC_CLOSE_CALLBACKI FMOD_CODEC_CLOSE_CALLBACK} close;
     {@link FMOD_CODEC_READ_CALLBACKI FMOD_CODEC_READ_CALLBACK} read;
     {@link FMOD_CODEC_GETLENGTH_CALLBACKI FMOD_CODEC_GETLENGTH_CALLBACK} getlength;
     {@link FMOD_CODEC_SETPOSITION_CALLBACKI FMOD_CODEC_SETPOSITION_CALLBACK} setposition;
     {@link FMOD_CODEC_GETPOSITION_CALLBACKI FMOD_CODEC_GETPOSITION_CALLBACK} getposition;
     {@link FMOD_CODEC_SOUNDCREATE_CALLBACKI FMOD_CODEC_SOUNDCREATE_CALLBACK} soundcreate;
     {@link FMOD_CODEC_GETWAVEFORMAT_CALLBACKI FMOD_CODEC_GETWAVEFORMAT_CALLBACK} getwaveformat;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FMOD_CODEC_DESCRIPTION.Buffer	An array of FMOD_CODEC_DESCRIPTION structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	APIVERSION	The struct member offsets.
static final int	CLOSE	The struct member offsets.
static final int	DEFAULTASSTREAM	The struct member offsets.
static final int	GETLENGTH	The struct member offsets.
static final int	GETPOSITION	The struct member offsets.
static final int	GETWAVEFORMAT	The struct member offsets.
static final int	NAME	The struct member offsets.
static final int	OPEN	The struct member offsets.
static final int	READ	The struct member offsets.
static final int	SETPOSITION	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SOUNDCREATE	The struct member offsets.
static final int	TIMEUNITS	The struct member offsets.
static final int	VERSION	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
FMOD_CODEC_DESCRIPTION(ByteBuffer container)	Creates a FMOD_CODEC_DESCRIPTION instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	apiversion()
FMOD_CODEC_DESCRIPTION	apiversion(int value)	Sets the specified value to the apiversion field.
static FMOD_CODEC_DESCRIPTION	calloc()	Returns a new FMOD_CODEC_DESCRIPTION instance allocated with memCalloc.
static FMOD_CODEC_DESCRIPTION.Buffer	calloc(int capacity)	Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated with memCalloc.
static FMOD_CODEC_DESCRIPTION.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static FMOD_CODEC_DESCRIPTION	calloc(MemoryStack stack)	Returns a new FMOD_CODEC_DESCRIPTION instance allocated on the specified MemoryStack and initializes all its bits to zero.
FMOD_CODEC_CLOSE_CALLBACK	close$()
FMOD_CODEC_DESCRIPTION	close$(FMOD_CODEC_CLOSE_CALLBACKI value)	Sets the specified value to the close field.
static FMOD_CODEC_DESCRIPTION	create()	Returns a new FMOD_CODEC_DESCRIPTION instance allocated with BufferUtils.
static FMOD_CODEC_DESCRIPTION.Buffer	create(int capacity)	Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated with BufferUtils.
static FMOD_CODEC_DESCRIPTION	create(long address)	Returns a new FMOD_CODEC_DESCRIPTION instance for the specified memory address.
static FMOD_CODEC_DESCRIPTION.Buffer	create(long address, int capacity)	Create a FMOD_CODEC_DESCRIPTION.Buffer instance at the specified memory.
static @Nullable FMOD_CODEC_DESCRIPTION	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable FMOD_CODEC_DESCRIPTION.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	defaultasstream()
FMOD_CODEC_DESCRIPTION	defaultasstream(int value)	Sets the specified value to the defaultasstream field.
FMOD_CODEC_GETLENGTH_CALLBACK	getlength()
FMOD_CODEC_DESCRIPTION	getlength(FMOD_CODEC_GETLENGTH_CALLBACKI value)	Sets the specified value to the getlength field.
FMOD_CODEC_GETPOSITION_CALLBACK	getposition()
FMOD_CODEC_DESCRIPTION	getposition(FMOD_CODEC_GETPOSITION_CALLBACKI value)	Sets the specified value to the getposition field.
FMOD_CODEC_GETWAVEFORMAT_CALLBACK	getwaveformat()
FMOD_CODEC_DESCRIPTION	getwaveformat(FMOD_CODEC_GETWAVEFORMAT_CALLBACKI value)	Sets the specified value to the getwaveformat field.
static FMOD_CODEC_DESCRIPTION	malloc()	Returns a new FMOD_CODEC_DESCRIPTION instance allocated with memAlloc.
static FMOD_CODEC_DESCRIPTION.Buffer	malloc(int capacity)	Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated with memAlloc.
static FMOD_CODEC_DESCRIPTION.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated on the specified MemoryStack.
static FMOD_CODEC_DESCRIPTION	malloc(MemoryStack stack)	Returns a new FMOD_CODEC_DESCRIPTION instance allocated on the specified MemoryStack.
ByteBuffer	name()
FMOD_CODEC_DESCRIPTION	name(ByteBuffer value)	Sets the address of the specified encoded string to the name field.
String	nameString()
static int	napiversion(long struct)	Unsafe version of apiversion().
static void	napiversion(long struct, int value)	Unsafe version of apiversion.
static FMOD_CODEC_CLOSE_CALLBACK	nclose$(long struct)	Unsafe version of close$().
static void	nclose$(long struct, FMOD_CODEC_CLOSE_CALLBACKI value)	Unsafe version of close$.
static int	ndefaultasstream(long struct)	Unsafe version of defaultasstream().
static void	ndefaultasstream(long struct, int value)	Unsafe version of defaultasstream.
static FMOD_CODEC_GETLENGTH_CALLBACK	ngetlength(long struct)	Unsafe version of getlength().
static void	ngetlength(long struct, FMOD_CODEC_GETLENGTH_CALLBACKI value)	Unsafe version of getlength.
static FMOD_CODEC_GETPOSITION_CALLBACK	ngetposition(long struct)	Unsafe version of getposition().
static void	ngetposition(long struct, FMOD_CODEC_GETPOSITION_CALLBACKI value)	Unsafe version of getposition.
static FMOD_CODEC_GETWAVEFORMAT_CALLBACK	ngetwaveformat(long struct)	Unsafe version of getwaveformat().
static void	ngetwaveformat(long struct, FMOD_CODEC_GETWAVEFORMAT_CALLBACKI value)	Unsafe version of getwaveformat.
static ByteBuffer	nname(long struct)	Unsafe version of name().
static void	nname(long struct, ByteBuffer value)	Unsafe version of name.
static String	nnameString(long struct)	Unsafe version of nameString().
static FMOD_CODEC_OPEN_CALLBACK	nopen(long struct)	Unsafe version of open().
static void	nopen(long struct, FMOD_CODEC_OPEN_CALLBACKI value)	Unsafe version of open.
static FMOD_CODEC_READ_CALLBACK	nread(long struct)	Unsafe version of read().
static void	nread(long struct, FMOD_CODEC_READ_CALLBACKI value)	Unsafe version of read.
static FMOD_CODEC_SETPOSITION_CALLBACK	nsetposition(long struct)	Unsafe version of setposition().
static void	nsetposition(long struct, FMOD_CODEC_SETPOSITION_CALLBACKI value)	Unsafe version of setposition.
static FMOD_CODEC_SOUNDCREATE_CALLBACK	nsoundcreate(long struct)	Unsafe version of soundcreate().
static void	nsoundcreate(long struct, FMOD_CODEC_SOUNDCREATE_CALLBACKI value)	Unsafe version of soundcreate.
static int	ntimeunits(long struct)	Unsafe version of timeunits().
static void	ntimeunits(long struct, int value)	Unsafe version of timeunits.
static int	nversion(long struct)	Unsafe version of version().
static void	nversion(long struct, int value)	Unsafe version of version.
FMOD_CODEC_OPEN_CALLBACK	open()
FMOD_CODEC_DESCRIPTION	open(FMOD_CODEC_OPEN_CALLBACKI value)	Sets the specified value to the open field.
FMOD_CODEC_READ_CALLBACK	read()
FMOD_CODEC_DESCRIPTION	read(FMOD_CODEC_READ_CALLBACKI value)	Sets the specified value to the read field.
FMOD_CODEC_DESCRIPTION	set(int apiversion, ByteBuffer name, int version, int defaultasstream, int timeunits, FMOD_CODEC_OPEN_CALLBACKI open, FMOD_CODEC_CLOSE_CALLBACKI close$, FMOD_CODEC_READ_CALLBACKI read, FMOD_CODEC_GETLENGTH_CALLBACKI getlength, FMOD_CODEC_SETPOSITION_CALLBACKI setposition, FMOD_CODEC_GETPOSITION_CALLBACKI getposition, FMOD_CODEC_SOUNDCREATE_CALLBACKI soundcreate, FMOD_CODEC_GETWAVEFORMAT_CALLBACKI getwaveformat)	Initializes this struct with the specified values.
FMOD_CODEC_DESCRIPTION	set(FMOD_CODEC_DESCRIPTION src)	Copies the specified struct data to this struct.
FMOD_CODEC_SETPOSITION_CALLBACK	setposition()
FMOD_CODEC_DESCRIPTION	setposition(FMOD_CODEC_SETPOSITION_CALLBACKI value)	Sets the specified value to the setposition field.
int	sizeof()	Returns sizeof(struct).
FMOD_CODEC_SOUNDCREATE_CALLBACK	soundcreate()
FMOD_CODEC_DESCRIPTION	soundcreate(FMOD_CODEC_SOUNDCREATE_CALLBACKI value)	Sets the specified value to the soundcreate field.
int	timeunits()
FMOD_CODEC_DESCRIPTION	timeunits(int value)	Sets the specified value to the timeunits field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	version()
FMOD_CODEC_DESCRIPTION	version(int value)	Sets the specified value to the version field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

APIVERSION

public static final int APIVERSION

The struct member offsets.

NAME

public static final int NAME

The struct member offsets.

VERSION

public static final int VERSION

The struct member offsets.

DEFAULTASSTREAM

public static final int DEFAULTASSTREAM

The struct member offsets.

TIMEUNITS

public static final int TIMEUNITS

The struct member offsets.

OPEN

public static final int OPEN

The struct member offsets.

CLOSE

public static final int CLOSE

The struct member offsets.

READ

public static final int READ

The struct member offsets.

GETLENGTH

public static final int GETLENGTH

The struct member offsets.

SETPOSITION

public static final int SETPOSITION

The struct member offsets.

GETPOSITION

public static final int GETPOSITION

The struct member offsets.

SOUNDCREATE

public static final int SOUNDCREATE

The struct member offsets.

GETWAVEFORMAT

public static final int GETWAVEFORMAT

The struct member offsets.

Constructor Details

FMOD_CODEC_DESCRIPTION

public FMOD_CODEC_DESCRIPTION(ByteBuffer container)

Creates a FMOD_CODEC_DESCRIPTION instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<FMOD_CODEC_DESCRIPTION>

apiversion

public int apiversion()

Returns:

the value of the apiversion field.

name

public ByteBuffer name()

Returns:

a ByteBuffer view of the null-terminated string pointed to by the name field.

nameString

public String nameString()

Returns:

the null-terminated string pointed to by the name field.

version

public int version()

Returns:

the value of the version field.

defaultasstream

public int defaultasstream()

Returns:

the value of the defaultasstream field.

timeunits

public int timeunits()

Returns:

the value of the timeunits field.

open

public FMOD_CODEC_OPEN_CALLBACK open()

Returns:

the value of the open field.

close$

public FMOD_CODEC_CLOSE_CALLBACK close$()

Returns:

the value of the close field.

read

public FMOD_CODEC_READ_CALLBACK read()

Returns:

the value of the read field.

getlength

public FMOD_CODEC_GETLENGTH_CALLBACK getlength()

Returns:

the value of the getlength field.

setposition

public FMOD_CODEC_SETPOSITION_CALLBACK setposition()

Returns:

the value of the setposition field.

getposition

public FMOD_CODEC_GETPOSITION_CALLBACK getposition()

Returns:

the value of the getposition field.

soundcreate

public FMOD_CODEC_SOUNDCREATE_CALLBACK soundcreate()

Returns:

the value of the soundcreate field.

getwaveformat

public FMOD_CODEC_GETWAVEFORMAT_CALLBACK getwaveformat()

Returns:

the value of the getwaveformat field.

apiversion

public FMOD_CODEC_DESCRIPTION apiversion(int value)

Sets the specified value to the apiversion field.

name

public FMOD_CODEC_DESCRIPTION name(ByteBuffer value)

Sets the address of the specified encoded string to the name field.

version

public FMOD_CODEC_DESCRIPTION version(int value)

Sets the specified value to the version field.

defaultasstream

public FMOD_CODEC_DESCRIPTION defaultasstream(int value)

Sets the specified value to the defaultasstream field.

timeunits

public FMOD_CODEC_DESCRIPTION timeunits(int value)

Sets the specified value to the timeunits field.

open

public FMOD_CODEC_DESCRIPTION open(FMOD_CODEC_OPEN_CALLBACKI value)

Sets the specified value to the open field.

close$

public FMOD_CODEC_DESCRIPTION close$(FMOD_CODEC_CLOSE_CALLBACKI value)

Sets the specified value to the close field.

read

public FMOD_CODEC_DESCRIPTION read(FMOD_CODEC_READ_CALLBACKI value)

Sets the specified value to the read field.

getlength

public FMOD_CODEC_DESCRIPTION getlength(FMOD_CODEC_GETLENGTH_CALLBACKI value)

Sets the specified value to the getlength field.

setposition

public FMOD_CODEC_DESCRIPTION setposition(FMOD_CODEC_SETPOSITION_CALLBACKI value)

Sets the specified value to the setposition field.

getposition

public FMOD_CODEC_DESCRIPTION getposition(FMOD_CODEC_GETPOSITION_CALLBACKI value)

Sets the specified value to the getposition field.

soundcreate

public FMOD_CODEC_DESCRIPTION soundcreate(FMOD_CODEC_SOUNDCREATE_CALLBACKI value)

Sets the specified value to the soundcreate field.

getwaveformat

public FMOD_CODEC_DESCRIPTION getwaveformat(FMOD_CODEC_GETWAVEFORMAT_CALLBACKI value)

Sets the specified value to the getwaveformat field.

set

public FMOD_CODEC_DESCRIPTION set(int apiversion,
 ByteBuffer name,
 int version,
 int defaultasstream,
 int timeunits,
 FMOD_CODEC_OPEN_CALLBACKI open,
 FMOD_CODEC_CLOSE_CALLBACKI close$,
 FMOD_CODEC_READ_CALLBACKI read,
 FMOD_CODEC_GETLENGTH_CALLBACKI getlength,
 FMOD_CODEC_SETPOSITION_CALLBACKI setposition,
 FMOD_CODEC_GETPOSITION_CALLBACKI getposition,
 FMOD_CODEC_SOUNDCREATE_CALLBACKI soundcreate,
 FMOD_CODEC_GETWAVEFORMAT_CALLBACKI getwaveformat)

Initializes this struct with the specified values.

set

public FMOD_CODEC_DESCRIPTION set(FMOD_CODEC_DESCRIPTION src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static FMOD_CODEC_DESCRIPTION malloc()

Returns a new FMOD_CODEC_DESCRIPTION instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static FMOD_CODEC_DESCRIPTION calloc()

Returns a new FMOD_CODEC_DESCRIPTION instance allocated with memCalloc. The instance must be explicitly freed.

create

public static FMOD_CODEC_DESCRIPTION create()

Returns a new FMOD_CODEC_DESCRIPTION instance allocated with BufferUtils.

create

public static FMOD_CODEC_DESCRIPTION create(long address)

Returns a new FMOD_CODEC_DESCRIPTION instance for the specified memory address.

createSafe

public static @Nullable FMOD_CODEC_DESCRIPTION createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static FMOD_CODEC_DESCRIPTION.Buffer malloc(int capacity)

Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static FMOD_CODEC_DESCRIPTION.Buffer calloc(int capacity)

Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static FMOD_CODEC_DESCRIPTION.Buffer create(int capacity)

Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static FMOD_CODEC_DESCRIPTION.Buffer create(long address,
 int capacity)

Create a FMOD_CODEC_DESCRIPTION.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable FMOD_CODEC_DESCRIPTION.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static FMOD_CODEC_DESCRIPTION malloc(MemoryStack stack)

Returns a new FMOD_CODEC_DESCRIPTION instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static FMOD_CODEC_DESCRIPTION calloc(MemoryStack stack)

Returns a new FMOD_CODEC_DESCRIPTION instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static FMOD_CODEC_DESCRIPTION.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static FMOD_CODEC_DESCRIPTION.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new FMOD_CODEC_DESCRIPTION.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

napiversion

public static int napiversion(long struct)

Unsafe version of apiversion().

nname

public static ByteBuffer nname(long struct)

Unsafe version of name().

nnameString

public static String nnameString(long struct)

Unsafe version of nameString().

nversion

public static int nversion(long struct)

Unsafe version of version().

ndefaultasstream

public static int ndefaultasstream(long struct)

Unsafe version of defaultasstream().

ntimeunits

public static int ntimeunits(long struct)

Unsafe version of timeunits().

nopen

public static FMOD_CODEC_OPEN_CALLBACK nopen(long struct)

Unsafe version of open().

nclose$

public static FMOD_CODEC_CLOSE_CALLBACK nclose$(long struct)

Unsafe version of close$().

nread

public static FMOD_CODEC_READ_CALLBACK nread(long struct)

Unsafe version of read().

ngetlength

public static FMOD_CODEC_GETLENGTH_CALLBACK ngetlength(long struct)

Unsafe version of getlength().

nsetposition

public static FMOD_CODEC_SETPOSITION_CALLBACK nsetposition(long struct)

Unsafe version of setposition().

ngetposition

public static FMOD_CODEC_GETPOSITION_CALLBACK ngetposition(long struct)

Unsafe version of getposition().

nsoundcreate

public static FMOD_CODEC_SOUNDCREATE_CALLBACK nsoundcreate(long struct)

Unsafe version of soundcreate().

ngetwaveformat

public static FMOD_CODEC_GETWAVEFORMAT_CALLBACK ngetwaveformat(long struct)

Unsafe version of getwaveformat().

napiversion

public static void napiversion(long struct,
 int value)

Unsafe version of apiversion.

nname

public static void nname(long struct,
 ByteBuffer value)

Unsafe version of name.

nversion

public static void nversion(long struct,
 int value)

Unsafe version of version.

ndefaultasstream

public static void ndefaultasstream(long struct,
 int value)

Unsafe version of defaultasstream.

ntimeunits

public static void ntimeunits(long struct,
 int value)

Unsafe version of timeunits.

nopen

public static void nopen(long struct,
 FMOD_CODEC_OPEN_CALLBACKI value)

Unsafe version of open.

nclose$

public static void nclose$(long struct,
 FMOD_CODEC_CLOSE_CALLBACKI value)

Unsafe version of close$.

nread

public static void nread(long struct,
 FMOD_CODEC_READ_CALLBACKI value)

Unsafe version of read.

ngetlength

public static void ngetlength(long struct,
 FMOD_CODEC_GETLENGTH_CALLBACKI value)

Unsafe version of getlength.

nsetposition

public static void nsetposition(long struct,
 FMOD_CODEC_SETPOSITION_CALLBACKI value)

Unsafe version of setposition.

ngetposition

public static void ngetposition(long struct,
 FMOD_CODEC_GETPOSITION_CALLBACKI value)

Unsafe version of getposition.

nsoundcreate

public static void nsoundcreate(long struct,
 FMOD_CODEC_SOUNDCREATE_CALLBACKI value)

Unsafe version of soundcreate.

ngetwaveformat

public static void ngetwaveformat(long struct,
 FMOD_CODEC_GETWAVEFORMAT_CALLBACKI value)

Unsafe version of getwaveformat.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate