Top Description Fields Methods
org.lwjgl.util.opus

public Interface OPEPacketFuncI

extends CallbackI
Known Direct Implementers
org.lwjgl.util.opus.OPEPacketFunc
Annotations
@FunctionalInterface
@NativeType:ope_packet_func
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Instances of this interface may be set with SET_PACKET_CALLBACK_REQUEST.

Type


void (*invoke) (
    void *user_data,
    unsigned char const *packet_ptr,
    opus_int32 packet_len,
    opus_uint32 flags
)

Field Summary

Modifier and TypeField and Description
public static final FFICIF
CIF

Method Summary

Modifier and TypeMethod and Description
public default void
callback(long
a pointer to the memory used for the function's return value.

If the function is declared as returning void, then this value is garbage and should not be used.

Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as LibFFI#ffi_call. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

ret, long
a vector of pointers to memory holding the arguments to the function
args)

Implements org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.
public default FFICIF
getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function.
public void
invoke(long
user-defined data passed to the callback
user_data, long
packet data
packet_ptr, int
number of bytes in the packet
packet_len, int
optional flags (none defined for now so zero)
flags)

Called on every packet encoded (including header).

Inherited from org.lwjgl.system.CallbackI:
address

Field Detail

CIFback to summary
public static final FFICIF CIF

Method Detail

callbackback to summary
public default void callback(long ret, long args)

Implements org.lwjgl.system.CallbackI.callback.

Doc from org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.

Parameters
ret:long

a pointer to the memory used for the function's return value.

If the function is declared as returning void, then this value is garbage and should not be used.

Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as LibFFI#ffi_call. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

args:long

a vector of pointers to memory holding the arguments to the function

Annotations
@Override
getCallInterfaceback to summary
public default FFICIF getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Doc from org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function. [INTERNAL API]

Returns:FFICIF

the CIF structure for this callback function

Annotations
@Override
invokeback to summary
public void invoke(long user_data, long packet_ptr, int packet_len, int flags)

Called on every packet encoded (including header).

Parameters
user_data:long

user-defined data passed to the callback

packet_ptr:long

packet data

packet_len:int

number of bytes in the packet

flags:int

optional flags (none defined for now so zero)