CRIWARE Unity Plugin Manual
Last Updated: 2024-07-12
|
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... | |
Global class of the Atom library.
|
strong |
|
strong |
Sound renderer type
|
strong |
Voice allocation method
Enumerator | |
---|---|
Once |
Allocate a Voice only once |
Retry |
Allocate a Voice repeatedly |
|
strong |
Biquad Filter type
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 |
|
strong |
Unpausing method
|
strong |
Panning type
|
strong |
Voice control method
Enumerator | |
---|---|
PreferLast |
Last-note priority |
PreferFirst |
First-note priority |
|
strong |
Parameter ID
|
strong |
Speaker ID
|
strong |
Format type
Enumerator | |
---|---|
ADX |
ADX |
HCA |
HCA |
HCA_MX |
HCA-MX |
WAVE |
Wave |
RAW_PCM |
RawPCM |
AUDIO_BUFFER |
Audio Buffer |
|
strong |
Curve type
Enumerator | |
---|---|
Linear |
straight line |
Square |
Slow transition |
SquareReverse |
high speed change |
SCurve |
S curve |
FlatAtHalf |
Inverted S curve |
|
strong |
Gets the method used to calculate the random coordinates of a 3D sound source
Enumerator | |
---|---|
None |
No settings |
Rectangle |
Rectangle |
Cuboid |
Cuboid |
Circle |
Circle |
Cylinder |
Cylinder |
Sphere |
Sphere |
List |
List of coordinates |
|
strong |
Definition of the parameters used to calculate coordinates for the randomization of the position of 3D sound sources
Enumerator | |
---|---|
None |
Unused |
Width |
Width |
Depth |
Depth |
Height |
Height |
Radius |
Radius |
|
strong |
Cue type
|
strong |
Processing mode during silence
|
inlinestatic |
Speaker angle setting (5.1ch)
speakerAngle | Output speaker angle |
frontLeftとfrontRightの位置を入れ替えるような設定をした場合、意図しない挙動になる可能性があります。
|
inlinestatic |
Speaker angle setting (7.1ch)
speakerAngle | Output speaker angle |
frontLeftとfrontRightの位置を入れ替えるような設定をした場合、意図しない挙動になる可能性があります。
|
inlinestatic |
Virtual speaker angle setting (5.1ch)
speakerAngle | Output speaker angle |
|
inlinestatic |
Virtual speaker angle setting (7.1ch)
speakerAngle | Output speaker angle |
|
inlinestatic |
Virtual speaker setting ON / OFF
sw | Switch (False = disable, True = enable) |
delegate void CueLinkCbFunc | ( | ref CueLinkInfo | info | ) |
Cue Link callback
info | Information about the Cue Link callback |
|
inlinestatic |
Registers the ACF file
binder | Binder |
acfPath | File path of the ACF file |
|
inlinestatic |
Registers the ACF data
acfData | ACF data |
dataSize | ACF data size |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
Gets the snapshot's name
|
inlinestatic |
Attaching the DSP bus settings
settingName | Name of the DSP bus setting |
|
inlinestatic |
Detaches the DSP bus settings
|
inlinestatic |
Applies the DSP bus snapshot
snapshot_name | DSP bus snapshot name |
time_ms | The time (in milliseconds) until the snapshot is fully reflected |
|
inlinestatic |
Gets the total number of game variables
|
inlinestatic |
Gets game variable information (index specified)
index | Game variable index |
info | Game variable information |
|
inlinestatic |
Gets game variables
game_variable_id | Game variable ID |
|
inlinestatic |
Gets game variables
game_variable_name | Game variable name |
|
inlinestatic |
Sets game variables
game_variable_id | Game variable ID |
game_variable_value | Game variable value |
|
inlinestatic |
Sets game variables
game_variable_name | Game variable name |
game_variable_value | Game variable value |
|
inlinestatic |
Sets the random number seed
seed | Random number seed |
|
inlinestatic |
Resets the performance monitor
|
inlinestatic |
Gets the performance information
|
inlinestatic |
Sets the global reference label for a selector
selector_index | Selector index |
label_index | Label index |
|
inlinestatic |
Sets the global reference label for a selector
selector_name | Selector name |
label_name | Label name |
|
inlinestatic |
Pause the timer
sw | True: Pause the timer, False: Resume the timer |
|
inlinestatic |
Prevents interruption to the server process
|
inlinestatic |
Allow interruption to the server process
|
inlinestatic |
[PC] Output device setting(by device ID)
deviceId | Device ID |
|
inlinestatic |
[PC] Initializing the list of output devices
|
inlinestatic |
[PC] Getting the number of the output devices
|
inlinestatic |
[PC] Getting the output device's name(by index)
index | Device index |
|
inlinestatic |
[PC] Output device setting(by index)
index | Device index |
|
inlinestatic |
[iOS] Confirms stoppage of sound output
|
inlinestatic |
[iOS] Enables AudioSession Restoration
flag | Whether to enable the restoration process |
|
inlinestatic |
Enable offset value when no send level value is set
enable | Enable flag |
|
staticaddremove |
Registering Cue Link callbacks