CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomExAsrRack.Config Struct Reference

A config structure for creating an ASR Rack More...

Static Public Member Functions

static Config Default ()
 Get the configuration structure with default values More...
 

Public Attributes

float serverFrequency
 Frequency of server process More...
 
int numBuses
 The number of buses More...
 
int outputChannels
 The number of output channels More...
 
CriAtom.SpeakerMapping speakerMapping
 Mixer speaker mapping More...
 
int outputSamplingRate
 Output sampling rate More...
 
CriAtomEx.SoundRendererType soundRendererType
 Sound renderer type More...
 
int outputRackId
 Destination ASR Rack ID More...
 
IntPtr context
 Pointer to platform-specific parameters More...
 

Detailed Description

A config structure for creating an ASR Rack

Description:
A structure for specifying the behavior of CriAtomExAsrRack.
You pass this structure as an argument when creating a module (the CriWare.CriAtomExAsrRack::CriAtomExAsrRack function).
Note:
Please change the default configuration obtained from CriWare.CriAtomExAsrRack::defaultConfig when needed.
See also
CriAtomExAsrRack::CriAtomExAsrRack, CriAtomExAsrRack::defaultConfig

Member Function Documentation

static Config Default ( )
inlinestatic

Get the configuration structure with default values

Returns
Configuration structure with default values
Description:
Get the default configuration structure to initialize CriWare.CriAtomExAsrRack.CriAtomExAsrRack .

Member Data Documentation

float serverFrequency

Frequency of server process

Description:
Specifies the frequency of running the server process
Note:
Set the same value as the one set to CriAtomConfig::serverFrequency for CriWareInitializer.
int numBuses

The number of buses

Description:
Specifies the number of buses that ASR creates.
The bus is responsible for mixing sounds and managing the DSPeffects.
int outputChannels

The number of output channels

Description:
Specifies the number of output channels of the ASR Rack.
Specify 6ch or more channels when using pan 3D or 3D Positioning features.
CriAtom.SpeakerMapping speakerMapping

Mixer speaker mapping

Description:
Specifies the speaker mapping for the ASR rack.
int outputSamplingRate

Output sampling rate

Description:
Specifies the output and processing sampling rate of the ASR Rack.
Normally, specify the sampling rate of the sound device on the target machine.
Note:
Lowering it lowers the processing load but lowers the sound quality.
CriAtomEx.SoundRendererType soundRendererType

Sound renderer type

Description:
Specifies the type of the output destination sound renderer of the ASR Rack.
If you specify CriAtomEx.SoundRendererType.Native for soundRendererType, the sound data is transferred to each platform's default output.
int outputRackId

Destination ASR Rack ID

Description:
Specifies the ASR Rack ID of the ASR Rack's output destination.
Valid only when you specify CriAtomEx.SoundRendererType.Asr for soundRendererType.
IntPtr context

Pointer to platform-specific parameters

Description:
Specifies a pointer to platform-specific parameters.
When using it as the argument to the CriAtomExAsrRack::CriAtomExAsrRack function, specify IntPtr.Zero because it is overwritten by the second argument PlatformContext.

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