必要な権限
このAPIでは、特定の操作に特定の権限が必要です。使用される型
以下を参照してくださいコンストラクタ
new AudioPlaybackStream()
new AudioPlaybackStream(id): AudioPlaybackStream
パラメーター
id
number
内部ストリーム識別子
戻り値
AudioPlaybackStreamプロパティ
streamId
streamId:number
メソッド
duckVolumeAsync()
duckVolumeAsync(mode:Int32, value: Int32, rampDurationMs: Int32): Promise<Int32>
ダッキングのためにストリームの音量を調整します。EXPLICITダッキングポリシーを使用する場合にのみ有効になります。
パラメーター
mode
Int32
(0) または (1)
value
Int32
下げることができる音量:
DBの場合:0~144dBPERCENTAGEの場合:0~100%
rampDurationMs
Int32
現在の音量がターゲットの音量になるまでの時間(ミリ秒単位)。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- (0):音量がダッキングされました
- (-3):ストリームが初期化されていません
- (-2):パラメーターが無効です
- (-8):ダッキングポリシーが正しくありません
例
flushAsync()
flushAsync():Promise<AudioStatus>
再生状態を変更せずに、バッファリングされたすべてのデータをフラッシュします。
戻り値
Promise<AudioStatus>
Promise:以下に解決されるプロミスオブジェクト:
- (0):フラッシュされました
- (-3):ストリームが初期化されていません
- (-8):再生中はフラッシュできません
- (-5):サーバー通信エラー
例
getAudioAttributesAsync()
getAudioAttributesAsync():Promise<AudioAttributes>
再生ストリームの現在のオーディオ属性を取得します。
戻り値
Promise<AudioAttributes>
Promise:以下を含むオブジェクトに解決されるプロミスオブジェクト:
contentType:再生中のコンテンツのタイプusage:ストリームの使用カテゴリーflags:現在の動作のフラグ。または、次の値で拒否します。- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getAudioConfigAsync()
getAudioConfigAsync():Promise<AudioConfig>
再生ストリームの現在のオーディオ構成を取得します。
戻り値
Promise<AudioConfig>
Promise:以下を含むオブジェクトに解決されるプロミスオブジェクト:
sampleRate:Hz単位の現在のサンプルレートchannelMask:現在のチャネル構成format:現在のサンプルフォーマット。または、次の値で拒否します。- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getAudioEffectSessionIdAsync()
getAudioEffectSessionIdAsync():Promise<Int32>
このストリームに関連付けられているカスタムオーディオエフェクトセッションIDを取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:エフェクトセッションID
- (-3):ストリームが初期化されていません
- (-2):エフェクトセッションが割り当てられていません
getAudioFocusSessionIdAsync()
getAudioFocusSessionIdAsync():Promise<Int32>
このストリームに関連付けられているオーディオフォーカスセッションIDを取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:フォーカスセッションID
- (-3):ストリームが初期化されていません
- (-2):フォーカスセッションが割り当てられていません
例
getBufferCountAsync()
getBufferCountAsync():Promise<Int32>
このストリームに構成されているバッファ数を取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:バッファ数
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
getChannelCountAsync()
getChannelCountAsync():Promise<Int32>
再生ストリームのチャネル数を取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:チャネル数
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getDuckingPolicyAsync()
getDuckingPolicyAsync():Promise<Int32>
ストリームの現在のダッキングポリシーを取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- (0):システムが自動的にダッキングを処理します
- (1):アプリケーションがダッキングを処理する必要があります
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getFramesPerBufferAsync()
getFramesPerBufferAsync():Promise<Int32>
このストリームに構成されているバッファあたりのフレーム数を取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:バッファあたりのフレーム数
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getLatencyInMsAsync()
getLatencyInMsAsync():Promise<Int32>
再生ストリームの現在のレイテンシをミリ秒単位で取得します。これには、バッファとハードウェアレイテンシの両方が含まれます。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:ミリ秒単位のレイテンシ
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getMajorVersion()
static getMajorVersion(): number
実装のメジャーバージョン番号を取得します。バージョンの確認に使用できます。
戻り値
number
number:メジャーバージョン番号を取得します。
getMinorVersion()
static getMinorVersion(): number
実装のマイナーバージョン番号を取得します。バージョンの確認に使用できます。
戻り値
number
number:マイナーバージョン番号を取得します。
getNumBytesInPipelineAsync()
getNumBytesInPipelineAsync():Promise<Int32>
再生パイプラインで現在再生待ちの状態にあるバイト数を取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:パイプラインにあるバイトの数
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getNumBytesOfNativeBufferAsync()
getNumBytesOfNativeBufferAsync():Promise<Int32>
再生に使用されるネイティブバッファのサイズを取得します。再生用にキューに入れることができるデータの最大量を表します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:バイト単位のバッファサイズ
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getPatchVersion()
static getPatchVersion(): number
実装のパッチバージョン番号を取得します。バージョンの確認に使用できます。
戻り値
number
number:パッチバージョン番号
getPresentedFrameCountAsync()
getPresentedFrameCountAsync():Promise<Int32>
再生されたフレームの総数を取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:成功時にオーディオパイプラインに再生されるフレーム数。
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getSampleRateAsync()
getSampleRateAsync():Promise<Int32>
再生ストリームのサンプルレートを取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:Hz単位のサンプルレート
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getSampleSizeAsync()
getSampleSizeAsync():Promise<Int32>
再生ストリームのサンプルサイズをビット単位で取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:ビット単位のサンプルサイズ(例:16、24、32)
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getUnderrunCountAsync()
getUnderrunCountAsync():Promise<Int32>
アンダーランの合計発生回数を取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:ストリームが存続している間のアンダーラン発生回数。
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getUnderrunSizeAsync()
getUnderrunSizeAsync():Promise<Int32>
アンダーランのサイズをフレーム単位で取得します。再生バッファが空になると、アンダーランが発生します。
クライアントがバッファーアンダーランしきい値を設定しており、再生バッファーがアンダーラン状態の場合、このAPIはバッファーサイズとしきい値の差を返します。
それ以外の場合、このAPIは0を返します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:バッファサイズとアンダーランしきい値のフレーム数の差。フレーム数は切り上げられます。
-
0:アンダーランなし - (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
getVolumeAsync()
getVolumeAsync():Promise<Int32>
ストリームの現在の音量レベルを取得します。
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- 0~100:現在の音量レベル
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
initCheckAsync()
initCheckAsync():Promise<AudioStatus>
再生ストリームが適切に初期化されているか確認します。ストリームを確実に準備するには、ほかのメソッドを使用する前に呼び出す必要があります。
戻り値
Promise<AudioStatus>
Promise:以下に解決されるプロミスオブジェクト:
- (0):ストリームは適切に初期化されています
- (-3):ストリームが初期化されていません
- (-5):サーバー通信エラー
例
pauseAsync()
pauseAsync():Promise<AudioStatus>
ストリームの再生を一時停止します。バッファ内のデータが保持されるため、再生を再開できます。
戻り値
Promise<AudioStatus>
Promise:以下に解決されるプロミスオブジェクト:
- (0):一時停止されました
- (-3):ストリームが初期化されていません
- (-8):ストリームは既に一時停止されています
- (-5):サーバー通信エラー
例
queryMinimumBufferInfoAsync()
queryMinimumBufferInfoAsync():Promise<Object>
最小バッファ情報を取得します
戻り値
Promise<Object>
minFramesPerBufferフィールドとminBufferCountフィールドのあるプロミスオブジェクト
registerEventObserverAsync()
registerEventObserverAsync(callback:(value: any) => void): Promise<AudioStatus>
再生ストリームイベントを受け取るコールバックを登録します。一度に登録できるコールバックは1つだけです。
パラメーター
callback
(value: any) => void
イベントを受け取る関数。イベントには以下のものがあります。
- (0):ストリームが失敗しました
- (1):ストリームが障害から回復しました
- (2):再生が停止しました
- (3):ストリームのミュート状態が変更されました
- (4):バッファアンダーランが発生しました
戻り値
Promise<AudioStatus>
Promise:以下に解決されるプロミスオブジェクト:
- (0):コールバックが登録されました
- (-3):ストリームが初期化されていません
- (-2):コールバックが無効です
- (-4):コールバックは既に登録されています
例
setVolumeAsync()
setVolumeAsync(gain:Int32): Promise<Int32>
個々のストリームの音量を絶対ゲイン(パーセンテージ)で設定します。設定されたゲインがストリームの音量に乗算されます。システム音量とは別の設定になります。
パラメーター
gain
Int32
音量レベル(0~100)
戻り値
Promise<Int32>
Promise:以下に解決されるプロミスオブジェクト:
- (0):音量が設定されました
- (-3):ストリームが初期化されていません
- (-2):ゲイン値が無効です
- (-5):サーバー通信エラー
例
setVolumeWithFadeAsync()
setVolumeWithFadeAsync(volume:Int32, duration: Int32, fadeType: AudioFadeType): Promise<Int32>
ストリームの音量をフェード効果付きで設定します。
パラメーター
volume
Int32
ターゲット音量(0~100)
duration
Int32
持続時間(ミリ秒)
fadeType
AudioFadeType フェードカーブタイプ戻り値
Promise<Int32>
Promise:フェードが開始されたときに解決されるプロミスオブジェクト
- (0):音量が設定されました
- (-3):ストリームが初期化されていません
- (-2):ゲイン値が無効です
- (-5):サーバー通信エラー
startAsync()
startAsync():Promise<AudioStatus>
ストリームの再生を開始または再開します。
戻り値
Promise<AudioStatus>
Promise:以下に解決されるプロミスオブジェクト:
- (0):開始されました
- (-3):ストリームが初期化されていません
- (-8):ストリームは既に再生されています
- (-5):サーバー通信エラー
例
stopAsync()
stopAsync():Promise<AudioStatus>
再生を停止し、すべてのバッファをクリアします。バッファリングされたデータをすべて破棄します。
戻り値
Promise<AudioStatus>
Promise:以下に解決されるプロミスオブジェクト:
- (0):停止しました
- (-3):ストリームが初期化されていません
- (-8):ストリームは既に停止しています
- (-5):サーバー通信エラー
例
unregisterEventObserverAsync()
unregisterEventObserverAsync():Promise<AudioStatus>
以前に登録されたイベントコールバックの登録を解除します。
戻り値
Promise<AudioStatus>
Promise:以下に解決されるプロミスオブジェクト:
- (0):コールバックの登録が解除されました
- (-3):ストリームが初期化されていません
- (-2):登録されているコールバックはありません
例
writeAsync()
writeAsync(buffer:ArrayBuffer): Promise<AudioStatus>
オーディオデータを再生バッファに書き込みます。
パラメーター
buffer
ArrayBuffer
書き込むオーディオデータ
戻り値
Promise<AudioStatus>
Promise:以下に解決されるプロミスオブジェクト:
- 正の値:書き込まれたバイト数
- (-3):ストリームが初期化されていません
- (-2):バッファが無効です
- (-8):書き込み操作が失敗しました
- (-6):バッファがいっぱいです
- (-5):サーバー通信エラー

