AudioPlaybackStream

コンストラクタ

new AudioPlaybackStream()

new AudioPlaybackStream(id): AudioPlaybackStream

新しいAudioPlaybackStreamインスタンスを作成します。このコンストラクターは直接呼び出さないでください。AudioPlaybackStreamBuilder.AudioPlaybackStreamBuilder.buildAsyncを使用してインスタンスを作成します。

パラメーター

id

number

内部ストリーム識別子

戻り値

AudioPlaybackStream

プロパティ

streamId

streamId: number

メソッド

duckVolumeAsync()

duckVolumeAsync(mode, value, rampDurationMs): Promise<number>

ダッキングのためにストリームの音量を調整します。EXPLICITダッキングポリシーを使用する場合にのみ有効になります。

パラメーター

mode

number

DB (0)またはPERCENTAGE (1)

value

number

下げることができる音量：

DBの場合： 0～144dB
PERCENTAGEの場合： 0～100%

rampDurationMs

number

目標の音量に達するまでのミリ秒単位の時間

戻り値

Promise<number>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：音量がダッキングされました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_INVALID_OPERATION (-8)：ダッキングポリシーが正しくありません

flushAsync()

flushAsync(): Promise<AudioStatus>

再生状態を変更せずに、バッファリングされたすべてのデータをフラッシュします。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：フラッシュされました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_INVALID_OPERATION (-8)：再生中はフラッシュできません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getAudioAttributesAsync()

getAudioAttributesAsync(): Promise<AudioAttributes>

再生ストリームの現在のオーディオ属性を取得します。

戻り値

Promise<AudioAttributes>

Promiseは、以下を含むAudioAttributesオブジェクトに解決されます。

contentType：再生中のコンテンツのタイプ
usage：ストリームの使用カテゴリー
flags：現在の動作のフラグ。または、次の値で拒否します。
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getAudioConfigAsync()

getAudioConfigAsync(): Promise<AudioConfig>

再生ストリームの現在のオーディオ構成を取得します。

戻り値

Promise<AudioConfig>

Promiseは、以下を含むAudioConfigオブジェクトに解決されます。

sampleRate： Hz単位の現在のサンプルレート
channelMask：現在のチャネル構成
format：現在のサンプルフォーマット。または、次の値で拒否します。
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getAudioEffectSessionIdAsync()

getAudioEffectSessionIdAsync(): Promise<number>

このストリームに関連付けられているカスタムオーディオエフェクトセッションIDを取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：エフェクトセッションID
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_BAD_VALUE (-2)：エフェクトセッションが割り当てられていません

getAudioFocusSessionIdAsync()

getAudioFocusSessionIdAsync(): Promise<number>

このストリームに関連付けられているオーディオフォーカスセッションIDを取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：フォーカスセッションID
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_BAD_VALUE (-2)：フォーカスセッションが割り当てられていません

getBufferCountAsync()

getBufferCountAsync(): Promise<number>

このストリームに構成されているバッファ数を取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：バッファ数
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getChannelCountAsync()

getChannelCountAsync(): Promise<number>

再生ストリームのチャネル数を取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：チャネル数
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getDuckingPolicyAsync()

getDuckingPolicyAsync(): Promise<number>

ストリームの現在のダッキングポリシーを取得します。

戻り値

Promise<number>

Promiseは、types/AudioCoreClientTypes.StreamDuckingPolicyに解決されます。

SYSTEM (0)：システムが自動的にダッキングを処理します
EXPLICIT (1)：アプリケーションがダッキングを処理する必要があります

または、次の値で拒否します。

STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getFramesPerBufferAsync()

getFramesPerBufferAsync(): Promise<number>

このストリームに構成されているバッファあたりのフレーム数を取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：バッファあたりのフレーム数
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getLatencyInMsAsync()

getLatencyInMsAsync(): Promise<number>

再生ストリームの現在のレイテンシをミリ秒単位で取得します。これには、バッファとハードウェアレイテンシの両方が含まれます。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：ミリ秒単位のレイテンシ
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getNumBytesInPipelineAsync()

getNumBytesInPipelineAsync(): Promise<number>

再生パイプラインで現在再生待ちの状態にあるバイト数を取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：パイプラインにあるバイトの数
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getNumBytesOfNativeBufferAsync()

getNumBytesOfNativeBufferAsync(): Promise<number>

再生に使用されるネイティブバッファのサイズを取得します。再生用にキューに入れることができるデータの最大量を表します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：バイト単位のバッファサイズ
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getPresentedFrameCountAsync()

getPresentedFrameCountAsync(): Promise<number>

再生されたフレームの総数を取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：成功時にオーディオパイプラインに再生されるフレーム数。
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getSampleRateAsync()

getSampleRateAsync(): Promise<number>

再生ストリームのサンプルレートを取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値： Hz単位のサンプルレート
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getSampleSizeAsync()

getSampleSizeAsync(): Promise<number>

再生ストリームのサンプルサイズをビット単位で取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：ビット単位のサンプルサイズ（例：16、24、32）
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getUnderrunCountAsync()

getUnderrunCountAsync(): Promise<number>

アンダーランの合計発生回数を取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：ストリームが存続している間のアンダーラン発生回数。
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getUnderrunSizeAsync()

getUnderrunSizeAsync(): Promise<number>

アンダーランのサイズをフレーム単位で取得します。再生バッファが空になると、アンダーランが発生します。

戻り値

Promise<number>

Promiseは以下に解決されます。

正の値：バッファサイズとアンダーランしきい値のフレーム数の差。フレーム数は切り上げられます。
0：アンダーランなし
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getVolumeAsync()

getVolumeAsync(): Promise<number>

ストリームの現在の音量レベルを取得します。

戻り値

Promise<number>

Promiseは以下に解決されます。

0～100：現在の音量レベル
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

initCheckAsync()

initCheckAsync(): Promise<AudioStatus>

再生ストリームが適切に初期化されているか確認します。ストリームを確実に準備するには、ほかのメソッドを使用する前に呼び出す必要があります。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：ストリームは適切に初期化されています
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

pauseAsync()

pauseAsync(): Promise<AudioStatus>

ストリームの再生を一時停止します。バッファ内のデータは保持されます。再生を再開するときはstartAsyncを使用します。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：一時停止されました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_INVALID_OPERATION (-8)：ストリームは既に一時停止されています
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

queryMinimumBufferInfoAsync()

queryMinimumBufferInfoAsync(): Promise<Object>

最小バッファ情報を取得します

戻り値

Promise<Object>

minFramesPerBufferフィールドとminBufferCountフィールドのあるオブジェクト

registerEventObserverAsync()

registerEventObserverAsync(callback): Promise<AudioStatus>

再生ストリームイベントを受け取るコールバックを登録します。一度に登録できるコールバックは1つだけです。

パラメーター

callback

(value) => void

イベントを受け取る関数。イベントには以下のものがあります。

DIED (0)：ストリームが失敗しました
RECOVERED (1)：ストリームが障害から回復しました
STOPPED (2)：再生が停止しました
MUTE_STATE_UPDATE (3)：ストリームのミュート状態が変更されました
FRAME_UNDERRUN (4)：バッファアンダーランが発生しました

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：コールバックが登録されました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_BAD_VALUE (-2)：コールバックが無効です
STATUS_ALREADY_EXISTS (-4)：コールバックは既に登録されています

setVolumeAsync()

setVolumeAsync(gain): Promise<number>

ストリームの音量レベルを設定します。システム音量とは別の設定になります。

パラメーター

gain

number

音量レベル（0～100）

戻り値

Promise<number>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：音量が設定されました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_BAD_VALUE (-2)：ゲイン値が無効です
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

setVolumeWithFadeAsync()

setVolumeWithFadeAsync(volume, duration, fadeType): Promise<number>

ストリームの音量をフェード効果付きで設定します。

パラメーター

volume

number

ターゲット音量（0～100）

duration

number

持続時間（ミリ秒）

fadeType

AudioFadeType

フェードカーブタイプ

戻り値

Promise<number>

フェードが開始されたときに解決されるPromiseです。

STATUS_NO_ERROR (0)：音量が設定されました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_BAD_VALUE (-2)：ゲイン値が無効です
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

startAsync()

startAsync(): Promise<AudioStatus>

ストリームの再生を開始または再開します。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：開始されました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_INVALID_OPERATION (-8)：ストリームは既に再生されています
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

stopAsync()

stopAsync(): Promise<AudioStatus>

再生を停止し、すべてのバッファをクリアします。pauseAsyncとは異なり、バッファリングされたデータをすべて破棄します。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：停止しました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_INVALID_OPERATION (-8)：ストリームは既に停止しています
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

unregisterEventObserverAsync()

unregisterEventObserverAsync(): Promise<AudioStatus>

以前に登録されたイベントコールバックの登録を解除します。

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

STATUS_NO_ERROR (0)：コールバックの登録が解除されました
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_BAD_VALUE (-2)：登録されたコールバックはありません

writeAsync()

writeAsync(buffer): Promise<AudioStatus>

オーディオデータを再生バッファに書き込みます。

パラメーター

buffer

ArrayBuffer

書き込むオーディオデータ

戻り値

Promise<AudioStatus>

Promiseは以下に解決されます。

正の値：書き込まれたバイト数
STATUS_NO_INIT (-3)：ストリームが初期化されていません
STATUS_BAD_VALUE (-2)：バッファが無効です
STATUS_INVALID_OPERATION (-8)：書き込み操作が失敗しました
STATUS_WOULD_BLOCK (-6)：バッファがいっぱいです
STATUS_DEAD_OBJECT (-5)：サーバー通信エラー

getMajorVersion()

static getMajorVersion(): number

AudioPlaybackStream実装のメジャーバージョン番号を取得します。バージョンの確認に使用できます。

戻り値

number

メジャーバージョン番号

getMinorVersion()

static getMinorVersion(): number

AudioPlaybackStream実装のマイナーバージョン番号を取得します。バージョンの確認に使用できます。

戻り値

number

マイナーバージョン番号

getPatchVersion()

static getPatchVersion(): number

AudioPlaybackStream実装のパッチバージョン番号を取得します。バージョンの確認に使用できます。

戻り値

number

パッチのバージョン番号

Last updated: 2025年10月2日