CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomEx Class Reference

Global class of the Atom library. More...

Classes

struct  AisacControlInfo
 A structure for getting the AISAC control information More...
 
struct  AisacInfo
 A structure for getting the AISAC information More...
 
struct  CueInfo
 Cue information More...
 
struct  CueLinkInfo
 Information about the Cue Link callback More...
 
struct  CuePos3dInfo
 The 3D information of the Cue More...
 
struct  FormatInfo
 Audio data format information More...
 
struct  GameVariableInfo
 Structure for acquiring game variable information More...
 
struct  NativeVector
 3D vector structure More...
 
struct  PerformanceInfo
 Performance information More...
 
struct  Randomize3dConfig
 Config structure used to randomize the positions of the 3D sound sources. More...
 
struct  ResourceUsage
 Usage of various resources More...
 
struct  SpeakerAngles6ch
 Output speaker angle (5.1ch) More...
 
struct  SpeakerAngles8ch
 Output speaker angle (7.1ch) More...
 
struct  WaveformInfo
 Sound waveform information More...
 

Public Types

enum  CharacterEncoding : int { Utf8, Sjis }
 Character code More...
 
enum  SoundRendererType {
  Default = 0, Native = 1, Asr = 2 , Spatial = 4,
  Hw1 = (0 << 16) | Native, Hw2 = (1 << 16) | Native, Hw3 = (2 << 16) | Native, Hw4 = (3 << 16) | Native,
  Haptic = (0 << 16) | Extended, Pseudo = (1 << 16) | Extended, SpatialChannels = (0 << 16) | Spatial, Ambisonics = (1 << 16) | Spatial,
  Passtrough = (2 << 16) | Spatial, Object = (3 << 16) | Spatial
}
 Sound renderer type More...
 
enum  VoiceAllocationMethod { Once, Retry }
 Voice allocation method More...
 
enum  BiquadFilterType {
  Off, LowPass, HighPass, Notch,
  LowShelf, HighShelf, Peaking
}
 Biquad Filter type More...
 
enum  ResumeMode { AllPlayback = 0, PausedPlayback = 1, PreparedPlayback = 2 }
 Unpausing method More...
 
enum  PanType { Unknown = -1, Pan3d = 0, Pos3d, Auto }
 Panning type More...
 
enum  VoiceControlMethod { PreferLast = 0, PreferFirst }
 Voice control method More...
 
enum  Parameter {
  Volume = 0, Pitch = 1, Pan3dAngle = 2, Pan3dDistance = 3,
  Pan3dVolume = 4, BusSendLevel0 = 9, BusSendLevel1 = 10, BusSendLevel2 = 11,
  BusSendLevel3 = 12, BusSendLevel4 = 13, BusSendLevel5 = 14, BusSendLevel6 = 15,
  BusSendLevel7 = 16, BandPassFilterCofLow = 17, BandPassFilterCofHigh = 18, BiquadFilterType = 19,
  BiquadFilterFreq = 20, BiquadFIlterQ = 21, BiquadFilterGain = 22, EnvelopeAttackTime = 23,
  EnvelopeHoldTime = 24, EnvelopeDecayTime = 25, EnvelopeReleaseTime = 26, EnvelopeSustainLevel = 27,
  StartTime = 28, Priority = 31
}
 Parameter ID More...
 
enum  Speaker {
  FrontLeft = 0, FrontRight = 1, FrontCenter = 2, LowFrequency = 3,
  SurroundLeft = 4, SurroundRight = 5, SurroundBackLeft = 6, SurroundBackRight = 7
}
 Speaker ID More...
 
enum  Format : uint {
  ADX = 0x00000001, HCA = 0x00000003, HCA_MX = 0x00000004, WAVE = 0x00000005,
  RAW_PCM = 0x00000006, AUDIO_BUFFER = 0x00000009
}
 Format type More...
 
enum  CurveType : int {
  Linear = 0, Square = 1, SquareReverse = 2, SCurve = 3,
  FlatAtHalf = 4
}
 Curve type More...
 
enum  Randomize3dCalcType : int {
  None = -1, Rectangle = 0, Cuboid = 1, Circle = 2,
  Cylinder = 3, Sphere = 4, List = 6
}
 Gets the method used to calculate the random coordinates of a 3D sound source More...
 
enum  Randomize3dParamType {
  None, Width, Depth, Height,
  Radius
}
 Definition of the parameters used to calculate coordinates for the randomization of the position of 3D sound sources More...
 
enum  CueType {
  Polyphonic, Sequential, Shuffle, Random,
  RandomNoRepeat, SwitchGameVariable, ComboSequential, SwitchSelector
}
 Cue type More...
 
enum  SilentMode : System.Int32 { Normal = 0, Stop = 1, Virtual = 2, VirtualRetrigger = 3 }
 Processing mode during silence More...
 

Public Member Functions

delegate void CueLinkCbFunc (ref CueLinkInfo info)
 Cue Link callback More...
 

Static Public Member Functions

static void SetSpeakerAngle (SpeakerAngles6ch speakerAngle)
 Speaker angle setting (5.1ch) More...
 
static void SetSpeakerAngle (SpeakerAngles8ch speakerAngle)
 Speaker angle setting (7.1ch) More...
 
static void SetVirtualSpeakerAngle (SpeakerAngles6ch speakerAngle)
 Virtual speaker angle setting (5.1ch) More...
 
static void SetVirtualSpeakerAngle (SpeakerAngles8ch speakerAngle)
 Virtual speaker angle setting (7.1ch) More...
 
static void ControlVirtualSpeakerSetting (bool sw)
 Virtual speaker setting ON / OFF More...
 
static bool RegisterAcf (CriFsBinder binder, string acfPath)
 Registers the ACF file More...
 
static bool RegisterAcf (IntPtr acfData, int dataSize)
 Registers the ACF data More...
 
static bool RegisterAcf (byte[] acfData)
 
static void UnregisterAcf ()
 Unregisters the ACF file More...
 
static string GetAppliedDspBusSnapshotName ()
 Gets the snapshot's name More...
 
static void AttachDspBusSetting (string settingName)
 Attaching the DSP bus settings More...
 
static void DetachDspBusSetting ()
 Detaches the DSP bus settings More...
 
static void ApplyDspBusSnapshot (string snapshot_name, int time_ms)
 Applies the DSP bus snapshot More...
 
static int GetNumGameVariables ()
 Gets the total number of game variables More...
 
static bool GetGameVariableInfo (ushort index, out GameVariableInfo info)
 Gets game variable information (index specified) More...
 
static float GetGameVariable (uint game_variable_id)
 Gets game variables More...
 
static float GetGameVariable (string game_variable_name)
 Gets game variables More...
 
static void SetGameVariable (uint game_variable_id, float game_variable_value)
 Sets game variables More...
 
static void SetGameVariable (string game_variable_name, float game_variable_value)
 Sets game variables More...
 
static void SetRandomSeed (uint seed)
 Sets the random number seed More...
 
static void ResetPerformanceMonitor ()
 Resets the performance monitor More...
 
static void GetPerformanceInfo (out PerformanceInfo info)
 Gets the performance information More...
 
static void SetGlobalLabelToSelectorByIndex (ushort selector_index, ushort label_index)
 Sets the global reference label for a selector More...
 
static void SetGlobalLabelToSelectorByName (string selector_name, string label_name)
 Sets the global reference label for a selector More...
 
static void PauseTimer (bool sw)
 Pause the timer More...
 
static void Lock ()
 Prevents interruption to the server process More...
 
static void Unlock ()
 Allow interruption to the server process More...
 
static void SetOutputAudioDevice_PC (string deviceId)
 [PC] Output device setting(by device ID) More...
 
static bool LoadAudioDeviceList_PC ()
 [PC] Initializing the list of output devices More...
 
static int GetNumAudioDevices_PC ()
 [PC] Getting the number of the output devices More...
 
static string GetAudioDeviceName_PC (int index)
 [PC] Getting the output device's name(by index) More...
 
static void SetOutputAudioDevice_PC (int index)
 [PC] Output device setting(by index) More...
 
static bool IsSoundStopped_IOS ()
 [iOS] Confirms stoppage of sound output More...
 
static void EnableAudioSessionRestoration_IOS (bool flag)
 [iOS] Enables AudioSession Restoration More...
 
static void EnableBusSendOffsetWhenLevelNotExist (bool enable)
 Enable offset value when no send level value is set More...
 

Public Attributes

const AisacControlId InvalidAisacControlId = 0xffffffffu
 Invalid value of the AISAC control ID
 

Properties

static CueLinkCbFunc OnCueLinkCallback
 Registering Cue Link callbacks More...
 

Detailed Description

Global class of the Atom library.

Description:
A class that contains setting functions for the Atom library and variable types shared in the Atom library.

Member Enumeration Documentation

enum CharacterEncoding : int
strong

Character code

Description:
Indicates the character code (character encoding method).
Enumerator
Utf8 

UTF-8

Sjis 

Shift_JIS

enum SoundRendererType
strong

Sound renderer type

Description:
Indicates the type of sound renderer created internally by CriWare.CriAtomExPlayer.
Enumerator
Default 

No restriction for output

Native 

Output to platform library

Asr 

Output to Atom Sound Renderer

Spatial 

Spatial audio output

Hw1 

Platform-specific definition 1

Hw2 

Platform-specific definition 2

Hw3 

Platform-specific definition 3

Hw4 

Platform-specific definition 4

Haptic 

Vibration

Pseudo 

Silent

SpatialChannels 

Channel Based Audio

Ambisonics 

Ambisonics

Passtrough 

Non-Spatial

Object 

Object Based Audio

enum VoiceAllocationMethod
strong

Voice allocation method

Description:
Data type used to specify the behavior of CriWare.CriAtomExPlayer when it allocates voices.
See also
CriAtomExPlayer::CriAtomExPlayer
Enumerator
Once 

Allocate a Voice only once

Retry 

Allocate a Voice repeatedly

enum BiquadFilterType
strong

Biquad Filter type

Description:
A data type that specifies the type of Biquad Filter.
Used in the CriWare.CriAtomExPlayer::SetBiquadFilterParameters .
See also
CriAtomExPlayer::SetBiquadFilterParameters
Enumerator
Off 

Filter disabled

LowPass 

Low pass filter

HighPass 

High pass filter

Notch 

Notch filter

LowShelf 

Low shelf filter

HighShelf 

High shelf filter

Peaking 

Peaking filter

enum ResumeMode
strong

Unpausing method

Description:
A data type for specifying the target to unpause.
Used as an argument to the CriWare.CriAtomExPlayer::Resume and CriWare.CriAtomExPlayback::Resume functions.
See also
CriAtomExPlayer::Resume, CriAtomExPlayback::Resume
Enumerator
AllPlayback 

Resumes playback regardless of how it was paused

PausedPlayback 

Resumes playback only for the sound paused by the Pause function

PreparedPlayback 

Starts playback of the sound prepared for playback using the Prepare function

enum PanType
strong

Panning type

Description:
A data type for specifying how to perform the localization calculation.
Used in the CriWare.CriAtomExPlayer::SetPanType .
See also
CriAtomExPlayer::SetPanType
Enumerator
Unknown 

Unknown panning type

Pan3d 

Calculates the localization using Panning 3D

Pos3d 

Calculates the localization with the 3D Positioning

Auto 

Calculates the localization based on the 3D Positioning when the 3D sound source/3D lister is set to the AtomExPlayer, or on the pan 3D if not set.

enum VoiceControlMethod
strong

Voice control method

Description:
A data type used to specify the Voice control method for the sound played by the AtomExPlayer.
Used in the CriWare.CriAtomExPlayer::SetVoiceControlMethod .
See also
CriAtomExPlayer::SetVoiceControlMethod
Enumerator
PreferLast 

Last-note priority

PreferFirst 

First-note priority

enum Parameter
strong

Parameter ID

Description:
The ID for specifying the parameter.
Used in functions such as CriWare.CriAtomExPlayer::GetParameterFloat32 .
See also
CriAtomExPlayer::GetParameterFloat32, CriAtomExPlayer::GetParameterSint32, CriAtomExPlayer::GetParameterUint32
Enumerator
Volume 

Volume

Pitch 

Pitch

Pan3dAngle 

Panning 3D angle

Pan3dDistance 

Panning 3D distance

Pan3dVolume 

Panning 3D volume

BusSendLevel0 

Bus Send Level 0

BusSendLevel1 

Bus Send Level 1

BusSendLevel2 

Bus Send Level 2

BusSendLevel3 

Bus Send Level 3

BusSendLevel4 

Bus Send Level 4

BusSendLevel5 

Bus Send Level 5

BusSendLevel6 

Bus Send Level 6

BusSendLevel7 

Bus Send Level 7

BandPassFilterCofLow 

Low cutoff frequency of the BandPass Filter

BandPassFilterCofHigh 

High cutoff frequency of the BandPass Filter

BiquadFilterType 

Filter type of the Biquad Filter

BiquadFilterFreq 

Biquad Filter frequency

BiquadFIlterQ 

Q value of the Biquad Filter

BiquadFilterGain 

Biquad Filter gain

EnvelopeAttackTime 

Envelope Attack Time

EnvelopeHoldTime 

Envelope hold time

EnvelopeDecayTime 

Envelope Decay Time

EnvelopeReleaseTime 

Envelope release time

EnvelopeSustainLevel 

Envelope sustain level

StartTime 

Playback start position

Priority 

Voice Priority

enum Speaker
strong

Speaker ID

Description:
An ID for specifying the speaker that outputs sound.
Used in the CriWare.CriAtomExPlayer::SetSendLevel .
See also
CriAtomExPlayer::SetSendLevel
Enumerator
FrontLeft 

Front left speaker

FrontRight 

Front right speaker

FrontCenter 

Front center speaker

LowFrequency 

LFE (≒ subwoofer)

SurroundLeft 

Surround left speaker

SurroundRight 

Surround right speaker

SurroundBackLeft 

Surround back left speaker

SurroundBackRight 

Surround back right speaker

enum Format : uint
strong

Format type

Description:
A data type used to specify the sound format to be played by the AtomExPlayer.
Used in the CriWare.CriAtomExPlayer::SetFormat .
See also
CriAtomExPlayer::SetFormat
Enumerator
ADX 

ADX

HCA 

HCA

HCA_MX 

HCA-MX

WAVE 

Wave

RAW_PCM 

RawPCM

AUDIO_BUFFER 

Audio Buffer

enum CurveType : int
strong

Curve type

Description:
This curve type is used as an envelope curve or a ducking curve for REACT.
See also
CriAtomExPlayer::SetEnvelopeAttackCurve, CriAtomExPlayer::SetEnvelopeDecayCurve, CriAtomExPlayer::SetEnvelopeReleaseCurve, CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter
Enumerator
Linear 

straight line

Square 

Slow transition

SquareReverse 

high speed change

SCurve 

S curve

FlatAtHalf 

Inverted S curve

enum Randomize3dCalcType : int
strong

Gets the method used to calculate the random coordinates of a 3D sound source

Description:
This is the definition of the method used to calculate the random coordinates of a 3D sound source.
See also
CriAtomEx::Randomize3dConfig
Enumerator
None 

No settings

Rectangle 

Rectangle

Cuboid 

Cuboid

Circle 

Circle

Cylinder 

Cylinder

Sphere 

Sphere

List 

List of coordinates

enum Randomize3dParamType
strong

Definition of the parameters used to calculate coordinates for the randomization of the position of 3D sound sources

Description:
Definition of the parameters that determine the calculation of a random position (i.e., shape indicating the coordinates space).
See also
CriAtomEx::randomize3dParamTable, CriAtomEx::Randomize3dConfig::GetParamByType, CriAtomEx::Randomize3dConfig::SetParamByType
Enumerator
None 

Unused

Width 

Width

Depth 

Depth

Height 

Height

Radius 

Radius

enum CueType
strong

Cue type

See also
CriAtomEx::CueInfo
Enumerator
Polyphonic 

Polyphonic

Sequential 

Sequential

Shuffle 

Shuffle playback

Random 

Random

RandomNoRepeat 

Random discontinued (randomly play sounds other than the one played previously)

SwitchGameVariable 

Switch playback (switches tracks to be played by referencing the game variable)

ComboSequential 

Combo Sequential (Sequential when consecutive combo is successful within the "combo time", and returns to "combo loopback" point when the end is reached)

SwitchSelector 

Selector

enum SilentMode : System.Int32
strong

Processing mode during silence

Description:
This data type is used to specify the processing mode when silent.
Whether it is silent is determined by any of the following values becoming 0:
  • Volume
  • Volume as the result of 3D panning calculations
  • Volume as the result of 3D positioning calculations
Note:
Note that the values of the Send Level and 2D Pan are not considered when determining if there is silence.
Enumerator
Normal 

Remains unchanged

Description:
No other processing is performed when it is silent. (Default value)
Stop 

Stop

Description:
When audio is muted (silent), it will automatically stop.
Virtual 

Virtualize

Description:
When audio is muted (silent), virtualization is automatically performed.
VirtualRetrigger 

Virtualized as retriggering type

Description:
When audio is muted (silent), it is automatically replayed and virtualized.

Member Function Documentation

static void SetSpeakerAngle ( SpeakerAngles6ch  speakerAngle)
inlinestatic

Speaker angle setting (5.1ch)

Parameters
speakerAngleOutput speaker angle
Description:
Sets the angle (arrangement) of the output speakers used when calculating Pan 3D or 3D Positioning.
Set the angle between -180 degrees and 180 degrees with the forward direction as 0 degrees.

frontLeftとfrontRightの位置を入れ替えるような設定をした場合、意図しない挙動になる可能性があります。

Note:
Changing the lowFrequency angle does not change the Pan3D or 3D Positioning calculation results.
The angle is set independently for each speaker system.
static void SetSpeakerAngle ( SpeakerAngles8ch  speakerAngle)
inlinestatic

Speaker angle setting (7.1ch)

Parameters
speakerAngleOutput speaker angle
Description:
Sets the angle (arrangement) of the output speakers used when calculating Pan 3D or 3D Positioning.
Set the angle between -180 degrees and 180 degrees with the forward direction as 0 degrees.

frontLeftとfrontRightの位置を入れ替えるような設定をした場合、意図しない挙動になる可能性があります。

Note:
Changing the lowFrequency angle does not change the Pan3D or 3D Positioning calculation results.
The angle is set independently for each speaker system.
static void SetVirtualSpeakerAngle ( SpeakerAngles6ch  speakerAngle)
inlinestatic

Virtual speaker angle setting (5.1ch)

Parameters
speakerAngleOutput speaker angle
Description:
Sets the angle (arrangement) of the output speakers used
when calculating Pan3D or 3D Positioning for virtual speakers.
Note:
The setting in this function will not be applied to the Pan3D or 3D Positioning calculations
unless the virtual speaker setting is enabled
by calling the CriWare.CriAtomEx::ControlVirtualSpeakerSetting function.
static void SetVirtualSpeakerAngle ( SpeakerAngles8ch  speakerAngle)
inlinestatic

Virtual speaker angle setting (7.1ch)

Parameters
speakerAngleOutput speaker angle
Description:
Sets the angle (arrangement) of the output speakers used
when calculating Pan3D or 3D Positioning for virtual speakers.
Note:
The setting in this function will not be applied to the Pan3D or 3D Positioning calculations
unless the virtual speaker setting is enabled
by calling the CriWare.CriAtomEx::ControlVirtualSpeakerSetting function.
static void ControlVirtualSpeakerSetting ( bool  sw)
inlinestatic

Virtual speaker setting ON / OFF

Parameters
swSwitch (False = disable, True = enable)
Description:
Turn On/Off the function that uses the virtual speaker settings when calculating Pan3D or 3D Positioning.
When enabled, multi-channel sounds will be played from the virtual speaker angles
set by the CriWare.CriAtomEx::SetVirtualSpeakerAngle function.
Note:
The default state is "disabled".
Also, if any voice is set to "enabled" during playback, the change will not be immediately reflected in the Pan3D or 3D Positioning calculations. The change will be applied from the playback of the next Voice.
delegate void CueLinkCbFunc ( ref CueLinkInfo  info)

Cue Link callback

Parameters
infoInformation about the Cue Link callback
Description:
This is the delegate type for Cue Link callbacks.
See also
CriAtomEx::OnCueLinkCallback
static bool RegisterAcf ( CriFsBinder  binder,
string  acfPath 
)
inlinestatic

Registers the ACF file

Parameters
binderBinder
acfPathFile path of the ACF file
Description:
Loads the ACF file and incorporates it into the library.
See also
CriAtomEx::UnregisterAcf
static bool RegisterAcf ( IntPtr  acfData,
int  dataSize 
)
inlinestatic

Registers the ACF data

Parameters
acfDataACF data
dataSizeACF data size
Description:
Loads the ACF data placed on the memory and captures it to the library.
Note:
The buffer address of the data to be passed as an argument should be fixed beforehand by the application so that it is not moved to the garbage collector.
Also, release the memory lock after unregistering the ACF file or after finalizing the library.
See also
CriAtomEx::UnregisterAcf
static bool RegisterAcf ( byte[]  acfData)
inlinestatic
Deprecated:
This is a deprecated API that will be removed. Please consider using CriWare.CriAtomEx.RegisterAcf(IntPtr, int) instead.
static void UnregisterAcf ( )
inlinestatic

Unregisters the ACF file

Description:
Unregisters the ACF file.
See also
CriAtomEx::RegisterAcf
static string GetAppliedDspBusSnapshotName ( )
inlinestatic

Gets the snapshot's name

Description:
Gets the current snapshot name. Returns null if none was set.
static void AttachDspBusSetting ( string  settingName)
inlinestatic

Attaching the DSP bus settings

Parameters
settingNameName of the DSP bus setting
Description:
Builds a DSP bus from the DSP bus settings and attaches it to the sound renderer.
Before calling this function, you must register the ACF information using the CriAtomEx::RegisterAcf function
// ACFファイルの読み込みと登録
CriAtomEx.RegisterAcf("Sample.acf");
// DSPバス設定の適用
CriAtomEx.AttachDspBusSetting("DspBusSetting_0");
Note:
This function is a return-on-complete function.
Calling this function blocks the server processing of the Atom library for a while.
If this function is called during sound playback, problems such as sound interruption may occur, so call this function at a timing when load fluctuations is accepted such as when switching scenes.
See also
CriAtomEx::DetachDspBusSetting, CriAtomEx::RegisterAcf
static void DetachDspBusSetting ( )
inlinestatic

Detaches the DSP bus settings

Description:
Detaches the DSP bus settings.
Note:
This function is a return-on-complete function.
Calling this function blocks the server processing of the Atom library for a while.
If this function is called during sound playback, problems such as sound interruption may occur, so call this function at a timing when load fluctuations is accepted such as when switching scenes.
See also
CriAtomEx::AttachDspBusSetting
static void ApplyDspBusSnapshot ( string  snapshot_name,
int  time_ms 
)
inlinestatic

Applies the DSP bus snapshot

Parameters
snapshot_nameDSP bus snapshot name
time_msThe time (in milliseconds) until the snapshot is fully reflected
Description:
Applies a DSP bus snapshot.
Calling this function changes the snapshot parameters. It takes time_ms milliseconds for the change to complete.
static int GetNumGameVariables ( )
inlinestatic

Gets the total number of game variables

Returns
The total number of game variables
Description:
Gets the total number of game variables registered in the ACF file.
Note:
It is necessary to register the ACF file before calling this function.
If the ACF file is not registered, -1 is returned.
static bool GetGameVariableInfo ( ushort  index,
out GameVariableInfo  info 
)
inlinestatic

Gets game variable information (index specified)

Parameters
indexGame variable index
infoGame variable information
Returns
Whether the information could be obtained
Description:
Gets the game variable information from the game variable index.
Returns False if there is no game variable with the specified index.
Note:
It is necessary to register the ACF file before calling this function.
static float GetGameVariable ( uint  game_variable_id)
inlinestatic

Gets game variables

Parameters
game_variable_idGame variable ID
Returns
Game variable value
Description:
Gets the value of the game variable registered in the ACF file.
Note:
It is necessary to register the ACF file before calling this function.
static float GetGameVariable ( string  game_variable_name)
inlinestatic

Gets game variables

Parameters
game_variable_nameGame variable name
Returns
Game variable value
Description:
Gets the value of the game variable registered in the ACF file.
Note:
It is necessary to register the ACF file before calling this function.
static void SetGameVariable ( uint  game_variable_id,
float  game_variable_value 
)
inlinestatic

Sets game variables

Parameters
game_variable_idGame variable ID
game_variable_valueGame variable value
Description:
Sets the value to the game variable registered in the ACF file.
Acceptable values are between 0.0f and 1.0f.
Note:
It is necessary to register the ACF file before calling this function.
static void SetGameVariable ( string  game_variable_name,
float  game_variable_value 
)
inlinestatic

Sets game variables

Parameters
game_variable_nameGame variable name
game_variable_valueGame variable value
Description:
Sets the value to the game variable registered in the ACF file.
Acceptable values are between 0.0f and 1.0f.
Note:
It is necessary to register the ACF file before calling this function.
static void SetRandomSeed ( uint  seed)
inlinestatic

Sets the random number seed

Parameters
seedRandom number seed
Description:
Sets the random number seed in the pseudo random number generator shared in entire CRI Atom library.
By setting the random number seed, it is possible to add reproducibility to various random playback processes.
If you want reproducibility in each AtomExPlayer, use the CriWare.CriAtomExPlayer::SetRandomSeed function.
If you do not need reproducibility and want to change the random number seed for each execution, use the CriWare.CriAtomConfig::useRandomSeedWithTime property instead of this function.
Note:
This function must be called before generating CriWare.CriAtomSource or CriWare.CriAtomExPlayer . Those created before setting the random number seed are not affected.
See also
CriWare.CriAtomExPlayer::SetRandomSeed
static void ResetPerformanceMonitor ( )
inlinestatic

Resets the performance monitor

Description:
Discards the measurement results up to now.
The performance monitor starts collecting performance information immediately after initializing the library and accumulates the measurement results.
If you do not want to include the previous measurement result in the future measurement, you need to call this function to discard the accumulated measurement.
See also
CriAtomEx::GetPerformanceInfo
static void GetPerformanceInfo ( out PerformanceInfo  info)
inlinestatic

Gets the performance information

Description:
Gets the performance information.
See also
CriAtomEx::PerformanceInfo, CriAtomEx::ResetPerformanceMonitor
static void SetGlobalLabelToSelectorByIndex ( ushort  selector_index,
ushort  label_index 
)
inlinestatic

Sets the global reference label for a selector

Parameters
selector_indexSelector index
label_indexLabel index
Description:
Set the globally referenced label for the selector registered in the ACF file.
Note:
It is necessary to register the ACF file before calling this function.
See also
CriAtomEx::SetGlobalLabelToSelectorByName
static void SetGlobalLabelToSelectorByName ( string  selector_name,
string  label_name 
)
inlinestatic

Sets the global reference label for a selector

Parameters
selector_nameSelector name
label_nameLabel name
Description:
Set the globally referenced label for the selector registered in the ACF file.
Note:
It is necessary to register the ACF file before calling this function.
See also
CriAtomEx::SetGlobalLabelToSelectorByIndex
static void PauseTimer ( bool  sw)
inlinestatic

Pause the timer

Parameters
swTrue: Pause the timer, False: Resume the timer
Description:
Pause/resume the master timer in the Atom library.
Pausing the main timer will stop the sequence time from progressing.
Note:
This function is used on platforms where applications can be suspended and resumed
to continue to use the timer function.
Before the application transitions to a dormant or suspended state,
you can stop the progress of the paused sequence by temporarily stopping the master timer.
Note:
Note that only the master timer in the Atom library is paused by this function.
To pause the audio, call CriAtomExAsr.PauseOutputVoice instead.
static void Lock ( )
inlinestatic

Prevents interruption to the server process

Description:
Prevents the lock of interruption to server processing.
The interruption to the server processing is prevented after this function is called until the CriWare.CriAtomEx::Unlock function is called.
If you want to reliably call multiple APIs in the same audio frame, use this function to prevent interruption to the server processing and then call those functions.
See also
CriAtomEx::Unlock
static void Unlock ( )
inlinestatic

Allow interruption to the server process

Description:
Do not prevent the interruption of the server processing (disable the effect of the CriWare.CriAtomEx::Lock function).
See also
CriAtomEx::Lock
static void SetOutputAudioDevice_PC ( string  deviceId)
inlinestatic

[PC] Output device setting(by device ID)

Parameters
deviceIdDevice ID
Description:
Sets the ID of the device to be used as Atom's audio output destination.
static bool LoadAudioDeviceList_PC ( )
inlinestatic

[PC] Initializing the list of output devices

Description:
Initializes the list of devices which can be used as Atom's audio output destination.
After calling this function, the number of devices can be obtained from CriAtomEx::GetNumAudioDevices_PC, and the names of the devices from CriAtomEx::GetAudioDeviceName_PC.
See also
CriAtomEx::GetNumAudioDevices_PC, CriAtomEx::GetAudioDeviceName_PC
static int GetNumAudioDevices_PC ( )
inlinestatic

[PC] Getting the number of the output devices

Returns
Amount of output devices
Description:
Gets the number of devices that can be selected as the audio output destination from Atom.
Please call this function after using CriAtomEx::LoadAudioDeviceList_PC function to initialize the device list inside the plugin. The maximum return value is 32.
See also
CriAtomEx::LoadAudioDeviceList_PC
static string GetAudioDeviceName_PC ( int  index)
inlinestatic

[PC] Getting the output device's name(by index)

Parameters
indexDevice index
Returns
Output device's name
Description:
Gets the names of devices that can be selected as the audio output destination from Atom.
Please call this function after using CriAtomEx::LoadAudioDeviceList_PC function to initialize the device list inside the plugin.
See also
CriAtomEx::LoadAudioDeviceList_PC
static void SetOutputAudioDevice_PC ( int  index)
inlinestatic

[PC] Output device setting(by index)

Parameters
indexDevice index
Description:
Sets the device to be used as Atom's audio output destination.
Please call this function after using CriAtomEx::LoadAudioDeviceList_PC function to initialize the device list inside the plugin.
See also
CriAtomEx::LoadAudioDeviceList_PC
static bool IsSoundStopped_IOS ( )
inlinestatic

[iOS] Confirms stoppage of sound output

Description:
Checks if the sound output is stopped.
If True, the sound output is stopped.
If this function returns True even if the application is not paused, the sound output is blocked by a system interrupt etc. that is not detected by the application.
For synchronizing the application with the sound, check the sound output status using this function, and add pausing if necessary.
Note:
This function is an API dedicated iOS.
static void EnableAudioSessionRestoration_IOS ( bool  flag)
inlinestatic

[iOS] Enables AudioSession Restoration

Parameters
flagWhether to enable the restoration process
Description:
Sets whether to automatically restore the audio after interruptions by other applications or the OS.
When the audio output is performed exclusively (i.e. CriAtomConfig.iosOverrideIPodMusic is true), this setting will determine whether to resume the audio after interruptions from other applications.
It is enabled by default, which means audio will immediately resume after an interruption.
You can set the argument to false and call this function when you want to temporarily disable the audio restoration, when dealing with one of these situations:
  • When you want to support voice input when the user enters information
  • When you want to temporarily use a module that offers audio playback, other than CRIWARE (example: video playback by WebView)
    Make sure to call this function again with "true" for the argument once you are done, in order to avoid that the audio of the application does not resume.
Note:
This function is an API dedicated iOS.
static void EnableBusSendOffsetWhenLevelNotExist ( bool  enable)
inlinestatic

Enable offset value when no send level value is set

Parameters
enableEnable flag
Description:
CriWare.CriAtomExPlayer.SetBusSendLevelOffset Specifies whether the offset value is taken into account
even if no send level value was set on the data side.
The behavior is as follows:
  • true: use the offsets on all Buses
  • false: use the offsets only on Buses for which the Send destination was specified on the data side
    The default value is true.
    For audio that is already playing back, the offset is applied when the parameter update is processed.

Property Documentation

CueLinkCbFunc OnCueLinkCallback
staticaddremove

Registering Cue Link callbacks

Description:
Registers a callback function that receives Cue Link information when processing a Cue Link during the Cue's playback.
The registered callback function is executed when the application's main thread updates right after the callback event is processed.

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