Drag[en]gine Script Module DragonScript  1.23
Dragengine.AudioSystem Class Reference

Audio system. More...

Inheritance diagram for Dragengine.AudioSystem:

Static Public Member Functions

Management
static Microphone getActiveMicrophone ()
 Active microphone. More...
 
static void setActiveMicrophone (Microphone microphone)
 Set active microphone. More...
 
Parameters
static int getParameterCount ()
 Number of parameters available. More...
 
static ModuleParameter getParameterInfo (int index)
 Parameter information. More...
 
static ModuleParameter getParameterInfo (String name)
 Named parameter information or null if not found. More...
 
static String getParameterValue (String name)
 Parameter value. More...
 
static void setParameterValue (String name, String value)
 Set named parameter value. More...
 
static String sendCommand (String command)
 Send command. More...
 
static int getFPSRate ()
 Frame-per-second rate averaged over the last couple of frames. More...
 

Detailed Description

Audio system.

This is a native class. This is a pure static class. The class can not be instantiated

Member Function Documentation

◆ getActiveMicrophone()

static Microphone Dragengine.AudioSystem.getActiveMicrophone ( )
static

Active microphone.

◆ getFPSRate()

static int Dragengine.AudioSystem.getFPSRate ( )
static

Frame-per-second rate averaged over the last couple of frames.

Version
1.6

Returns 0 if module is not using a separate thread.

◆ getParameterCount()

static int Dragengine.AudioSystem.getParameterCount ( )
static

Number of parameters available.

◆ getParameterInfo() [1/2]

static ModuleParameter Dragengine.AudioSystem.getParameterInfo ( int  index)
static

Parameter information.

Exceptions
EOutOfBoundaryindex less than 0 or greater than or equal to getParameterCount().

◆ getParameterInfo() [2/2]

static ModuleParameter Dragengine.AudioSystem.getParameterInfo ( String  name)
static

Named parameter information or null if not found.

◆ getParameterValue()

static String Dragengine.AudioSystem.getParameterValue ( String  name)
static

Parameter value.

Exceptions
EInvalidParamParameter with name not found.

◆ sendCommand()

static String Dragengine.AudioSystem.sendCommand ( String  command)
static

Send command.

◆ setActiveMicrophone()

static void Dragengine.AudioSystem.setActiveMicrophone ( Microphone  microphone)
static

Set active microphone.

◆ setParameterValue()

static void Dragengine.AudioSystem.setParameterValue ( String  name,
String  value 
)
static

Set named parameter value.

Exceptions
EInvalidParamParameter with name not found.

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