CRIWARE Unity Plugin Manual  Last Updated: 2024-04-24
クラス | 公開型 | 公開メンバ関数 | 静的公開メンバ関数 | 公開変数類 | プロパティ | 全メンバ一覧
CriAtomEx クラス
CRI Atom Native Wrapper

Atomライブラリのグローバルクラスです。 [詳解]

クラス

struct  AisacControlInfo
 AISACコントロール情報取得用構造体 [詳解]
 
struct  AisacInfo
 AISAC情報取得用構造体 [詳解]
 
struct  CueInfo
 キュー情報 [詳解]
 
struct  CueLinkInfo
 キューリンクコールバック情報 [詳解]
 
struct  CuePos3dInfo
 キュー3D情報 [詳解]
 
struct  FormatInfo
 音声データフォーマット情報 [詳解]
 
struct  GameVariableInfo
 ゲーム変数情報取得用構造体 [詳解]
 
struct  NativeVector
 3次元ベクター構造体 [詳解]
 
struct  PerformanceInfo
 パフォーマンス情報 [詳解]
 
struct  Randomize3dConfig
 3D音源の位置のランダム化に関するコンフィグ構造体 [詳解]
 
struct  ResourceUsage
 各種リソースの使用状況 [詳解]
 
struct  SpeakerAngles6ch
 出力スピーカーの角度(5.1ch) [詳解]
 
struct  SpeakerAngles8ch
 出力スピーカーの角度(7.1ch) [詳解]
 
struct  WaveformInfo
 音声波形情報 [詳解]
 

公開型

enum  CharacterEncoding : int { Utf8, Sjis }
 文字コード [詳解]
 
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
}
 サウンドレンダラタイプ [詳解]
 
enum  VoiceAllocationMethod { Once, Retry }
 ボイス確保方式 [詳解]
 
enum  BiquadFilterType {
  Off, LowPass, HighPass, Notch,
  LowShelf, HighShelf, Peaking
}
 バイクアッドフィルタのタイプ [詳解]
 
enum  ResumeMode { AllPlayback = 0, PausedPlayback = 1, PreparedPlayback = 2 }
 ポーズ解除方法 [詳解]
 
enum  PanType { Unknown = -1, Pan3d = 0, Pos3d, Auto }
 パンタイプ [詳解]
 
enum  VoiceControlMethod { PreferLast = 0, PreferFirst }
 ボイス制御方式 [詳解]
 
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
}
 パラメータID [詳解]
 
enum  Speaker {
  FrontLeft = 0, FrontRight = 1, FrontCenter = 2, LowFrequency = 3,
  SurroundLeft = 4, SurroundRight = 5, SurroundBackLeft = 6, SurroundBackRight = 7
}
 スピーカーID [詳解]
 
enum  Format : uint {
  ADX = 0x00000001, HCA = 0x00000003, HCA_MX = 0x00000004, WAVE = 0x00000005,
  RAW_PCM = 0x00000006, AUDIO_BUFFER = 0x00000009
}
 フォーマット種別 [詳解]
 
enum  CurveType : int {
  Linear = 0, Square = 1, SquareReverse = 2, SCurve = 3,
  FlatAtHalf = 4
}
 曲線タイプ [詳解]
 
enum  Randomize3dCalcType : int {
  None = -1, Rectangle = 0, Cuboid = 1, Circle = 2,
  Cylinder = 3, Sphere = 4, List = 6
}
 3D音源の位置のランダム化における位置座標の算出方法 [詳解]
 
enum  Randomize3dParamType {
  None, Width, Depth, Height,
  Radius
}
 3D音源位置ランダム化における位置座標の算出パラメータの内容定義 [詳解]
 
enum  CueType {
  Polyphonic, Sequential, Shuffle, Random,
  RandomNoRepeat, SwitchGameVariable, ComboSequential, SwitchSelector
}
 キュータイプ [詳解]
 
enum  SilentMode : System.Int32 { Normal = 0, Stop = 1, Virtual = 2, VirtualRetrigger = 3 }
 無音時処理モード [詳解]
 

公開メンバ関数

delegate void CueLinkCbFunc (ref CueLinkInfo info)
 キューリンクコールバック [詳解]
 

静的公開メンバ関数

static void SetSpeakerAngle (SpeakerAngles6ch speakerAngle)
 スピーカー角度の設定(5.1ch) [詳解]
 
static void SetSpeakerAngle (SpeakerAngles8ch speakerAngle)
 スピーカー角度の設定(7.1ch) [詳解]
 
static void SetVirtualSpeakerAngle (SpeakerAngles6ch speakerAngle)
 バーチャルスピーカー角度の設定(5.1ch) [詳解]
 
static void SetVirtualSpeakerAngle (SpeakerAngles8ch speakerAngle)
 バーチャルスピーカー角度の設定(7.1ch) [詳解]
 
static void ControlVirtualSpeakerSetting (bool sw)
 バーチャルスピーカー設定のON/OFF [詳解]
 
static bool RegisterAcf (CriFsBinder binder, string acfPath)
 ACFファイルの登録 [詳解]
 
static bool RegisterAcf (IntPtr acfData, int dataSize)
 ACFデータの登録 [詳解]
 
static bool RegisterAcf (byte[] acfData)
 
static void UnregisterAcf ()
 ACFファイルの登録解除 [詳解]
 
static string GetAppliedDspBusSnapshotName ()
 スナップショット名の取得 [詳解]
 
static void AttachDspBusSetting (string settingName)
 DSPバス設定のアタッチ [詳解]
 
static void DetachDspBusSetting ()
 DSPバス設定のデタッチ [詳解]
 
static void ApplyDspBusSnapshot (string snapshot_name, int time_ms)
 DSPバススナップショットの適用 [詳解]
 
static int GetNumGameVariables ()
 ゲーム変数の総数の取得 [詳解]
 
static bool GetGameVariableInfo (ushort index, out GameVariableInfo info)
 ゲーム変数情報の取得（インデックス指定） [詳解]
 
static float GetGameVariable (uint game_variable_id)
 ゲーム変数の取得 [詳解]
 
static float GetGameVariable (string game_variable_name)
 ゲーム変数の取得 [詳解]
 
static void SetGameVariable (uint game_variable_id, float game_variable_value)
 ゲーム変数の設定 [詳解]
 
static void SetGameVariable (string game_variable_name, float game_variable_value)
 ゲーム変数の設定 [詳解]
 
static void SetRandomSeed (uint seed)
 乱数種の設定 [詳解]
 
static void ResetPerformanceMonitor ()
 パフォーマンスモニタのリセット [詳解]
 
static void GetPerformanceInfo (out PerformanceInfo info)
 パフォーマンス情報の取得 [詳解]
 
static void SetGlobalLabelToSelectorByIndex (ushort selector_index, ushort label_index)
 セレクタに対するグローバル参照ラベルの設定 [詳解]
 
static void SetGlobalLabelToSelectorByName (string selector_name, string label_name)
 セレクタに対するグローバル参照ラベルの設定 [詳解]
 
static void PauseTimer (bool sw)
 タイマのポーズ [詳解]
 
static void Lock ()
 サーバ処理の割り込みの防止 [詳解]
 
static void Unlock ()
 サーバ処理の割り込み防止の解除 [詳解]
 
static void SetOutputAudioDevice_PC (string deviceId)
 [PC] 出力デバイスの設定(デバイスID指定) [詳解]
 
static bool LoadAudioDeviceList_PC ()
 [PC] 出力デバイスリストの初期化 [詳解]
 
static int GetNumAudioDevices_PC ()
 [PC] 出力デバイス数の取得 [詳解]
 
static string GetAudioDeviceName_PC (int index)
 [PC] 出力デバイス名の取得(インデクス指定) [詳解]
 
static void SetOutputAudioDevice_PC (int index)
 [PC] 出力デバイスの設定(インデクス指定) [詳解]
 
static bool IsSoundStopped_IOS ()
 [iOS] サウンド出力停止の確認 [詳解]
 
static void EnableAudioSessionRestoration_IOS (bool flag)
 [iOS] AudioSession 復帰処理の有効化 [詳解]
 
static void EnableBusSendOffsetWhenLevelNotExist (bool enable)
 センドレベル値が無い場合のオフセット値有効化 [詳解]
 

公開変数類

const AisacControlId InvalidAisacControlId = 0xffffffffu
 AISACコントロールIDの無効値
 

プロパティ

static CueLinkCbFunc OnCueLinkCallback
 キューリンクコールバックの登録 [詳解]
 

詳解

Atomライブラリのグローバルクラスです。

説明:
Atomライブラリに対する設定関数や、Atomライブラリ内で共有する変数型を含むクラスです。

列挙型メンバ詳解

enum CharacterEncoding : int
strong

文字コード

説明:
文字コード（文字符号化方式）を表します。
列挙値
Utf8 

UTF-8

Sjis 

Shift_JIS

enum SoundRendererType
strong

サウンドレンダラタイプ

説明:
CriWare.CriAtomExPlayer が内部で作成するサウンドレンダラの種別をを表します。
列挙値
Default 

出力方式を制限しない

Native 

プラットフォームライブラリへ出力

Asr 

Atom Sound Rendererへ出力

Spatial 

立体音響出力

Hw1 

機種固有定義1

Hw2 

機種固有定義2

Hw3 

機種固有定義3

Hw4 

機種固有定義4

Haptic 

振動

Pseudo 

無音

SpatialChannels 

Channel Based Audio

Ambisonics 

Ambisonics

Passtrough 

Non-Spatial

Object 

Object Based Audio

enum VoiceAllocationMethod
strong

ボイス確保方式

説明:
CriWare.CriAtomExPlayer がボイスを確保する際の動作仕様を指定するためのデータ型です。
参照
CriAtomExPlayer::CriAtomExPlayer
列挙値
Once 

ボイスの確保は1回限り

Retry 

ボイスを繰り返し確保する

enum BiquadFilterType
strong

バイクアッドフィルタのタイプ

説明:
バイクアッドフィルタのタイプを指定するためのデータ型です。
CriWare.CriAtomExPlayer::SetBiquadFilterParameters 関数で利用します。
参照
CriAtomExPlayer::SetBiquadFilterParameters
列挙値
Off 

フィルタ無効

LowPass 

ローパスフィルタ

HighPass 

ハイパスフィルタ

Notch 

ノッチフィルタ

LowShelf 

ローシェルフフィルタ

HighShelf 

ハイシェルフフィルタ

Peaking 

ピーキングフフィルタ

enum ResumeMode
strong

ポーズ解除方法

説明:
ポーズを解除する対象を指定するためのデータ型です。
CriWare.CriAtomExPlayer::Resume 関数、および CriWare.CriAtomExPlayback::Resume 関数の引数として使用します。
参照
CriAtomExPlayer::Resume, CriAtomExPlayback::Resume
列挙値
AllPlayback 

一時停止方法に関係なく再生を再開

PausedPlayback 

Pause関数でポーズをかけた音声のみ再生を再開

PreparedPlayback 

Prepare関数で再生準備を指示した音声の再生を開始

enum PanType
strong

パンタイプ

説明:
どのようにして定位計算を行うかを指定するためのデータ型です。
CriWare.CriAtomExPlayer::SetPanType 関数で利用します。
参照
CriAtomExPlayer::SetPanType
列挙値
Unknown 

パンタイプが判明していない状態

Pan3d 

パン3Dで定位を計算

Pos3d 

3Dポジショニングで定位を計算

Auto 

AtomExプレーヤに3D音源／3Dリスナーが設定されている場合は3Dポジショニングで、 設定されていない場合はパン3Dで、それぞれ定位を計算します。

enum VoiceControlMethod
strong

ボイス制御方式

説明:
AtomExプレーヤで再生する音声の発音制御方法を指定するためのデータ型です。
CriWare.CriAtomExPlayer::SetVoiceControlMethod 関数で利用します。
参照
CriAtomExPlayer::SetVoiceControlMethod
列挙値
PreferLast 

後着優先

PreferFirst 

先着優先

enum Parameter
strong

パラメータID

説明:
パラメータを指定するためのIDです。
CriWare.CriAtomExPlayer::GetParameterFloat32 関数等で利用します。
参照
CriAtomExPlayer::GetParameterFloat32, CriAtomExPlayer::GetParameterSint32, CriAtomExPlayer::GetParameterUint32
列挙値
Volume 

ボリューム

Pitch 

ピッチ

Pan3dAngle 

パンニング3D角度

Pan3dDistance 

パンニング3D距離

Pan3dVolume 

パンニング3Dボリューム

BusSendLevel0 

バスセンドレベル0

BusSendLevel1 

バスセンドレベル1

BusSendLevel2 

バスセンドレベル2

BusSendLevel3 

バスセンドレベル3

BusSendLevel4 

バスセンドレベル4

BusSendLevel5 

バスセンドレベル5

BusSendLevel6 

バスセンドレベル6

BusSendLevel7 

バスセンドレベル7

BandPassFilterCofLow 

バンドパスフィルタの低域カットオフ周波数

BandPassFilterCofHigh 

バンドパスフィルタの高域カットオフ周波数

BiquadFilterType 

バイクアッドフィルタのフィルタタイプ

BiquadFilterFreq 

バイクアッドフィルタの周波数

BiquadFIlterQ 

バイクアッドフィルタのQ値

BiquadFilterGain 

バイクアッドフィルタのゲイン

EnvelopeAttackTime 

エンベロープのアタックタイム

EnvelopeHoldTime 

エンベロープのホールドタイム

EnvelopeDecayTime 

エンベロープのディケイタイム

EnvelopeReleaseTime 

エンベロープのリリースタイム

EnvelopeSustainLevel 

エンベロープのサスティンレベル

StartTime 

再生開始位置

Priority 

ボイスプライオリティ

enum Speaker
strong

スピーカーID

説明:
音声を出力するスピーカーを指定するためのIDです。
CriWare.CriAtomExPlayer::SetSendLevel 関数で利用します。
参照
CriAtomExPlayer::SetSendLevel
列挙値
FrontLeft 

フロントレフトスピーカー

FrontRight 

フロントライトスピーカー

FrontCenter 

フロントセンタースピーカー

LowFrequency 

LFE（≒サブウーハー）

SurroundLeft 

サラウンドレフトスピーカー

SurroundRight 

サラウンドライトスピーカー

SurroundBackLeft 

サラウンドバックレフトスピーカー

SurroundBackRight 

サラウンドバックライトスピーカー

enum Format : uint
strong

フォーマット種別

説明:
AtomExプレーヤで再生する音声のフォーマットを指定するためのデータ型です。
CriWare.CriAtomExPlayer::SetFormat 関数で利用します。
参照
CriAtomExPlayer::SetFormat
列挙値
ADX 

ADX

HCA 

HCA

HCA_MX 

HCA-MX

WAVE 

Wave

RAW_PCM 

RawPCM

AUDIO_BUFFER 

Audio Buffer

enum CurveType : int
strong

曲線タイプ

説明:
エンベロープカーブやREACTのダッキング曲線として使用するカーブタイプです。
参照
CriAtomExPlayer::SetEnvelopeAttackCurve, CriAtomExPlayer::SetEnvelopeDecayCurve, CriAtomExPlayer::SetEnvelopeReleaseCurve, CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter
列挙値
Linear 

直線

Square 

低速変化

SquareReverse 

高速変化

SCurve 

S字曲線

FlatAtHalf 

逆S字曲線

enum Randomize3dCalcType : int
strong

3D音源の位置のランダム化における位置座標の算出方法

説明:
3D音源の位置のランダム化における位置座標の算出方法の定義です。
参照
CriAtomEx::Randomize3dConfig
列挙値
None 

設定無し

Rectangle 

矩形

Cuboid 

直方体

Circle 

円

Cylinder 

円柱

Sphere 

球

List 

座標リスト

enum Randomize3dParamType
strong

3D音源位置ランダム化における位置座標の算出パラメータの内容定義

説明:
ランダム位置算出方法（座標範囲を示す形状）を決定するパラメータの意味合いの定義です。
参照
CriAtomEx::randomize3dParamTable, CriAtomEx::Randomize3dConfig::GetParamByType, CriAtomEx::Randomize3dConfig::SetParamByType
列挙値
None 

未使用

Width 

左右幅

Depth 

前後幅

Height 

上下幅

Radius 

半径

enum CueType
strong

キュータイプ

参照
CriAtomEx::CueInfo
列挙値
Polyphonic 

ポリフォニック

Sequential 

シーケンシャル

Shuffle 

シャッフル再生

Random 

ランダム

RandomNoRepeat 

ランダム非連続（前回再生した音以外をランダムに鳴らす）

SwitchGameVariable 

スイッチ再生（ゲーム変数を参照して再生トラックの切り替える）

ComboSequential 

コンボシーケンシャル（「コンボ時間」内に連続コンボが決まるとシーケンシャル、最後までいくと「コンボループバック」地点に戻る）

SwitchSelector 

セレクタ

enum SilentMode : System.Int32
strong

無音時処理モード

説明:
無音時処理モードを指定するためのデータ型です。
無音となったかどうかは、以下のいずれかの値が0になったかどうかで判断します。
  • ボリューム
  • 3Dパンニングの演算結果によるボリューム
  • 3Dポジショニングの演算結果によるボリューム
注意:
センドレベルや2Dパンの設定値では無音と判断されない点にご注意ください。
列挙値
Normal 

何もしない

説明:
無音となっても特別な処理は行いません。（デフォルト値）
Stop 

停止する

説明:
無音となった際は自動的に停止します。
Virtual 

バーチャル化する

説明:
無音となった際は自動的にバーチャル化します。
VirtualRetrigger 

再発音型でバーチャル化する

説明:
無音となった際は自動的に再発音型でバーチャル化します。

関数詳解

static void SetSpeakerAngle ( SpeakerAngles6ch  speakerAngle)
inlinestatic

スピーカー角度の設定(5.1ch)

引数
speakerAngle出力スピーカーの角度
説明:
パン3Dや3Dポジショニングの計算時に使用する、出力スピーカーの角度（配置）を設定します。
角度は、正面方向を0度として-180度から180度の間で設定してください。

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

注意:
lowFrequencyの角度を変更しても、パン3Dや3Dポジショニングの計算結果は変化しません。
設定した角度は、各スピーカーシステムごとに独立して設定されます。
static void SetSpeakerAngle ( SpeakerAngles8ch  speakerAngle)
inlinestatic

スピーカー角度の設定(7.1ch)

引数
speakerAngle出力スピーカーの角度
説明:
パン3Dや3Dポジショニングの計算時に使用する、出力スピーカーの角度（配置）を設定します。
角度は、正面方向を0度として-180度から180度の間で設定してください。

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

注意:
lowFrequencyの角度を変更しても、パン3Dや3Dポジショニングの計算結果は変化しません。
設定した角度は、各スピーカーシステムごとに独立して設定されます。
static void SetVirtualSpeakerAngle ( SpeakerAngles6ch  speakerAngle)
inlinestatic

バーチャルスピーカー角度の設定(5.1ch)

引数
speakerAngle出力スピーカーの角度
説明:
バーチャルスピーカーにおけるパン3Dや3Dポジショニングの計算時に使用する、
出力スピーカーの角度（配置）を設定します。
注意:
本関数での設定は CriWare.CriAtomEx::ControlVirtualSpeakerSetting 関数にて
バーチャルスピーカー設定を有効にしない限り、
設定したバーチャルスピーカー角度はパン3Dや3Dポジショニングの計算に反映されません。
static void SetVirtualSpeakerAngle ( SpeakerAngles8ch  speakerAngle)
inlinestatic

バーチャルスピーカー角度の設定(7.1ch)

引数
speakerAngle出力スピーカーの角度
説明:
バーチャルスピーカーにおけるパン3Dや3Dポジショニングの計算時に使用する、
出力スピーカーの角度（配置）を設定します。
注意:
本関数での設定は CriWare.CriAtomEx::ControlVirtualSpeakerSetting 関数にて
バーチャルスピーカー設定を有効にしない限り、
設定したバーチャルスピーカー角度はパン3Dや3Dポジショニングの計算に反映されません。
static void ControlVirtualSpeakerSetting ( bool  sw)
inlinestatic

バーチャルスピーカー設定のON/OFF

引数
swスイッチ（false = 無効、true = 有効）
説明:
パン3Dや3Dポジショニングの計算時にバーチャルスピーカーの設定を使用する機能のON/OFFを設定します。
この設定を有効にすると、マルチチャンネルサウンドは CriWare.CriAtomEx::SetVirtualSpeakerAngle 関数にて設定した
バーチャルスピーカー角度からそれぞれ再生されます。
注意:
デフォルトの状態は「無効」になっています。
また、何かボイスを再生中に「有効」にした場合、パン3Dや3Dポジショニングの計算には即時反映されません。 次回ボイス再生時から反映されます。
delegate void CueLinkCbFunc ( ref CueLinkInfo  info)

キューリンクコールバック

引数
infoキューリンクコールバック情報
説明:
キューリンクコールバック関数型です。
参照
CriAtomEx::OnCueLinkCallback
static bool RegisterAcf ( CriFsBinder  binder,
string  acfPath 
)
inlinestatic

ACFファイルの登録

引数
binderバインダ
acfPathACFファイルのファイルパス
説明:
ACFファイルをロードし、ライブラリに取り込みます。
参照
CriAtomEx::UnregisterAcf
static bool RegisterAcf ( IntPtr  acfData,
int  dataSize 
)
inlinestatic

ACFデータの登録

引数
acfDataACFデータ
dataSizeACFデータのサイズ
説明:
メモリ上に配置されたACFデータをロードし、ライブラリに取り込みます。
注意:
引数として渡すデータのバッファアドレスは、ガベージコレクターに移動されないように アプリケーション側で事前に固定したものを渡してください。
また、メモリの固定解除はACFファイルの登録解除後、またはライブラリ終了処理後に行ってください。
参照
CriAtomEx::UnregisterAcf
static bool RegisterAcf ( byte[]  acfData)
inlinestatic
非推奨:
削除予定の非推奨APIです。 CriWare.CriAtomEx.RegisterAcf(IntPtr, int)の使用を検討してください。
static void UnregisterAcf ( )
inlinestatic

ACFファイルの登録解除

説明:
ACFファイルの登録を解除します。
参照
CriAtomEx::RegisterAcf
static string GetAppliedDspBusSnapshotName ( )
inlinestatic

スナップショット名の取得

説明:
現在設定されているスナップショット名を取得します。設定されていない場合、nullを返します。
static void AttachDspBusSetting ( string  settingName)
inlinestatic

DSPバス設定のアタッチ

引数
settingNameDSPバス設定の名前
説明:
DSPバス設定からDSPバスを構築してサウンドレンダラにアタッチします。
本関数を実行するには、あらかじめ CriAtomEx::RegisterAcf 関数でACF情報を登録しておく必要があります
：
// ACFファイルの読み込みと登録
CriAtomEx.RegisterAcf("Sample.acf");
// DSPバス設定の適用
CriAtomEx.AttachDspBusSetting("DspBusSetting_0");
：
注意:
本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。
参照
CriAtomEx::DetachDspBusSetting, CriAtomEx::RegisterAcf
static void DetachDspBusSetting ( )
inlinestatic

DSPバス設定のデタッチ

説明:
DSPバス設定をデタッチします。
注意:
本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。
参照
CriAtomEx::AttachDspBusSetting
static void ApplyDspBusSnapshot ( string  snapshot_name,
int  time_ms 
)
inlinestatic

DSPバススナップショットの適用

引数
snapshot_nameDSPバススナップショット名
time_msスナップショットが完全に反映されるまでの時間（ミリ秒）
説明:
DSPバススナップショットを適用します。
本関数を呼び出すとスナップショットのパラメータに変化します。 完全に変化を終えるまでに、time_ms ミリ秒かかります。
static int GetNumGameVariables ( )
inlinestatic

ゲーム変数の総数の取得

戻り値
ゲーム変数の総数
説明:
ACFファイル内に登録されているゲーム変数の総数を取得します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
ACFファイルが登録されていない場合、-1が返ります。
static bool GetGameVariableInfo ( ushort  index,
out GameVariableInfo  info 
)
inlinestatic

ゲーム変数情報の取得（インデックス指定）

引数
indexゲーム変数インデックス
infoゲーム変数情報
戻り値
情報が取得できたかどうか？
説明:
ゲーム変数インデックスからゲーム変数情報を取得します。
指定したインデックスのゲーム変数が存在しない場合、Falseが返ります。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static float GetGameVariable ( uint  game_variable_id)
inlinestatic

ゲーム変数の取得

引数
game_variable_idゲーム変数ID
戻り値
ゲーム変数値
説明:
ACFファイル内に登録されているゲーム変数値を取得します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static float GetGameVariable ( string  game_variable_name)
inlinestatic

ゲーム変数の取得

引数
game_variable_nameゲーム変数名
戻り値
ゲーム変数値
説明:
ACFファイル内に登録されているゲーム変数値を取得します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static void SetGameVariable ( uint  game_variable_id,
float  game_variable_value 
)
inlinestatic

ゲーム変数の設定

引数
game_variable_idゲーム変数ID
game_variable_valueゲーム変数値
説明:
ACFファイル内に登録されているゲーム変数に値を設定します。
設定可能な範囲は0.0f～1.0fの間です。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static void SetGameVariable ( string  game_variable_name,
float  game_variable_value 
)
inlinestatic

ゲーム変数の設定

引数
game_variable_nameゲーム変数名
game_variable_valueゲーム変数値
説明:
ACFファイル内に登録されているゲーム変数に値を設定します。
設定可能な範囲は0.0f～1.0fの間です。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static void SetRandomSeed ( uint  seed)
inlinestatic

乱数種の設定

引数
seed乱数種
説明:
CRI Atomライブラリ全体で共有する疑似乱数生成器に乱数種を設定します。
乱数種を設定することにより、各種ランダム再生処理に再現性を持たせることができます。
AtomExプレーヤごとに再現性を持たせたい場合は、 CriWare.CriAtomExPlayer::SetRandomSeed 関数を使用してください。
再現性の必要がなく、実行ごとに乱数種を切り替えたい場合は、本関数 ではなく、 CriWare.CriAtomConfig::useRandomSeedWithTime プロパティを使用してください。
注意:
本関数は CriWare.CriAtomSource または CriWare.CriAtomExPlayer の生成前に呼び出す必要が あります。乱数種を設定する前に作成されたものについては影響を受けません。
参照
CriWare.CriAtomExPlayer::SetRandomSeed
static void ResetPerformanceMonitor ( )
inlinestatic

パフォーマンスモニタのリセット

説明:
現在までの計測結果を破棄します。
パフォーマンスモニタは、ライブラリ初期化直後からパフォーマンス情報の取得を開始し、 計測結果を累積します。
以前の計測結果を今後の計測に含めたくない場合には、 本関数を実行し、累積された計測内容を一旦破棄する必要があります。
参照
CriAtomEx::GetPerformanceInfo
static void GetPerformanceInfo ( out PerformanceInfo  info)
inlinestatic

パフォーマンス情報の取得

説明:
パフォーマンス情報を取得します。
参照
CriAtomEx::PerformanceInfo, CriAtomEx::ResetPerformanceMonitor
static void SetGlobalLabelToSelectorByIndex ( ushort  selector_index,
ushort  label_index 
)
inlinestatic

セレクタに対するグローバル参照ラベルの設定

引数
selector_indexセレクタインデックス
label_indexラベルインデックス
説明:
ACFファイル内に登録されているセレクタに対してグローバル参照されるラベルを設定します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
参照
CriAtomEx::SetGlobalLabelToSelectorByName
static void SetGlobalLabelToSelectorByName ( string  selector_name,
string  label_name 
)
inlinestatic

セレクタに対するグローバル参照ラベルの設定

引数
selector_nameセレクタ名
label_nameラベル名
説明:
ACFファイル内に登録されているセレクタに対してグローバル参照されるラベルを設定します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
参照
CriAtomEx::SetGlobalLabelToSelectorByIndex
static void PauseTimer ( bool  sw)
inlinestatic

タイマのポーズ

引数
swtrue=タイマ一時停止、false=タイマ再開
説明:
Atomライブラリ内のマスタタイマを一時停止／再開します。
マスタタイマを一時停止すると、シーケンス時刻が進行しなくなります。
備考:
本関数は アプリケーションが休止したり一時停止するようなプラットフォームにおいて、
休止中や一時停止中でもタイマが進行してしまうプラットフォーム向けの機能です。
アプリケーションが休止状態や一時停止状態に遷移する前に
本関数でマスタタイマを一時停止しておくことで、休止中のシーケンスの進行を止める事ができます。
注意:
本関数で一時停止する対象はあくまでAtomライブラリ内のマスタタイマです。
音声の一時停止が必要な場合はCriAtomExAsr.PauseOutputVoiceを利用してください。
static void Lock ( )
inlinestatic

サーバ処理の割り込みの防止

説明:
サーバ処理の割り込み抑止します。
本関数実行後、 CriWare.CriAtomEx::Unlock 関数実行までの間、サーバ処理の動作が抑止されます。
複数のAPIを同一オーディオフレーム内で確実に実行したい場合には、本関数でサーバ処理の 割り込みを防止し、それらの関数を実行してください。
参照
CriAtomEx::Unlock
static void Unlock ( )
inlinestatic

サーバ処理の割り込み防止の解除

説明:
CriWare.CriAtomEx::Lock 関数による、サーバ処理の割り込み防止を解除します。
参照
CriAtomEx::Lock
static void SetOutputAudioDevice_PC ( string  deviceId)
inlinestatic

[PC] 出力デバイスの設定(デバイスID指定)

引数
deviceIdデバイスID
説明:
Atomからの音声出力先となるデバイスIDを設定します。
static bool LoadAudioDeviceList_PC ( )
inlinestatic

[PC] 出力デバイスリストの初期化

説明:
Atomからの音声出力先となるデバイスリストを初期化します。
本関数の呼び出し後、 CriAtomEx::GetNumAudioDevices_PC でのデバイス数を取得や、 CriAtomEx::GetAudioDeviceName_PC でのデバイス名の取得が可能になります。
参照
CriAtomEx::GetNumAudioDevices_PC, CriAtomEx::GetAudioDeviceName_PC
static int GetNumAudioDevices_PC ( )
inlinestatic

[PC] 出力デバイス数の取得

戻り値
出力デバイス数
説明:
Atomからの音声出力先として選択可能なデバイス数を取得します。
事前に CriAtomEx::LoadAudioDeviceList_PC を呼び出して プラグイン内でのデバイスリストを初期化してから、本関数を呼び出してください。 戻り値の最大は32です。
参照
CriAtomEx::LoadAudioDeviceList_PC
static string GetAudioDeviceName_PC ( int  index)
inlinestatic

[PC] 出力デバイス名の取得(インデクス指定)

引数
indexデバイスインデクス
戻り値
出力デバイス名
説明:
Atomからの音声出力先として選択可能なデバイスの名前を取得します。
事前に CriAtomEx::LoadAudioDeviceList_PC を呼び出して プラグイン内でのデバイスリストを初期化してから、本関数を呼び出してください。
参照
CriAtomEx::LoadAudioDeviceList_PC
static void SetOutputAudioDevice_PC ( int  index)
inlinestatic

[PC] 出力デバイスの設定(インデクス指定)

引数
indexデバイスインデクス
説明:
Atomからの音声出力先となるデバイスを設定します。
事前に CriAtomEx::LoadAudioDeviceList_PC を呼び出して プラグイン内でのデバイスリストを初期化してから、本関数を呼び出してください。
参照
CriAtomEx::LoadAudioDeviceList_PC
static bool IsSoundStopped_IOS ( )
inlinestatic

[iOS] サウンド出力停止の確認

説明:
サウンド出力が停止しているかどうかの確認を行います。
Trueの場合、サウンド出力が停止しています。
アプリケーションをポーズしていないにも関わらず本関数がTrueを返した場合は、 アプリケーションに検知されないシステムの割り込み等により、サウンド出力が妨げられています。
音声と同期した処理を行う場合には、本関数によりサウンド出力状態を確認し、 必要に応じてポーズ処理を追加してください。
注意:
本関数はiOS専用APIです。
static void EnableAudioSessionRestoration_IOS ( bool  flag)
inlinestatic

[iOS] AudioSession 復帰処理の有効化

引数
flag復帰処理を有効化するかどうか
説明:
他アプリやシステムからの音声割り込みに対して、自動で復帰処理を行うかどうかを設定します。
音声出力を排他的に行うモード( CriAtomConfig.iosOverrideIPodMusic が true )の場合に、 他アプリケーションからの割り込みに対して音声を復帰させるかどうかの設定になります。
デフォルトは「有効」で、割り込みに対して即座に復帰処理を行います。
以下のような処理を行うために一時的に復帰処理を無効化したい場合に、引数に false を設定して 本関数を呼び出してください。また、意図せずアプリケーションの音声が復帰しなくなる問題を回避するため、 処理の終了後は引数に true を設定してもう一度本関数を呼び出してください。
  • ユーザーによるテキスト入力時に音声入力をサポートしたい場合
  • 一時的に CRIWARE 以外の音声再生を伴うモジュール(例：WebView による動画再生)を利用したい場合
注意:
本関数はiOS専用APIです。
static void EnableBusSendOffsetWhenLevelNotExist ( bool  enable)
inlinestatic

センドレベル値が無い場合のオフセット値有効化

引数
enable有効化フラグ
説明:
CriWare.CriAtomExPlayer.SetBusSendLevelOffset などでセンド量を設定した際に
データ側にセンドレベル値設定が無くてもオフセット値を加味するかを設定します。
有効化フラグ値に対応する挙動は以下の通りです。
  • ture:すべてのバスに対してオフセットを指定する
  • false:データ側でセンド先が設定されているバスのみ
    システムデフォルトは true です。
    再生中の音声に対しては、パラメーターの更新適用時に合わせて反映されます。

プロパティ詳解

CueLinkCbFunc OnCueLinkCallback
staticaddremove

キューリンクコールバックの登録

説明:
キュー再生時にキューリンクを処理した際に、キューリンク情報を受け取るコールバック関数を登録します。
登録されたコールバック関数は、コールバックイベントを処理した直後の、アプリケーション メインスレッドの更新タイミングで実行されます。
このクラス詳解は次のファイルから抽出されました: