ParaScripting::ParaAudio Class Reference
[ParaAudio]

List of all members.

---

Detailed Description

Audio Engine functions.

Static Public Member Functions
static bool	IsAudioEngineEnabled ()
	---------------- Audio Engine Functions ---------------- get is audio engine enabled
static void	EnableAudioEngine ()
	enable Audio Engine
static void	DisableAudioEngine ()
	disable Audio Engine
static void	PauseCategory (const char *strCategoryName)
	pause certain category in Audio Engine
static void	ResumeCategory (const char *strCategoryName)
	resume certain category in Audio Engine
static void	StopCategory (const char *strCategoryName)
	stop certain category in Audio Engine
static void	EnableAudioBank (const char *strBankName)
	initialize the audio banks needed in Audio Engine
static void	DisableAudioBank (const char *strBankName)
	clean up the audio banks needed in Audio Engine
static string	GetCurrentAudioBankName ()
	get the current audio bank name
static void	SetAudioStereo ()
	set listener's sound output format to stereo
static void	SetAudio5Point1 ()
	set listener's sound output format to 5.1 sound
static int	GetAudioFormat ()
	get listener's sound output format
static void	PlayBGMusic (const char *strBGMusicName)
	---------------- Background Functions ---------------- play background music
static void	PauseBGMusic ()
	pause background music
static void	ResumeBGMusic ()
	resume background music
static void	StopBGMusic ()
	stop background music
static bool	IsBGMusicEnabled ()
	get is background music enabled
static void	EnableBGMusic ()
	enable background music
static void	DisableBGMusic ()
	disable background music
static float	GetBGMusicVolume ()
	Get background music volume.
static void	SetBGMusicVolume (const float fVolume)
	set background music volume
static void	PlayDialog (const char *strDialogName, const char *strScript)
	---------------- Dialog Functions ---------------- play dialog music
static void	SkipDialog ()
	skip dialog music to the next marker
static void	PauseDialog ()
	pause dialog music
static void	ResumeDialog ()
	resume dialog music
static void	StopDialog ()
	stop dialog music
static bool	IsDialogEnabled ()
	get is dialog music enabled
static void	EnableDialog ()
	enable dialog music
static void	DisableDialog ()
	disable dialog music
static float	GetDialogVolume ()
	get dialog volume
static void	SetDialogVolume (const float fVolume)
	set dialog volume
static void	PlayAmbientSound (const char *strAmbientSoundName)
	---------------- Ambient Sound Functions ---------------- play ambient sound
static void	PauseAmbientSound (const char *strAmbientSoundName)
	pause ambient sound
static void	ResumeAmbientSound (const char *strAmbientSoundName)
	resume ambient sound
static void	StopAmbientSound (const char *strAmbientSoundName)
	stop ambient sound
static bool	IsAmbientSoundEnabled ()
	get is ambient sound enabled
static void	EnableAmbientSound ()
	enable ambient sound music
static void	DisableAmbientSound ()
	disable ambient sound music
static float	GetAmbientSoundVolume ()
	get ambient sound volume
static void	SetAmbientSoundVolume (const float fVolume)
	set ambient sound volume
static void	PlayUISound (const char *strUISoundName)
	---------------- UserInterface Sound Functions ---------------- play UI sound
static float	GetUISoundVolume ()
	get UI sound volume
static void	SetUISoundVolume (const float fVolume)
	set UI sound volume
static void	PlayStatic3DSound (const char *str3DSoundName, const char *assetName, float x, float y, float z)
	---------------- 3D Sound Functions ---------------- play 3D sound in static position
static void	PauseStatic3DSound (const char *assetName)
	pause 3D sound in static position
static void	ResumeStatic3DSound (const char *assetName)
	Resume 3D sound in static position.
static void	StopStatic3DSound (const char *assetName)
	stop 3D sound in static position
static void	PlayDynamic3DSound (const char *str3DSoundName, const char *objectName)
	play 3D sound to dynamic object
static float	Get3DSoundVolume ()
	get 3D sound volume
static void	Set3DSoundVolume (const float fVolume)
	set 3D sound volume
static void	PlayInteractiveSound (const char *strInteractiveSoundName)
	---------------- Interactive Sound Functions ---------------- play Interactive sound
static float	GetInteractiveSoundVolume ()
	get interactive sound volume
static void	SetInteractiveSoundVolume (const float fVolume)
	set interactive sound volume
static bool	PlayWaveFile (const char *szWavePath, int nLoopCount)
	Prepare and play a wave object from a standard PCM, XMA (Xbox 360) file.
static bool	PlayWaveFile1 (const char *szWavePath)
static bool	StopWaveFile (const char *szWavePath, bool bImmediateStop)
	stop a wave file
static bool	StopWaveFile1 (const char *szWavePath)
static bool	ReleaseWaveFile (const char *szWavePath)
	release a wave file
static const char *	GetRecordingDeviceEnum ()
	enumerate the available recording devices in this machine.
static const char *	GetRecordingFormatEnum ()
	enumerate the available recording formats on this machine.
static bool	SetRecordingOutput (const char *sOutputFile, int nDeviceIndex, int nWaveFormatIndex)
	set the recording output properties for recording with BeginRecording() and StopRecording() function.
static bool	BeginRecording ()
	start recording to the current recording output
static bool	PauseOrResumeRecording (int nState)
	Parameters: nState,:  0 for toggle pause and resume.
static bool	StopRecording ()
	stop recording and save output to the current recording output
static bool	IsRecording ()
	whether it is recording sound.
static bool	IsRecordingPaused ()
	whether it is recording is paused.
static const char *	GetLastRecordedData (int nTimeLength)
	try return a snapshot of the recorded wave data in the last nTimeLength time.

---

Member Function Documentation

static void ParaScripting::ParaAudio::PauseCategory

(

const char *

strCategoryName

)

[static]

pause certain category in Audio Engine

Parameters:

strCategoryName,:

category name

static void ParaScripting::ParaAudio::ResumeCategory

(

const char *

strCategoryName

)

[static]

resume certain category in Audio Engine

Parameters:

strCategoryName,:

category name

static void ParaScripting::ParaAudio::StopCategory

(

const char *

strCategoryName

)

[static]

stop certain category in Audio Engine

Parameters:

strCategoryName,:

category name

static void ParaScripting::ParaAudio::EnableAudioBank

(

const char *

strBankName

)

[static]

initialize the audio banks needed in Audio Engine

Parameters:

strBankName,:

sound and wave bank name

static void ParaScripting::ParaAudio::DisableAudioBank

(

const char *

strBankName

)

[static]

clean up the audio banks needed in Audio Engine

Parameters:

strBankName,:

sound and wave bank name

static string ParaScripting::ParaAudio::GetCurrentAudioBankName

(

)

[static]

get the current audio bank name

Returns:

: current audio bank name

static int ParaScripting::ParaAudio::GetAudioFormat

(

)

[static]

get listener's sound output format

Returns:

: 2:Stereo 6:5Point1

static void ParaScripting::ParaAudio::PlayBGMusic

(

const char *

strBGMusicName

)

[static]

---------------- Background Functions ---------------- play background music

Parameters:

strBGMusicName,:

background music name

static void ParaScripting::ParaAudio::PauseBGMusic

(

)

[static]

pause background music

Parameters:

strBGMusicName,:

background music name

static void ParaScripting::ParaAudio::ResumeBGMusic

(

)

[static]

resume background music

Parameters:

strBGMusicName,:

background music name

static void ParaScripting::ParaAudio::StopBGMusic

(

)

[static]

stop background music

Parameters:

strBGMusicName,:

background music name

static float ParaScripting::ParaAudio::GetBGMusicVolume

(

)

[static]

Get background music volume.

Parameters:

fVolume,:

background music volume

static void ParaScripting::ParaAudio::SetBGMusicVolume

(

const float

fVolume

)

[static]

set background music volume

Parameters:

fVolume,:

background music volume

static void ParaScripting::ParaAudio::PlayDialog	(	const char *	strDialogName,
		const char *	strScript
	)			[static]

---------------- Dialog Functions ---------------- play dialog music

Parameters:

strDialogName,:

dialog music name

static float ParaScripting::ParaAudio::GetDialogVolume

(

)

[static]

get dialog volume

Parameters:

fVolume,:

dialog volume

static void ParaScripting::ParaAudio::SetDialogVolume

(

const float

fVolume

)

[static]

set dialog volume

Parameters:

fVolume,:

dialog volume

static void ParaScripting::ParaAudio::PlayAmbientSound

(

const char *

strAmbientSoundName

)

[static]

---------------- Ambient Sound Functions ---------------- play ambient sound

Parameters:

strAmbientSoundName,:

ambient sound name

static void ParaScripting::ParaAudio::PauseAmbientSound

(

const char *

strAmbientSoundName

)

[static]

pause ambient sound

Parameters:

strAmbientSoundName,:

ambient sound name

static void ParaScripting::ParaAudio::ResumeAmbientSound

(

const char *

strAmbientSoundName

)

[static]

resume ambient sound

Parameters:

strAmbientSoundName,:

ambient sound name

static void ParaScripting::ParaAudio::StopAmbientSound

(

const char *

strAmbientSoundName

)

[static]

stop ambient sound

Parameters:

strAmbientSoundName,:

ambient sound name

static float ParaScripting::ParaAudio::GetAmbientSoundVolume

(

)

[static]

get ambient sound volume

Parameters:

fVolume,:

ambient sound volume

static void ParaScripting::ParaAudio::SetAmbientSoundVolume

(

const float

fVolume

)

[static]

set ambient sound volume

Parameters:

fVolume,:

ambient sound volume

static void ParaScripting::ParaAudio::PlayUISound

(

const char *

strUISoundName

)

[static]

---------------- UserInterface Sound Functions ---------------- play UI sound

Parameters:

strUISoundName,:

UI sound name

static float ParaScripting::ParaAudio::GetUISoundVolume

(

)

[static]

get UI sound volume

Parameters:

fVolume,:

UI sound volume

static void ParaScripting::ParaAudio::SetUISoundVolume

(

const float

fVolume

)

[static]

set UI sound volume

Parameters:

fVolume,:

UI sound volume

static void ParaScripting::ParaAudio::PlayStatic3DSound	(	const char *	str3DSoundName,
		const char *	assetName,
		float	x,
		float	y,
		float	z
	)			[static]

---------------- 3D Sound Functions ---------------- play 3D sound in static position

Parameters:

	str3DSoundName,:	3D sound name
	assetName,:	3D sound asset name, this is the KEY to the 3D Sound
	x,y,z,:	3D sound position

static void ParaScripting::ParaAudio::PauseStatic3DSound

(

const char *

assetName

)

[static]

pause 3D sound in static position

Parameters:

assetName,:

3D sound asset name, this is the KEY to the 3D Sound

static void ParaScripting::ParaAudio::ResumeStatic3DSound

(

const char *

assetName

)

[static]

Resume 3D sound in static position.

Parameters:

assetName,:

3D sound asset name, this is the KEY to the 3D Sound

static void ParaScripting::ParaAudio::StopStatic3DSound

(

const char *

assetName

)

[static]

stop 3D sound in static position

Parameters:

assetName,:

3D sound asset name, this is the KEY to the 3D Sound

static void ParaScripting::ParaAudio::PlayDynamic3DSound	(	const char *	str3DSoundName,
		const char *	objectName
	)			[static]

play 3D sound to dynamic object

Parameters:

	str3DSoundName,:	3D sound name
	objectName,:	3D sound object name, this is the KEY to the 3D Sound this is the name of the base class BaseObject

static float ParaScripting::ParaAudio::Get3DSoundVolume

(

)

[static]

get 3D sound volume

Parameters:

fVolume,:

3D sound volume

static void ParaScripting::ParaAudio::Set3DSoundVolume

(

const float

fVolume

)

[static]

set 3D sound volume

Parameters:

fVolume,:

3D sound volume

static void ParaScripting::ParaAudio::PlayInteractiveSound

(

const char *

strInteractiveSoundName

)

[static]

---------------- Interactive Sound Functions ---------------- play Interactive sound

Parameters:

strInteractiveSoundName,:

interactive sound name NOTE: Interactive sound is now behave like UI sound, and it don't promise Zero-Latency

static float ParaScripting::ParaAudio::GetInteractiveSoundVolume

(

)

[static]

get interactive sound volume

Parameters:

fVolume,:

interactive sound volume

static void ParaScripting::ParaAudio::SetInteractiveSoundVolume

(

const float

fVolume

)

[static]

set interactive sound volume

Parameters:

fVolume,:

interactive sound volume

static bool ParaScripting::ParaAudio::PlayWaveFile	(	const char *	szWavePath,
		int	nLoopCount
	)			[static]

Prepare and play a wave object from a standard PCM, XMA (Xbox 360) file.

If a wave file is already prepared before. It will be reused.

Parameters:

	szWavePath	Path to the wave file.
	nLoopCount	Number of times to loop this file. If there is no loop region, but the loop count is nonzero, the entire wave is looped.

static bool ParaScripting::ParaAudio::StopWaveFile	(	const char *	szWavePath,
		bool	bImmediateStop
	)			[static]

stop a wave file

Parameters:

	szWavePath	Path to the wave file.
	bImmediateStop	if false, it plays the wave to completion, then stops. For looping waves, this flag plays the current iteration to completion, then stops (ignoring any subsequent iterations). In either case, any release (or tail) is played. To stop the wave immediately, use true.

static bool ParaScripting::ParaAudio::ReleaseWaveFile

(

const char *

szWavePath

)

[static]

release a wave file

Parameters:

szWavePath

Path to the wave file.

static const char* ParaScripting::ParaAudio::GetRecordingDeviceEnum

(

)

[static]

enumerate the available recording devices in this machine.

returned as strings separated by ';' this function is not thread safe

static const char* ParaScripting::ParaAudio::GetRecordingFormatEnum

(

)

[static]

enumerate the available recording formats on this machine.

returned as strings separated by ';' this function is not thread safe

static bool ParaScripting::ParaAudio::SetRecordingOutput	(	const char *	sOutputFile,
		int	nDeviceIndex,
		int	nWaveFormatIndex
	)			[static]

set the recording output properties for recording with BeginRecording() and StopRecording() function.

Parameters:

	sOutputFile,:	the output file. it can be nil. Default is "temp/soundcapture.wav",
	nDeviceIndex,:	-1 to use the current one. or it should be a valid index as in GetRecordingDeviceEnum();
	nWaveFormatIndex,:	-1 to use the current one. or it should be a valid index as in GetRecordingFormatEnum();

static bool ParaScripting::ParaAudio::PauseOrResumeRecording

(

int

nState

)

[static]

Parameters:

nState,:

0 for toggle pause and resume.

-1 for pause, 1 for resume.

static bool ParaScripting::ParaAudio::IsRecording

(

)

[static]

whether it is recording sound.

static bool ParaScripting::ParaAudio::IsRecordingPaused

(

)

[static]

whether it is recording is paused.

static const char* ParaScripting::ParaAudio::GetLastRecordedData

(

int

nTimeLength

)

[static]

try return a snapshot of the recorded wave data in the last nTimeLength time.

just turn the music to strings to be displayed by the GUI.

---