Struct CriAtomExPlayback
再生ID
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public readonly struct CriAtomExPlayback
Remarks
説明: Start() 関数実行時に返されるIDです。 プレーヤー単位ではなく、 Start() 関数で再生した個々の音声に対して パラメーター変更や状態取得を行いたい場合、本IDを使用して制御を行う必要があります。 無効な再生IDはInvalidPlaybackIdです。
Properties
NativeHandle
ネイティブハンドル
Declaration
public uint NativeHandle { get; }
Property Value
Type | Description |
---|---|
uint |
Methods
GetAisacControlById(uint, out float)
AISACコントロール値の取得(コントロールID指定)
Declaration
public bool GetAisacControlById(uint controlId, out float controlValue)
Parameters
Type | Name | Description |
---|---|---|
uint | controlId | コントロールID |
float | controlValue | コントロール値(0.0f~1.0f)、未設定時は-1.0f |
Returns
Type | Description |
---|---|
bool | true = 取得できた、 false = 取得できなかった) |
Remarks
説明: Start() 関数で再生された音声に設定されているAISACコントロール値を、コントロールID指定で取得します。 AISACコントロール値が取得できた場合(未設定時も「-1.0fが取得できた」と扱われます)、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。
注意: 本関数は、音声再生中のみAISACコントロール値を取得可能です。 再生終了後や、発音数制御によりボイスが消去された場合には、 AISACコントロール値の取得に失敗します。
See Also
GetAisacControlByName(ArgString, out float)
AISACコントロール値の取得(コントロール名指定)
Declaration
public bool GetAisacControlByName(ArgString controlName, out float controlValue)
Parameters
Type | Name | Description |
---|---|---|
ArgString | controlName | コントロール名 |
float | controlValue | コントロール値(0.0f~1.0f)、未設定時は-1.0f |
Returns
Type | Description |
---|---|
bool | true = 取得できた、 false = 取得できなかった) |
Remarks
説明: Start() 関数で再生された音声に設定されているAISACコントロール値を、コントロール名指定で取得します。 AISACコントロール値が取得できた場合(未設定時も「-1.0fが取得できた」と扱われます)、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。
注意: 本関数は、音声再生中のみAISACコントロール値を取得可能です。 再生終了後や、発音数制御によりボイスが消去された場合には、 AISACコントロール値の取得に失敗します。
See Also
GetAtomPlayer()
Atomプレーヤーの取得
Declaration
public CriAtomPlayer GetAtomPlayer()
Returns
Type | Description |
---|---|
CriAtomPlayer | Atomプレーヤーオブジェクト |
Remarks
説明: 再生IDに紐づけられたボイス(=Atomプレーヤーオブジェクト)を取得します。
備考: 複数の波形データを含むキューを再生している場合、 本関数は最初に見つかったボイスに対応するAtomプレーヤーオブジェクトを返します。 波形データが再生されていない場合、本関数はnullを返します。
GetBeatSyncInfo(out Info)
ビート同期情報の取得
Declaration
public bool GetBeatSyncInfo(out CriAtomExBeatSync.Info info)
Parameters
Type | Name | Description |
---|---|---|
CriAtomExBeatSync.Info | info | ビート同期情報 |
Returns
Type | Description |
---|---|
bool | 成功/失敗 |
Remarks
説明: 再生中のキューのビート同期情報を取得します。 現在のBPM、小節のカウント、拍のカウント、拍の進捗割合(0.0~1.0)を取得することができます。 キューにはビート同期情報が設定されている必要があります。 キューリンクやスタートアクションで再生しているキューの情報は取得できません。
備考: 以下に該当するデータを再生中の場合、ビート同期情報の取得に失敗します。 - キュー以外のデータを再生している。(ビート同期情報が存在しないため) - ビート同期情報が設定されていないキューを再生している。 - ビート同期情報が設定されているキューを"間接的"に再生している。(キューリンクやスタートアクションで再生している)
GetCurrentBlockIndex()
再生音のカレントブロックインデックスの取得
Declaration
public int GetCurrentBlockIndex()
Returns
Type | Description |
---|---|
int | カレントブロックインデックス |
Remarks
説明: Start() 関数で再生されたブロックシーケンスの カレントブロックインデックスを取得します。
備考: 再生IDにより再生しているデータがブロックシーケンスではない場合は、 InvalidBlockIndex が返ります。
See Also
GetFormatInfo(out FormatInfo)
再生音声のフォーマット情報の取得
Declaration
public bool GetFormatInfo(out CriAtomEx.FormatInfo info)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.FormatInfo | info | フォーマット情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか( true = 取得できた、 false = 取得できなかった) |
Remarks
説明: Start() 関数で再生された音声のフォーマット情報を取得します。 フォーマット情報が取得できた場合、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。
備考: 複数の音声データを含むキューを再生した場合、最初に見つかった音声 データの情報が返されます。
注意: 本関数は、音声再生中のみフォーマット情報を取得可能です。 再生準備中や再生終了後、発音数制御によりボイスが消去された場合には、 フォーマット情報の取得に失敗します。 ボイスの再生状態は GetStatus() 関数で取得することはできないためご注意ください。
See Also
GetNumPlayedSamples(out long, out int)
再生サンプル数の取得
Declaration
public bool GetNumPlayedSamples(out long numSamples, out int samplingRate)
Parameters
Type | Name | Description |
---|---|---|
long | numSamples | 再生済みサンプル数 |
int | samplingRate | サンプリングレート |
Returns
Type | Description |
---|---|
bool | サンプル数が取得できたかどうか( true = 取得できた、 false = 取得できなかった) |
Remarks
説明: Start() 関数で再生された音声の再生サンプル数、 およびサンプリングレートを返します。 再生サンプル数が取得できた場合、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。 (エラー発生時は num_samples や sampling_rate の値も負値になります。)
備考: 再生済みサンプル数の値の精度は、プラットフォーム SDK のサウンドライブラリに依存します。 (プラットフォームによって、再生済みサンプル数の正確さは異なります。) 複数の音声データを含むキューを再生した場合、最初に見つかった音声 データの情報が返されます。
注意: ドライブでリードリトライ処理等が発生し、音声データの供給が途切れた場合、 再生サンプル数のカウントアップが停止します。 (データ供給が再開されれば、カウントアップが再開されます。) 本関数は、音声再生中のみ再生サンプル数を取得可能です。 再生終了後や、発音数制御によりボイスが消去された場合には、 再生サンプル数の取得に失敗します。
See Also
GetNumRenderedSamples(out long, out int)
サウンドバッファーへの書き込みサンプル数の取得
Declaration
public bool GetNumRenderedSamples(out long numSamples, out int samplingRate)
Parameters
Type | Name | Description |
---|---|---|
long | numSamples | 書き込み済みサンプル数 |
int | samplingRate | サンプリングレート |
Returns
Type | Description |
---|---|
bool | サンプル数が取得できたかどうか( true = 取得できた、 false = 取得できなかった) |
Remarks
説明: Start() 関数で再生された音声について、 サウンドバッファーへの書き込み済みサンプル数、およびサンプリングレートを返します。 本関数は GetNumPlayedSamples(out long, out int) 関数と異なり、 サウンドバッファーに書き込まれた未出力の音声データのサンプル数を含む値を返します。 書き込み済みサンプル数が取得できた場合、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。 (エラー発生時は num_samples や sampling_rate の値も負値になります。)
備考: 書き込み済みサンプル数の値の精度は、プラットフォーム SDK のサウンドライブラリに依存します。 (プラットフォームによって、書き込み済みサンプル数の正確さは異なります。) 複数の音声データを含むキューを再生した場合、最初に見つかった音声 データの情報が返されます。
注意: ドライブでリードリトライ処理等が発生し、音声データの供給が途切れた場合、 書き込み済みサンプル数のカウントアップが停止します。 (データ供給が再開されれば、カウントアップが再開されます。) 本関数は、音声再生中のみ書き込み済みサンプル数を取得可能です。 再生終了後や、発音数制御によりボイスが消去された場合には、 書き込み済みサンプル数の取得に失敗します。
See Also
GetParameterFloat32(ParameterId, out float)
パラメータの取得(浮動小数点数)
Declaration
public bool GetParameterFloat32(CriAtomEx.ParameterId parameterId, out float valueFloat32)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.ParameterId | parameterId | パラメーターID |
float | valueFloat32 | パラメーター設定値 |
Returns
Type | Description |
---|---|
bool | true = 取得できた、 false = 取得できなかった) |
Remarks
説明: Start() 関数で再生された音声に設定されている各種パラメーターの値を取得します。 値は浮動小数点数で取得されます。 パラメーターが取得できた場合、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。
注意: 本関数は、音声再生中のみパラメーターを取得可能です。 再生終了後や、発音数制御によりボイスが消去された場合には、 パラメーターの取得に失敗します。
See Also
GetParameterSint32(ParameterId, out int)
パラメーターの取得(符号付き整数)
Declaration
public bool GetParameterSint32(CriAtomEx.ParameterId parameterId, out int valueSint32)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.ParameterId | parameterId | パラメーターID |
int | valueSint32 | パラメーター設定値 |
Returns
Type | Description |
---|---|
bool | true = 取得できた、 false = 取得できなかった) |
Remarks
説明: Start() 関数で再生された音声に設定されている各種パラメーターの値を取得します。 値は符号付き整数で取得されます。 パラメーターが取得できた場合、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。
注意: 本関数は、音声再生中のみパラメーターを取得可能です。 再生終了後や、発音数制御によりボイスが消去された場合には、 パラメーターの取得に失敗します。
See Also
GetParameterUint32(ParameterId, out uint)
パラメーターの取得(符号なし整数)
Declaration
public bool GetParameterUint32(CriAtomEx.ParameterId parameterId, out uint valueUint32)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.ParameterId | parameterId | パラメーターID |
uint | valueUint32 | パラメーター設定値 |
Returns
Type | Description |
---|---|
bool | true = 取得できた、 false = 取得できなかった) |
Remarks
説明: Start() 関数で再生された音声に設定されている各種パラメーターの値を取得します。 値は符号なし整数で取得されます。 パラメーターが取得できた場合、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。
注意: 本関数は、音声再生中のみパラメーターを取得可能です。 再生終了後や、発音数制御によりボイスが消去された場合には、 パラメーターの取得に失敗します。
See Also
GetPlaybackTrackInfo(out TrackInfo)
再生トラック情報の取得
Declaration
public bool GetPlaybackTrackInfo(out CriAtomExPlayback.TrackInfo info)
Parameters
Type | Name | Description |
---|---|---|
CriAtomExPlayback.TrackInfo | info | 再生トラック情報 |
Returns
Type | Description |
---|---|
bool | 成功/失敗 |
Remarks
説明: 再生中のキューのトラック情報を取得します。 取得できるトラック情報はキュー直下の情報だけです。サブシーケンスやキューリンクの情報は取得できません。
備考: 以下に該当するデータを再生中の場合、トラック情報の取得に失敗します。 - キュー以外のデータを再生している。(トラック情報が存在しないため) - 再生中のキューがポリフォニックタイプ、またはセレクター参照のスイッチタイプである。(トラック情報が複数存在する可能性があるため) - 再生中のキューがトラック遷移タイプである。(遷移により再生トラックが変わるため)
GetSequencePosition()
シーケンス再生位置の取得
Declaration
public long GetSequencePosition()
Returns
Type | Description |
---|---|
long | シーケンス再生位置(ミリ秒単位) |
Remarks
説明: Start() 関数で再生された音声のシーケンス再生位置を取得します。 再生位置が取得できた場合、本関数は 0 以上の値を返します。 指定したシーケンスが既に消去されている場合等には、本関数は負値を返します。
備考: 本関数が返す再生時刻は「シーケンスデータ上の再生位置」です。 シーケンスループや、ブロック遷移を行った場合は、巻き戻った値が返ります。 キュー指定以外での再生ではシーケンサーが動作しません。キュー再生以外の再生に対して 本関数は負値を返します。 Pause(NativeBool) 関数でポーズをかけた場合、 再生位置の更新も停止します。 (ポーズを解除すれば再度更新が再開されます。) 本関数で取得可能な時刻の精度は、サーバー処理の周波数に依存します。 (時刻の更新はサーバー処理単位で行われます。)
注意: 戻り値の型はCriSint64ですが、現状、32bit以上の精度はありません。 再生位置を元に制御を行う場合、シーケンスループ等の設定がないデータでは約24日で再生位置が異常になる点に注意が必要です。 ( 2147483647 ミリ秒を超えた時点で、再生位置がオーバーフローし、負値になります。) 本関数は、音声再生中のみ位置を取得可能です。 再生終了後や、発音数制御によりシーケンスが消去された場合には、 再生位置の取得に失敗します。 (負値が返ります。)
GetSource(out SourceInfo)
再生音声の再生元情報の取得
Declaration
public bool GetSource(out CriAtomEx.SourceInfo source)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.SourceInfo | source | 再生元情報 |
Returns
Type | Description |
---|---|
bool | = 情報が取得できた |
Remarks
説明: Start() 関数で再生された音声の再生元情報を取得します。 取得した情報を元に、GetCueInfoByIndex(int, out CueInfo) 関数等を利用することで、 より詳細な情報を取得することができます。 再生元情報が取得できた場合、本関数は true を返します。 指定したボイスが既に消去されている場合等には、本関数は false を返します。
備考 再生元のタイプによって、取得できる情報が異なります。 typeを参照し、共用体sourceの中のどの構造体としてアクセスするかを選択してください。
注意: 本関数は、音声再生中のみ再生元情報を取得可能です。 再生終了後や、発音数制御によりボイスが消去された場合には、 再生元情報の取得に失敗します。
See Also
GetStatus()
再生ステータスの取得
Declaration
public CriAtomExPlayback.Status GetStatus()
Returns
Type | Description |
---|---|
CriAtomExPlayback.Status | 再生ステータス |
Remarks
説明: Start() 関数で再生された音声のステータスを取得します。
備考: GetStatus() 関数がAtomExプレーヤーのステータスを返すのに対し、 本関数は再生済みの個々の音声のステータスを取得します。 再生中の音声のボイスリソースは、以下の場合に削除されます。 - 再生が完了した場合。 - Stop() 関数で再生中の音声を停止した場合。 - 高プライオリティの発音リクエストにより再生中のボイスが奪い取られた場合。 - 再生中にエラーが発生した場合。 そのため、 Stop() 関数を使用して明示的に再生を停止したか、 その他の要因によって再生が停止されたかの違いに関係なく、 再生音のステータスはいずれの場合も Removed に遷移します。 (エラーの発生を検知する必要がある場合には、本関数ではなく、GetStatus() 関数で AtomEx プレーヤーのステータスをチェックする必要があります。)
See Also
GetTime()
再生時刻の取得
Declaration
public long GetTime()
Returns
Type | Description |
---|---|
long | 再生時刻(ミリ秒単位) |
Remarks
説明: Start() 関数で再生された音声の再生時刻を取得します。 再生時刻が取得できた場合、本関数は 0 以上の値を返します。 指定したボイスが既に消去されている場合等には、本関数は負値を返します。
備考: 本関数が返す再生時刻は「再生開始後からの経過時間」です。 ループ再生時や、シームレス連結再生時を行った場合でも、 再生位置に応じて時刻が巻き戻ることはありません。 Pause(NativeBool) 関数でポーズをかけた場合、 再生時刻のカウントアップも停止します。 (ポーズを解除すれば再度カウントアップが再開されます。) 本関数で取得可能な時刻の精度は、サーバー処理の周波数に依存します。 (時刻の更新はサーバー処理単位で行われます。) より精度の高い時刻を取得する必要がある場合には、本関数の代わりに GetNumPlayedSamples(out long, out int) 関数を使用し、 再生済みサンプル数を取得してください。
注意: 戻り値の型はCriSint64ですが、現状、32bit以上の精度はありません。 再生時刻を元に制御を行う場合、約24日で再生時刻が異常になる点に注意が必要です。 ( 2147483647 ミリ秒を超えた時点で、再生時刻がオーバーフローし、負値になります。) 本関数は、音声再生中のみ時刻を取得可能です。 ( GetTime() 関数と異なり、本関数は再生中の音声ごとに時刻を 取得可能ですが、再生終了時刻を取ることができません。) 再生終了後や、発音数制御によりボイスが消去された場合には、 再生時刻の取得に失敗します。 (負値が返ります。) ドライブでリードリトライ処理等が発生し、一時的に音声データの供給が途切れた場合でも、 再生時刻のカウントアップが途切れることはありません。 (データ供給停止により再生が停止した場合でも、時刻は進み続けます。) そのため、本関数で取得した時刻を元に映像との同期を行った場合、 リードリトライ発生毎に同期が大きくズレる可能性があります。 波形データと映像の同期を厳密に取る必要がある場合は、本関数の代わりに GetNumPlayedSamples(out long, out int) 関数を使用し、 再生済みサンプル数との同期を取ってください。
See Also
GetTimeSyncedWithAudio()
再生時刻の取得(再生音声に同期した補正込み)
Declaration
public long GetTimeSyncedWithAudio()
Returns
Type | Description |
---|---|
long | 再生時刻(ミリ秒単位) |
Remarks
説明: Start() 関数で再生された音声の再生時刻を取得します。 再生時刻が取得できた場合、本関数は 0 以上の値を返します。 指定したボイスが既に消去されている場合等には、本関数は負値を返します。
備考: GetTime() 関数が返す「再生開始後からの経過時間」とは 異なり、本関数からは再生中の音声に同期した再生時刻を取得することが 可能です。 デバイスのリードリトライ処理等により音声データの供給が途切れて 再生が停止した場合、またはシステムの割り込みにより音声出力が妨げられた 場合には、再生時刻のカウントアップが一時的に停止します。 再生された音声に厳密に同期した処理を行いたい場合は、本関数で 取得した再生時刻を用いてください。 ただし、ループ再生時や、シームレス連結再生時に行った場合でも、 再生位置に応じて時刻が巻き戻ることはありません。 また、波形の詰まっていないシーケンスキューや 再生波形が切り替わるブロックシーケンスキューに対しては、正常に再生時刻を 取得することができません。 Pause(NativeBool) 関数でポーズをかけた場合、 再生時刻のカウントアップも停止します。 (ポーズを解除すれば再度カウントアップが再開されます。) 本関数による再生時刻の取得を行う場合は、対応するAtomExプレーヤー作成時に、 CriAtomExPlayer.Config 構造体の enable_audio_synced_timer を true に 設定してください。 デフォルトでは無効になっています。 戻り値の型は long ですが、現状、32bit以上の精度はありません。 再生時刻を元に制御を行う場合、約24日で再生時刻が異常になる点に注意が必要です。 ( 2147483647 ミリ秒を超えた時点で、再生時刻がオーバーフローし、負値になります。) 本関数は、音声再生中のみ時刻を取得可能です。 ( GetTime() 関数と異なり、本関数は再生中の音声ごとに時刻を 取得可能ですが、再生終了時刻を取ることができません。) 再生終了後や、発音数制御によりボイスが消去された場合には、 再生時刻の取得に失敗します。 (負値が返ります。) 本関数は内部で時刻計算を行っており、プラットフォームによっては処理負荷が 問題になる可能性があります。また、アプリケーションの同じフレーム内であっても、 呼び出し毎に更新された時刻を返します。 アプリケーションによる再生時刻の利用方法にもよりますが、基本的に本関数を用いた 時刻取得は1フレームにつき一度のみ行うようにしてください。
See Also
GetTimeSyncedWithAudioMicro()
再生時刻の取得(再生音声に同期した補正込み)
Declaration
public long GetTimeSyncedWithAudioMicro()
Returns
Type | Description |
---|---|
long | 再生時刻(マイクロ秒単位) |
Remarks
説明: Start() 関数で再生された音声の再生時刻を取得します。 再生時刻が取得できた場合、本関数は 0 以上の値を返します。 指定したボイスが既に消去されている場合等には、本関数は負値を返します。
備考: GetTime() 関数が返す「再生開始後からの経過時間」とは 異なり、本関数からは再生中の音声に同期した再生時刻を取得することが 可能です。 デバイスのリードリトライ処理等により音声データの供給が途切れて 再生が停止した場合、またはシステムの割り込みにより音声出力が妨げられた 場合には、再生時刻のカウントアップが一時的に停止します。 再生された音声に厳密に同期した処理を行いたい場合は、本関数で 取得した再生時刻を用いてください。 ただし、ループ再生時や、シームレス連結再生時に行った場合でも、 再生位置に応じて時刻が巻き戻ることはありません。 また、波形の詰まっていないシーケンスキューや 再生波形が切り替わるブロックシーケンスキューに対しては、正常に再生時刻を 取得することができません。 Pause(NativeBool) 関数でポーズをかけた場合、 再生時刻のカウントアップも停止します。 (ポーズを解除すれば再度カウントアップが再開されます。) 本関数による再生時刻の取得を行う場合は、対応するAtomExプレーヤー作成時に、 CriAtomExPlayer.Config 構造体の enable_audio_synced_timer を true に 設定してください。 デフォルトでは無効になっています。 本関数は、音声再生中のみ時刻を取得可能です。 ( GetTime() 関数と異なり、本関数は再生中の音声ごとに時刻を 取得可能ですが、再生終了時刻を取ることができません。) 再生終了後や、発音数制御によりボイスが消去された場合には、 再生時刻の取得に失敗します。 (負値が返ります。) 本関数は内部で時刻計算を行っており、プラットフォームによっては処理負荷が 問題になる可能性があります。また、アプリケーションの同じフレーム内であっても、 呼び出し毎に更新された時刻を返します。 アプリケーションによる再生時刻の利用方法にもよりますが、基本的に本関数を用いた 時刻取得は1フレームにつき一度のみ行うようにしてください。
See Also
IsPaused()
再生音のポーズ状態の取得
Declaration
public bool IsPaused()
Returns
Type | Description |
---|---|
bool | ポーズ中かどうか(false = ポーズされていない、true = ポーズ中) |
Remarks
説明: 再生中の音声がポーズ中かどうかを返します。
See Also
Pause(NativeBool)
再生音のポーズ/ポーズ解除
Declaration
public void Pause(NativeBool sw)
Parameters
Type | Name | Description |
---|---|---|
NativeBool | sw | スイッチ( false = ポーズ解除、 true = ポーズ ) |
Remarks
説明: 再生音単位でポーズ/ポーズ解除を行います。 sw に true を指定して本関数を実行すると、指定したIDの音声がポーズ (一時停止)されます。 sw に false を指定して本関数を実行すると、指定したIDの音声のポーズが 解除され、一時停止していた音声の再生が再開されます。 本関数を使用することで、プレーヤーによって再生された音声を、プレーヤー単位ではなく、 個別にポーズ/ポーズ解除させることが可能です。
備考: プレーヤーによって再生された全ての音声をポーズ/ポーズ解除したい場合、 本関数ではなく Pause(NativeBool) 関数をご利用ください。 フェーダーをアタッチしたプレーヤーで再生した音声に対して本関数で個別にポーズ/ポーズ解除の操作を行った場合、 クロスフェード処理はフェードイン側の音声のポーズ状態に同期して行われます。 例えば、クロスフェード中にPause(NativeBool) 関数で両方の音声をポーズした場合、 フェードイン側の音声のポーズを解除すればクロスフェード処理が再開されますが、 フェードアウト側の音声のポーズを解除してもクロスフェード処理は再開されません。
注意: 第2引数(sw)に false を指定してポーズ解除の操作を行った場合、 本関数でポーズをかけた音声だけでなく、Prepare() 関数で再生準備中の音声についても再生が開始されてしまいます。 (旧バージョンとの互換性維持のための仕様です。) 本関数でポーズをかけた音声についてのみポーズを解除したい場合、 本関数を使用せず、 Resume(ResumeMode)(id, PausedPlayback); を実行してポーズ解除を行ってください。 フェーダーをアタッチしたプレーヤーに対し再生ID指定でポーズの解除を行うと、 フェードインする音声の発音リソースが確保できない場合や、 フェードインする音声の発音リソースが奪い取られた場合にポーズ解除が行えず、 フェードアウト側の音声がいつまで経ってもフェードアウトしない状態となります。 フェーダーをアタッチしたプレーヤーで再生した音声に対しては、本関数ではなく、 Pause(NativeBool) 関数でポーズの解除を行ってください。
See Also
Resume(ResumeMode)
再生音の機能別のポーズ解除
Declaration
public void Resume(CriAtomEx.ResumeMode mode)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.ResumeMode | mode | ポーズ解除対象 |
Remarks
説明: 再生音単位で一時停止状態の解除を行います。 Pause(NativeBool) 関数と異なり、 Prepare() 関数で再生開始待ちの音声と、 Pause(NativeBool) 関数(または Pause(NativeBool) 関数でポーズをかけた音声とを、 個別に再開させることが可能です。 第2引数(mode)に PausedPlayback を指定して本関数を実行すると、 ユーザが Pause(NativeBool) 関数(または Pause(NativeBool) 関数)で一時停止状態になった音声の再生が再開されます。 第2引数(mode)に PreparedPlayback を指定して本関数を実行すると、 ユーザが Prepare() 関数で再生準備を指示した音声の再生が開始されます。 Pause(NativeBool) 関数でポーズ状態のプレーヤーに対して Prepare() 関数で再生準備を行った場合、 その音声は PausedPlayback 指定のポーズ解除処理と、 PreparedPlayback 指定のポーズ解除処理の両方が行われるまで、再生が開始されません。
備考: フェーダーをアタッチしたプレーヤーで再生した音声に対して本関数で個別にポーズ解除の操作を行った場合、 クロスフェード処理はフェードイン側の音声のポーズ状態に同期して行われます。 例えば、クロスフェード中にPause(NativeBool) 関数で両方の音声をポーズした場合、 フェードイン側の音声のポーズを解除すればクロスフェード処理が再開されますが、 フェードアウト側の音声のポーズを解除してもクロスフェード処理は再開されません。
注意: フェーダーをアタッチしたプレーヤーに対し再生ID指定でポーズの解除を行うと、 フェードインする音声の発音リソースが確保できない場合や、 フェードインする音声の発音リソースが奪い取られた場合にポーズ解除が行えず、 フェードアウト側の音声がいつまで経ってもフェードアウトしない状態となります。 フェーダーをアタッチしたプレーヤーで再生した音声に対しては、本関数ではなく、 Pause(NativeBool) 関数でポーズの解除を行ってください。
See Also
SetBeatSyncOffset(short)
ビート同期オフセットの設定
Declaration
public bool SetBeatSyncOffset(short timeMs)
Parameters
Type | Name | Description |
---|---|---|
short | timeMs | オフセット時間 |
Returns
Type | Description |
---|---|
bool | 成功/失敗 |
Remarks
説明: 再生中のキューのビート同期オフセットを設定します。 キューにはビート同期情報が設定されている必要があります。 キューリンクやスタートアクションで再生しているキューへの設定はできません。
備考: 以下に該当するデータを再生中の場合、ビート同期オフセットの設定に失敗します。 - キュー以外のデータを再生している。(ビート同期情報が存在しないため) - ビート同期情報が設定されていないキューを再生している。 - ビート同期情報が設定されているキューを"間接的"に再生している。(キューリンクやスタートアクションで再生している)
SetNextBlockIndex(int)
再生音のブロック遷移
Declaration
public void SetNextBlockIndex(int index)
Parameters
Type | Name | Description |
---|---|---|
int | index | ブロックインデックス |
Remarks
説明: 再生音単位でブロック遷移を行います。 本関数を実行すると、指定したIDの音声がブロックシーケンスの場合はデータの 設定に従った任意の遷移タイミングで指定ブロックに遷移します。
備考: 再生開始ブロックの指定は SetFirstBlockIndex(int) 関数を使用して行い、 再生中のブロックインデックス取得は GetCurrentBlockIndex() 関数を使用します。
See Also
Stop()
再生音の停止
Declaration
public void Stop()
Remarks
説明: 再生音単位で停止処理を行います。 本関数を使用することで、プレーヤーによって再生された音声を、プレーヤー単位ではなく、 個別に停止させることが可能です。
備考: AtomEx プレーヤーによって再生された全ての音声を停止したい場合、 本関数ではなく Stop() 関数をご利用ください。 ( Stop() 関数は、そのプレーヤーで再生中の全ての音声を停止します。)
注意: 本関数で再生音の停止を行うと、再生中の音声のステータスは Removed に遷移します。 停止時にボイスリソースも破棄されるため、一旦 Removed 状態に遷移した再生 ID からは、以降情報を取得できなくなります。
See Also
StopWithoutReleaseTime()
再生音の停止(リリースタイム無視)
Declaration
public void StopWithoutReleaseTime()
Remarks
説明: 再生音単位で停止処理を行います。 この際、再生中の音声にエンベロープのリリースタイムが設定されていたとしても、それを無視して停止します。 本関数を使用することで、プレーヤーによって再生された音声を、プレーヤー単位ではなく、 個別に停止させることが可能です。
備考: プレーヤーによって再生された全ての音声を停止したい場合、 本関数ではなく StopWithoutReleaseTime() 関数をご利用ください。
注意: 本関数で再生音の停止を行うと、再生中の音声のステータスは Removed に遷移します。 停止時にボイスリソースも破棄されるため、一旦 Removed 状態に遷移した再生 ID からは、以降情報を取得できなくなります。