Wave ボイスプール [詳解]

CriAtomExWaveVoicePool の継承関係図

クラス
struct	Config
	Waveボイスプール初期化コンフィグ [詳解]

公開型
enum	VoicePoolId { StandardMemory = StandardMemoryAsrVoicePoolId, StandardStreaming = StandardStreamingAsrVoicePoolId, StandardMemory = StandardMemoryNsrVoicePoolId, StandardStreaming = StandardStreamingNsrVoicePoolId, HcaMxMemory = 4, HcaMxStreaming = 5, LowLatencyMemory = StandardMemoryNsrVoicePoolId, LowLatencyStreaming = StandardStreamingNsrVoicePoolId }
	プラグイン内部で生成するボイスプールへアクセスするためのID [詳解]

enum	PitchShifterMode : int
	ピッチシフタDSP動作モード [詳解]

公開メンバ関数
	CriAtomExWaveVoicePool (Config config)
	Wave 再生可能なボイスプールの作成 [詳解]

	CriAtomExWaveVoicePool (int numVoices, int maxChannels, int maxSamplingRate, bool streamingFlag, uint identifier=0)
	Wave ボイスプールの作成 [詳解]

UsedVoicesInfo	GetNumUsedVoices ()
	ボイスプールのボイス使用状況取得 [詳解]

override void	Dispose ()
	ボイスプールの破棄 [詳解]

void	AttachDspTimeStretch ()
	タイムストレッチDSPのアタッチ [詳解]

void	AttachDspPitchShifter (PitchShifterMode mode=PitchShifterMode.Music, int windosSize=1024, int overlapTimes=4)
	ピッチシフタDSPのアタッチ [詳解]

void	DetachDsp ()
	DSPのデタッチ [詳解]

静的公開メンバ関数
static void	SetDefaultConfigForWaveVoicePool (ref Config config)
	Waveボイスプール作成用コンフィグ構造体にデフォルト値をセット

static UsedVoicesInfo	GetNumUsedVoices (VoicePoolId voicePoolId)
	ボイスプールのボイス使用状況取得 [詳解]

プロパティ
uint	identifier `[get]`
	ボイスプール識別子 [詳解]

詳解

Wave ボイスプール

列挙型メンバ詳解

enum VoicePoolId

stronginherited

プラグイン内部で生成するボイスプールへアクセスするためのID

参照: CriAtomExVoicePool.GetNumUsedVoices

列挙値
StandardMemory	機種標準のメモリ再生ボイスプールID
StandardStreaming	機種標準のストリーミング再生ボイスプールID
StandardMemory	機種標準のメモリ再生ボイスプールID
StandardStreaming	機種標準のストリーミング再生ボイスプールID
HcaMxMemory	HCA-MXメモリ再生ボイスプールID
HcaMxStreaming	HCA-MXストリーミング再生ボイスプールID
LowLatencyMemory	[Android] 低遅延メモリ再生ボイスプールID
LowLatencyStreaming	[Android] 低遅延ストリーミング再生ボイスプールID

enum PitchShifterMode : int

stronginherited

ピッチシフタDSP動作モード

説明:: ピッチシフトの処理方法（アルゴリズム）を指定します。

参照: CriAtomExVoicePool.AttachDspPitchShifter, CriAtomExPlayer.SetDspParameter

構築子と解体子

CriAtomExWaveVoicePool ( Config config )

inline

Wave 再生可能なボイスプールの作成

引数

config Waveボイスプール初期化コンフィグ

戻り値: Waveボイスプール

説明:: 本関数を実行することで、Wave 再生が可能なボイスがプールされます。
AtomEx プレーヤで Wave データ（もしくは Wave データを含むキュー）の再生を行うと、 AtomEx プレーヤは作成された Wave ボイスプールからボイスを取得し、再生を行います。
再生終了後は、必ず、Dispose 関数でオブジェクトを破棄してください。

注意:: 再生終了後は、必ず、Dispose 関数でオブジェクトを破棄してください。
特定の CriAtomExPlayer に対して、作成したボイスプールからボイスを取得するように明示的に設定したい場合は、
identifier としてデフォルトの 0 以外の値を指定して作成し、 CriAtomExPlayer::SetVoicePoolIdentifier 関数を
呼び出してください。

参照: CriAtomExPlayer::SetVoicePoolIdentifier

CriAtomExWaveVoicePool	(	int	numVoices,
		int	maxChannels,
		int	maxSamplingRate,
		bool	streamingFlag,
		uint	identifier = `0`
	)

inline

Wave ボイスプールの作成

引数

numVoices	ボイス数
maxChannels	最大チャンネル数
maxSamplingRate	最大サンプリングレート
streamingFlag	ストリーミング再生フラグ
identifier	ボイスプール識別子

戻り値: Wave ボイスプール

説明:: 本関数を実行することで、Wave 再生が可能なボイスがプールされます。
AtomEx プレーヤで Wave データ（もしくは Wave データを含むキュー）の再生を行うと、 AtomEx プレーヤは作成された Wave ボイスプールからボイスを取得し、再生を行います。
再生終了後は、必ず、Dispose 関数でオブジェクトを破棄してください。
特定の CriAtomExPlayer に対して、作成したボイスプールからボイスを取得するように明示的に設定したい場合は、 identifier としてデフォルトの 0 以外の値を指定して作成し、 CriAtomExPlayer::SetVoicePoolIdentifier 関数を呼び出してください。

参照: CriAtomExPlayer::SetVoicePoolIdentifier

関数詳解

static UsedVoicesInfo GetNumUsedVoices ( VoicePoolId voicePoolId )

inlinestaticinherited

ボイスプールのボイス使用状況取得

引数

voicePoolId ボイスプールのID

戻り値: ボイス使用状況

説明:: 指定されたボイスプールのボイス使用状況を取得します。

注意:: 本関数はデバッグ目的でのみ使用してください。

参照: CriAtomExVoicePool::VoicePoolId, CriAtomExVoicePool::UsedVoicesInfo

UsedVoicesInfo GetNumUsedVoices ( )

inlineinherited

ボイスプールのボイス使用状況取得

戻り値: ボイス使用状況

説明:: ボイス使用状況を取得します。

注意:: 本関数はデバッグ目的でのみ使用してください。

参照: CriAtomExVoicePool::UsedVoicesInfo

override void Dispose ( )

inlineinherited

ボイスプールの破棄

説明:: ボイスプールオブジェクトの破棄を行います。
作成したオブジェクトを本APIで破棄しない場合、リソースリークが発生しますので必ず破棄してください。

void AttachDspTimeStretch ( )

inlineinherited

タイムストレッチDSPのアタッチ

説明:: ボイスプールにタイムストレッチDSPを追加します。

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

参照: CriAtomExVoicePool::DetachInsertionDsp

void AttachDspPitchShifter	(	PitchShifterMode	mode = `PitchShifterMode.Music`,
		int	windosSize = `1024`,
		int	overlapTimes = `4`
	)

inlineinherited

ピッチシフタDSPのアタッチ

引数

mode	ピッチシフトモード
windosSize	ウィンドウサイズ
overlapTimes	オーバーラップ回数

説明:: ボイスプールにピッチシフタDSPを追加します。

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

参照: CriAtomExVoicePool::DetachInsertionDsp

void DetachDsp ( )

inlineinherited

DSPのデタッチ

説明:: ボイスプールに追加したDSPを取り外します。

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

参照: CriAtomExVoicePool::AttachDspPitchShifter, CriAtomExVoicePool::AttachDspTimeStretch

プロパティ詳解

uint identifier

getinherited

ボイスプール識別子

説明:: ボイスプール識別子は、ボイスプールを一意に識別するためのIDです。

備考:: プレーヤー（CriAtomExPlayer.SetVoicePoolIdentifier）とボイスプールの両方に同じ識別子を設定することで、
当該のプレーヤーは設定されたボイスプールからのみボイスを取得するようになります。

参照: CriAtomExVoicePool::VoicePoolId, CriAtomExVoicePool::UsedVoicesInfo

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

CriAtomExVoicePool.cs

クラス

公開型

公開メンバ関数

静的公開メンバ関数

プロパティ

詳解

列挙型メンバ詳解

構築子と解体子

関数詳解

プロパティ詳解