AudioPlaybackStreamBuilder
コンストラクタ
new AudioPlaybackStreamBuilder()
new AudioPlaybackStreamBuilder():
AudioPlaybackStreamBuilder
戻り値
プロパティ
args
args:
Object={}
メソッド
buildAsync()
buildAsync():
Promise<AudioPlaybackStream>
現在のビルダー構成を使用して、新しいAudioPlaybackStreamを作成します。ビルドする前に、setAudioConfigとsetAudioAttributesを呼び出す必要があります。
戻り値
Promise<AudioPlaybackStream>
Promiseは以下に解決されます。
- 成功した場合、新しいAudioPlaybackStreamインスタンス
または、次の値で拒否します。
STATUS_BAD_VALUE (-2)： 必要な構成が見つかりませんSTATUS_NO_INIT (-3)： オーディオシステムが初期化されていませんSTATUS_NO_MEMORY (-1)： リソースを割り当てることができませんでしたSTATUS_DEAD_OBJECT (-5)： サーバー通信エラーSTATUS_INVALID_OPERATION (-8)： 構成の組み合わせが無効です
reset()
reset():
void
すべてのビルダー構成をデフォルト値にリセットします。
ビルダーを再利用して別のストリーム構成を作成する場合に使用できます。
戻り値
void
setAudioAttributes()
setAudioAttributes(
attributes):void
ビルドするストリームのオーディオ属性を設定します。buildAsyncの前に呼び出す必要があります。これらの属性は、ストリームとオーディオフォーカスシステムのやり取りに影響します。
パラメーター
attributes
以下を含むオーディオ属性オブジェクト。
- contentType： types/AudioCoreClientTypes.AudioContentType列挙型から取得したコンテンツのタイプ
- usage： types/AudioCoreClientTypes.AudioUsageType列挙型から取得した使用シナリオ
- flags： types/AudioCoreClientTypes.AudioFlags列挙型から取得した動作フラグ
戻り値
void
setAudioConfig()
setAudioConfig(
config):void
ビルドするストリームのオーディオ構成を設定します。buildAsyncの前に呼び出す必要があります。
パラメーター
config
以下を含むオーディオ構成オブジェクト。
sampleRate： types/AudioCoreClientTypes.AudioSampleRate列挙型から取得したサンプルレート（Hz単位）channelMask： types/AudioCoreClientTypes.AudioChannelMask列挙型から取得したチャネル構成format： types/AudioCoreClientTypes.AudioSampleFormat列挙型から取得したサンプルフォーマット
戻り値
void
setAudioEffectSessionId()
setAudioEffectSessionId(
effectSessionId):void
ストリームのカスタムオーディオエフェクトセッションIDを設定します。これにより、このストリームにカスタムオーディオエフェクトを適用できます。
パラメーター
effectSessionId
number
次から取得したエフェクトセッションID： AudioManager.AudioManager.allocateCustomAudioEffectSessionAsync
戻り値
void
setAudioFocusSessionId()
setAudioFocusSessionId(
focusSessionId):void
ストリームのオーディオフォーカスセッションIDを設定します。これにより、フォーカス管理のために、ストリームを特定のフォーカスセッションに関連付けることができます。
パラメーター
focusSessionId
number
次から取得したフォーカスセッションID：
- AudioFocusManager.AudioFocusManager.createAudioFocusSessionAsync
- AudioFocusManager.AudioFocusManager.getDefaultAudioFocusSessionAsync
- 既存のAudioFocusSession.AudioFocusSession.getAudioSessionId
戻り値
void
setBufferCount()
setBufferCount(
bufferCount):void
ストリームに使用するバッファ数を設定します。バッファを増やすとレイテンシが増加しますが、アンダーランに対する保護は強化されます。
パラメーター
bufferCount
number
バッファ数。0より大きくなければなりません。一般的な値： 2、3、4
戻り値
void
setDuckingPolicy()
setDuckingPolicy(
duckPolicy):void
ストリームのダッキングポリシーを設定します。これにより、オーディオフォーカスがダッキングされたときの音量の下げ方が決まります。
パラメーター
duckPolicy
次のダッキングポリシーがあります。
SYSTEM (0)： システムが自動的に音量を下げますEXPLICIT (1)： アプリケーションがAudioPlaybackStream.duckVolumeAsync呼び出しを使用して音量を下げる必要があります
戻り値
void
setFramesPerBuffer()
setFramesPerBuffer(
framesPerBuffer):void
ストリームのバッファあたりのフレーム数を設定します。値を大きくするとレイテンシが増加しますが、電力効率は向上します。値を小さくするとレイテンシは減少しますが、アンダーランが発生する可能性があります。
パラメーター
framesPerBuffer
number
バッファあたりのフレーム数。0より大きくなければなりません。一般的な値： 256、512、1024、2048
戻り値
void
setUnderrunThreshold()
setUnderrunThreshold(
framesThreshold):void
バッファアンダーランをレポートするしきい値を設定します。再生バッファが空になると、アンダーランが発生します。
パラメーター
framesThreshold
number
フレーム数のしきい値。使用可能なフレームがこの値を下回ると、アンダーランイベントがトリガーされます。0より大きくなければなりません。
戻り値
void
destroyAsync()
staticdestroyAsync(playbackStream):Promise<AudioStatus>
既存のAudioPlaybackStreamを破棄します。これにより、ストリームに関連するすべてのリソースがリリースされます。このメソッドを呼び出した後は、ストリームオブジェクトを使用しないでください。進行中の再生がすべて停止されます。
パラメーター
playbackStream
破棄するストリーム
戻り値
Promise<AudioStatus>
Promiseは以下に解決されます。
STATUS_NO_ERROR (0)： ストリームが破棄されましたSTATUS_BAD_VALUE (-2)： ストリームオブジェクトが無効ですSTATUS_NO_INIT (-3)： オーディオシステムが初期化されていませんSTATUS_INVALID_OPERATION (-8)： ストリームは既に破棄されています
Last updated: 2025年10月2日
