CriAtomExAsrRack クラス

ASRラック [詳解]

CriDisposableを継承しています。

クラス
struct	Config
	ASRラック作成用コンフィグ構造体 [詳解]
interface	IPlatformConfig
	ASRラック作成用プラットフォーム固有コンフィグ構造体インターフェース [詳解]
struct	PerformanceInfo
	パフォーマンス情報 [詳解]
struct	PlatformConfig
	ASRラック作成用プラットフォーム固有コンフィグ構造体 [詳解]

公開メンバ関数
	CriAtomExAsrRack (Config config, IPlatformConfig platformConfig)
	ASRラックの作成 [詳解]
	CriAtomExAsrRack (Config config, PlatformConfig platformConfig)
	ASRラックの作成 [詳解]
void	AttachDspBusSetting (string settingName)
	DSPバス設定のアタッチ [詳解]
void	DetachDspBusSetting ()
	DSPバス設定のデタッチ [詳解]
void	ApplyDspBusSnapshot (string snapshotName, int timeMs)
	DSPバススナップショットの適用 [詳解]
string	GetAppliedDspBusSnapshotName ()
	スナップショット名の取得 [詳解]
PerformanceInfo	GetPerformanceInfo ()
	ASRラックのパフォーマンス情報を取得 [詳解]
void	ResetPerformanceMonitor ()
	ASRラックのパフォーマンス計測をリセット [詳解]
override void	Dispose ()
	ASRラックの破棄 [詳解]

静的公開メンバ関数
static string	GetAppliedDspBusSnapshotName (CriAtomExAsrRackId rackId)
	スナップショット名の取得 [詳解]
static PerformanceInfo	GetPerformanceInfoByRackId (CriAtomExAsrRackId rackId=CriAtomExAsrRack.defaultRackId)
	ASRラックのパフォーマンス情報を取得 [詳解]
static void	ResetPerformanceMonitorByRackId (CriAtomExAsrRackId rackId=CriAtomExAsrRack.defaultRackId)
	ASRラックのパフォーマンス計測をリセット [詳解]
static void	SetAisacControl (CriAtomExAsrRackId rackId, string controlName, float value)
	名前指定によるAISACコントロール値設定 [詳解]
static void	SetAisacControl (CriAtomExAsrRackId rackId, int controlId, float value)
	ID指定によるAISACコントロール値設定 [詳解]
static void	SetDefaultConfig (ref Config config)
	デフォルトパラメーターをセット [詳解]
static void	GetNumRenderedSamples (CriAtomExAsrRackId rackId, out Int64 numSamples, out Int32 samplingRate)
	ASRラックの総レンダリング量の取得 [詳解]
static CriAtomExAsrRackId	GetAmbisonicRackId ()
	Ambisonics再生用ASRラックIDを取得 [詳解]
static CriAtomExAsrRackId	GetChannelBasedAudioRackId ()
	チャンネルベース 再生用ASRラックIDを取得 [詳解]
static CriAtomExAsrRackId	GetObjectBasedAudioRackId ()
	ObjectBasedAudio 再生用ASRラックIDを取得 [詳解]
static CriAtomExAsrRackId	GetPassThroughRackId ()
	パススルー再生用ASRラックIDを取得 [詳解]

公開変数類
const CriAtomExAsrRackId	defaultRackId = 0
	デフォルトASRラックID [詳解]
const CriAtomExAsrRackId	IllegalRackId = -1
	不正なラックID [詳解]

プロパティ
CriAtomExAsrRackId	rackId [get]
	ASRラックIDの取得 [詳解]
static CriAtomExAsrRack	Default [get]
	デフォルトASRラック [詳解]
static Config	defaultConfig = new CriAtomExAsrRack(defaultRackId) [get]
	デフォルトコンフィギュレーション [詳解]

詳解

ASRラック

構築子と解体子

CriAtomExAsrRack ( Config  config, IPlatformConfig  platformConfig  )

inline

ASRラックの作成

引数

config	コンフィグ構造体
platformConfig	プラットフォーム固有パラメータ構造体

戻り値

ASRラック

説明:

ASRラックを作成します。
本関数で作成したASRラックは、必ず Dispose 関数で破棄してください。
プラットフォーム固有パラメータを使用しない場合は platformConfig にnullを指定してください。

CriAtomExAsrRack ( Config  config, PlatformConfig  platformConfig  )

inline

ASRラックの作成

非推奨:

削除予定の非推奨APIです。 CriWare.CriAtomExAsrRack.CriAtomExAsrRack(Config, IPlatformConfig) の使用を検討してください。

引数

config	コンフィグ構造体
platformConfig	プラットフォーム固有パラメータ構造体

戻り値

ASRラック

説明:

ASRラックを作成します。
本関数で作成したASRラックは、必ず Dispose 関数で破棄してください。

関数詳解

void AttachDspBusSetting ( string  settingName )

inline

DSPバス設定のアタッチ

引数

settingName

DSPバス設定の名前

説明:

DSPバス設定からDSPバスを構築してASRラックにアタッチします。
本関数を実行するには、あらかじめ CriAtomEx::RegisterAcf 関数でACF情報を登録しておく必要があります

注意:

本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

参照

CriAtomExAsrRack::DetachDspBusSetting, CriAtomEx::RegisterAcf

void DetachDspBusSetting ( )

inline

DSPバス設定のデタッチ

説明:

DSPバス設定をデタッチします。

注意:

本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

参照

CriAtomExAsrRack::AttachDspBusSetting

void ApplyDspBusSnapshot ( string  snapshotName, int  timeMs  )

inline

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

引数

snapshotName	DSPバススナップショット名
timeMs	スナップショットが完全に反映されるまでの時間（ミリ秒）

説明:

DSPバススナップショットをASRラックに適用します。
本関数を呼び出すとスナップショットのパラメータに変化します。 完全に変化を終えるまでに、timeMsミリ秒かかります。

static string GetAppliedDspBusSnapshotName ( CriAtomExAsrRackId  rackId )

inlinestatic

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

引数

rackId

ラックのID

戻り値

スナップショット名

説明:

現在設定されているスナップショット名を取得します。設定されていない場合、nullを返しします。

string GetAppliedDspBusSnapshotName ( )

inline

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

戻り値

スナップショット名

説明:

現在設定されているスナップショット名を取得します。設定されていない場合、nullを返しします。

PerformanceInfo GetPerformanceInfo ( )

inline

ASRラックのパフォーマンス情報を取得

戻り値

ASRラックのパフォーマンス情報

説明:

現在のASRラックインスタンスからパフォーマンス情報を取得します。

参照

CriAtomExAsrRack::ResetPerformanceMonitor, CriAtomExAsrRack::GetPerformanceInfoByRackId

static PerformanceInfo GetPerformanceInfoByRackId ( CriAtomExAsrRackId  rackId = CriAtomExAsrRack.defaultRackId )

inlinestatic

ASRラックのパフォーマンス情報を取得

引数

rackId

ラックのID

戻り値

ASRラックのパフォーマンス情報

説明:

指定したIDのASRラックのパフォーマンス情報を取得します。
ラックIDを指定しない場合、ライブラリ初期化時に生成されるデフォルトASRラックのパフォーマンス情報が返されます。
不正なラックIDが指定された場合、メンバー変数の値がすべて0の構造体が返されます。

参照

CriAtomExAsrRack::ResetPerformanceMonitorByRackId, CriAtomExAsrRack::GetPerformanceInfo

void ResetPerformanceMonitor ( )

inline

ASRラックのパフォーマンス計測をリセット

説明:

現在のASRラックインスタンスのパフォーマンス計測をリセットします。

参照

CriAtomExAsrRack::GetPerformanceInfo, CriAtomExAsrRack::ResetPerformanceMonitorByRackId

static void ResetPerformanceMonitorByRackId ( CriAtomExAsrRackId  rackId = CriAtomExAsrRack.defaultRackId )

inlinestatic

ASRラックのパフォーマンス計測をリセット

引数

rackId

ラックのID

説明:

指定したIDのASRラックのパフォーマンス計測をリセットします。
ラックIDを指定しない場合、ライブラリ初期化時に生成されるデフォルトASRラックのパフォーマンス情報がリセットされます。

参照

CriAtomExAsrRack::GetPerformanceInfoByRackId, CriAtomExAsrRack::ResetPerformanceMonitor

static void SetAisacControl ( CriAtomExAsrRackId  rackId, string  controlName, float  value  )

inlinestatic

名前指定によるAISACコントロール値設定

引数

rackId	ラックのID
controlName	AISACコントロール名
value	AISACコントロール値

説明:

名前指定でAISACコントロール値を設定します。

static void SetAisacControl ( CriAtomExAsrRackId  rackId, int  controlId, float  value  )

inlinestatic

ID指定によるAISACコントロール値設定

引数

rackId	ラックのID
controlId	AISACコントロールID
value	AISACコントロール値

説明:

ID指定でAISACコントロール値を設定します。

static void SetDefaultConfig ( ref Config  config )

inlinestatic

デフォルトパラメーターをセット

引数

config

初期化コンフィグ

説明:

CriWare.CriAtomExAsrRack.CriAtomExAsrRack で使用する初期化コンフィグにデフォルトパラメーターをセットします。

override void Dispose ( )

inline

ASRラックの破棄

説明:

ASRラックを破棄します。

static void GetNumRenderedSamples ( CriAtomExAsrRackId  rackId, out Int64  numSamples, out Int32  samplingRate  )

inlinestatic

ASRラックの総レンダリング量の取得

引数

rackId	ラックのID
numSamples	レンダリング済みサンプル数
samplingRate	サンプリングレート

説明:

ASRラックのレンダリング済みサンプル数とサンプリングレートを取得します。

注意:

本関数のレンダリング済みサンプル数の増加パターンは実行中のプラットフォームや出力デバイスによって変化する可能性があります。

static CriAtomExAsrRackId GetAmbisonicRackId ( )

inlinestatic

Ambisonics再生用ASRラックIDを取得

戻り値

ASRラックID

説明:

Ambisonics再生に使用するASRラックIDを取得します。
取得したIDは CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId) によって
CriAtomExAsrRackオブジェクトとして取り扱えます。

Ambisonics再生用ASRラックは、出力ポート「_ambisonics」の設定があるACFの登録により自動で作成されます。
取得したASRラックIDはACF登録中のみ有効です。
ACFの登録を解除すると、Ambisonics再生用ASRラックも削除されるため取得したASRラックIDは無効になります。
Ambisonics再生用ASRラックが作成されていない場合、 CriAtomExAsrRack.IllegalRackId を返します。

参照

CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetChannelBasedAudioRackId ( )

inlinestatic

チャンネルベース 再生用ASRラックIDを取得

戻り値

ASRラックID

説明:

チャンネルベース再生に使用するASRラックIDを取得します。
取得したIDは CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId) によって
CriAtomExAsrRackオブジェクトとして取り扱えます。

チャンネルベース再生用ASRラックは、出力ポート「_7_1_4」の設定で
「専用のミキサーを使用する」にTrueを指定しているACFの登録により自動で作成されます。
取得したASRラックIDはACF登録中のみ有効です。
ACFの登録を解除すると、チャンネルベース再生用ASRラックも削除されるため取得したASRラックIDは無効になります。
チャンネルベース再生用ASRラックが作成されていない場合、 CriAtomExAsrRack.IllegalRackId を返します。

参照

CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetObjectBasedAudioRackId ( )

inlinestatic

ObjectBasedAudio 再生用ASRラックIDを取得

戻り値

ASRラックID

説明:

ObjectBasedAudio再生に使用するASRラックIDを取得します。
取得したIDは CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId) によって
CriAtomExAsrRackオブジェクトとして取り扱えます。

ObjectBasedAudio再生用ASRラックは、出力ポート「_object_based_audio」の設定があるACFの登録により自動で作成されます。
取得したASRラックIDはACF登録中のみ有効です。
ACFの登録を解除すると、ObjectBasedAudio再生用ASRラックも削除されるため取得したASRラックIDは無効になります。
ObjectBasedAudio再生用ASRラックが作成されていない場合、 CriAtomExAsrRack.IllegalRackId を返します。

参照

CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetPassThroughRackId ( )

inlinestatic

パススルー再生用ASRラックIDを取得

戻り値

ASRラックID

説明:

パススルー 再生のみを行うASRラックのIDを取得します。
取得したIDは CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId) によって
CriAtomExAsrRackオブジェクトとして取り扱えます。

パススルー再生用ASRラックは、出力ポート「_pass_through」の設定があるACFの登録により自動で作成されます。
取得したASRラックIDはACF登録中のみ有効です。
ACFの登録を解除すると、パススルー再生用ASRラックも削除されるため取得したASRラックIDは無効になります。
パススルー再生用ASRラックが作成されていない場合、 CriAtomExAsrRack.IllegalRackId を返します。

参照

CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

メンバ詳解

const CriAtomExAsrRackId defaultRackId = 0

デフォルトASRラックID

説明:

デフォルトのASRラックIDです。 通常出力に戻す場合や生成したASRラックを破棄する場合には、各種プレーヤに対して この定数を利用してASRラックIDの指定を行ってください。

参照

CriAtomExPlayer::SetAsrRackId, CriMana::Player::SetAsrRackId

const CriAtomExAsrRackId IllegalRackId = -1

不正なラックID

説明:

デフォルトのASRラックIDです。 ASRラックの生成に失敗した場合に返る値です。

プロパティ詳解

CriAtomExAsrRackId rackId

get

ASRラックIDの取得

説明:

ASRラックオブジェクトのIDを取得します。

CriAtomExAsrRack Default

staticget

デフォルトASRラック

説明:

初期化時に自動的に作成されるASRラックです。

Config defaultConfig = new CriAtomExAsrRack(defaultRackId)

staticget

デフォルトコンフィギュレーション

非推奨:

削除予定の非推奨APIです。 CriWare.CriAtomExAsrRack.Config.Default の使用を検討してください。

説明:

デフォルトコンフィグです。

備考:

本プロパティで取得したデフォルトコンフィギュレーションを必要に応じて変更して

参照

CriAtomExAsrRack::CriAtomExAsrRack

---

このクラス詳解は次のファイルから抽出されました:

• CriAtomExAsrRack.cs