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

Initialization configuration structure used when creating of Wave voice pool More...

Static Public Member Functions

static Config Default ()
 Default values of the configuration structure used to create a Wave Voice Pool
 

Public Attributes

uint identifier
 Voice Pool identifier More...
 
int numVoices
 Number of voices to pool More...
 
PlayerConfig playerConfig
 Voice Specifications More...
 
bool isStreamingOnly
 Whether it is limited to streaming playback More...
 
System.Int32 minChannels
 Minimum number of channels More...
 

Detailed Description

Initialization configuration structure used when creating of Wave voice pool

Member Data Documentation

uint identifier

Voice Pool identifier

Description:
A unique number that identifies the Voice Pool.
If an identifier is specified when creating a Voice Pool,
the Voice Pool will only be referenced by players which have the same identifier.
Note:
You can also specify the same Voice Pool identifier for different voice pools.
int numVoices

Number of voices to pool

PlayerConfig playerConfig

Voice Specifications

bool isStreamingOnly

Whether it is limited to streaming playback

System.Int32 minChannels

Minimum number of channels

Description:
The Voice Pool created can only be used to play back audio with a number of channels
between the minimum and the maximum values (PlayerConfig.maxChannels).

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