外部音声を入力するためのAuxIn [詳解]

CriDisposableを継承しています。

クラス
struct	Config
	AuxIn作成用コンフィグ構造体 [詳解]

公開メンバ関数
	CriAtomExAuxIn (Config?config=null)
	AuxInの作成 [詳解]

override void	Dispose ()
	AuxInの破棄 [詳解]

void	Start ()
	AuxInの再生開始 [詳解]

void	Stop ()
	AuxInの再生停止 [詳解]

void	SetFormat (int numChannels, int samplingRate)
	フォーマットの設定 [詳解]

void	GetFormat (out int numChannels, out int samplingRate)
	フォーマットの取得 [詳解]

void	SetVolume (float volume)
	ボリューム設定 [詳解]

void	SetFrequencyRatio (float frequencyRatio)
	周波数調整比の設定 [詳解]

void	SetBusSendLevel (string busName, float level)
	バスセンドレベル設定 [詳解]

void	SetInputReadStream (CriAudioReadStream stream)
	リードストリームの設定 [詳解]

詳解

外部音声を入力するためのAuxIn

説明:: AuxInはADXの外部の音声データをADXのDSPバスに流すことができます。
入力データの再生開始、ステータスの取得、入力データの書込み等の制御を行います。

構築子と解体子

CriAtomExAuxIn ( Config? config = null )

inline

AuxInの作成

引数

config AuxIn作成用コンフィグ構造体

戻り値: AtomAuxInハンドル

説明:: 音声入力用のAuxInを作成します。
AuxInはADXの外部の音声データをADXのDSPバスに流すことができます。

音声の再生を開始するにはCriWare.CriAtomExAuxIn::Start 関数を実行します。
入力する音声は CriWare.CriAtomExAuxIn::SetInputReadStream に指定するコールバック関数を経由してAuxInに渡します。

注意:: 本関数は完了復帰型の関数です。実行にかかる時間は、プラットフォームによって異なります。
マイクの作成／破棄は、シーンの切り替わり等、負荷変動を許容できるタイミングで行うようお願いいたします。

参照: CriAtomExAuxIn::Dispose

関数詳解

override void Dispose ( )

inline

AuxInの破棄

説明:: AuxInを破棄します。

注意:: 本関数は完了復帰型の関数です。実行にかかる時間は、プラットフォームによって異なります。
マイクの作成／破棄は、シーンの切り替わり等、負荷変動を許容できるタイミングで行うようお願いいたします。

参照: CriAtomExAuxIn::CriAtomExAuxIn

void Start ( )

inline

AuxInの再生開始

説明:: AuxInの再生を開始します。

参照: CriAtomExAuxIn::Stop

void Stop ( )

inline

AuxInの再生停止

説明:: AuxInの再生を停止します。

参照: CriAtomExAuxIn::Start

void SetFormat	(	int	numChannels,
		int	samplingRate
	)

inline

フォーマットの設定

引数

numChannels	チャンネル数
samplingRate	サンプリング周波数

説明:: 再生を行う音声のフォーマットを設定します。
CriWare.CriAtomExAuxIn::Start を呼ぶ前に設定する必要があります。

参照: CriAtomExAuxIn::GetFormat

void GetFormat	(	out int	numChannels,
		out int	samplingRate
	)

inline

フォーマットの取得

引数

numChannels	チャンネル数
samplingRate	サンプリング周波数

説明:: CriWare.CriAtomExAuxIn::SetFormat で設定したフォーマット情報を取得します。

参照: CriAtomExAuxIn::SetFormat

void SetVolume ( float volume )

inline

ボリューム設定

引数

volume ボリューム値

説明:: AuxInの音声のボリュームを設定をします。

ボリューム値は音声データの振幅に対する倍率です（単位はデシベルではありません）。
例えば、1.0fを指定した場合、原音はそのままのボリュームで出力されます。
0.5fを指定した場合、原音波形の振幅を半分にしたデータと同じ音量（-6dB）で音声が出力されます。
0.0fを指定した場合、音声はミュートされます（無音になります）。

void SetFrequencyRatio ( float frequencyRatio )

inline

周波数調整比の設定

引数

frequencyRatio 周波数調整比(0.25f～4.0f)

説明:: AuxInの音声の周波数調整比を設定します。
周波数調整比は、音声データの周波数と再生周波数の比率で、再生速度の倍率と等価です。
周波数比が1.0fを超える場合、音声データは原音より高速に再生され、 1.0f未満の場合は、音声データは原音より低速で再生されます。

周波数比は、音声のピッチにも影響します。
例えば、周波数比を1.0fで再生した場合、音声データは原音通りのピッチで再生されますが、周波数比を2.0fに変更した場合、ピッチは1オクターブ上がます。
（再生速度が2倍になるため。）

注意:: 周波数比に1.0fを超える値を設定した場合、再生する音声のデータが通常より速く消費されるため、音声データの供給をより早く行う必要があります。
周波数比に1.0fを超える値を設定する場合には、AuxIn作成時に指定する最大サンプリングレートの値を、周波数比を考慮した値に設定してください。
（AuxIn作成時に指定する CriWare.CriAtomExAuxIn::Config 構造体の maxSamplingRate の値に、「原音のサンプリングレート×周波数比」で計算される値を指定する必要があります。）

void SetBusSendLevel	(	string	busName,
		float	level
	)

inline

バスセンドレベル設定

引数

busName	バス名
level	レベル値（0.0f~1.0f）

説明:: AuxInの音声のバスセンドレベルを設定します。
バスセンドレベルは、音声をどのバスにどれだけ流すかを指定するための仕組みです。

第2引数にはDSPバス設定内のバス名を指定します。
第3引数では送信時のレベル（ボリューム）を指定します。

第2引数のバス名で指定したバスが適用中のDSPバス設定に存在しない場合、設定値は無効値として処理されます。
センドレベル値の範囲や扱いは、ボリュームと同等です。CriWare.CriAtomExAuxIn::SetVolume 関数を参照してください。

void SetInputReadStream ( CriAudioReadStream stream )

inline

リードストリームの設定

引数

stream リードストリーム

説明:: AuxInの入力方向のリードストリームを設定します。
コールバック関数は大抵のプラットフォームで別スレッドから呼ばれるため、呼ばれる側はスレッドセーフ実装する必要があります。

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

CriAtomExAuxIn.cs

クラス

公開メンバ関数

詳解

構築子と解体子

関数詳解