構造体 CriAtomExHcaMxConfigTag
[CriAtomExHcaMx API]

HCA-MX初期化用コンフィグ構造体 [詳細]

#include <cri_atom_ex.h>

すべてのメンバ一覧

Public 変数

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


説明

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

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

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


変数

CriFloat32 server_frequency

サーバー処理の実行頻度

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

CriSint32 num_mixers

ミキサ数

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

本パラメーターを0に設定した場合でも、ミキサは 1 つだけ作成されます。
(旧バージョンとの互換性維持のため。)
HCA-MXを使用しない場合には、本パラメーターと max_voices の両方を 0 に設定してください。

CriSint32 max_voices

ミキサに登録可能な最大ボイス数

説明:
ミキサごとに登録可能なHCA-MXボイスの数を指定します。
HCA-MXボイスプールを作成する際には、ボイスの総数が num_mixers × max_voices を超えないようご注意ください。

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を指定する必要があります。

CriSint32 max_sampling_rate

最大サンプリングレート

説明:
HCA-MXの出力に指定できる最大サンプリングレートです。
ミキサの最終出力でピッチを変更する場合に設定します。
ミキサの最終出力でピッチを変更しない場合は、output_sampling_rateと同じ値を設定してください。
備考:
例えばHCA-MX再生時にcriAtomExHcaMx_SetFrequencyRatio 関数に 2.0f を指定してピッチを上げる場合は、 output_sampling_rate * 2 を指定してHCA-MXを初期化してください。

CriSint32 output_channels

出力チャンネル数

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

CriSint32 output_sampling_rate

出力サンプリングレート

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

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初期化時に別途指定。)


CRI Middleware logo Copyright (c) 2006-2018 CRI Middleware Co., Ltd.