org.jouvieje.fmodex.structures
Class FMOD_ADVANCEDSETTINGS

java.lang.Object
  org.jouvieje.fmodex.utils.Pointer
      org.jouvieje.fmodex.structures.FMOD_ADVANCEDSETTINGS

public class FMOD_ADVANCEDSETTINGS

extends Pointer

Constructor Summary

FMOD_ADVANCEDSETTINGS()
Create an object that holds a null FMOD_ADVANCEDSETTINGS.

Method Summary

static FMOD_ADVANCEDSETTINGS	allocate() Allocate a new FMOD_ADVANCEDSETTINGS.
static FMOD_ADVANCEDSETTINGS	asFMOD_ADVANCEDSETTINGS(Pointer pointer) Create a view of the Pointer object as a FMOD_ADVANCEDSETTINGS object.
java.lang.String[]	getASIOChannelList() [r/w] Optional.
int	getASIONumChannels() [r/w] Optional.
FMOD_SPEAKER[]	getASIOSpeakerList() [r/w] Optional.
int	getCbSize() [w] Size of this structure.
java.lang.String	getDebugLogFilename() [r/w] Optional.
int	getDefaultDecodeBufferSize() [r/w] Optional.
int	getEventQueueSize() [r/w] Optional.
int	getGeometryMaxFadeTime() [r/w] Optional.
float	getHRTFFreq() [r/w] Optional.
float	getHRTFMaxAngle() [r/w] Optional.
float	getHRTFMinAngle() [r/w] Optional.
int	getMax3DReverbDSPs() [r/w] Optional.
int	getMaxAdpcmCodecs() [r/w] Optional.
int	getMaxCELTcodecs() [r/w] Optional.
int	getMaxMpegCodecs() [r/w] Optional.
int	getMaxPCMCodecs() [r/w] Optional.
int	getMaxSpectrumWaveDataBuffers() [r/w] Optional.
int	getMaxXmaCodecs() [r/w] Optional.
short	getProfilePort() [r/w] Optional.
float	getVol0VirtualVol() [r/w] Optional.
void	release()
void	setASIOChannelList(java.lang.String[] ASIOChannelList) [r/w] Optional.
void	setASIOSpeakerList(FMOD_SPEAKER[] ASIOSpeakerList) [r/w] Optional.
void	setDebugLogFilename(java.lang.String debugLogFilename) [r/w] Optional.
void	setDefaultDecodeBufferSize(int defaultDecodeBufferSize) [r/w] Optional.
void	setEventQueueSize(int eventQueueSize) [r/w] Optional.
void	setGeometryMaxFadeTime(int geometryMaxFadeTime) [r/w] Optional.
void	setHRTFFreq(float HRTFFreq) [r/w] Optional.
void	setHRTFMaxAngle(float HRTFMaxAngle) [r/w] Optional.
void	setHRTFMinAngle(float HRTFMinAngle) [r/w] Optional.
void	setMax3DReverbDSPs(int max3DReverbDSPs) [r/w] Optional.
void	setMaxAdpcmCodecs(int maxAdpcmCodecs) [r/w] Optional.
void	setMaxCELTcodecs(int maxCELTcodecs) [r/w] Optional.
void	setMaxMpegCodecs(int maxMpegCodecs) [r/w] Optional.
void	setMaxPCMCodecs(int maxPCMCodecs) [r/w] Optional.
void	setMaxSpectrumWaveDataBuffers(int maxSpectrumWaveDataBuffers) [r/w] Optional.
void	setMaxXmaCodecs(int maxXmaCodecs) [r/w] Optional.
void	setProfilePort(short profilePort) [r/w] Optional.
void	setVol0VirtualVol(float vol0VirtualVol) [r/w] Optional.

Methods inherited from class org.jouvieje.fmodex.utils.Pointer

asByteBuffer, asDouble, asFloat, asInt, asLong, asPointer, asString, asString, equals, isNull, shareMemory

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FMOD_ADVANCEDSETTINGS

public FMOD_ADVANCEDSETTINGS()

Create an object that holds a null FMOD_ADVANCEDSETTINGS.
The call isNull() on the object created will returns true.

  FMOD_ADVANCEDSETTINGS obj = new FMOD_ADVANCEDSETTINGS();
  (obj == null) <=> false
  obj.isNull() <=> true
 

To creates a new FMOD_ADVANCEDSETTINGS, use the static "constructor" :

  FMOD_ADVANCEDSETTINGS obj = FMOD_ADVANCEDSETTINGS.allocate();

See Also:

allocate()

Method Detail

asFMOD_ADVANCEDSETTINGS

public static FMOD_ADVANCEDSETTINGS asFMOD_ADVANCEDSETTINGS(Pointer pointer)

Create a view of the Pointer object as a FMOD_ADVANCEDSETTINGS object.
This view is valid only if the memory holded by the Pointer holds a FMOD_ADVANCEDSETTINGS object.

allocate

public static FMOD_ADVANCEDSETTINGS allocate()

Allocate a new FMOD_ADVANCEDSETTINGS.
The call isNull() on the object created will return false.

  FMOD_ADVANCEDSETTINGS obj = FMOD_ADVANCEDSETTINGS.allocate();
  (obj == null) <=> obj.isNull() <=> false
 

release

public void release()

getCbSize

public int getCbSize()

[w] Size of this structure. Use sizeof(FMOD_ADVANCEDSETTINGS) NOTE: This must be set before calling System::getAdvancedSettings!

getMaxMpegCodecs

public int getMaxMpegCodecs()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. Mpeg codecs consume 21,684 bytes per instance and this number will determine how many mpeg channels can be played simultaneously. Default = 16.

setMaxMpegCodecs

public void setMaxMpegCodecs(int maxMpegCodecs)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. Mpeg codecs consume 21,684 bytes per instance and this number will determine how many mpeg channels can be played simultaneously. Default = 16.

getMaxAdpcmCodecs

public int getMaxAdpcmCodecs()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. ADPCM codecs consume 2,136 bytes per instance (based on FSB encoded ADPCM block size - see remarks) and this number will determine how many ADPCM channels can be played simultaneously. Default = 32.

setMaxAdpcmCodecs

public void setMaxAdpcmCodecs(int maxAdpcmCodecs)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. ADPCM codecs consume 2,136 bytes per instance (based on FSB encoded ADPCM block size - see remarks) and this number will determine how many ADPCM channels can be played simultaneously. Default = 32.

getMaxXmaCodecs

public int getMaxXmaCodecs()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. XMA codecs consume 14,836 bytes per instance and this number will determine how many XMA channels can be played simultaneously. Default = 32.

setMaxXmaCodecs

public void setMaxXmaCodecs(int maxXmaCodecs)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. XMA codecs consume 14,836 bytes per instance and this number will determine how many XMA channels can be played simultaneously. Default = 32.

getMaxCELTcodecs

public int getMaxCELTcodecs()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. CELT codecs consume 11,500 bytes per instance and this number will determine how many CELT channels can be played simultaneously. Default = 16

setMaxCELTcodecs

public void setMaxCELTcodecs(int maxCELTcodecs)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. CELT codecs consume 11,500 bytes per instance and this number will determine how many CELT channels can be played simultaneously. Default = 16

getMaxPCMCodecs

public int getMaxPCMCodecs()

[r/w] Optional. Specify 0 to ignore. For use with PS3 only. PCM codecs consume 12,672 bytes per instance and this number will determine how many streams and PCM voices can be played simultaneously. Default = 16

setMaxPCMCodecs

public void setMaxPCMCodecs(int maxPCMCodecs)

[r/w] Optional. Specify 0 to ignore. For use with PS3 only. PCM codecs consume 12,672 bytes per instance and this number will determine how many streams and PCM voices can be played simultaneously. Default = 16

getASIONumChannels

public int getASIONumChannels()

[r/w] Optional. Specify 0 to ignore. Number of channels available on the ASIO device.

getASIOChannelList

public java.lang.String[] getASIOChannelList()

[r/w] Optional. Specify 0 to ignore. Pointer to an array of strings (number of entries defined by ASIONumChannels) with ASIO channel names.

setASIOChannelList

public void setASIOChannelList(java.lang.String[] ASIOChannelList)

[r/w] Optional. Specify 0 to ignore. Pointer to an array of strings (number of entries defined by ASIONumChannels) with ASIO channel names.

getASIOSpeakerList

public FMOD_SPEAKER[] getASIOSpeakerList()

[r/w] Optional. Specify 0 to ignore. Pointer to a list of speakers that the ASIO channels map to. This can be called after System::init to remap ASIO output.

setASIOSpeakerList

public void setASIOSpeakerList(FMOD_SPEAKER[] ASIOSpeakerList)

[r/w] Optional. Specify 0 to ignore. Pointer to a list of speakers that the ASIO channels map to. This can be called after System::init to remap ASIO output.

getMax3DReverbDSPs

public int getMax3DReverbDSPs()

[r/w] Optional. Specify 0 to ignore. The max number of 3d reverb DSP's in the system. (NOTE: CURRENTLY DISABLED / UNUSED)

setMax3DReverbDSPs

public void setMax3DReverbDSPs(int max3DReverbDSPs)

[r/w] Optional. Specify 0 to ignore. The max number of 3d reverb DSP's in the system. (NOTE: CURRENTLY DISABLED / UNUSED)

getHRTFMinAngle

public float getHRTFMinAngle()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function begins to have an effect. 0 = in front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 180.0.

setHRTFMinAngle

public void setHRTFMinAngle(float HRTFMinAngle)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function begins to have an effect. 0 = in front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 180.0.

getHRTFMaxAngle

public float getHRTFMaxAngle()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function has maximum effect. 0 = front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 360.0.

setHRTFMaxAngle

public void setHRTFMaxAngle(float HRTFMaxAngle)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function has maximum effect. 0 = front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 360.0.

getHRTFFreq

public float getHRTFFreq()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The cutoff frequency of the HRTF's lowpass filter function when at maximum effect. (i.e. at HRTFMaxAngle). Default = 4000.0.

setHRTFFreq

public void setHRTFFreq(float HRTFFreq)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_SOFTWARE_HRTF. The cutoff frequency of the HRTF's lowpass filter function when at maximum effect. (i.e. at HRTFMaxAngle). Default = 4000.0.

getVol0VirtualVol

public float getVol0VirtualVol()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_VOL0_BECOMES_VIRTUAL. If this flag is used, and the volume is 0.0, then the sound will become virtual. Use this value to raise the threshold to a different point where a sound goes virtual.

setVol0VirtualVol

public void setVol0VirtualVol(float vol0VirtualVol)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_VOL0_BECOMES_VIRTUAL. If this flag is used, and the volume is 0.0, then the sound will become virtual. Use this value to raise the threshold to a different point where a sound goes virtual.

getEventQueueSize

public int getEventQueueSize()

[r/w] Optional. Specify 0 to ignore. For use with FMOD Event system only. Specifies the number of slots available for simultaneous non blocking loads. Default = 32.

setEventQueueSize

public void setEventQueueSize(int eventQueueSize)

[r/w] Optional. Specify 0 to ignore. For use with FMOD Event system only. Specifies the number of slots available for simultaneous non blocking loads. Default = 32.

getDefaultDecodeBufferSize

public int getDefaultDecodeBufferSize()

[r/w] Optional. Specify 0 to ignore. For streams. This determines the default size of the double buffer (in milliseconds) that a stream uses. Default = 400ms

setDefaultDecodeBufferSize

public void setDefaultDecodeBufferSize(int defaultDecodeBufferSize)

[r/w] Optional. Specify 0 to ignore. For streams. This determines the default size of the double buffer (in milliseconds) that a stream uses. Default = 400ms

getDebugLogFilename

public java.lang.String getDebugLogFilename()

[r/w] Optional. Specify 0 to ignore. Gives fmod's logging system a path/filename. Normally the log is placed in the same directory as the executable and called fmod.log. When using System::getAdvancedSettings, provide at least 256 bytes of memory to copy into.

setDebugLogFilename

public void setDebugLogFilename(java.lang.String debugLogFilename)

[r/w] Optional. Specify 0 to ignore. Gives fmod's logging system a path/filename. Normally the log is placed in the same directory as the executable and called fmod.log. When using System::getAdvancedSettings, provide at least 256 bytes of memory to copy into.

getProfilePort

public short getProfilePort()

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_ENABLE_PROFILE. Specify the port to listen on for connections by the profiler application.

setProfilePort

public void setProfilePort(short profilePort)

[r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_ENABLE_PROFILE. Specify the port to listen on for connections by the profiler application.

getGeometryMaxFadeTime

public int getGeometryMaxFadeTime()

[r/w] Optional. Specify 0 to ignore. The maximum time in miliseconds it takes for a channel to fade to the new level when its occlusion changes.

setGeometryMaxFadeTime

public void setGeometryMaxFadeTime(int geometryMaxFadeTime)

[r/w] Optional. Specify 0 to ignore. The maximum time in miliseconds it takes for a channel to fade to the new level when its occlusion changes.

getMaxSpectrumWaveDataBuffers

public int getMaxSpectrumWaveDataBuffers()

[r/w] Optional. Specify 0 to ignore. Tells System::init to allocate a pool of wavedata/spectrum buffers to prevent memory fragmentation, any additional buffers will be allocated normally.

setMaxSpectrumWaveDataBuffers

public void setMaxSpectrumWaveDataBuffers(int maxSpectrumWaveDataBuffers)

[r/w] Optional. Specify 0 to ignore. Tells System::init to allocate a pool of wavedata/spectrum buffers to prevent memory fragmentation, any additional buffers will be allocated normally.