C# Class FMOD.Sound

Show file Open project: punker76/simple-music-player Class Usage Examples

Public Methods

Method	Description
@lock ( uint offset, uint length, IntPtr &ptr1, IntPtr &ptr2, uint &len1, uint &len2 ) : RESULT
Sound ( IntPtr raw ) : System
addSyncPoint ( uint offset, TIMEUNIT offsettype, string name, IntPtr &point ) : RESULT
deleteSyncPoint ( IntPtr point ) : RESULT
get3DConeSettings ( float &insideconeangle, float &outsideconeangle, float &outsidevolume ) : RESULT
get3DCustomRolloff ( IntPtr &points, int &numpoints ) : RESULT
get3DMinMaxDistance ( float &min, float &max ) : RESULT
getDefaults ( float &frequency, int &priority ) : RESULT
getFormat ( SOUND_TYPE &type, SOUND_FORMAT &format, int &channels, int &bits ) : RESULT
getLength ( uint &length, TIMEUNIT lengthtype ) : RESULT
getLoopCount ( int &loopcount ) : RESULT
getLoopPoints ( uint &loopstart, TIMEUNIT loopstarttype, uint &loopend, TIMEUNIT loopendtype ) : RESULT
getMode ( MODE &mode ) : RESULT
getMusicChannelVolume ( int channel, float &volume ) : RESULT
getMusicNumChannels ( int &numchannels ) : RESULT
getMusicSpeed ( float &speed ) : RESULT
getName ( StringBuilder name, int namelen ) : RESULT
getNumSubSounds ( int &numsubsounds ) : RESULT
getNumSyncPoints ( int &numsyncpoints ) : RESULT
getNumTags ( int &numtags, int &numtagsupdated ) : RESULT
getOpenState ( OPENSTATE &openstate, uint &percentbuffered, bool &starving, bool &diskbusy ) : RESULT
getSoundGroup ( SoundGroup &soundgroup ) : RESULT
getSubSound ( int index, Sound &subsound ) : RESULT
getSubSoundParent ( Sound &parentsound ) : RESULT
getSyncPoint ( int index, IntPtr &point ) : RESULT
getSyncPointInfo ( IntPtr point, StringBuilder name, int namelen, uint &offset, TIMEUNIT offsettype ) : RESULT
getSystemObject ( System &system ) : RESULT
getTag ( string name, int index, TAG &tag ) : RESULT
getUserData ( IntPtr &userdata ) : RESULT
readData ( IntPtr buffer, uint lenbytes, uint &read ) : RESULT
release ( ) : RESULT
seekData ( uint pcm ) : RESULT
set3DConeSettings ( float insideconeangle, float outsideconeangle, float outsidevolume ) : RESULT
set3DCustomRolloff ( VECTOR &points, int numpoints ) : RESULT
set3DMinMaxDistance ( float min, float max ) : RESULT
setDefaults ( float frequency, int priority ) : RESULT
setLoopCount ( int loopcount ) : RESULT
setLoopPoints ( uint loopstart, TIMEUNIT loopstarttype, uint loopend, TIMEUNIT loopendtype ) : RESULT
setMode ( MODE mode ) : RESULT
setMusicChannelVolume ( int channel, float volume ) : RESULT
setMusicSpeed ( float speed ) : RESULT
setSoundGroup ( SoundGroup soundgroup ) : RESULT
setUserData ( IntPtr userdata ) : RESULT
unlock ( IntPtr ptr1, IntPtr ptr2, uint len1, uint len2 ) : RESULT

Private Methods

Method	Description
FMOD_Sound_AddSyncPoint ( IntPtr sound, uint offset, TIMEUNIT offsettype, string name, IntPtr &point ) : RESULT
FMOD_Sound_DeleteSyncPoint ( IntPtr sound, IntPtr point ) : RESULT
FMOD_Sound_Get3DConeSettings ( IntPtr sound, float &insideconeangle, float &outsideconeangle, float &outsidevolume ) : RESULT
FMOD_Sound_Get3DCustomRolloff ( IntPtr sound, IntPtr &points, int &numpoints ) : RESULT
FMOD_Sound_Get3DMinMaxDistance ( IntPtr sound, float &min, float &max ) : RESULT
FMOD_Sound_GetDefaults ( IntPtr sound, float &frequency, int &priority ) : RESULT
FMOD_Sound_GetFormat ( IntPtr sound, SOUND_TYPE &type, SOUND_FORMAT &format, int &channels, int &bits ) : RESULT
FMOD_Sound_GetLength ( IntPtr sound, uint &length, TIMEUNIT lengthtype ) : RESULT
FMOD_Sound_GetLoopCount ( IntPtr sound, int &loopcount ) : RESULT
FMOD_Sound_GetLoopPoints ( IntPtr sound, uint &loopstart, TIMEUNIT loopstarttype, uint &loopend, TIMEUNIT loopendtype ) : RESULT
FMOD_Sound_GetMode ( IntPtr sound, MODE &mode ) : RESULT
FMOD_Sound_GetMusicChannelVolume ( IntPtr sound, int channel, float &volume ) : RESULT
FMOD_Sound_GetMusicNumChannels ( IntPtr sound, int &numchannels ) : RESULT
FMOD_Sound_GetMusicSpeed ( IntPtr sound, float &speed ) : RESULT
FMOD_Sound_GetName ( IntPtr sound, IntPtr name, int namelen ) : RESULT
FMOD_Sound_GetNumSubSounds ( IntPtr sound, int &numsubsounds ) : RESULT
FMOD_Sound_GetNumSyncPoints ( IntPtr sound, int &numsyncpoints ) : RESULT
FMOD_Sound_GetNumTags ( IntPtr sound, int &numtags, int &numtagsupdated ) : RESULT
FMOD_Sound_GetOpenState ( IntPtr sound, OPENSTATE &openstate, uint &percentbuffered, bool &starving, bool &diskbusy ) : RESULT
FMOD_Sound_GetSoundGroup ( IntPtr sound, IntPtr &soundgroup ) : RESULT
FMOD_Sound_GetSubSound ( IntPtr sound, int index, IntPtr &subsound ) : RESULT
FMOD_Sound_GetSubSoundParent ( IntPtr sound, IntPtr &parentsound ) : RESULT
FMOD_Sound_GetSyncPoint ( IntPtr sound, int index, IntPtr &point ) : RESULT
FMOD_Sound_GetSyncPointInfo ( IntPtr sound, IntPtr point, IntPtr name, int namelen, uint &offset, TIMEUNIT offsettype ) : RESULT
FMOD_Sound_GetSystemObject ( IntPtr sound, IntPtr &system ) : RESULT
FMOD_Sound_GetTag ( IntPtr sound, string name, int index, TAG &tag ) : RESULT
FMOD_Sound_GetUserData ( IntPtr sound, IntPtr &userdata ) : RESULT
FMOD_Sound_Lock ( IntPtr sound, uint offset, uint length, IntPtr &ptr1, IntPtr &ptr2, uint &len1, uint &len2 ) : RESULT
FMOD_Sound_ReadData ( IntPtr sound, IntPtr buffer, uint lenbytes, uint &read ) : RESULT
FMOD_Sound_Release ( IntPtr sound ) : RESULT
FMOD_Sound_SeekData ( IntPtr sound, uint pcm ) : RESULT
FMOD_Sound_Set3DConeSettings ( IntPtr sound, float insideconeangle, float outsideconeangle, float outsidevolume ) : RESULT
FMOD_Sound_Set3DCustomRolloff ( IntPtr sound, VECTOR &points, int numpoints ) : RESULT
FMOD_Sound_Set3DMinMaxDistance ( IntPtr sound, float min, float max ) : RESULT
FMOD_Sound_SetDefaults ( IntPtr sound, float frequency, int priority ) : RESULT
FMOD_Sound_SetLoopCount ( IntPtr sound, int loopcount ) : RESULT
FMOD_Sound_SetLoopPoints ( IntPtr sound, uint loopstart, TIMEUNIT loopstarttype, uint loopend, TIMEUNIT loopendtype ) : RESULT
FMOD_Sound_SetMode ( IntPtr sound, MODE mode ) : RESULT
FMOD_Sound_SetMusicChannelVolume ( IntPtr sound, int channel, float volume ) : RESULT
FMOD_Sound_SetMusicSpeed ( IntPtr sound, float speed ) : RESULT
FMOD_Sound_SetSoundGroup ( IntPtr sound, IntPtr soundgroup ) : RESULT
FMOD_Sound_SetUserData ( IntPtr sound, IntPtr userdata ) : RESULT
FMOD_Sound_Unlock ( IntPtr sound, IntPtr ptr1, IntPtr ptr2, uint len1, uint len2 ) : RESULT

Method Details

@lock() public method

public @lock ( uint offset, uint length, IntPtr &ptr1, IntPtr &ptr2, uint &len1, uint &len2 ) : RESULT
offset	uint
length	uint
ptr1	System.IntPtr
ptr2	System.IntPtr
len1	uint
len2	uint
return	RESULT

Sound() public method

public Sound ( IntPtr raw ) : System
raw	System.IntPtr
return	System

addSyncPoint() public method

public addSyncPoint ( uint offset, TIMEUNIT offsettype, string name, IntPtr &point ) : RESULT
offset	uint
offsettype	TIMEUNIT
name	string
point	System.IntPtr
return	RESULT

deleteSyncPoint() public method

public deleteSyncPoint ( IntPtr point ) : RESULT
point	System.IntPtr
return	RESULT

get3DConeSettings() public method

public get3DConeSettings ( float &insideconeangle, float &outsideconeangle, float &outsidevolume ) : RESULT
insideconeangle	float
outsideconeangle	float
outsidevolume	float
return	RESULT

get3DCustomRolloff() public method

public get3DCustomRolloff ( IntPtr &points, int &numpoints ) : RESULT
points	System.IntPtr
numpoints	int
return	RESULT

get3DMinMaxDistance() public method

public get3DMinMaxDistance ( float &min, float &max ) : RESULT
min	float
max	float
return	RESULT

getDefaults() public method

public getDefaults ( float &frequency, int &priority ) : RESULT
frequency	float
priority	int
return	RESULT

getFormat() public method

public getFormat ( SOUND_TYPE &type, SOUND_FORMAT &format, int &channels, int &bits ) : RESULT
type	SOUND_TYPE
format	SOUND_FORMAT
channels	int
bits	int
return	RESULT

getLength() public method

public getLength ( uint &length, TIMEUNIT lengthtype ) : RESULT
length	uint
lengthtype	TIMEUNIT
return	RESULT

getLoopCount() public method

public getLoopCount ( int &loopcount ) : RESULT
loopcount	int
return	RESULT

getLoopPoints() public method

public getLoopPoints ( uint &loopstart, TIMEUNIT loopstarttype, uint &loopend, TIMEUNIT loopendtype ) : RESULT
loopstart	uint
loopstarttype	TIMEUNIT
loopend	uint
loopendtype	TIMEUNIT
return	RESULT

getMode() public method

public getMode ( MODE &mode ) : RESULT
mode	MODE
return	RESULT

getMusicChannelVolume() public method

public getMusicChannelVolume ( int channel, float &volume ) : RESULT
channel	int
volume	float
return	RESULT

getMusicNumChannels() public method

public getMusicNumChannels ( int &numchannels ) : RESULT
numchannels	int
return	RESULT

getMusicSpeed() public method

public getMusicSpeed ( float &speed ) : RESULT
speed	float
return	RESULT

getName() public method

public getName ( StringBuilder name, int namelen ) : RESULT
name	StringBuilder
namelen	int
return	RESULT

getNumSubSounds() public method

public getNumSubSounds ( int &numsubsounds ) : RESULT
numsubsounds	int
return	RESULT

getNumSyncPoints() public method

public getNumSyncPoints ( int &numsyncpoints ) : RESULT
numsyncpoints	int
return	RESULT

getNumTags() public method

public getNumTags ( int &numtags, int &numtagsupdated ) : RESULT
numtags	int
numtagsupdated	int
return	RESULT

getOpenState() public method

public getOpenState ( OPENSTATE &openstate, uint &percentbuffered, bool &starving, bool &diskbusy ) : RESULT
openstate	OPENSTATE
percentbuffered	uint
starving	bool
diskbusy	bool
return	RESULT

getSoundGroup() public method

public getSoundGroup ( SoundGroup &soundgroup ) : RESULT
soundgroup	SoundGroup
return	RESULT

getSubSound() public method

public getSubSound ( int index, Sound &subsound ) : RESULT
index	int
subsound	Sound
return	RESULT

getSubSoundParent() public method

public getSubSoundParent ( Sound &parentsound ) : RESULT
parentsound	Sound
return	RESULT

getSyncPoint() public method

public getSyncPoint ( int index, IntPtr &point ) : RESULT
index	int
point	System.IntPtr
return	RESULT

getSyncPointInfo() public method

public getSyncPointInfo ( IntPtr point, StringBuilder name, int namelen, uint &offset, TIMEUNIT offsettype ) : RESULT
point	System.IntPtr
name	StringBuilder
namelen	int
offset	uint
offsettype	TIMEUNIT
return	RESULT

getSystemObject() public method

public getSystemObject ( System &system ) : RESULT
system	System
return	RESULT

getTag() public method

public getTag ( string name, int index, TAG &tag ) : RESULT
name	string
index	int
tag	TAG
return	RESULT

getUserData() public method

public getUserData ( IntPtr &userdata ) : RESULT
userdata	System.IntPtr
return	RESULT

readData() public method

public readData ( IntPtr buffer, uint lenbytes, uint &read ) : RESULT
buffer	System.IntPtr
lenbytes	uint
read	uint
return	RESULT

release() public method

public release ( ) : RESULT
return	RESULT

seekData() public method

public seekData ( uint pcm ) : RESULT
pcm	uint
return	RESULT

set3DConeSettings() public method

public set3DConeSettings ( float insideconeangle, float outsideconeangle, float outsidevolume ) : RESULT
insideconeangle	float
outsideconeangle	float
outsidevolume	float
return	RESULT

set3DCustomRolloff() public method

public set3DCustomRolloff ( VECTOR &points, int numpoints ) : RESULT
points	VECTOR
numpoints	int
return	RESULT

set3DMinMaxDistance() public method

public set3DMinMaxDistance ( float min, float max ) : RESULT
min	float
max	float
return	RESULT

setDefaults() public method

public setDefaults ( float frequency, int priority ) : RESULT
frequency	float
priority	int
return	RESULT

setLoopCount() public method

public setLoopCount ( int loopcount ) : RESULT
loopcount	int
return	RESULT

setLoopPoints() public method

public setLoopPoints ( uint loopstart, TIMEUNIT loopstarttype, uint loopend, TIMEUNIT loopendtype ) : RESULT
loopstart	uint
loopstarttype	TIMEUNIT
loopend	uint
loopendtype	TIMEUNIT
return	RESULT

setMode() public method

public setMode ( MODE mode ) : RESULT
mode	MODE
return	RESULT

setMusicChannelVolume() public method

public setMusicChannelVolume ( int channel, float volume ) : RESULT
channel	int
volume	float
return	RESULT

setMusicSpeed() public method

public setMusicSpeed ( float speed ) : RESULT
speed	float
return	RESULT

setSoundGroup() public method

public setSoundGroup ( SoundGroup soundgroup ) : RESULT
soundgroup	SoundGroup
return	RESULT

setUserData() public method

public setUserData ( IntPtr userdata ) : RESULT
userdata	System.IntPtr
return	RESULT

unlock() public method

public unlock ( IntPtr ptr1, IntPtr ptr2, uint len1, uint len2 ) : RESULT
ptr1	IntPtr
ptr2	IntPtr
len1	uint
len2	uint
return	RESULT