org.jouvieje.fmodex.structures
Class FMOD_CREATESOUNDEXINFO

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

public class FMOD_CREATESOUNDEXINFO

extends Pointer

Constructor Summary

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

Method Summary

static FMOD_CREATESOUNDEXINFO	allocate() Allocate a new FMOD_CREATESOUNDEXINFO.
static FMOD_CREATESOUNDEXINFO	asFMOD_CREATESOUNDEXINFO(Pointer pointer) Create a view of the Pointer object as a FMOD_CREATESOUNDEXINFO object.
int	getCbSize() [w] Size of this structure.
int	getDecodeBufferSize() [w] Optional.
int	getDefaultFrequency() [w] Optional.
java.lang.String	getDlsName() [w] Optional.
java.lang.String	getEncryptionKey() [w] Optional.
int	getFileOffset() [w] Optional.
FMOD_SOUND_FORMAT	getFormat() [w] Optional.
int	getIgnoresetfilesystem() [w] Optional.
java.nio.IntBuffer	getInclusionList() [w] Optional.
int	getInclusionListNum() [w] Optional.
int	getInitialSeekPosition() [w] Optional.
int	getInitialSeekPosType() [w] Optional.
SoundGroup	getInitialSoundGroup() [w] Optional.
int	getInitialSubsound() [w] Optional.
int	getLength() [w] Optional.
int	getMaxPolyphony() [w] Optional.
FMOD_SOUND_NONBLOCKCALLBACK	getNonBlockCallback() [w] Optional.
int	getNumChannels() [w] Optional.
int	getNumSubsounds() [w] Optional.
FMOD_SOUND_PCMREADCALLBACK	getPcmReadCallback() [w] Optional.
FMOD_SOUND_PCMSETPOSCALLBACK	getPcmSetPosCallback() [w] Optional.
FMOD_SPEAKERMAPTYPE	getSpeakerMap() [w] Optional.
FMOD_SOUND_TYPE	getSuggestedSoundType() [w] Optional.
FMOD_FILE_ASYNCCANCELCALLBACK	getUserAsyncCancel() [w] Optional.
FMOD_FILE_ASYNCREADCALLBACK	getUserAsyncRead() [w] Optional.
FMOD_FILE_CLOSECALLBACK	getUserClose() [w] Optional.
Pointer	getUserData() [w] Optional.
FMOD_FILE_OPENCALLBACK	getUserOpen() [w] Optional.
FMOD_FILE_READCALLBACK	getUserRead() [w] Optional.
FMOD_FILE_SEEKCALLBACK	getUserSeek() [w] Optional.
void	release()
void	setDecodeBufferSize(int decodeBufferSize) [w] Optional.
void	setDefaultFrequency(int defaultFrequency) [w] Optional.
void	setDlsName(java.lang.String dlsName) [w] Optional.
void	setEncryptionKey(java.lang.String encryptionKey) [w] Optional.
void	setFileOffset(int fileOffset) [w] Optional.
void	setFormat(FMOD_SOUND_FORMAT format) [w] Optional.
void	setIgnoresetfilesystem(int ignoresetfilesystem) [w] Optional.
void	setInclusionList(java.nio.IntBuffer inclusionList) [w] Optional.
void	setInitialSeekPosition(int initialSeekPosition) [w] Optional.
void	setInitialSeekPosType(int initialSeekPosType) [w] Optional.
void	setInitialSoundGroup(SoundGroup initialSoundGroup) [w] Optional.
void	setInitialSubsound(int initialSubsound) [w] Optional.
void	setLength(int length) [w] Optional.
void	setMaxPolyphony(int maxPolyphony) [w] Optional.
void	setNonBlockCallback(FMOD_SOUND_NONBLOCKCALLBACK nonBlockCallback) [w] Optional.
void	setNumChannels(int numChannels) [w] Optional.
void	setNumSubsounds(int numSubsounds) [w] Optional.
void	setPcmReadCallback(FMOD_SOUND_PCMREADCALLBACK pcmReadCallback) [w] Optional.
void	setPcmSetPosCallback(FMOD_SOUND_PCMSETPOSCALLBACK pcmSetPosCallback) [w] Optional.
void	setSpeakerMap(FMOD_SPEAKERMAPTYPE speakerMap) [w] Optional.
void	setSuggestedSoundType(FMOD_SOUND_TYPE suggestedSoundType) [w] Optional.
void	setUserAsyncCancel(FMOD_FILE_ASYNCCANCELCALLBACK userAsyncCancel) [w] Optional.
void	setUserAsyncRead(FMOD_FILE_ASYNCREADCALLBACK userAsyncRead) [w] Optional.
void	setUserClose(FMOD_FILE_CLOSECALLBACK userClose) [w] Optional.
void	setUserData(Pointer userData) [w] Optional.
void	setUserOpen(FMOD_FILE_OPENCALLBACK userOpen) [w] Optional.
void	setUserRead(FMOD_FILE_READCALLBACK userRead) [w] Optional.
void	setUserSeek(FMOD_FILE_SEEKCALLBACK userSeek) [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_CREATESOUNDEXINFO

public FMOD_CREATESOUNDEXINFO()

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

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

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

  FMOD_CREATESOUNDEXINFO obj = FMOD_CREATESOUNDEXINFO.allocate();

See Also:

allocate()

Method Detail

asFMOD_CREATESOUNDEXINFO

public static FMOD_CREATESOUNDEXINFO asFMOD_CREATESOUNDEXINFO(Pointer pointer)

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

allocate

public static FMOD_CREATESOUNDEXINFO allocate()

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

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

release

public void release()

getCbSize

public int getCbSize()

[w] Size of this structure. This is used so the structure can be expanded in the future and still work on older versions of FMOD Ex.

getLength

public int getLength()

[w] Optional. Specify 0 to ignore. Size in bytes of file to load, or sound to create (in this case only if FMOD_OPENUSER is used). Required if loading from memory. If 0 is specified, then it will use the size of the file (unless loading from memory then an error will be returned).

setLength

public void setLength(int length)

[w] Optional. Specify 0 to ignore. Size in bytes of file to load, or sound to create (in this case only if FMOD_OPENUSER is used). Required if loading from memory. If 0 is specified, then it will use the size of the file (unless loading from memory then an error will be returned).

getFileOffset

public int getFileOffset()

[w] Optional. Specify 0 to ignore. Offset from start of the file to start loading from. This is useful for loading files from inside big data files.

setFileOffset

public void setFileOffset(int fileOffset)

[w] Optional. Specify 0 to ignore. Offset from start of the file to start loading from. This is useful for loading files from inside big data files.

getNumChannels

public int getNumChannels()

[w] Optional. Specify 0 to ignore. Number of channels in a sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used.

setNumChannels

public void setNumChannels(int numChannels)

[w] Optional. Specify 0 to ignore. Number of channels in a sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used.

getDefaultFrequency

public int getDefaultFrequency()

[w] Optional. Specify 0 to ignore. Default frequency of sound in a sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. Other formats use the frequency determined by the file format.

setDefaultFrequency

public void setDefaultFrequency(int defaultFrequency)

[w] Optional. Specify 0 to ignore. Default frequency of sound in a sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. Other formats use the frequency determined by the file format.

getFormat

public FMOD_SOUND_FORMAT getFormat()

[w] Optional. Specify 0 or FMOD_SOUND_FORMAT_NONE to ignore. Format of the sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. Other formats use the format determined by the file format.

setFormat

public void setFormat(FMOD_SOUND_FORMAT format)

[w] Optional. Specify 0 or FMOD_SOUND_FORMAT_NONE to ignore. Format of the sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. Other formats use the format determined by the file format.

getDecodeBufferSize

public int getDecodeBufferSize()

[w] Optional. Specify 0 to ignore. For streams. This determines the size of the double buffer (in PCM samples) that a stream uses. Use this for user created streams if you want to determine the size of the callback buffer passed to you. Specify 0 to use FMOD's default size which is currently equivalent to 400ms of the sound format created/loaded.

setDecodeBufferSize

public void setDecodeBufferSize(int decodeBufferSize)

[w] Optional. Specify 0 to ignore. For streams. This determines the size of the double buffer (in PCM samples) that a stream uses. Use this for user created streams if you want to determine the size of the callback buffer passed to you. Specify 0 to use FMOD's default size which is currently equivalent to 400ms of the sound format created/loaded.

getInitialSubsound

public int getInitialSubsound()

[w] Optional. Specify 0 to ignore. In a multi-sample file format such as .FSB/.DLS/.SF2, specify the initial subsound to seek to, only if FMOD_CREATESTREAM is used.

setInitialSubsound

public void setInitialSubsound(int initialSubsound)

[w] Optional. Specify 0 to ignore. In a multi-sample file format such as .FSB/.DLS/.SF2, specify the initial subsound to seek to, only if FMOD_CREATESTREAM is used.

getNumSubsounds

public int getNumSubsounds()

[w] Optional. Specify 0 to ignore or have no subsounds. In a sound created with FMOD_OPENUSER, specify the number of subsounds that are accessable with Sound::getSubSound. If not created with FMOD_OPENUSER, this will limit the number of subsounds loaded within a multi-subsound file. If using FSB, then if FMOD_CREATESOUNDEXINFO::inclusionlist is used, this will shuffle subsounds down so that there are not any gaps. It will mean that the indices of the sounds will be different.

setNumSubsounds

public void setNumSubsounds(int numSubsounds)

[w] Optional. Specify 0 to ignore or have no subsounds. In a sound created with FMOD_OPENUSER, specify the number of subsounds that are accessable with Sound::getSubSound. If not created with FMOD_OPENUSER, this will limit the number of subsounds loaded within a multi-subsound file. If using FSB, then if FMOD_CREATESOUNDEXINFO::inclusionlist is used, this will shuffle subsounds down so that there are not any gaps. It will mean that the indices of the sounds will be different.

getInclusionList

public java.nio.IntBuffer getInclusionList()

[w] Optional. Specify 0 to ignore. In a multi-sample format such as .FSB/.DLS/.SF2 it may be desirable to specify only a subset of sounds to be loaded out of the whole file. This is an array of subsound indices to load into memory when created.

setInclusionList

public void setInclusionList(java.nio.IntBuffer inclusionList)

[w] Optional. Specify 0 to ignore. In a multi-sample format such as .FSB/.DLS/.SF2 it may be desirable to specify only a subset of sounds to be loaded out of the whole file. This is an array of subsound indices to load into memory when created.

getInclusionListNum

public int getInclusionListNum()

[w] Optional. Specify 0 to ignore. This is the number of integers contained within the inclusionlist array.

getPcmReadCallback

public FMOD_SOUND_PCMREADCALLBACK getPcmReadCallback()

[w] Optional. Specify 0 to ignore. Callback to 'piggyback' on FMOD's read functions and accept or even write PCM data while FMOD is opening the sound. Used for user sounds created with FMOD_OPENUSER or for capturing decoded data as FMOD reads it.

setPcmReadCallback

public void setPcmReadCallback(FMOD_SOUND_PCMREADCALLBACK pcmReadCallback)

[w] Optional. Specify 0 to ignore. Callback to 'piggyback' on FMOD's read functions and accept or even write PCM data while FMOD is opening the sound. Used for user sounds created with FMOD_OPENUSER or for capturing decoded data as FMOD reads it.

getPcmSetPosCallback

public FMOD_SOUND_PCMSETPOSCALLBACK getPcmSetPosCallback()

[w] Optional. Specify 0 to ignore. Callback for when the user calls a seeking function such as Channel::setTime or Channel::setPosition within a multi-sample sound, and for when it is opened.

setPcmSetPosCallback

public void setPcmSetPosCallback(FMOD_SOUND_PCMSETPOSCALLBACK pcmSetPosCallback)

[w] Optional. Specify 0 to ignore. Callback for when the user calls a seeking function such as Channel::setTime or Channel::setPosition within a multi-sample sound, and for when it is opened.

getNonBlockCallback

public FMOD_SOUND_NONBLOCKCALLBACK getNonBlockCallback()

[w] Optional. Specify 0 to ignore. Callback for successful completion, or error while loading a sound that used the FMOD_NONBLOCKING flag.

setNonBlockCallback

public void setNonBlockCallback(FMOD_SOUND_NONBLOCKCALLBACK nonBlockCallback)

[w] Optional. Specify 0 to ignore. Callback for successful completion, or error while loading a sound that used the FMOD_NONBLOCKING flag.

getDlsName

public java.lang.String getDlsName()

[w] Optional. Specify 0 to ignore. Filename for a DLS or SF2 sample set when loading a MIDI file. If not specified, on Windows it will attempt to open /windows/system32/drivers/gm.dls or /windows/system32/drivers/etc/gm.dls, on Mac it will attempt to load /System/Library/Components/CoreAudio.component/Contents/Resources/gs_instruments.dls, otherwise the MIDI will fail to open. Current DLS support is for level 1 of the specification.

setDlsName

public void setDlsName(java.lang.String dlsName)

[w] Optional. Specify 0 to ignore. Filename for a DLS or SF2 sample set when loading a MIDI file. If not specified, on Windows it will attempt to open /windows/system32/drivers/gm.dls or /windows/system32/drivers/etc/gm.dls, on Mac it will attempt to load /System/Library/Components/CoreAudio.component/Contents/Resources/gs_instruments.dls, otherwise the MIDI will fail to open. Current DLS support is for level 1 of the specification.

getEncryptionKey

public java.lang.String getEncryptionKey()

[w] Optional. Specify 0 to ignore. Key for encrypted FSB file. Without this key an encrypted FSB file will not load.

setEncryptionKey

public void setEncryptionKey(java.lang.String encryptionKey)

[w] Optional. Specify 0 to ignore. Key for encrypted FSB file. Without this key an encrypted FSB file will not load.

getMaxPolyphony

public int getMaxPolyphony()

[w] Optional. Specify 0 to ignore. For sequenced formats with dynamic channel allocation such as .MID and .IT, this specifies the maximum voice count allowed while playing. .IT defaults to 64. .MID defaults to 32.

setMaxPolyphony

public void setMaxPolyphony(int maxPolyphony)

[w] Optional. Specify 0 to ignore. For sequenced formats with dynamic channel allocation such as .MID and .IT, this specifies the maximum voice count allowed while playing. .IT defaults to 64. .MID defaults to 32.

getUserData

public Pointer getUserData()

[w] Optional. Specify 0 to ignore. This is user data to be attached to the sound during creation. Access via Sound::getUserData. Note: This is not passed to FMOD_FILE_OPENCALLBACK, that is a different userdata that is file specific.

setUserData

public void setUserData(Pointer userData)

[w] Optional. Specify 0 to ignore. This is user data to be attached to the sound during creation. Access via Sound::getUserData. Note: This is not passed to FMOD_FILE_OPENCALLBACK, that is a different userdata that is file specific.

getSuggestedSoundType

public FMOD_SOUND_TYPE getSuggestedSoundType()

[w] Optional. Specify 0 or FMOD_SOUND_TYPE_UNKNOWN to ignore. Instead of scanning all codec types, use this to speed up loading by making it jump straight to this codec.

setSuggestedSoundType

public void setSuggestedSoundType(FMOD_SOUND_TYPE suggestedSoundType)

[w] Optional. Specify 0 or FMOD_SOUND_TYPE_UNKNOWN to ignore. Instead of scanning all codec types, use this to speed up loading by making it jump straight to this codec.

getUserOpen

public FMOD_FILE_OPENCALLBACK getUserOpen()

[w] Optional. Specify 0 to ignore. Callback for opening this file.

setUserOpen

public void setUserOpen(FMOD_FILE_OPENCALLBACK userOpen)

[w] Optional. Specify 0 to ignore. Callback for opening this file.

getUserClose

public FMOD_FILE_CLOSECALLBACK getUserClose()

[w] Optional. Specify 0 to ignore. Callback for closing this file.

setUserClose

public void setUserClose(FMOD_FILE_CLOSECALLBACK userClose)

[w] Optional. Specify 0 to ignore. Callback for closing this file.

getUserRead

public FMOD_FILE_READCALLBACK getUserRead()

[w] Optional. Specify 0 to ignore. Callback for reading from this file.

setUserRead

public void setUserRead(FMOD_FILE_READCALLBACK userRead)

[w] Optional. Specify 0 to ignore. Callback for reading from this file.

getUserSeek

public FMOD_FILE_SEEKCALLBACK getUserSeek()

[w] Optional. Specify 0 to ignore. Callback for seeking within this file.

setUserSeek

public void setUserSeek(FMOD_FILE_SEEKCALLBACK userSeek)

[w] Optional. Specify 0 to ignore. Callback for seeking within this file.

getUserAsyncRead

public FMOD_FILE_ASYNCREADCALLBACK getUserAsyncRead()

[w] Optional. Specify 0 to ignore. Callback for seeking within this file.

setUserAsyncRead

public void setUserAsyncRead(FMOD_FILE_ASYNCREADCALLBACK userAsyncRead)

[w] Optional. Specify 0 to ignore. Callback for seeking within this file.

getUserAsyncCancel

public FMOD_FILE_ASYNCCANCELCALLBACK getUserAsyncCancel()

[w] Optional. Specify 0 to ignore. Callback for seeking within this file.

setUserAsyncCancel

public void setUserAsyncCancel(FMOD_FILE_ASYNCCANCELCALLBACK userAsyncCancel)

[w] Optional. Specify 0 to ignore. Callback for seeking within this file.

getSpeakerMap

public FMOD_SPEAKERMAPTYPE getSpeakerMap()

[w] Optional. Specify 0 to ignore. Use this to differ the way fmod maps multichannel sounds to speakers. See FMOD_SPEAKERMAPTYPE for more.

setSpeakerMap

public void setSpeakerMap(FMOD_SPEAKERMAPTYPE speakerMap)

[w] Optional. Specify 0 to ignore. Use this to differ the way fmod maps multichannel sounds to speakers. See FMOD_SPEAKERMAPTYPE for more.

getInitialSoundGroup

public SoundGroup getInitialSoundGroup()

[w] Optional. Specify 0 to ignore. Specify a sound group if required, to put sound in as it is created.

setInitialSoundGroup

public void setInitialSoundGroup(SoundGroup initialSoundGroup)

[w] Optional. Specify 0 to ignore. Specify a sound group if required, to put sound in as it is created.

getInitialSeekPosition

public int getInitialSeekPosition()

[w] Optional. Specify 0 to ignore. For streams. Specify an initial position to seek the stream to.

setInitialSeekPosition

public void setInitialSeekPosition(int initialSeekPosition)

[w] Optional. Specify 0 to ignore. For streams. Specify an initial position to seek the stream to.

getInitialSeekPosType

public int getInitialSeekPosType()

[w] Optional. Specify 0 to ignore. For streams. Specify the time unit for the position set in initialseekposition.

setInitialSeekPosType

public void setInitialSeekPosType(int initialSeekPosType)

[w] Optional. Specify 0 to ignore. For streams. Specify the time unit for the position set in initialseekposition.

getIgnoresetfilesystem

public int getIgnoresetfilesystem()

[w] Optional. Specify 0 to ignore. Set to 1 to use fmod's built in file system. Ignores setFileSystem callbacks and also FMOD_CREATESOUNEXINFO file callbacks. Useful for specific cases where you don't want to use your own file system but want to use fmod's file system (ie net streaming).

setIgnoresetfilesystem

public void setIgnoresetfilesystem(int ignoresetfilesystem)

[w] Optional. Specify 0 to ignore. Set to 1 to use fmod's built in file system. Ignores setFileSystem callbacks and also FMOD_CREATESOUNEXINFO file callbacks. Useful for specific cases where you don't want to use your own file system but want to use fmod's file system (ie net streaming).