CriAtomConfig Class Reference

Parameters for initializing CRI Atom More...

Classes
class	AndroidLowLatencyStandardVoicePoolConfig
class	EditorPcmOutputConfig
class	HcaMxVoicePoolConfig
class	InGamePreviewConfig
class	StandardVoicePoolConfig

Public Types
enum	InGamePreviewSwitchMode { , Enable, FollowBuildSetting, Default }

Public Attributes
string	acfFileName = ""
	ACF file name More...
int	maxVirtualVoices = 32
int	maxVoiceLimitGroups = 32
int	maxCategories = 32
int	maxAisacs = 8
int	maxBusSends = 8
int	maxSequenceEventsPerFrame = 2
int	maxBeatSyncCallbacksPerFrame = 1
int	maxCueLinkCallbacksPerFrame = 1
StandardVoicePoolConfig	standardVoicePoolConfig = new StandardVoicePoolConfig()
HcaMxVoicePoolConfig	hcaMxVoicePoolConfig = new HcaMxVoicePoolConfig()
int	outputSamplingRate = 0
bool	usesInGamePreview = false
InGamePreviewSwitchMode	inGamePreviewMode = InGamePreviewSwitchMode.Default
InGamePreviewConfig	inGamePreviewConfig = new InGamePreviewConfig()
float	serverFrequency = 60.0f
CriAtom.SpeakerMapping	speakerMapping
int	asrOutputChannels = 0
bool	useRandomSeedWithTime = true
int	categoriesPerPlayback = 4
int	maxFaders = 4
int	maxBuses = 8
float	maxPitch = 2400f
int	maxParameterBlocks = 1024
CriAtomEx.SoundRendererType	soundRendererType = CriAtomEx.SoundRendererType.Native
bool	keepPlayingSoundOnPause = true
bool	enableSonicSync = true
bool	enableAtomSoundDisabledMode = false
bool	enableAtomSoundDisabledModeLinux = false
EditorPcmOutputConfig	editorPcmOutputConfig = new EditorPcmOutputConfig()
int	pcBufferingTime = 0
bool	useMicrosoftSpatialSound = true
bool	iosEnableSonicSync = true
int	iosBufferingTime = 50
bool	iosOverrideIPodMusic = false
bool	iosEnableOSNotificationHandling = true
bool	androidEnableSonicSync = true
int	androidBufferingTime = 133
int	androidStartBufferingTime = 100
AndroidLowLatencyStandardVoicePoolConfig	androidLowLatencyStandardVoicePoolConfig = new AndroidLowLatencyStandardVoicePoolConfig()
bool	androidUsesAndroidFastMixer = true
bool	androidForceToUseAsrForDefaultPlayback = true
bool	androidUsesAAudio = false
int	androidStreamType = 0

Detailed Description

Parameters for initializing CRI Atom

Member Enumeration Documentation

enum InGamePreviewSwitchMode

strong

In-Game Preview settings

Enumerator
Enable	Disabled
FollowBuildSetting	Enabled
Default	Available for Development Build only "usesInGamePreview"

Member Data Documentation

string acfFileName = ""

ACF file name

Note:

The ACF file need to be placed in the StreamingAssets folder.

int maxVirtualVoices = 32

Maximum number of virtual Voices

int maxVoiceLimitGroups = 32

Maximum number of Voice limit groups

int maxCategories = 32

Maximum number of categories

int maxAisacs = 8

Maximum number of AISACs

int maxBusSends = 8

Maximum number of bus sends

int maxSequenceEventsPerFrame = 2

Maximum number of sequence events in each frame

int maxBeatSyncCallbacksPerFrame = 1

Maximum number of beat-synchronization callbacks in each frame

int maxCueLinkCallbacksPerFrame = 1

Maximum number of Cue Link callbacks per frame

StandardVoicePoolConfig standardVoicePoolConfig = new StandardVoicePoolConfig()

Parameters for creating standard Voice Pool

HcaMxVoicePoolConfig hcaMxVoicePoolConfig = new HcaMxVoicePoolConfig()

HCA-MX Voice Pool creation parameters

int outputSamplingRate = 0

Output sampling rate

bool usesInGamePreview = false

Whether to use In-Game Preview

InGamePreviewSwitchMode inGamePreviewMode = InGamePreviewSwitchMode.Default

In-Game Preview settings (effective only when specified in inspector)

InGamePreviewConfig inGamePreviewConfig = new InGamePreviewConfig()

In-Game Preview parameters

float serverFrequency = 60.0f

Server frequency

CriAtom.SpeakerMapping speakerMapping

ASR speaker mapping

int asrOutputChannels = 0

The number of ASR output channels

bool useRandomSeedWithTime = true

Whether to use time(System.DateTime.Now.Ticks) as random seed

int categoriesPerPlayback = 4

Number of category references per playback

int maxFaders = 4

Maximum number of faders

int maxBuses = 8

Maximum number of buses

float maxPitch = 2400f

Maximum pitch change

int maxParameterBlocks = 1024

Maximum number of parameter blocks

CriAtomEx.SoundRendererType soundRendererType = CriAtomEx.SoundRendererType.Native

Whether to use VR sound output mode

bool keepPlayingSoundOnPause = true

Whether to pause the audio output when paused on a StandAlone platform or in the editor

bool enableSonicSync = true

Whether to Enable SonicSYNC (excluding Android, iOS and Switch)

bool enableAtomSoundDisabledMode = false

Whether the audio output will be disabled or not (except on Linux)

bool enableAtomSoundDisabledModeLinux = false

Whether the audio output will be disabled or not (on Linux)

EditorPcmOutputConfig editorPcmOutputConfig = new EditorPcmOutputConfig()

[Editor] Parameters related to the User PCM Output Mode

int pcBufferingTime = 0

[PC] Output buffering time

bool useMicrosoftSpatialSound = true

[PC] Microsoft Spatial Sound enable flag

bool iosEnableSonicSync = true

[iOS] Enables SonicSYNC mode

int iosBufferingTime = 50

[iOS] Output buffering time (milliseconds)

bool iosOverrideIPodMusic = false

[iOS] Whether to override iPod playback

bool iosEnableOSNotificationHandling = true

[iOS] Whether to suspend and resume the audio system in response to an audio interruption notification from the OS

bool androidEnableSonicSync = true

[Android] Enables SonicSYNC Mode

int androidBufferingTime = 133

[Android] ASR (normal playback) output buffering time

int androidStartBufferingTime = 100

[Android] NSR (Low Delay Playback) Playback Start Buffering Time

AndroidLowLatencyStandardVoicePoolConfig androidLowLatencyStandardVoicePoolConfig = new AndroidLowLatencyStandardVoicePoolConfig()

[Android] Parameters for creating low latency playback Voice Pool

bool androidUsesAndroidFastMixer = true

[Android] Whether to use the Fast Mixer of Android to reduce the output delay during audio playback. Affects the output delay of ASR/NSR and the result of delay estimation function

bool androidForceToUseAsrForDefaultPlayback = true

[Android] Force CriAtomSource to use ASR for playback when low lantency playback is enabled

bool androidUsesAAudio = false

[Android] Beta: Enable AAudio or not

int androidStreamType = 0

[Android] Stream type setting

---

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

• CriWareInitializer.cs