AudioFocusSession
コンストラクタ
new AudioFocusSession()
new AudioFocusSession(
id):AudioFocusSession
オーディオフォーカスリクエストの管理に使用できる新しいAudioFocusSessionを作成します。
パラメーター
id
number
AudioFocusManager.AudioFocusManager.createAudioFocusSessionAsyncから取得したセッションID
戻り値
プロパティ
focusUsage
focusUsage:
number
sessionId
sessionId:
number
メソッド
getAudioSessionId()
getAudioSessionId():
number
このAudioFocusSessionインスタンスのセッションIDを取得します。
戻り値
number
このインスタンスに割り当てられたセッションID
getUsage()
getUsage():
number
このフォーカスセッションの現在のオーディオ使用タイプを取得します。フォーカスがリクエストされていない場合はUSAGE_NONEを返します。
戻り値
number
types/AudioCoreClientTypes.AudioUsageType列挙型から取得した現在のオーディオ使用タイプ
registerAudioFocusListenerAsync()
registerAudioFocusListenerAsync(
callback):Promise<AudioFocusStatus>
オーディオフォーカス変更通知を受け取るコールバックを登録します。セッションごとに一度に登録できるコールバックは1つだけです。
パラメーター
callback
(value) => void
フォーカス変更イベントを受け取る関数。イベントには以下のものがあります。
GRANTED (0)： フォーカスが付与されましたRELEASED (1)： フォーカスがリリースされましたDUCKED (2)： オーディオダッキングが行われました（音量が下がりました）PAUSED (3)： オーディオが一時停止しましたSTOPPED (4)： オーディオが停止しました
戻り値
Promise<AudioFocusStatus>
Promiseは以下に解決されます。
AUDIO_FOCUS_STATUS_NO_ERROR (0)： コールバックが登録されましたAUDIO_FOCUS_STATUS_BAD_VALUE (-2)： コールバックが無効ですAUDIO_FOCUS_STATUS_NO_INIT (-3)： セッションが初期化されていませんAUDIO_FOCUS_STATUS_INVALID_OPERATION (-8)： コールバックは既に登録されています
releaseAudioFocusAsync()
releaseAudioFocusAsync():
Promise<AudioFocusStatus>
以前にリクエストされたオーディオフォーカスをリリースします。オーディオの再生が完了したとき、またはフォーカスが不要になったときに呼び出す必要があります。
戻り値
Promise<AudioFocusStatus>
Promiseは以下に解決されます。
AUDIO_FOCUS_STATUS_NO_ERROR (0)： フォーカスがリリースされましたAUDIO_FOCUS_STATUS_BAD_VALUE (-2)： セッション状態が無効ですAUDIO_FOCUS_STATUS_NO_INIT (-3)： セッションが初期化されていませんAUDIO_FOCUS_STATUS_INVALID_OPERATION (-8)： フォーカスが保持されていません
requestAudioFocusAsync()
requestAudioFocusAsync(
attr?):Promise<AudioFocusStatus>
指定された属性を持つセッションのオーディオフォーカスをリクエストします。フォーカスが付与されると、使用タイプに応じて、以前にフォーカスされたオーディオがダッキング、一時停止、または停止される場合があります。
パラメーター
attr?
フォーカスリクエストの構成（任意）。指定しない場合、デフォルトでUSAGE_MEDIAになります。
戻り値
Promise<AudioFocusStatus>
Promiseは以下に解決されます。
AUDIO_FOCUS_STATUS_NO_ERROR (0)： フォーカスが付与されましたAUDIO_FOCUS_STATUS_DENIED (1)： フォーカスリクエストが拒否されましたAUDIO_FOCUS_STATUS_DELAYED (2)： フォーカスリクエストが遅延しましたAUDIO_FOCUS_STATUS_BAD_VALUE (-2)： 属性が無効ですAUDIO_FOCUS_STATUS_NO_INIT (-3)： セッションが初期化されていませんAUDIO_FOCUS_STATUS_INVALID_OPERATION (-8)： 無効な操作です
unregisterAudioFocusListenerAsync()
unregisterAudioFocusListenerAsync():
Promise<AudioFocusStatus>
以前に登録されたフォーカス変更コールバックの登録を解除します。
戻り値
Promise<AudioFocusStatus>
Promiseは以下に解決されます。
AUDIO_FOCUS_STATUS_NO_ERROR (0)： コールバックの登録が解除されましたAUDIO_FOCUS_STATUS_BAD_VALUE (-2)： セッション状態が無効ですAUDIO_FOCUS_STATUS_NO_INIT (-3)： セッションが初期化されていませんAUDIO_FOCUS_STATUS_INVALID_OPERATION (-8)： 登録されたコールバックはありません
Last updated: 2025年10月2日
