FMOD.Sound Struct Reference

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

Public Attributes
IntPtr	handle

Private Member Functions
static RESULT	FMOD5_Sound_Release (IntPtr sound)
static RESULT	FMOD5_Sound_GetSystemObject (IntPtr sound, out IntPtr system)
static RESULT	FMOD5_Sound_Lock (IntPtr sound, uint offset, uint length, out IntPtr ptr1, out IntPtr ptr2, out uint len1, out uint len2)
static RESULT	FMOD5_Sound_Unlock (IntPtr sound, IntPtr ptr1, IntPtr ptr2, uint len1, uint len2)
static RESULT	FMOD5_Sound_SetDefaults (IntPtr sound, float frequency, int priority)
static RESULT	FMOD5_Sound_GetDefaults (IntPtr sound, out float frequency, out int priority)
static RESULT	FMOD5_Sound_Set3DMinMaxDistance (IntPtr sound, float min, float max)
static RESULT	FMOD5_Sound_Get3DMinMaxDistance (IntPtr sound, out float min, out float max)
static RESULT	FMOD5_Sound_Set3DConeSettings (IntPtr sound, float insideconeangle, float outsideconeangle, float outsidevolume)
static RESULT	FMOD5_Sound_Get3DConeSettings (IntPtr sound, out float insideconeangle, out float outsideconeangle, out float outsidevolume)
static RESULT	FMOD5_Sound_Set3DCustomRolloff (IntPtr sound, ref VECTOR points, int numpoints)
static RESULT	FMOD5_Sound_Get3DCustomRolloff (IntPtr sound, out IntPtr points, out int numpoints)
static RESULT	FMOD5_Sound_GetSubSound (IntPtr sound, int index, out IntPtr subsound)
static RESULT	FMOD5_Sound_GetSubSoundParent (IntPtr sound, out IntPtr parentsound)
static RESULT	FMOD5_Sound_GetName (IntPtr sound, IntPtr name, int namelen)
static RESULT	FMOD5_Sound_GetLength (IntPtr sound, out uint length, TIMEUNIT lengthtype)
static RESULT	FMOD5_Sound_GetFormat (IntPtr sound, out SOUND_TYPE type, out SOUND_FORMAT format, out int channels, out int bits)
static RESULT	FMOD5_Sound_GetNumSubSounds (IntPtr sound, out int numsubsounds)
static RESULT	FMOD5_Sound_GetNumTags (IntPtr sound, out int numtags, out int numtagsupdated)
static RESULT	FMOD5_Sound_GetTag (IntPtr sound, byte[] name, int index, out TAG tag)
static RESULT	FMOD5_Sound_GetOpenState (IntPtr sound, out OPENSTATE openstate, out uint percentbuffered, out bool starving, out bool diskbusy)
static RESULT	FMOD5_Sound_ReadData (IntPtr sound, byte[] buffer, uint length, IntPtr zero)
static RESULT	FMOD5_Sound_ReadData (IntPtr sound, byte[] buffer, uint length, out uint read)
static RESULT	FMOD5_Sound_ReadData (IntPtr sound, IntPtr buffer, uint length, out uint read)
static RESULT	FMOD5_Sound_SeekData (IntPtr sound, uint pcm)
static RESULT	FMOD5_Sound_SetSoundGroup (IntPtr sound, IntPtr soundgroup)
static RESULT	FMOD5_Sound_GetSoundGroup (IntPtr sound, out IntPtr soundgroup)
static RESULT	FMOD5_Sound_GetNumSyncPoints (IntPtr sound, out int numsyncpoints)
static RESULT	FMOD5_Sound_GetSyncPoint (IntPtr sound, int index, out IntPtr point)
static RESULT	FMOD5_Sound_GetSyncPointInfo (IntPtr sound, IntPtr point, IntPtr name, int namelen, out uint offset, TIMEUNIT offsettype)
static RESULT	FMOD5_Sound_AddSyncPoint (IntPtr sound, uint offset, TIMEUNIT offsettype, byte[] name, out IntPtr point)
static RESULT	FMOD5_Sound_DeleteSyncPoint (IntPtr sound, IntPtr point)
static RESULT	FMOD5_Sound_SetMode (IntPtr sound, MODE mode)
static RESULT	FMOD5_Sound_GetMode (IntPtr sound, out MODE mode)
static RESULT	FMOD5_Sound_SetLoopCount (IntPtr sound, int loopcount)
static RESULT	FMOD5_Sound_GetLoopCount (IntPtr sound, out int loopcount)
static RESULT	FMOD5_Sound_SetLoopPoints (IntPtr sound, uint loopstart, TIMEUNIT loopstarttype, uint loopend, TIMEUNIT loopendtype)
static RESULT	FMOD5_Sound_GetLoopPoints (IntPtr sound, out uint loopstart, TIMEUNIT loopstarttype, out uint loopend, TIMEUNIT loopendtype)
static RESULT	FMOD5_Sound_GetMusicNumChannels (IntPtr sound, out int numchannels)
static RESULT	FMOD5_Sound_SetMusicChannelVolume (IntPtr sound, int channel, float volume)
static RESULT	FMOD5_Sound_GetMusicChannelVolume (IntPtr sound, int channel, out float volume)
static RESULT	FMOD5_Sound_SetMusicSpeed (IntPtr sound, float speed)
static RESULT	FMOD5_Sound_GetMusicSpeed (IntPtr sound, out float speed)
static RESULT	FMOD5_Sound_SetUserData (IntPtr sound, IntPtr userdata)
static RESULT	FMOD5_Sound_GetUserData (IntPtr sound, out IntPtr userdata)

Constructor & Destructor Documentation

Sound()

FMOD.Sound.Sound

(

IntPtr

ptr

)

Member Function Documentation

addSyncPoint()

RESULT FMOD.Sound.addSyncPoint	(	uint	offset,
		TIMEUNIT	offsettype,
		string	name,
		out IntPtr	point )

clearHandle()

void FMOD.Sound.clearHandle

(

)

deleteSyncPoint()

RESULT FMOD.Sound.deleteSyncPoint

(

IntPtr

point

)

FMOD5_Sound_AddSyncPoint()

static RESULT FMOD.Sound.FMOD5_Sound_AddSyncPoint ( IntPtr sound, uint offset, TIMEUNIT offsettype, byte[] name, out IntPtr point )

private

FMOD5_Sound_DeleteSyncPoint()

static RESULT FMOD.Sound.FMOD5_Sound_DeleteSyncPoint ( IntPtr sound, IntPtr point )

private

FMOD5_Sound_Get3DConeSettings()

static RESULT FMOD.Sound.FMOD5_Sound_Get3DConeSettings ( IntPtr sound, out float insideconeangle, out float outsideconeangle, out float outsidevolume )

private

FMOD5_Sound_Get3DCustomRolloff()

static RESULT FMOD.Sound.FMOD5_Sound_Get3DCustomRolloff ( IntPtr sound, out IntPtr points, out int numpoints )

private

FMOD5_Sound_Get3DMinMaxDistance()

static RESULT FMOD.Sound.FMOD5_Sound_Get3DMinMaxDistance ( IntPtr sound, out float min, out float max )

private

FMOD5_Sound_GetDefaults()

static RESULT FMOD.Sound.FMOD5_Sound_GetDefaults ( IntPtr sound, out float frequency, out int priority )

private

FMOD5_Sound_GetFormat()

static RESULT FMOD.Sound.FMOD5_Sound_GetFormat ( IntPtr sound, out SOUND_TYPE type, out SOUND_FORMAT format, out int channels, out int bits )

private

FMOD5_Sound_GetLength()

static RESULT FMOD.Sound.FMOD5_Sound_GetLength ( IntPtr sound, out uint length, TIMEUNIT lengthtype )

private

FMOD5_Sound_GetLoopCount()

static RESULT FMOD.Sound.FMOD5_Sound_GetLoopCount ( IntPtr sound, out int loopcount )

private

FMOD5_Sound_GetLoopPoints()

static RESULT FMOD.Sound.FMOD5_Sound_GetLoopPoints ( IntPtr sound, out uint loopstart, TIMEUNIT loopstarttype, out uint loopend, TIMEUNIT loopendtype )

private

FMOD5_Sound_GetMode()

static RESULT FMOD.Sound.FMOD5_Sound_GetMode ( IntPtr sound, out MODE mode )

private

FMOD5_Sound_GetMusicChannelVolume()

static RESULT FMOD.Sound.FMOD5_Sound_GetMusicChannelVolume ( IntPtr sound, int channel, out float volume )

private

FMOD5_Sound_GetMusicNumChannels()

static RESULT FMOD.Sound.FMOD5_Sound_GetMusicNumChannels ( IntPtr sound, out int numchannels )

private

FMOD5_Sound_GetMusicSpeed()

static RESULT FMOD.Sound.FMOD5_Sound_GetMusicSpeed ( IntPtr sound, out float speed )

private

FMOD5_Sound_GetName()

static RESULT FMOD.Sound.FMOD5_Sound_GetName ( IntPtr sound, IntPtr name, int namelen )

private

FMOD5_Sound_GetNumSubSounds()

static RESULT FMOD.Sound.FMOD5_Sound_GetNumSubSounds ( IntPtr sound, out int numsubsounds )

private

FMOD5_Sound_GetNumSyncPoints()

static RESULT FMOD.Sound.FMOD5_Sound_GetNumSyncPoints ( IntPtr sound, out int numsyncpoints )

private

FMOD5_Sound_GetNumTags()

static RESULT FMOD.Sound.FMOD5_Sound_GetNumTags ( IntPtr sound, out int numtags, out int numtagsupdated )

private

FMOD5_Sound_GetOpenState()

static RESULT FMOD.Sound.FMOD5_Sound_GetOpenState ( IntPtr sound, out OPENSTATE openstate, out uint percentbuffered, out bool starving, out bool diskbusy )

private

FMOD5_Sound_GetSoundGroup()

static RESULT FMOD.Sound.FMOD5_Sound_GetSoundGroup ( IntPtr sound, out IntPtr soundgroup )

private

FMOD5_Sound_GetSubSound()

static RESULT FMOD.Sound.FMOD5_Sound_GetSubSound ( IntPtr sound, int index, out IntPtr subsound )

private

FMOD5_Sound_GetSubSoundParent()

static RESULT FMOD.Sound.FMOD5_Sound_GetSubSoundParent ( IntPtr sound, out IntPtr parentsound )

private

FMOD5_Sound_GetSyncPoint()

static RESULT FMOD.Sound.FMOD5_Sound_GetSyncPoint ( IntPtr sound, int index, out IntPtr point )

private

FMOD5_Sound_GetSyncPointInfo()

static RESULT FMOD.Sound.FMOD5_Sound_GetSyncPointInfo ( IntPtr sound, IntPtr point, IntPtr name, int namelen, out uint offset, TIMEUNIT offsettype )

private

FMOD5_Sound_GetSystemObject()

static RESULT FMOD.Sound.FMOD5_Sound_GetSystemObject ( IntPtr sound, out IntPtr system )

private

FMOD5_Sound_GetTag()

static RESULT FMOD.Sound.FMOD5_Sound_GetTag ( IntPtr sound, byte[] name, int index, out TAG tag )

private

FMOD5_Sound_GetUserData()

static RESULT FMOD.Sound.FMOD5_Sound_GetUserData ( IntPtr sound, out IntPtr userdata )

private

FMOD5_Sound_Lock()

static RESULT FMOD.Sound.FMOD5_Sound_Lock ( IntPtr sound, uint offset, uint length, out IntPtr ptr1, out IntPtr ptr2, out uint len1, out uint len2 )

private

FMOD5_Sound_ReadData() [1/3]

static RESULT FMOD.Sound.FMOD5_Sound_ReadData ( IntPtr sound, byte[] buffer, uint length, IntPtr zero )

private

FMOD5_Sound_ReadData() [2/3]

static RESULT FMOD.Sound.FMOD5_Sound_ReadData ( IntPtr sound, byte[] buffer, uint length, out uint read )

private

FMOD5_Sound_ReadData() [3/3]

static RESULT FMOD.Sound.FMOD5_Sound_ReadData ( IntPtr sound, IntPtr buffer, uint length, out uint read )

private

FMOD5_Sound_Release()

static RESULT FMOD.Sound.FMOD5_Sound_Release ( IntPtr sound )

private

FMOD5_Sound_SeekData()

static RESULT FMOD.Sound.FMOD5_Sound_SeekData ( IntPtr sound, uint pcm )

private

FMOD5_Sound_Set3DConeSettings()

static RESULT FMOD.Sound.FMOD5_Sound_Set3DConeSettings ( IntPtr sound, float insideconeangle, float outsideconeangle, float outsidevolume )

private

FMOD5_Sound_Set3DCustomRolloff()

static RESULT FMOD.Sound.FMOD5_Sound_Set3DCustomRolloff ( IntPtr sound, ref VECTOR points, int numpoints )

private

FMOD5_Sound_Set3DMinMaxDistance()

static RESULT FMOD.Sound.FMOD5_Sound_Set3DMinMaxDistance ( IntPtr sound, float min, float max )

private

FMOD5_Sound_SetDefaults()

static RESULT FMOD.Sound.FMOD5_Sound_SetDefaults ( IntPtr sound, float frequency, int priority )

private

FMOD5_Sound_SetLoopCount()

static RESULT FMOD.Sound.FMOD5_Sound_SetLoopCount ( IntPtr sound, int loopcount )

private

FMOD5_Sound_SetLoopPoints()

static RESULT FMOD.Sound.FMOD5_Sound_SetLoopPoints ( IntPtr sound, uint loopstart, TIMEUNIT loopstarttype, uint loopend, TIMEUNIT loopendtype )

private

FMOD5_Sound_SetMode()

static RESULT FMOD.Sound.FMOD5_Sound_SetMode ( IntPtr sound, MODE mode )

private

FMOD5_Sound_SetMusicChannelVolume()

static RESULT FMOD.Sound.FMOD5_Sound_SetMusicChannelVolume ( IntPtr sound, int channel, float volume )

private

FMOD5_Sound_SetMusicSpeed()

static RESULT FMOD.Sound.FMOD5_Sound_SetMusicSpeed ( IntPtr sound, float speed )

private

FMOD5_Sound_SetSoundGroup()

static RESULT FMOD.Sound.FMOD5_Sound_SetSoundGroup ( IntPtr sound, IntPtr soundgroup )

private

FMOD5_Sound_SetUserData()

static RESULT FMOD.Sound.FMOD5_Sound_SetUserData ( IntPtr sound, IntPtr userdata )

private

FMOD5_Sound_Unlock()

static RESULT FMOD.Sound.FMOD5_Sound_Unlock ( IntPtr sound, IntPtr ptr1, IntPtr ptr2, uint len1, uint len2 )

private

get3DConeSettings()

RESULT FMOD.Sound.get3DConeSettings	(	out float	insideconeangle,
		out float	outsideconeangle,
		out float	outsidevolume )

get3DCustomRolloff()

RESULT FMOD.Sound.get3DCustomRolloff	(	out IntPtr	points,
		out int	numpoints )

get3DMinMaxDistance()

RESULT FMOD.Sound.get3DMinMaxDistance	(	out float	min,
		out float	max )

getDefaults()

RESULT FMOD.Sound.getDefaults	(	out float	frequency,
		out int	priority )

getFormat()

RESULT FMOD.Sound.getFormat	(	out SOUND_TYPE	type,
		out SOUND_FORMAT	format,
		out int	channels,
		out int	bits )

getLength()

RESULT FMOD.Sound.getLength	(	out uint	length,
		TIMEUNIT	lengthtype )

getLoopCount()

RESULT FMOD.Sound.getLoopCount

(

out int

loopcount

)

getLoopPoints()

RESULT FMOD.Sound.getLoopPoints	(	out uint	loopstart,
		TIMEUNIT	loopstarttype,
		out uint	loopend,
		TIMEUNIT	loopendtype )

getMode()

RESULT FMOD.Sound.getMode

(

out MODE

mode

)

getMusicChannelVolume()

RESULT FMOD.Sound.getMusicChannelVolume	(	int	channel,
		out float	volume )

getMusicNumChannels()

RESULT FMOD.Sound.getMusicNumChannels

(

out int

numchannels

)

getMusicSpeed()

RESULT FMOD.Sound.getMusicSpeed

(

out float

speed

)

getName()

RESULT FMOD.Sound.getName	(	out string	name,
		int	namelen )

getNumSubSounds()

RESULT FMOD.Sound.getNumSubSounds

(

out int

numsubsounds

)

getNumSyncPoints()

RESULT FMOD.Sound.getNumSyncPoints

(

out int

numsyncpoints

)

getNumTags()

RESULT FMOD.Sound.getNumTags	(	out int	numtags,
		out int	numtagsupdated )

getOpenState()

RESULT FMOD.Sound.getOpenState	(	out OPENSTATE	openstate,
		out uint	percentbuffered,
		out bool	starving,
		out bool	diskbusy )

getSoundGroup()

RESULT FMOD.Sound.getSoundGroup

(

out SoundGroup

soundgroup

)

getSubSound()

RESULT FMOD.Sound.getSubSound	(	int	index,
		out Sound	subsound )

getSubSoundParent()

RESULT FMOD.Sound.getSubSoundParent

(

out Sound

parentsound

)

getSyncPoint()

RESULT FMOD.Sound.getSyncPoint	(	int	index,
		out IntPtr	point )

getSyncPointInfo() [1/2]

RESULT FMOD.Sound.getSyncPointInfo	(	IntPtr	point,
		out string	name,
		int	namelen,
		out uint	offset,
		TIMEUNIT	offsettype )

getSyncPointInfo() [2/2]

RESULT FMOD.Sound.getSyncPointInfo	(	IntPtr	point,
		out uint	offset,
		TIMEUNIT	offsettype )

getSystemObject()

RESULT FMOD.Sound.getSystemObject

(

out System

system

)

getTag()

RESULT FMOD.Sound.getTag	(	string	name,
		int	index,
		out TAG	tag )

getUserData()

RESULT FMOD.Sound.getUserData

(

out IntPtr

userdata

)

hasHandle()

bool FMOD.Sound.hasHandle

(

)

lock()

RESULT FMOD.Sound.lock	(	uint	offset,
		uint	length,
		out IntPtr	ptr1,
		out IntPtr	ptr2,
		out uint	len1,
		out uint	len2 )

readData() [1/3]

RESULT FMOD.Sound.readData

(

byte[]

buffer

)

readData() [2/3]

RESULT FMOD.Sound.readData	(	byte[]	buffer,
		out uint	read )

readData() [3/3]

RESULT FMOD.Sound.readData	(	IntPtr	buffer,
		uint	length,
		out uint	read )

release()

RESULT FMOD.Sound.release

(

)

seekData()

RESULT FMOD.Sound.seekData

(

uint

pcm

)

set3DConeSettings()

RESULT FMOD.Sound.set3DConeSettings	(	float	insideconeangle,
		float	outsideconeangle,
		float	outsidevolume )

set3DCustomRolloff()

RESULT FMOD.Sound.set3DCustomRolloff	(	ref VECTOR	points,
		int	numpoints )

set3DMinMaxDistance()

RESULT FMOD.Sound.set3DMinMaxDistance	(	float	min,
		float	max )

setDefaults()

RESULT FMOD.Sound.setDefaults	(	float	frequency,
		int	priority )

setLoopCount()

RESULT FMOD.Sound.setLoopCount

(

int

loopcount

)

setLoopPoints()

RESULT FMOD.Sound.setLoopPoints	(	uint	loopstart,
		TIMEUNIT	loopstarttype,
		uint	loopend,
		TIMEUNIT	loopendtype )

setMode()

RESULT FMOD.Sound.setMode

(

MODE

mode

)

setMusicChannelVolume()

RESULT FMOD.Sound.setMusicChannelVolume	(	int	channel,
		float	volume )

setMusicSpeed()

RESULT FMOD.Sound.setMusicSpeed

(

float

speed

)

setSoundGroup()

RESULT FMOD.Sound.setSoundGroup

(

SoundGroup

soundgroup

)

setUserData()

RESULT FMOD.Sound.setUserData

(

IntPtr

userdata

)

unlock()

RESULT FMOD.Sound.unlock	(	IntPtr	ptr1,
		IntPtr	ptr2,
		uint	len1,
		uint	len2 )

Member Data Documentation

handle

IntPtr FMOD.Sound.handle

---

The documentation for this struct was generated from the following file:

• Assets/Plugins/FMOD/src/fmod.cs