CriAtomExPlayback API

無効な再生ID

説明:

criAtomExPlayer_Start 関数で音声の再生を開始した際、 ボイスリミットコントロール等によりボイスが確保できなかった場合に返される、 無効な再生IDです。

備考:

再生 ID を指定する API に対して本 ID をセットした場合でも、 エラーコールバックは発生しません。
（何もされずに関数からリターンします。）
そのため、 criAtomExPlayer_Start 関数の結果にかかわらず、 再生 ID を使用した処理を常時行っても、特に問題ありません。

参照:

CriAtomExPlaybackId, criAtomExPlayer_Start

無効なブロックインデックス

説明:

criAtomExPlayback_GetCurrentBlockIndex 関数で再生中の音声のカレントブロック インデックスを取得した際、再生中の音声がブロックシーケンスではない場合に 返される無効なインデックスです。

参照:

criAtomExPlayback_GetCurrentBlockIndex

再生ステータス

説明:

AtomExプレーヤーで再生済みの音声のステータスです。
criAtomExPlayback_GetStatus 関数で取得可能です。

再生状態は、通常以下の順序で遷移します。

1. CRIATOMEXPLAYBACK_STATUS_PREP
2. CRIATOMEXPLAYBACK_STATUS_PLAYING
3. CRIATOMEXPLAYBACK_STATUS_REMOVED

備考

CriAtomExPlaybackStatusはAtomExプレーヤーのステータスではなく、 プレーヤーで再生を行った（ criAtomExPlayer_Start 関数を実行した） 音声のステータスです。

再生中の音声リソースは、発音が停止された時点で破棄されます。
そのため、以下のケースで再生音のステータスが CRIATOMEXPLAYBACK_STATUS_REMOVED に遷移します。

• 再生が完了した場合。
• criAtomExPlayback_Stop 関数で再生中の音声を停止した場合。
• 高プライオリティの発音リクエストにより再生中のボイスが奪い取られた場合。
• 再生中にエラーが発生した場合。

参照:

criAtomExPlayer_Start, criAtomExPlayback_GetStatus, criAtomExPlayback_Stop

再生元のタイプ

説明:

AtomExプレーヤーで再生するまたは再生中の音声の、再生元のタイプです。

参照:

CriAtomExSourceInfo

再生元の情報

説明:

AtomExプレーヤーで再生するまたは再生中の音声の、再生元（何を再生する／している）の情報です。
criAtomExPlayback_GetSource 関数で取得可能です。
取得した情報を元に、criAtomExAcb_GetCueInfoByIndex 関数等を利用することで、 より詳細な情報を取得することができます。

備考

再生元のタイプによって、取得できる情報が異なります。
typeを参照し、共用体sourceの中のどの構造体としてアクセスするかを選択してください。

 CriAtomExSourceInfo source;
 criAtomExPlayback_GetSource(playback_id, &source);
 
 switch (source.type) {
 case CRIATOMEXPLAYBACK_SOURCE_TYPE_CUE_ID:
    {
        CriAtomExCueInfo cue_info;
        criAtomExAcb_GetCueInfoById(source.info.cue_id.acb, source.info.cue_id.id, &cue_info);
            :
    }
    break;
        :
 }

参照:

criAtomExPlayback_GetSource, criAtomExAcb_GetCueInfoByIndex

再生イベント

説明:

再生イベントの種別を示す値です。
再生イベントコールバックに引数として渡されます。

参照:

CriAtomExPlaybackEventCbFunc, criAtomExPlayer_SetPlaybackEventCallback

再生情報詳細

説明:

再生イベント発生時に、当該再生に関する詳細情報を通知するための構造体です。
再生イベントコールバックに引数として渡されます。

参照:

CriAtomExPlaybackEventCbFunc, criAtomExPlayer_SetPlaybackEventCallback

再生イベントコールバック関数型

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	playback_event	発生したイベント
[in]	info	詳細情報

説明:

再生イベントの通知に使用される、コールバック関数の型です。
criAtomExPlayer_SetPlaybackEventCallback 関数に本関数型のコールバック関数を登録することで、 再生イベント発生時にコールバックを受け取ることが可能となります。

注意:

本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

参照:

criAtomExPlayer_SetPlaybackEventCallback, CriAtomExPlaybackEvent, CriAtomExPlaybackInfoDetail

再生ステータス

説明:

AtomExプレーヤーで再生済みの音声のステータスです。
criAtomExPlayback_GetStatus 関数で取得可能です。

再生状態は、通常以下の順序で遷移します。

1. CRIATOMEXPLAYBACK_STATUS_PREP
2. CRIATOMEXPLAYBACK_STATUS_PLAYING
3. CRIATOMEXPLAYBACK_STATUS_REMOVED

備考

CriAtomExPlaybackStatusはAtomExプレーヤーのステータスではなく、 プレーヤーで再生を行った（ criAtomExPlayer_Start 関数を実行した） 音声のステータスです。

再生中の音声リソースは、発音が停止された時点で破棄されます。
そのため、以下のケースで再生音のステータスが CRIATOMEXPLAYBACK_STATUS_REMOVED に遷移します。

• 再生が完了した場合。
• criAtomExPlayback_Stop 関数で再生中の音声を停止した場合。
• 高プライオリティの発音リクエストにより再生中のボイスが奪い取られた場合。
• 再生中にエラーが発生した場合。

参照:

criAtomExPlayer_Start, criAtomExPlayback_GetStatus, criAtomExPlayback_Stop

列挙型の値:

CRIATOMEXPLAYBACK_STATUS_PREP	再生準備中
CRIATOMEXPLAYBACK_STATUS_PLAYING	再生中
CRIATOMEXPLAYBACK_STATUS_REMOVED	削除された

再生元のタイプ

説明:

AtomExプレーヤーで再生するまたは再生中の音声の、再生元のタイプです。

参照:

CriAtomExSourceInfo

列挙型の値:

CRIATOMEX_SOURCE_TYPE_NONE	未設定
CRIATOMEX_SOURCE_TYPE_CUE_ID	キューID
CRIATOMEX_SOURCE_TYPE_CUE_NAME	キュー名
CRIATOMEX_SOURCE_TYPE_CUE_INDEX	キューインデックス
CRIATOMEX_SOURCE_TYPE_DATA	オンメモリデータ
CRIATOMEX_SOURCE_TYPE_FILE	ファイル名
CRIATOMEX_SOURCE_TYPE_CONTENT_ID	CPKコンテンツID
CRIATOMEX_SOURCE_TYPE_WAVE_ID	音声データID
CRIATOMEX_SOURCE_TYPE_VIBRATION_ID	振動ID
CRIATOMEX_SOURCE_TYPE_SOUND_GENERATOR_ID	サウンドジェネレータID
CRIATOMEX_SOURCE_TYPE_RAW_PCM_FLOAT_ID	RawPcmFloatID

再生イベント

説明:

再生イベントの種別を示す値です。
再生イベントコールバックに引数として渡されます。

参照:

CriAtomExPlaybackEventCbFunc, criAtomExPlayer_SetPlaybackEventCallback

列挙型の値:

CRIATOMEX_PLAYBACK_EVENT_ALLOCATE	新規再生リソースの確保 説明: キューの再生に必要なリソースが確保されたことを示す値です。 リソース確保時点ではボイスの割り当ては行われておらず、 発音がされていません（バーチャル化した状態で作成されます）。
CRIATOMEX_PLAYBACK_EVENT_FROM_VIRTUAL_TO_NORMAL	ボイスの割り当て 説明: バーチャル状態の再生リソースに対してボイスが割り当てられたことを示す値です。 ボイスが割り当てられたことで、キューの発音が開始されます。 備考: キューに複数の波形データが含まれる場合、いずれか1つの波形データが再生された時点で本イベントが発生します。 （キュー再生に関連するボイスの数が0から1に代わる瞬間に本イベントが発生します。） 既にボイスが割り当てられた状態で、さらに追加のボイスが割り当てられるタイミングでは本イベントは発生ません。
CRIATOMEX_PLAYBACK_EVENT_FROM_NORMAL_TO_VIRTUAL	バーチャル化 説明: キューの再生がバーチャル化されたことを示す値です。 以下のいずれかの要因により、発音中のキューからボイスが切り離された場合に発生します。 キューに含まれる波形データを終端まで再生したため、ボイスが不要になった criAtomExPlayer_Stop 関数等の呼び出しにより、再生中の波形データが停止された プライオリティ制御により、再生中の波形データが停止され、ボイスが奪い取られた 備考: 本イベントは、キューに含まれる"波形データ"が再生されなくなった状態を示します。 本イベント発生時点では、キューの再生は終了していません。 （キューの再生が終了した際には、別途 CRIATOMEX_PLAYBACK_EVENT_REMOVE イベントが発生します。） キューに複数の波形データが含まれる場合、全ての波形データが再生されなくなった時点で本イベントが発生します。 （キュー再生に関連するボイスの数が1から0に代わる瞬間に本イベントが発生します。） 複数のボイスが割り当てられた状態でそのうちの1つが停止された場合には、本イベントは発生ません。
CRIATOMEX_PLAYBACK_EVENT_REMOVE	再生リソースの解放 説明: 再生リソースが解放されたことを示す値です。 キューの再生が完了した際や、再生停止要求によりキューが停止された場合に本イベントが発生します。 備考: キューに含まれる波形データが再生されている場合、 本イベント発生前に、必ず CRIATOMEX_PLAYBACK_EVENT_FROM_NORMAL_TO_VIRTUAL イベントが発生します。

再生音の停止

引数:

[in]

id

再生ID

説明:

再生音単位で停止処理を行います。
本関数を使用することで、プレーヤーによって再生された音声を、プレーヤー単位ではなく、 個別に停止させることが可能です。

備考:

AtomEx プレーヤーによって再生された全ての音声を停止したい場合、 本関数ではなく criAtomExPlayer_Stop 関数をご利用ください。
（ criAtomExPlayer_Stop 関数は、そのプレーヤーで再生中の全ての音声を停止します。）

注意:

本関数で再生音の停止を行うと、再生中の音声のステータスは CRIATOMEXPLAYBACK_STATUS_REMOVED に遷移します。
停止時にボイスリソースも破棄されるため、一旦 CRIATOMEXPLAYBACK_STATUS_REMOVED 状態に遷移した再生 ID からは、以降情報を取得できなくなります。

参照:

criAtomExPlayer_Stop, criAtomExPlayback_GetStatus

再生音の停止（リリースタイム無視）

引数:

[in]

id

再生ID

説明:

再生音単位で停止処理を行います。
この際、再生中の音声にエンベロープのリリースタイムが設定されていたとしても、それを無視して停止します。
本関数を使用することで、プレーヤーによって再生された音声を、プレーヤー単位ではなく、 個別に停止させることが可能です。

備考:

プレーヤーによって再生された全ての音声を停止したい場合、 本関数ではなく criAtomExPlayer_StopWithoutReleaseTime 関数をご利用ください。

注意:

本関数で再生音の停止を行うと、再生中の音声のステータスは CRIATOMEXPLAYBACK_STATUS_REMOVED に遷移します。
停止時にボイスリソースも破棄されるため、一旦 CRIATOMEXPLAYBACK_STATUS_REMOVED 状態に遷移した再生 ID からは、以降情報を取得できなくなります。

参照:

criAtomExPlayer_StopWithoutReleaseTime

再生音のポーズ／ポーズ解除

引数:

[in]	id	再生ID
[in]	sw	スイッチ（ CRI_FALSE = ポーズ解除、 CRI_TRUE = ポーズ ）

説明:

再生音単位でポーズ／ポーズ解除を行います。
sw に CRI_TRUE を指定して本関数を実行すると、指定したIDの音声がポーズ （一時停止）されます。
sw に CRI_FALSE を指定して本関数を実行すると、指定したIDの音声のポーズが 解除され、一時停止していた音声の再生が再開されます。

本関数を使用することで、プレーヤーによって再生された音声を、プレーヤー単位ではなく、 個別にポーズ／ポーズ解除させることが可能です。

備考:

プレーヤーによって再生された全ての音声をポーズ／ポーズ解除したい場合、 本関数ではなく criAtomExPlayer_Pause 関数をご利用ください。

フェーダーをアタッチしたプレーヤーで再生した音声に対して本関数で個別にポーズ／ポーズ解除の操作を行った場合、 クロスフェード処理はフェードイン側の音声のポーズ状態に同期して行われます。
例えば、クロスフェード中にcriAtomExPlayer_Pause 関数で両方の音声をポーズした場合、 フェードイン側の音声のポーズを解除すればクロスフェード処理が再開されますが、 フェードアウト側の音声のポーズを解除してもクロスフェード処理は再開されません。

注意:

第2引数（sw）に CRI_FALSE を指定してポーズ解除の操作を行った場合、 本関数でポーズをかけた音声だけでなく、criAtomExPlayer_Prepare 関数で再生準備中の音声についても再生が開始されてしまいます。
（旧バージョンとの互換性維持のための仕様です。）
本関数でポーズをかけた音声についてのみポーズを解除したい場合、 本関数を使用せず、 criAtomExPlayback_Resume(id, CRIATOMEX_RESUME_PAUSED_PLAYBACK); を実行してポーズ解除を行ってください。

フェーダーをアタッチしたプレーヤーに対し再生ID指定でポーズの解除を行うと、 フェードインする音声の発音リソースが確保できない場合や、 フェードインする音声の発音リソースが奪い取られた場合にポーズ解除が行えず、 フェードアウト側の音声がいつまで経ってもフェードアウトしない状態となります。
フェーダーをアタッチしたプレーヤーで再生した音声に対しては、本関数ではなく、 criAtomExPlayer_Pause 関数でポーズの解除を行ってください。

参照:

criAtomExPlayback_IsPaused, criAtomExPlayer_Pause, criAtomExPlayback_Resume

再生音の機能別のポーズ解除

引数:

[in]	id	再生ID
[in]	mode	ポーズ解除対象

説明:

再生音単位で一時停止状態の解除を行います。
criAtomExPlayback_Pause 関数と異なり、 criAtomExPlayer_Prepare 関数で再生開始待ちの音声と、 criAtomExPlayer_Pause 関数（または criAtomExPlayback_Pause 関数でポーズをかけた音声とを、 個別に再開させることが可能です。

第2引数（mode）に CRIATOMEX_RESUME_PAUSED_PLAYBACK を指定して本関数を実行すると、 ユーザが criAtomExPlayer_Pause 関数（または criAtomExPlayback_Pause 関数）で一時停止状態になった音声の再生が再開されます。
第2引数（mode）に CRIATOMEX_RESUME_PREPARED_PLAYBACK を指定して本関数を実行すると、 ユーザが criAtomExPlayer_Prepare 関数で再生準備を指示した音声の再生が開始されます。

criAtomExPlayback_Pause 関数でポーズ状態のプレーヤーに対して criAtomExPlayer_Prepare 関数で再生準備を行った場合、 その音声は CRIATOMEX_RESUME_PAUSED_PLAYBACK 指定のポーズ解除処理と、 CRIATOMEX_RESUME_PREPARED_PLAYBACK 指定のポーズ解除処理の両方が行われるまで、再生が開始されません。

備考:

フェーダーをアタッチしたプレーヤーで再生した音声に対して本関数で個別にポーズ解除の操作を行った場合、 クロスフェード処理はフェードイン側の音声のポーズ状態に同期して行われます。
例えば、クロスフェード中にcriAtomExPlayer_Pause 関数で両方の音声をポーズした場合、 フェードイン側の音声のポーズを解除すればクロスフェード処理が再開されますが、 フェードアウト側の音声のポーズを解除してもクロスフェード処理は再開されません。

注意:

フェーダーをアタッチしたプレーヤーに対し再生ID指定でポーズの解除を行うと、 フェードインする音声の発音リソースが確保できない場合や、 フェードインする音声の発音リソースが奪い取られた場合にポーズ解除が行えず、 フェードアウト側の音声がいつまで経ってもフェードアウトしない状態となります。
フェーダーをアタッチしたプレーヤーで再生した音声に対しては、本関数ではなく、 criAtomExPlayer_Pause 関数でポーズの解除を行ってください。

参照:

criAtomExPlayback_IsPaused, criAtomExPlayer_Resume, criAtomExPlayer_Pause

再生音のポーズ状態の取得

引数:

[in]

id

再生ID

戻り値:

CriBool ポーズ中かどうか（CRI_FALSE = ポーズされていない、CRI_TRUE = ポーズ中）

説明:

再生中の音声がポーズ中かどうかを返します。

参照:

criAtomExPlayback_Pause

再生ステータスの取得

引数:

[in]

id

再生ID

戻り値:

CriAtomExPlaybackStatus 再生ステータス

説明:

criAtomExPlayer_Start 関数で再生された音声のステータスを取得します。

備考:

criAtomExPlayer_GetStatus 関数がAtomExプレーヤーのステータスを返すのに対し、 本関数は再生済みの個々の音声のステータスを取得します。

再生中の音声のボイスリソースは、以下の場合に削除されます。

• 再生が完了した場合。
• criAtomExPlayback_Stop 関数で再生中の音声を停止した場合。
• 高プライオリティの発音リクエストにより再生中のボイスが奪い取られた場合。
• 再生中にエラーが発生した場合。

そのため、 criAtomExPlayback_Stop 関数を使用して明示的に再生を停止したか、 その他の要因によって再生が停止されたかの違いに関係なく、 再生音のステータスはいずれの場合も CRIATOMEXPLAYBACK_STATUS_REMOVED に遷移します。
（エラーの発生を検知する必要がある場合には、本関数ではなく、criAtomExPlayer_GetStatus 関数で AtomEx プレーヤーのステータスをチェックする必要があります。）

参照:

criAtomExPlayer_Start, criAtomExPlayer_GetStatus, criAtomExPlayback_Stop

再生音声のフォーマット情報の取得

引数:

[in]	id	再生ID
[out]	info	フォーマット情報

戻り値:

CriBool 情報が取得できたかどうか（ CRI_TRUE = 取得できた、 CRI_FALSE = 取得できなかった）

説明:

criAtomExPlayer_Start 関数で再生された音声のフォーマット情報を取得します。

フォーマット情報が取得できた場合、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。

備考:

複数の音声データを含むキューを再生した場合、最初に見つかった音声 データの情報が返されます。

注意:

本関数は、音声再生中のみフォーマット情報を取得可能です。
再生準備中や再生終了後、発音数制御によりボイスが消去された場合には、 フォーマット情報の取得に失敗します。
ボイスの再生状態は criAtomExPlayback_GetStatus 関数で取得することはできないためご注意ください。

参照:

criAtomExPlayer_Start, criAtomExPlayer_GetStatus

再生音声の再生元情報の取得

引数:

[in]	id	再生ID
[out]	source	再生元情報

戻り値:

	CRI_TRUE	= 情報が取得できた
	CRI_FALSE	= 情報が取得できなかった

説明:

criAtomExPlayer_Start 関数で再生された音声の再生元情報を取得します。
取得した情報を元に、criAtomExAcb_GetCueInfoByIndex 関数等を利用することで、 より詳細な情報を取得することができます。

再生元情報が取得できた場合、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。

備考

再生元のタイプによって、取得できる情報が異なります。
typeを参照し、共用体sourceの中のどの構造体としてアクセスするかを選択してください。

 CriAtomExSourceInfo source;
 criAtomExPlayback_GetSource(playback_id, &source);
 
 switch (source.type) {
 case CRIATOMEXPLAYBACK_SOURCE_TYPE_CUE_ID:
    {
        CriAtomExCueInfo cue_info;
        criAtomExAcb_GetCueInfoById(source.info.cue_id.acb, source.info.cue_id.id, &cue_info);
            :
    }
    break;
        :
 }

注意:

本関数は、音声再生中のみ再生元情報を取得可能です。
再生終了後や、発音数制御によりボイスが消去された場合には、 再生元情報の取得に失敗します。

参照:

criAtomExPlayer_Start, criAtomExPlayer_GetStatus

Atomプレーヤーの取得

引数:

[in]

id

再生ID

戻り値:

CriAtomPlayerHn

Atomプレーヤーハンドル

説明:

再生IDに紐づけられたボイス（＝Atomプレーヤーハンドル）を取得します。

備考:

複数の波形データを含むキューを再生している場合、 本関数は最初に見つかったボイスに対応するAtomプレーヤーハンドルを返します。
波形データが再生されていない場合、本関数はNULLを返します。

再生時刻の取得

引数:

[in]

id

再生ID

戻り値:

Sint64 再生時刻（ミリ秒単位）

説明:

criAtomExPlayer_Start 関数で再生された音声の再生時刻を取得します。

再生時刻が取得できた場合、本関数は 0 以上の値を返します。
指定したボイスが既に消去されている場合等には、本関数は負値を返します。

備考:

本関数が返す再生時刻は「再生開始後からの経過時間」です。
ループ再生時や、シームレス連結再生時を行った場合でも、 再生位置に応じて時刻が巻き戻ることはありません。

criAtomExPlayer_Pause 関数でポーズをかけた場合、 再生時刻のカウントアップも停止します。
（ポーズを解除すれば再度カウントアップが再開されます。）
本関数で取得可能な時刻の精度は、サーバー処理の周波数に依存します。
（時刻の更新はサーバー処理単位で行われます。）
より精度の高い時刻を取得する必要がある場合には、本関数の代わりに criAtomExPlayback_GetNumPlayedSamples 関数を使用し、 再生済みサンプル数を取得してください。

注意:

戻り値の型はCriSint64ですが、現状、32bit以上の精度はありません。
再生時刻を元に制御を行う場合、約24日で再生時刻が異常になる点に注意が必要です。
（ 2147483647 ミリ秒を超えた時点で、再生時刻がオーバーフローし、負値になります。）

本関数は、音声再生中のみ時刻を取得可能です。
（ criAtomExPlayer_GetTime 関数と異なり、本関数は再生中の音声ごとに時刻を 取得可能ですが、再生終了時刻を取ることができません。）
再生終了後や、発音数制御によりボイスが消去された場合には、 再生時刻の取得に失敗します。
（負値が返ります。）

ドライブでリードリトライ処理等が発生し、一時的に音声データの供給が途切れた場合でも、 再生時刻のカウントアップが途切れることはありません。
（データ供給停止により再生が停止した場合でも、時刻は進み続けます。）
そのため、本関数で取得した時刻を元に映像との同期を行った場合、 リードリトライ発生毎に同期が大きくズレる可能性があります。
波形データと映像の同期を厳密に取る必要がある場合は、本関数の代わりに criAtomExPlayback_GetNumPlayedSamples 関数を使用し、 再生済みサンプル数との同期を取ってください。

参照:

criAtomExPlayer_Start, criAtomExPlayer_GetTime, criAtomExPlayback_GetNumPlayedSamples

再生時刻の取得（再生音声に同期した補正込み）

引数:

[in]

id

再生ID

戻り値:

Sint64 再生時刻（ミリ秒単位）

説明:

criAtomExPlayer_Start 関数で再生された音声の再生時刻を取得します。

再生時刻が取得できた場合、本関数は 0 以上の値を返します。
指定したボイスが既に消去されている場合等には、本関数は負値を返します。

備考:

criAtomExPlayback_GetTime 関数が返す「再生開始後からの経過時間」とは 異なり、本関数からは再生中の音声に同期した再生時刻を取得することが 可能です。
デバイスのリードリトライ処理等により音声データの供給が途切れて 再生が停止した場合、またはシステムによる割り込みにより音声出力が妨げられた 場合には、再生時刻のカウントアップが一時的に停止します。
再生された音声に厳密に同期した処理を行いたい場合は、本関数で 取得した再生時刻を用いてください。
ただし、ループ再生時や、シームレス連結再生時を行った場合でも、 再生位置に応じて時刻が巻き戻ることはありません。
また、波形の詰まっていないシーケンスキューや 再生波形が切り替わるブロックシーケンスキューに対しては、正常に再生時刻を 取得することができません。

criAtomExPlayer_Pause 関数でポーズをかけた場合、 再生時刻のカウントアップも停止します。
（ポーズを解除すれば再度カウントアップが再開されます。）

本関数による再生時刻の取得を行う場合は、対応するAtomExプレーヤー作成時に、 CriAtomExPlayerConfig 構造体の enable_audio_synced_timer を CRI_TRUE に 設定してください。
デフォルトでは無効になっています。

戻り値の型は long ですが、現状、32bit以上の精度はありません。
再生時刻を元に制御を行う場合、約24日で再生時刻が異常になる点に注意が必要です。
（ 2147483647 ミリ秒を超えた時点で、再生時刻がオーバーフローし、負値になります。）

本関数は、音声再生中のみ時刻を取得可能です。
（ criAtomExPlayer_GetTime 関数と異なり、本関数は再生中の音声ごとに時刻を 取得可能ですが、再生終了時刻を取ることができません。）
再生終了後や、発音数制御によりボイスが消去された場合には、 再生時刻の取得に失敗します。
（負値が返ります。）

本関数は内部で時刻計算を行っており、プラットフォームによっては処理負荷が 問題になる可能性があります。また、アプリケーションの同じフレーム内であっても、 呼び出し毎に更新された時刻を返します。
アプリケーションによる再生時刻の利用方法にもよりますが、基本的に本関数を用いた 時刻取得は1フレームにつき一度のみ行うようにしてください。

参照:

criAtomExPlayer_Create, criAtomExPlayer_Start, criAtomExPlayback_GetTime

再生時刻の取得（再生音声に同期した補正込み）

引数:

[in]

id

再生ID

戻り値:

Sint64 再生時刻（マイクロ秒単位）

説明:

criAtomExPlayer_Start 関数で再生された音声の再生時刻を取得します。

再生時刻が取得できた場合、本関数は 0 以上の値を返します。
指定したボイスが既に消去されている場合等には、本関数は負値を返します。

備考:

criAtomExPlayback_GetTime 関数が返す「再生開始後からの経過時間」とは 異なり、本関数からは再生中の音声に同期した再生時刻を取得することが 可能です。
デバイスのリードリトライ処理等により音声データの供給が途切れて 再生が停止した場合、またはシステムによる割り込みにより音声出力が妨げられた 場合には、再生時刻のカウントアップが一時的に停止します。
再生された音声に厳密に同期した処理を行いたい場合は、本関数で 取得した再生時刻を用いてください。
ただし、ループ再生時や、シームレス連結再生時を行った場合でも、 再生位置に応じて時刻が巻き戻ることはありません。
また、波形の詰まっていないシーケンスキューや 再生波形が切り替わるブロックシーケンスキューに対しては、正常に再生時刻を 取得することができません。

criAtomExPlayer_Pause 関数でポーズをかけた場合、 再生時刻のカウントアップも停止します。
（ポーズを解除すれば再度カウントアップが再開されます。）

本関数による再生時刻の取得を行う場合は、対応するAtomExプレーヤー作成時に、 CriAtomExPlayerConfig 構造体の enable_audio_synced_timer を CRI_TRUE に 設定してください。
デフォルトでは無効になっています。

本関数は、音声再生中のみ時刻を取得可能です。
（ criAtomExPlayer_GetTime 関数と異なり、本関数は再生中の音声ごとに時刻を 取得可能ですが、再生終了時刻を取ることができません。）
再生終了後や、発音数制御によりボイスが消去された場合には、 再生時刻の取得に失敗します。
（負値が返ります。）

本関数は内部で時刻計算を行っており、プラットフォームによっては処理負荷が 問題になる可能性があります。また、アプリケーションの同じフレーム内であっても、 呼び出し毎に更新された時刻を返します。
アプリケーションによる再生時刻の利用方法にもよりますが、基本的に本関数を用いた 時刻取得は1フレームにつき一度のみ行うようにしてください。

参照:

criAtomExPlayer_Create, criAtomExPlayer_Start, criAtomExPlayback_GetTime

シーケンス再生位置の取得

引数:

[in]

id

再生ID

戻り値:

Sint64 シーケンス再生位置（ミリ秒単位）

説明:

criAtomExPlayer_Start 関数で再生された音声のシーケンス再生位置を取得します。

再生位置が取得できた場合、本関数は 0 以上の値を返します。
指定したシーケンスが既に消去されている場合等には、本関数は負値を返します。

備考:

本関数が返す再生時刻は「シーケンスデータ上の再生位置」です。
シーケンスループや、ブロック遷移を行った場合は、巻き戻った値が返ります。

キュー指定以外での再生ではシーケンサーが動作しません。キュー再生以外の再生に対して 本関数は負値を返します。

criAtomExPlayer_Pause 関数でポーズをかけた場合、 再生位置の更新も停止します。
（ポーズを解除すれば再度更新が再開されます。）
本関数で取得可能な時刻の精度は、サーバー処理の周波数に依存します。
（時刻の更新はサーバー処理単位で行われます。）

注意:

戻り値の型はCriSint64ですが、現状、32bit以上の精度はありません。
再生位置を元に制御を行う場合、シーケンスループ等の設定がないデータでは約24日で再生位置が異常になる点に注意が必要です。
（ 2147483647 ミリ秒を超えた時点で、再生位置がオーバーフローし、負値になります。）

本関数は、音声再生中のみ位置を取得可能です。
再生終了後や、発音数制御によりシーケンスが消去された場合には、 再生位置の取得に失敗します。
（負値が返ります。）

再生サンプル数の取得

引数:

[in]	id	再生ID
[out]	num_samples	再生済みサンプル数
[out]	sampling_rate	サンプリングレート

戻り値:

CriBool サンプル数が取得できたかどうか（ CRI_TRUE = 取得できた、 CRI_FALSE = 取得できなかった）

説明:

criAtomExPlayer_Start 関数で再生された音声の再生サンプル数、 およびサンプリングレートを返します。

再生サンプル数が取得できた場合、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。
（エラー発生時は num_samples や sampling_rate の値も負値になります。）

備考:

再生済みサンプル数の値の精度は、プラットフォーム SDK のサウンドライブラリに依存します。
（プラットフォームによって、再生済みサンプル数の正確さは異なります。）

複数の音声データを含むキューを再生した場合、最初に見つかった音声 データの情報が返されます。

注意:

ドライブでリードリトライ処理等が発生し、音声データの供給が途切れた場合、 再生サンプル数のカウントアップが停止します。
（データ供給が再開されれば、カウントアップが再開されます。）

本関数は、音声再生中のみ再生サンプル数を取得可能です。
再生終了後や、発音数制御によりボイスが消去された場合には、 再生サンプル数の取得に失敗します。

参照:

criAtomExPlayer_Start

サウンドバッファ-への書き込みサンプル数の取得

引数:

[in]	id	再生ID
[out]	num_samples	書き込み済みサンプル数
[out]	sampling_rate	サンプリングレート

戻り値:

CriBool サンプル数が取得できたかどうか（ CRI_TRUE = 取得できた、 CRI_FALSE = 取得できなかった）

説明:

criAtomExPlayer_Start 関数で再生された音声について、 サウンドバッファ-への書き込み済みサンプル数、およびサンプリングレートを返します。
本関数は criAtomExPlayback_GetNumPlayedSamples 関数と異なり、 サウンドバッファ-に書き込まれた未出力の音声データのサンプル数を含む値を返します。
書き込み済みサンプル数が取得できた場合、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。
（エラー発生時は num_samples や sampling_rate の値も負値になります。）

備考:

書き込み済みサンプル数の値の精度は、プラットフォーム SDK のサウンドライブラリに依存します。
（プラットフォームによって、書き込み済みサンプル数の正確さは異なります。）

複数の音声データを含むキューを再生した場合、最初に見つかった音声 データの情報が返されます。

注意:

ドライブでリードリトライ処理等が発生し、音声データの供給が途切れた場合、 書き込み済みサンプル数のカウントアップが停止します。
（データ供給が再開されれば、カウントアップが再開されます。）

本関数は、音声再生中のみ書き込み済みサンプル数を取得可能です。
再生終了後や、発音数制御によりボイスが消去された場合には、 書き込み済みサンプル数の取得に失敗します。

参照:

criAtomExPlayback_GetNumPlayedSamples

パラメータの取得（浮動小数点数）

引数:

[in]	playback_id	再生ID
[in]	parameter_id	パラメーターID
[out]	value_float32	パラメーター設定値

戻り値:

パラメーターが取得できたかどうか（ CRI_TRUE = 取得できた、 CRI_FALSE = 取得できなかった）

説明:

criAtomExPlayer_Start 関数で再生された音声に設定されている各種パラメーターの値を取得します。
値は浮動小数点数で取得されます。
パラメーターが取得できた場合、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。

注意:

本関数は、音声再生中のみパラメーターを取得可能です。
再生終了後や、発音数制御によりボイスが消去された場合には、 パラメーターの取得に失敗します。

参照:

CriAtomExParameterId, criAtomExPlayback_GetParameterUint32, criAtomExPlayback_GetParameterSint32

パラメーターの取得（符号なし整数）

引数:

[in]	playback_id	再生ID
[in]	parameter_id	パラメーターID
[out]	value_uint32	パラメーター設定値

戻り値:

パラメーターが取得できたかどうか（ CRI_TRUE = 取得できた、 CRI_FALSE = 取得できなかった）

説明:

criAtomExPlayer_Start 関数で再生された音声に設定されている各種パラメーターの値を取得します。
値は符号なし整数で取得されます。
パラメーターが取得できた場合、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。

注意:

本関数は、音声再生中のみパラメーターを取得可能です。
再生終了後や、発音数制御によりボイスが消去された場合には、 パラメーターの取得に失敗します。

参照:

CriAtomExParameterId, criAtomExPlayback_GetParameterFloat32, criAtomExPlayback_GetParameterSint32

パラメーターの取得（符号付き整数）

引数:

[in]	playback_id	再生ID
[in]	parameter_id	パラメーターID
[out]	value_sint32	パラメーター設定値

戻り値:

パラメーターが取得できたかどうか（ CRI_TRUE = 取得できた、 CRI_FALSE = 取得できなかった）

説明:

criAtomExPlayer_Start 関数で再生された音声に設定されている各種パラメーターの値を取得します。
値は符号付き整数で取得されます。
パラメーターが取得できた場合、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。

注意:

本関数は、音声再生中のみパラメーターを取得可能です。
再生終了後や、発音数制御によりボイスが消去された場合には、 パラメーターの取得に失敗します。

参照:

CriAtomExParameterId, criAtomExPlayback_GetParameterFloat32, criAtomExPlayback_GetParameterUint32

AISACコントロール値の取得（コントロールID指定）

引数:

[in]	playback_id	再生ID
[in]	control_id	コントロールID
[out]	control_value	コントロール値（0.0f〜1.0f）、未設定時は-1.0f

戻り値:

AISACコントロール値が取得できたかどうか（ CRI_TRUE = 取得できた、 CRI_FALSE = 取得できなかった）

説明:

criAtomExPlayer_Start 関数で再生された音声に設定されているAISACコントロール値を、コントロールID指定で取得します。
AISACコントロール値が取得できた場合（未設定時も「-1.0fが取得できた」と扱われます）、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。

注意:

本関数は、音声再生中のみAISACコントロール値を取得可能です。
再生終了後や、発音数制御によりボイスが消去された場合には、 AISACコントロール値の取得に失敗します。

参照:

criAtomExPlayer_SetAisacControlById, criAtomExPlayback_GetAisacControlByName

AISACコントロール値の取得（コントロール名指定）

引数:

[in]	playback_id	再生ID
[in]	control_name	コントロール名
[out]	control_value	コントロール値（0.0f〜1.0f）、未設定時は-1.0f

戻り値:

AISACコントロール値が取得できたかどうか（ CRI_TRUE = 取得できた、 CRI_FALSE = 取得できなかった）

説明:

criAtomExPlayer_Start 関数で再生された音声に設定されているAISACコントロール値を、コントロール名指定で取得します。
AISACコントロール値が取得できた場合（未設定時も「-1.0fが取得できた」と扱われます）、本関数は CRI_TRUE を返します。
指定したボイスが既に消去されている場合等には、本関数は CRI_FALSE を返します。

注意:

本関数は、音声再生中のみAISACコントロール値を取得可能です。
再生終了後や、発音数制御によりボイスが消去された場合には、 AISACコントロール値の取得に失敗します。

参照:

criAtomExPlayer_SetAisacControlById, criAtomExPlayback_GetAisacControlByName

再生音のブロック遷移

引数:

[in]	id	再生ID
[in]	index	ブロックインデックス

説明:

再生音単位でブロック遷移を行います。
本関数を実行すると、指定したIDの音声がブロックシーケンスの場合はデータの 設定に従った任意の遷移タイミングで指定ブロックに遷移します。

備考:

再生開始ブロックの指定は criAtomExPlayer_SetFirstBlockIndex 関数を使用して行い、 再生中のブロックインデックス取得は criAtomExPlayback_GetCurrentBlockIndex 関数を使用します。

参照:

criAtomExPlayer_SetFirstBlockIndex, criAtomExPlayback_GetCurrentBlockIndex

再生音のカレントブロックインデックスの取得

引数:

[in]

id

再生ID

戻り値:

CriAtomExBlockIndex カレントブロックインデックス

説明:

criAtomExPlayer_Start 関数で再生されたブロックシーケンスの カレントブロックインデックスを取得します。

備考:

再生IDにより再生しているデータがブロックシーケンスではない場合は、 CRIATOMEX_INVALID_BLOCK_INDEX が返ります。

参照:

criAtomExPlayer_Start, criAtomExPlayer_SetFirstBlockIndex, criAtomExPlayback_SetNextBlockIndex

再生トラック情報の取得

引数:

[in]	id	再生ID
[out]	info	再生トラック情報

戻り値:

CriBool 成功／失敗

説明:

再生中のキューのトラック情報を取得します。
取得できるトラック情報はキュー直下の情報だけです、サブシーケンスやキューリンクの情報は取得できません。

備考:

以下に該当するデータを再生中の場合、トラック情報の取得に失敗します。

• キュー以外のデータを再生している。（トラック情報が存在しないため）
  
• 再生中のキューがポリフォニックタイプ、またはセレクター参照のスイッチタイプである。（トラック情報が複数存在する可能性があるため）
  
• 再生中のキューがトラック遷移タイプである。（遷移により再生トラックが変わるため）
  

ビート同期情報の取得

引数:

[in]	id	再生ID
[out]	info	ビート同期情報

戻り値:

CriBool 成功／失敗

説明:

再生中のキューのビート同期情報を取得します。
現在のBPM、小節のカウント、拍のカウント、拍の進捗割合(0.0〜1.0)を取得することができます。
キューにはビート同期情報が設定されている必要があります。
キューリンクやスタートアクションで再生しているキューの情報は取得できません。

備考:

以下に該当するデータを再生中の場合、ビート同期情報の取得に失敗します。

• キュー以外のデータを再生している。（ビート同期情報が存在しないため）
  
• ビート同期情報が設定されていないキューを再生している。
  
• ビート同期情報が設定されているキューを"間接的"に再生している。（キューリンクやスタートアクションで再生している）
  

ビート同期オフセットの設定

引数:

[in]	id	再生ID
[in]	time_ms	オフセット時間

戻り値:

CriBool 成功／失敗

説明:

再生中のキューのビート同期オフセットを設定します。
キューにはビート同期情報が設定されている必要があります。
キューリンクやスタートアクションで再生しているキューへの設定はできません。

備考:

以下に該当するデータを再生中の場合、ビート同期オフセットの設定に失敗します。

• キュー以外のデータを再生している。（ビート同期情報が存在しないため）
  
• ビート同期情報が設定されていないキューを再生している。
  
• ビート同期情報が設定されているキューを"間接的"に再生している。（キューリンクやスタートアクションで再生している）