Top Description Fields Constructors Methods
org.lwjgl.openal

public Class SOFTLoopback

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Native bindings to the SOFT_loopback extension.

This extension allows an application to read back OpenAL's rendered audio instead of having it output to an audio device on the system. Unextended OpenAL will output audio to an audio device, with no mechanism to allow an application to divert the audio somewhere else.

Field Summary

Modifier and TypeField and Description
public static final int
ALC_5POINT1_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_6POINT1_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_7POINT1_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_BYTE_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_FLOAT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_FORMAT_CHANNELS_SOFT

Accepted as part of the attrList parameter of CreateContext.

public static final int
ALC_FORMAT_TYPE_SOFT

Accepted as part of the attrList parameter of CreateContext.

public static final int
ALC_INT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_MONO_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_QUAD_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_SHORT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_STEREO_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_UNSIGNED_BYTE_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_UNSIGNED_INT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

public static final int
ALC_UNSIGNED_SHORT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static boolean
alcIsRenderFormatSupportedSOFT(long
the loopback device to query
device
,
int
the sample rate of the rendered audio
frequency
,
int
the channel configuration used for rendering. One of:
MONO_SOFTSTEREO_SOFTQUAD_SOFT5POINT1_SOFT6POINT1_SOFT7POINT1_SOFT
channels
,
int type)

When creating contexts, the attribute list must specify the format used for rendering.

public static long
alcLoopbackOpenDeviceSOFT(ByteBuffer
which device or device driver to use for subsequent rendering. This may be NULL for an implementation-defined default, otherwise it must be a valid name returned by enumeration (and further must be a device capable of loopback rendering).
deviceName
)

Loopback devices provide a way for applications to "read back" rendered audio without it being sent to an actual audio device.

public static long
alcLoopbackOpenDeviceSOFT(CharSequence
which device or device driver to use for subsequent rendering. This may be NULL for an implementation-defined default, otherwise it must be a valid name returned by enumeration (and further must be a device capable of loopback rendering).
deviceName
)

Loopback devices provide a way for applications to "read back" rendered audio without it being sent to an actual audio device.

public static void
alcRenderSamplesSOFT(long
the loopback device which samples are rendered from, using its contexts and associated buffers and sources
device
,
ByteBuffer
the buffer that will receive the samples. It must be big enough to contain at least samples sample frames.
buffer
,
int
the number of sample frames to render
samples
)

The state of various objects on loopback devices (including processed buffers and source offsets) is processed only when new samples are rendered.

public static void
alcRenderSamplesSOFT(long
the loopback device which samples are rendered from, using its contexts and associated buffers and sources
device
,
ShortBuffer
the buffer that will receive the samples. It must be big enough to contain at least samples sample frames.
buffer
,
int
the number of sample frames to render
samples
)

The state of various objects on loopback devices (including processed buffers and source offsets) is processed only when new samples are rendered.

public static void
alcRenderSamplesSOFT(long
the loopback device which samples are rendered from, using its contexts and associated buffers and sources
device
,
IntBuffer
the buffer that will receive the samples. It must be big enough to contain at least samples sample frames.
buffer
,
int
the number of sample frames to render
samples
)

The state of various objects on loopback devices (including processed buffers and source offsets) is processed only when new samples are rendered.

public static void
alcRenderSamplesSOFT(long
the loopback device which samples are rendered from, using its contexts and associated buffers and sources
device
,
FloatBuffer
the buffer that will receive the samples. It must be big enough to contain at least samples sample frames.
buffer
,
int
the number of sample frames to render
samples
)

The state of various objects on loopback devices (including processed buffers and source offsets) is processed only when new samples are rendered.

public static void
alcRenderSamplesSOFT(long device, short[] buffer, int samples)

Array version of: RenderSamplesSOFT

public static void
alcRenderSamplesSOFT(long device, int[] buffer, int samples)

Array version of: RenderSamplesSOFT

public static void
alcRenderSamplesSOFT(long device, float[] buffer, int samples)

Array version of: RenderSamplesSOFT

public static long
nalcLoopbackOpenDeviceSOFT(long deviceName)

Unsafe version of: LoopbackOpenDeviceSOFT

public static void
nalcRenderSamplesSOFT(long device, long buffer, int samples)

Unsafe version of: RenderSamplesSOFT

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALC_5POINT1_SOFTback to summary
public static final int ALC_5POINT1_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

ALC_6POINT1_SOFTback to summary
public static final int ALC_6POINT1_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

ALC_7POINT1_SOFTback to summary
public static final int ALC_7POINT1_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

ALC_BYTE_SOFTback to summary
public static final int ALC_BYTE_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

ALC_FLOAT_SOFTback to summary
public static final int ALC_FLOAT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

ALC_FORMAT_CHANNELS_SOFTback to summary
public static final int ALC_FORMAT_CHANNELS_SOFT

Accepted as part of the attrList parameter of CreateContext.

ALC_FORMAT_TYPE_SOFTback to summary
public static final int ALC_FORMAT_TYPE_SOFT

Accepted as part of the attrList parameter of CreateContext.

ALC_INT_SOFTback to summary
public static final int ALC_INT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

ALC_MONO_SOFTback to summary
public static final int ALC_MONO_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

ALC_QUAD_SOFTback to summary
public static final int ALC_QUAD_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

ALC_SHORT_SOFTback to summary
public static final int ALC_SHORT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

ALC_STEREO_SOFTback to summary
public static final int ALC_STEREO_SOFT

Accepted by the channels parameter of IsRenderFormatSupportedSOFT.

ALC_UNSIGNED_BYTE_SOFTback to summary
public static final int ALC_UNSIGNED_BYTE_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

ALC_UNSIGNED_INT_SOFTback to summary
public static final int ALC_UNSIGNED_INT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

ALC_UNSIGNED_SHORT_SOFTback to summary
public static final int ALC_UNSIGNED_SHORT_SOFT

Accepted by the type parameter of IsRenderFormatSupportedSOFT.

Constructor Detail

SOFTLoopbackback to summary
protected SOFTLoopback()

Method Detail

alcIsRenderFormatSupportedSOFTback to summary
public static boolean alcIsRenderFormatSupportedSOFT(long device, int frequency, int channels, int type)

When creating contexts, the attribute list must specify the format used for rendering. This is done with the FORMAT_CHANNELS_SOFT, FORMAT_TYPE_SOFT, and FREQUENCY attributes. This controls the format of the audio subsequently rendered by the device.

To check if a particular rendering format is available, use this function.

Parameters
device:long

the loopback device to query

frequency:int

the sample rate of the rendered audio

channels:int

the channel configuration used for rendering. One of:

MONO_SOFTSTEREO_SOFTQUAD_SOFT5POINT1_SOFT6POINT1_SOFT7POINT1_SOFT
type:int

sample type of the written audio. One of:

BYTE_SOFTUNSIGNED_BYTE_SOFTSHORT_SOFTUNSIGNED_SHORT_SOFTINT_SOFTUNSIGNED_INT_SOFT
FLOAT_SOFT
Annotations
@NativeType:ALCboolean
alcLoopbackOpenDeviceSOFTback to summary
public static long alcLoopbackOpenDeviceSOFT(ByteBuffer deviceName)

Loopback devices provide a way for applications to "read back" rendered audio without it being sent to an actual audio device. It allows applications to render audio as fast or slow as it needs, making it suitable for non-real-time rendering, and so it can be passed to an audio codec or something for further processing.

To open a loopback device, use this function.

A loopback device behaves largely the same as a playback device. You may query playback state and error codes, and create contexts, which can then be set as current to generate sources and buffers like normal.

Note that loopback devices do not have either the SYNC or REFRESH attributes. Attempting to query them will result in an INVALID_ENUM error.

Parameters
deviceName:ByteBuffer

which device or device driver to use for subsequent rendering. This may be NULL for an implementation-defined default, otherwise it must be a valid name returned by enumeration (and further must be a device capable of loopback rendering).

Annotations
@NativeType:ALCdevice *
alcLoopbackOpenDeviceSOFTback to summary
public static long alcLoopbackOpenDeviceSOFT(CharSequence deviceName)

Loopback devices provide a way for applications to "read back" rendered audio without it being sent to an actual audio device. It allows applications to render audio as fast or slow as it needs, making it suitable for non-real-time rendering, and so it can be passed to an audio codec or something for further processing.

To open a loopback device, use this function.

A loopback device behaves largely the same as a playback device. You may query playback state and error codes, and create contexts, which can then be set as current to generate sources and buffers like normal.

Note that loopback devices do not have either the SYNC or REFRESH attributes. Attempting to query them will result in an INVALID_ENUM error.

Parameters
deviceName:CharSequence

which device or device driver to use for subsequent rendering. This may be NULL for an implementation-defined default, otherwise it must be a valid name returned by enumeration (and further must be a device capable of loopback rendering).

Annotations
@NativeType:ALCdevice *
alcRenderSamplesSOFTback to summary
public static void alcRenderSamplesSOFT(long device, ByteBuffer buffer, int samples)

The state of various objects on loopback devices (including processed buffers and source offsets) is processed only when new samples are rendered. To render samples, use this function.

Parameters
device:long

the loopback device which samples are rendered from, using its contexts and associated buffers and sources

buffer:ByteBuffer

the buffer that will receive the samples. It must be big enough to contain at least samples sample frames.

samples:int

the number of sample frames to render

Annotations
@NativeType:ALCvoid
alcRenderSamplesSOFTback to summary
public static void alcRenderSamplesSOFT(long device, ShortBuffer buffer, int samples)

The state of various objects on loopback devices (including processed buffers and source offsets) is processed only when new samples are rendered. To render samples, use this function.

Parameters
device:long

the loopback device which samples are rendered from, using its contexts and associated buffers and sources

buffer:ShortBuffer

the buffer that will receive the samples. It must be big enough to contain at least samples sample frames.

samples:int

the number of sample frames to render

Annotations
@NativeType:ALCvoid
alcRenderSamplesSOFTback to summary
public static void alcRenderSamplesSOFT(long device, IntBuffer buffer, int samples)

The state of various objects on loopback devices (including processed buffers and source offsets) is processed only when new samples are rendered. To render samples, use this function.

Parameters
device:long

the loopback device which samples are rendered from, using its contexts and associated buffers and sources

buffer:IntBuffer

the buffer that will receive the samples. It must be big enough to contain at least samples sample frames.

samples:int

the number of sample frames to render

Annotations
@NativeType:ALCvoid
alcRenderSamplesSOFTback to summary
public static void alcRenderSamplesSOFT(long device, FloatBuffer buffer, int samples)

The state of various objects on loopback devices (including processed buffers and source offsets) is processed only when new samples are rendered. To render samples, use this function.

Parameters
device:long

the loopback device which samples are rendered from, using its contexts and associated buffers and sources

buffer:FloatBuffer

the buffer that will receive the samples. It must be big enough to contain at least samples sample frames.

samples:int

the number of sample frames to render

Annotations
@NativeType:ALCvoid
alcRenderSamplesSOFTback to summary
public static void alcRenderSamplesSOFT(long device, short[] buffer, int samples)

Array version of: RenderSamplesSOFT

Annotations
@NativeType:ALCvoid
alcRenderSamplesSOFTback to summary
public static void alcRenderSamplesSOFT(long device, int[] buffer, int samples)

Array version of: RenderSamplesSOFT

Annotations
@NativeType:ALCvoid
alcRenderSamplesSOFTback to summary
public static void alcRenderSamplesSOFT(long device, float[] buffer, int samples)

Array version of: RenderSamplesSOFT

Annotations
@NativeType:ALCvoid
nalcLoopbackOpenDeviceSOFTback to summary
public static long nalcLoopbackOpenDeviceSOFT(long deviceName)

Unsafe version of: LoopbackOpenDeviceSOFT

nalcRenderSamplesSOFTback to summary
public static void nalcRenderSamplesSOFT(long device, long buffer, int samples)

Unsafe version of: RenderSamplesSOFT