---

IAudioScript Class Reference

IAudioScript is the interface for DirectMusic script objects. More...

#include <IAudio.h>

Inheritance diagram for IAudioScript::

List of all members.

Public Methods
virtual bool	Init (const AudioScriptInit &init)=0
virtual bool	SetVariable (std::string sVarName, int32 iVal)=0
virtual bool	GetVariable (std::string sVarName, int32 &iVal)=0
virtual bool	CallRoutine (std::string sRoutineName)=0

---

Detailed Description

IAudioScript is the interface for DirectMusic script objects.

Audio script objects allow an audio designer to perform custom actions through the use of variables and routines that can be set, retrieved, and executed from code.

---

Member Function Documentation

bool IAudioScript::CallRoutine ( std::string sRoutineName ) [pure virtual]

Calls a specific routine in a script. Parameters: sRoutineName   indicates the name of the routine to call Returns: true indicates success, false indicates failure. See also: GetVariable(), SetVariable()

bool IAudioScript::GetVariable ( std::string sVarName, int32 & iVal ) [pure virtual]

Retrieves the value of a named variable in a script. Parameters: sVarName   specifies the variable name to retrieve iVal   which will hold the value of the script variable Returns: true indicates success, false indicates failure. See also: SetVariable(), CallRoutine()

bool IAudioScript::Init ( const AudioScriptInit & init ) [pure virtual]

Initializes the script object with the data needed to load and execute script functions. Parameters: init   SegmentInit structure contains all initialization parameters. Returns: true indicates success, false indicates failure. See also: SegmentInit, Destroy()

bool IAudioScript::SetVariable ( std::string sVarName, int32 iVal ) [pure virtual]

Sets a named variable in a script to a numerical value. Parameters: sVarName   specifies the variable name to set iVal   is the value to which the variable will be set Returns: true indicates success, false indicates failure. See also: GetVariable(), CallRoutine()

---

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

• IAudio.h

---