CRI ADX2  Last Updated: 2021-07-02 16:39 p
CriAtomHcaMxConfigTag 構造体

HCA-MX初期化用コンフィグ構造体HCA-MXの動作仕様を指定するための構造体です。
criAtomHcaMx_Initialize 関数の引数に指定します。
[詳解]

#include <cri_atom.h>

フィールド

CriFloat32 server_frequency
 サーバー処理の実行頻度 [詳解]
 
CriSint32 num_mixers
 ミキサ数 [詳解]
 
CriSint32 max_players
 ミキサに登録可能な最大プレーヤー数 [詳解]
 
CriSint32 max_input_channels
 入力データの最大チャンネル数 [詳解]
 
CriSint32 max_sampling_rate
 最大サンプリングレート [詳解]
 
CriSint32 output_channels
 出力チャンネル数 [詳解]
 
CriSint32 output_sampling_rate
 出力サンプリングレート [詳解]
 
CriAtomSoundRendererType sound_renderer_type
 サウンドレンダラタイプ [詳解]
 

詳解

HCA-MX初期化用コンフィグ構造体

HCA-MXの動作仕様を指定するための構造体です。
criAtomHcaMx_Initialize 関数の引数に指定します。

備考:
デフォルト設定を使用する場合、 criAtomHcaMx_SetDefaultConfig マクロで 構造体にデフォルトパラメーターをセットした後、 criAtomHcaMx_Initialize 関数 に構造体を指定してください。
注意
将来的にメンバが増える可能性があるため、 criAtomHcaMx_SetDefaultConfig マクロを使用しない場合には、使用前に必ず構造体をゼロクリアしてください。
(構造体のメンバに不定値が入らないようご注意ください。)
参照
criAtomHcaMx_Initialize, criAtomHcaMx_SetDefaultConfig

フィールド詳解

◆ server_frequency

CriFloat32 server_frequency

サーバー処理の実行頻度

説明:
サーバー処理を実行する頻度を指定します。
注意
Atomライブラリ初期化時に指定した値( CriAtomConfig 構造体の server_frequency )と、同じ値をセットする必要があります。
参照
CriAtomConfig

◆ num_mixers

CriSint32 num_mixers

ミキサ数

説明:
HCA-MXデコード結果を送信するミキサの数を指定します。
ミキサを複数作成することで、 ミキサごとに異なるバスエフェクトを適用することが可能になります。
注意
HCA-MXのデコード処理、および定常状態の処理負荷は、 ミキサの数に比例して重くなります。

◆ max_players

CriSint32 max_players

ミキサに登録可能な最大プレーヤー数

説明:
ミキサごとに登録可能なHCA-MXプレーヤーの数を指定します。

◆ max_input_channels

CriSint32 max_input_channels

入力データの最大チャンネル数

説明:
アプリケーション中で再生するHCA-MXデータの最大チャンネル数を指定します。
再生するデータがモノラルの場合は1を、ステレオの場合は2を指定してください。
備考:
HCA-MX初期化時に max_input_channels に指定された数以下の音声データが 再生可能になります。
例えば、 max_input_channels に6を指定した場合、5.1ch音声だけでなく、 モノラル音声やステレオ音声も再生可能になります。
100個のデータのうち、99個がモノラル、1個がステレオの場合でも、 max_input_channels には2を指定する必要があります。

◆ max_sampling_rate

CriSint32 max_sampling_rate

最大サンプリングレート

説明:
HCA-MXの出力に指定できる最大サンプリングレートです。
備考:
例えば::criAtomHcaMx_SetFrequencyRatio 関数に 2.0f を指定する場合は output_sampling_rate * 2 を指定してください。

◆ output_channels

CriSint32 output_channels

出力チャンネル数

説明:
HCA-MXデータの出力チャンネル数を指定します。
通常、ターゲット機に接続されたスピーカーの数(出力デバイスの 最大チャンネル数)を指定します。
備考:
モノラル音声のみを再生し、パンをコントロールしない場合には、 output_channels を1にすることで、処理負荷を下げることが可能です。
注意
output_channels の数を max_input_channels 以下の値に設定することは できません。

◆ output_sampling_rate

CriSint32 output_sampling_rate

出力サンプリングレート

説明:
再生するHCA-MXデータのサンプリングレートを指定します。
HCA-MXは、音単位のサンプリングレート変更を行えません。
HCA-MXデータを作成する際には、必ず全ての音声データを同一のサンプリング レートで作成し、その値を output_sampling_rate に指定してください。

◆ sound_renderer_type

CriAtomSoundRendererType sound_renderer_type

サウンドレンダラタイプ

説明:
HCA-MXの出力先サウンドレンダラの種別を指定します。
sound_renderer_type に CRIATOM_SOUND_RENDERER_DEFAULT を指定した場合、 音声データはデフォルト設定のサウンドレンダラに転送されます。
sound_renderer_type に CRIATOM_SOUND_RENDERER_NATIVE を指定した場合、 音声データはデフォルト設定の各プラットフォームのサウンド出力に転送されます。
sound_renderer_type に CRIATOM_SOUND_RENDERER_ASR を指定した場合、 音声データはASR(Atom Sound Renderer)に転送されます。
(ASRの出力先は、ASR初期化時に別途指定。)

この構造体詳解は次のファイルから抽出されました: