Console

Settings

Sign out

Notifications

Alexa

Amazonアプリストア

AWS

ドキュメント

Support

My Cases

Console

Vega開発者向けドキュメント

ホーム

開発

設計と開発

公開

リファレンス

サポート

AudioManager

コンストラクタ

new AudioManager()

new AudioManager(): AudioManager

戻り値

AudioManager

メソッド

allocateCustomAudioEffectSessionAsync()

static allocateCustomAudioEffectSessionAsync(): Promise<number>

カスタムオーディオエフェクトの一意のセッションIDを作成します。このIDを使用して、オーディオエフェクトを特定の再生ストリームまたは録音ストリームに関連付けることができます。

戻り値

Promise<number>

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

正の数：新しい一意のセッションID

次の値で拒否：

STATUS_NO_MEMORY (-1)：セッションを割り当てることができませんでした
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

areSystemSoundsEnabledAsync()

static areSystemSoundsEnabledAsync(): Promise<boolean>

システムサウンドが現在有効になっているか確認します。

戻り値

Promise<boolean>

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

true：システムサウンドが有効になっています
false：システムサウンドが無効になっています

次の値で拒否：

STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

disableAvrcpAbsoluteVolumeAsync()

static disableAvrcpAbsoluteVolumeAsync(btAddress): Promise<AudioStatus>

BluetoothデバイスのAVRCP絶対音量制御を無効にします。無効にすると、システムが音量を制御します。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

btAddress

String

Bluetoothデバイスのアドレス

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：アドレスが無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_INVALID_OPERATION (-8)：デバイスはAVRCPをサポートしていません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

disableSystemSoundsAsync()

static disableSystemSoundsAsync(): Promise<AudioStatus>

すべてのシステムサウンドを無効にします。enableSystemSoundsAsyncを使用して再度有効にするまで、システムサウンドは再生されません。

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました
STATUS_INVALID_OPERATION (-8)：操作が失敗しました

disableUsageAsync()

static disableUsageAsync(usage): Promise<AudioStatus>

特定の使用タイプのオーディオ再生を無効にします。現時点では、USAGE_NOTIFICATIONのみをサポートしています。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

usage

number

無効にする使用タイプ

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：使用タイプが無効か、サポートされていません
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

enableAvrcpAbsoluteVolumeAsync()

static enableAvrcpAbsoluteVolumeAsync(btAddress): Promise<AudioStatus>

BluetoothデバイスのAVRCP絶対音量制御を有効にします。有効にすると、Bluetoothデバイス自体が音量を制御します。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

btAddress

String

Bluetoothデバイスのアドレス

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：アドレスが無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_INVALID_OPERATION (-8)：デバイスはAVRCPをサポートしていません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

enableSystemSoundsAsync()

static enableSystemSoundsAsync(): Promise<AudioStatus>

無効にしたシステムサウンドを有効にします。システムサウンドはデフォルトで有効になっています。

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました
STATUS_INVALID_OPERATION (-8)：操作が失敗しました

enableUsageAsync()

static enableUsageAsync(usage): Promise<AudioStatus>

特定の使用タイプのオーディオ再生を有効にします。現時点では、USAGE_NOTIFICATIONのみをサポートしています。他の使用タイプを設定すると、この関数は「[com.amazon.apmf.SecurityError]: No Permission」例外をスローします。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

usage

number

有効にする使用タイプ

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：使用タイプが無効か、サポートされていません
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getAudioDeviceListAsync()

static getAudioDeviceListAsync(device, role): Promise<AudioDeviceInfo[]>

指定されたロールに一致する、使用可能なオーディオデバイスのリストを取得します。

パラメーター

device

AudioDevice

フィルタリングの基準となるデバイスタイプ。すべてのデバイスの場合はDEVICE_ALL。値：

DEVICE_NONE (0x0)
DEVICE_DEFAULT (1 << 30)
DEVICE_SPEAKER (1 << 0)
DEVICE_WIRED_HEADSET (1 << 1)
DEVICE_BLUETOOTH_SCO (1 << 2)
DEVICE_BLUETOOTH_A2DP (1 << 3)
AudioDevice列挙型で定義されているその他のデバイス

role

AudioRole

フィルタリングの基準となるロール。値：

ROLE_SOURCE (0)：入力デバイス
ROLE_SINK (1)：出力デバイス
ROLE_SOURCE_SINK (2)：入力デバイスと出力デバイスの両方

戻り値

Promise<AudioDeviceInfo[]>

Promiseは、AudioDeviceInfoオブジェクトの配列に解決されます。

各オブジェクトには以下が含まれます。

role： AudioRole
type： AudioDevice
name：文字列
formats： AudioSampleFormat[]
sampleRates： AudioSampleRate[]
channelMasks： AudioChannelMask[]

次の値で拒否：

STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getGlobalVolumeMuteAsync()

static getGlobalVolumeMuteAsync(): Promise<boolean>

現在のグローバル音量ミュート状態を取得します。

戻り値

Promise<boolean>

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

true：グローバルミュートが有効になっています
false：グローバルミュートが無効になっています

次の値で拒否：

STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getMajorVersion()

static getMajorVersion(): number

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

戻り値

number

メジャーバージョン番号

getMaxVolumeAsync()

static getMaxVolumeAsync(): Promise<number>

現在の最大音量制限を取得します。

戻り値

Promise<number>

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

0～100：現在の最大音量制限

次の値で拒否：

STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getMicMuteAsync()

static getMicMuteAsync(): Promise<boolean>

現在のマイクのミュート状態を取得します。

戻り値

Promise<boolean>

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

true：マイクはミュートされています
false：マイクはミュートされていません

次の値で拒否：

STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getMinorVersion()

static getMinorVersion(): number

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

戻り値

number

マイナーバージョン番号

getMuteAsync()

static getMuteAsync(volType): Promise<boolean>

特定の音量タイプのミュート状態を取得します。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

volType

AudioVolumeType

照会する音量タイプ。タイプについてはsetVolumeAsyncを参照。

戻り値

Promise<boolean>

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

true：音量タイプがミュートされています
false：音量タイプがミュートされていません

次の値で拒否：

STATUS_BAD_VALUE (-2)：音量タイプが無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getPatchVersion()

static getPatchVersion(): number

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

戻り値

number

パッチのバージョン番号

getSinkFormatsSelectionPolicyAsync()

static getSinkFormatsSelectionPolicyAsync(): Promise<number>

オーディオ出力形式を選択するための現在のポリシーを取得します。

戻り値

Promise<number>

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

SinkFormatsSelectionPolicyの値。setSinkFormatsSelectionPolicyAsyncを参照

次の値で拒否：

STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getSupportedPlaybackConfigurationsAsync()

static getSupportedPlaybackConfigurationsAsync(attributes, deviceType): Promise<AudioConfigAttr[]>

指定された属性とデバイスで再生するためのサポート対象オーディオ構成を取得します。これを使用して、形式、サンプルレート、チャネルの有効な組み合わせを決定します。

パラメーター

attributes

AudioAttributes

コンテンツのタイプと使用を定義するオーディオ属性

deviceType

number

照会するデバイスタイプ。現在の出力にはDEVICE_DEFAULTを使用します。

戻り値

Promise<AudioConfigAttr[]>

Promiseは、サポート対象の構成の配列に解決されます。

各構成には以下が含まれます。

sampleRate： AudioSampleRate
channelMask： AudioChannelMask
format： AudioSampleFormat
layout： SampleLayout

次の値で拒否：

STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_NOT_ENOUGH_DATA (-10)：使用可能な構成はありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getSupportedRecordConfigurationsAsync()

static getSupportedRecordConfigurationsAsync(excludeDisconnectedDevice, sourceType): Promise<AudioConfigAttr[]>

録音用のサポート対象オーディオ構成を取得します。これを使用して、録音の形式、サンプルレート、チャネルの有効な組み合わせを決定します。

パラメーター

excludeDisconnectedDevice

boolean

trueの場合、接続されているデバイスの構成のみを返します。falseの場合、構成ファイルからサポート対象のすべての構成を返します。

sourceType

number

構成を照会する対象のオーディオソースタイプ

戻り値

Promise<AudioConfigAttr[]>

Promiseは、サポート対象の構成の配列に解決されます。

各構成には以下が含まれます。

sampleRate： AudioSampleRate
channelMask： AudioChannelMask
format： AudioSampleFormat
layout： SampleLayout

次の値で拒否：

STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_NOT_ENOUGH_DATA (-10)：使用可能な構成はありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getSupportedSinkFormatsSelectionPoliciesAsync()

static getSupportedSinkFormatsSelectionPoliciesAsync(): Promise<SinkPolicies[]>

サポート対象のシンクフォーマット選択ポリシーのリストを取得します。デバイスによってはサポートされていないポリシーもあります。このリストを使用して、使用可能なオプションを確認してください。

戻り値

Promise<SinkPolicies[]>

Promiseは、サポート対象のポリシーの配列に解決されます。

各項目には以下が含まれます。

policy: number (SinkFormatsSelectionPolicy value)

次の値で拒否：

STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getSystemSoundThemeAsync()

static getSystemSoundThemeAsync(): Promise<String>

現在アクティブなシステムサウンドテーマを取得します。

戻り値

Promise<String>

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

String：現在のテーマ識別子

次の値で拒否：

STATUS_NO_FILE (-11)：テーマが設定されていません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getSystemSoundThemeListAsync()

static getSystemSoundThemeListAsync(): Promise<AudioTheme[]>

サポート対象のすべてのシステムサウンドテーマのリストを取得します。システムサウンドテーマは、システムイベント用のさまざまなサウンドセットを定義します。

戻り値

Promise<AudioTheme[]>

Promiseは、AudioThemeオブジェクトの配列に解決されます。

各オブジェクトには以下が含まれます。

theme：文字列（テーマの識別子）

次の値で拒否：

STATUS_NO_FILE (-11)：テーマファイルが見つかりません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getTelephonyMuteAsync()

static getTelephonyMuteAsync(device, address): Promise<boolean>

特定のデバイスのテレフォニーオーディオのミュート状態を取得します。

パラメーター

device

AudioDevice

照会するデバイス

address

String

デバイスの一意の識別子。

戻り値

Promise<boolean>

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

true：テレフォニーの音声はミュートになっています
false：テレフォニーの音声はミュートになっていません

次の値で拒否：

STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_INVALID_OPERATION (-8)：デバイスがテレフォニーモードになっていません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

getVolumeAsync()

static getVolumeAsync(type): Promise<number>

特定のオーディオタイプの現在の音量レベルを取得します。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

type

AudioVolumeType

照会するオーディオタイプ。タイプについてはsetVolumeAsyncを参照。

戻り値

Promise<number>

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

0～100：現在の音量レベル
STATUS_BAD_VALUE (-2)：タイプが無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

isAvrcpAbsoluteVolumeEnabledAsync()

static isAvrcpAbsoluteVolumeEnabledAsync(btAddress): Promise<boolean>

BluetoothデバイスのAVRCP絶対音量制御が有効になっているか確認します。

パラメーター

btAddress

String

Bluetoothデバイスのアドレス

戻り値

Promise<boolean>

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

true： AVRCP絶対音量が有効になっています
false： AVRCP絶対音量が無効になっています。次の値で拒否：
STATUS_BAD_VALUE (-2)：アドレスが無効です
STATUS_INVALID_OPERATION (-8)：デバイスはAVRCPをサポートしていません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

isServerReadyAsync()

static isServerReadyAsync(): Promise<boolean>

オーディオサーバーがコマンドを処理できる状態にあるか確認します。

戻り値

Promise<boolean>

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

true：サーバーの準備が完了しています
false：サーバーの準備ができていません

次の値で拒否：

STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

廃止

このメソッドは後方互換性のために維持されていますが、将来のバージョンでは削除される可能性があります。代わりにregisterAudioEventObserverAsyncのSERVER_UP/SERVER_DOWNイベントを使用してください。

isUsageEnabledAsync()

static isUsageEnabledAsync(usage): Promise<boolean>

特定の使用タイプでオーディオ再生が有効になっているか確認します。

パラメーター

usage

number

照会する使用タイプ

戻り値

Promise<boolean>

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

true：使用タイプが有効になっています
false：使用タイプが無効になっています

次の値で拒否：

STATUS_BAD_VALUE (-2)：使用タイプが無効です
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

playSystemSoundAsync()

static playSystemSoundAsync(soundType): Promise<AudioStatus>

システムサウンドを再生します。

パラメーター

soundType

AudioSystemSound

再生するシステムサウンドのタイプ。値：

BOOT_UP (0)
BACK_BUTTON (1)
HOME_BUTTON (4)
MENU_BUTTON (5)
UP/DOWN/LEFT/RIGHT (6/9)
MIC_ON/OFF (10/11)
BLUETOOTH related (12/14)
ERROR (15)
VOLUME_UP/DOWN (16/17)
AudioSystemSound列挙型で定義されているその他のタイプ

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：サウンドタイプが無効です
STATUS_NO_FILE (-11)：サウンドファイルが見つかりません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

registerAudioEventObserverAsync()

static registerAudioEventObserverAsync(callback): Promise<AudioStatus>

オーディオシステムイベントのコールバック関数を登録します。システム全体で一度に登録できるコールバックは1つだけです。

パラメーター

callback

(value) => void

コールバック関数は以下のイベントを受け取ります。

DEVICE_STATE_UPDATE (0)：オーディオデバイスの接続が変更されました。パラメーター：{device: AudioDevice, role: AudioRole, connect: boolean}
VOLUME_UPDATE (1)：音量が変更されました。パラメーター：{type: AudioVolumeType, volume: number}
GLOBAL_VOLUME_MUTE_UPDATE (2)：グローバルミュートが変更されました。パラメーター：{mute: boolean}
SERVER_DOWN (3)：オーディオサーバーを利用できません
SERVER_UP (4)：オーディオサーバーを利用できます
AUDIO_USAGE_STATE_CHANGE (5)：使用状態が変更されました。パラメーター：{usage: AudioUsageType, active: boolean}
MIC_MUTE_STATE_UPDATE (6)：マイクのミュートが変更されました。パラメーター：{muteState: boolean}
VOLUME_MUTE_UPDATE (7)：音量タイプのミュートが変更されました。パラメーター：{volumeType: AudioVolumeType, muteState: boolean}
TELEPHONY_MUTE_UPDATE (8)：テレフォニーのミュートが変更されました。パラメーター：{deviceType: AudioDevice, deviceAddress: string, deviceName: string, muteState: boolean}

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：コールバックが無効です
STATUS_ALREADY_EXISTS (-4)：コールバックは既に登録されています
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

setActiveVolumeAsync()

static setActiveVolumeAsync(volume): Promise<AudioStatus>

現在アクティブなストリームの音量を設定します。アクティブなストリームは、最新のオーディオフォーカスホルダーによって決まります。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

volume

number

音量レベル（0～100）。この範囲外の値は制限されます。

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：音量の値が無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_INVALID_OPERATION (-8)：アクティブなストリームはありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

setGlobalVolumeMuteAsync()

static setGlobalVolumeMuteAsync(mute, flags): Promise<AudioStatus>

グローバル音量ミュート状態を設定します。有効にすると、個々の音量設定に関係なく、すべてのオーディオ出力をミュートします。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

mute

boolean

グローバルミュートを有効にする場合はtrue、無効にする場合はfalse

flags

AudioVolumeFlags = AudioVolumeFlags.VOLUME_FLAG_NONE

ミュート動作に影響するフラグ（任意）：

VOLUME_FLAG_NONE (0)：特別な動作なし
VOLUME_FLAG_SHOW_UI (1)：ミュート状態のUIを表示します
VOLUME_FLAG_PLAY_NOTIFICATION (2)：状態変更サウンドを再生します

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました
STATUS_INVALID_OPERATION (-8)：操作が失敗しました

setMaxVolumeAsync()

static setMaxVolumeAsync(maxVolume): Promise<AudioStatus>

すべてのオーディオタイプの最大音量制限を設定します。すべての音量タイプに影響するグローバル音量上限として機能します。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

maxVolume

number

最大音量レベル（0～100）。この範囲外の値は制限されます。この制限を超える現在の音量は、制限に合わせて小さくなります。

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：音量の値が無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

setMicMuteAsync()

static setMicMuteAsync(mute): Promise<AudioStatus>

マイクのミュート状態を設定します。マイクからのすべてのオーディオ録音に影響します。

パラメーター

mute

boolean

マイクをミュートする場合はtrue、ミュートを解除する場合はfalse

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました
STATUS_INVALID_OPERATION (-8)：操作が失敗しました

setMuteAsync()

static setMuteAsync(volType, mute): Promise<AudioStatus>

特定の音量タイプのミュート状態を設定します。ある音量タイプをミュートすると、そのタイプのすべてのオーディオストリームが無音になります。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

volType

AudioVolumeType

ミュート／ミュート解除する音量タイプ。タイプについてはsetVolumeAsyncを参照。

mute

boolean

ミュートする場合はtrue、ミュート解除する場合はfalse

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：音量タイプが無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

setSinkFormatsSelectionPolicyAsync()

static setSinkFormatsSelectionPolicyAsync(policy): Promise<AudioStatus>

HDMI／デジタル出力でオーディオ出力形式を選択するためのポリシーを設定します。サポートするデバイスへの送信時のオーディオのエンコード方法に影響します。

パラメーター

policy

SinkFormatsSelectionPolicy

形式選択ポリシー：

AUTO (0)：シンク機能に基づいて選択します
ENFORCE_PCM (1)： PCM出力を強制します
PASSTHROUGH_DDP (2)： Dolby Digital Plusパススルーを許可します
PASSTHROUGH_DD (3)： Dolby Digitalパススルーを許可します
ENFORCE_DDP (4)： Dolby Digital Plusエンコーディングを強制します
ENFORCE_DD (5)： Dolby Digitalエンコーディングを強制します

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：ポリシーが無効です
STATUS_INVALID_OPERATION (-8)：ポリシーがサポートされていません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

setSystemSoundThemeAsync()

static setSystemSoundThemeAsync(soundTheme): Promise<AudioStatus>

アクティブなシステムサウンドテーマを設定します。getSystemSoundThemeListAsyncによって返されるテーマのいずれかである必要があります。

パラメーター

soundTheme

String

テーマ識別文字列

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：テーマが無効です
STATUS_NO_FILE (-11)：テーマファイルが見つかりません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

setTelephonyMuteAsync()

static setTelephonyMuteAsync(device, address, mute): Promise<AudioStatus>

特定のデバイスのテレフォニーオーディオのミュート状態を設定します。

パラメーター

device

AudioDevice

ミュート状態を設定する対象のデバイス

address

String

デバイスの一意の識別子。

mute

boolean

ミュートする場合はtrue、ミュート解除する場合はfalse

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_INVALID_OPERATION (-8)：デバイスがテレフォニーモードになっていません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

setVolumeAsync()

static setVolumeAsync(type, volume, flags): Promise<AudioStatus>

特定のオーディオタイプの音量を設定します。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

type

AudioVolumeType

調整するオーディオタイプ：

VOLUME_TYPE_DEFAULT (-1)
VOLUME_TYPE_MEDIA (0)
VOLUME_TYPE_VOICE_ASSISTANT (1)
VOLUME_TYPE_VOICE_CALL (2)
VOLUME_TYPE_RING (3)
VOLUME_TYPE_ALARM (4)
VOLUME_TYPE_NOTIFICATION (5)
VOLUME_TYPE_ACCESSIBILITY (6)
VOLUME_TYPE_SYSTEM (7)
VOLUME_TYPE_NAVIGATION (8)

volume

number

音量レベル（0～100）。この範囲外の値は制限されます。

flags

AudioVolumeFlags = AudioVolumeFlags.VOLUME_FLAG_NONE

音量変更動作に影響するフラグ（任意）：

VOLUME_FLAG_NONE (0)：特別な動作なし
VOLUME_FLAG_SHOW_UI (1)：音量スライダーのUIを表示します
VOLUME_FLAG_PLAY_NOTIFICATION (2)：音量変更サウンドを再生します

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：タイプまたは音量が無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

startTelephonyAsync()

static startTelephonyAsync(device, address, mode): Promise<AudioStatus>

指定されたデバイスからテレフォニー通話を開始します。

クライアントでデバイス「DEVICE_DEFAULT」を指定すると、オーディオサーバー側でテレフォニーを判断し、通話を開始できるようになります。一部の特定のプラットフォームでは、HFPデバイス、音声通話モデムなど、複数のテレフォニーソースをサポートできます。この場合、正確にはクライアントがgetAudioDeviceListAsync APIを使用してデバイスのリストを照会し、特定のデバイスと、それに対応するアドレスを選択します。

パラメーター

device

AudioDevice

テレフォニーオーディオに使用するデバイス。一般的な値は次のとおりです。

DEVICE_DEFAULT (1 << 30)
DEVICE_BLUETOOTH_SCO (1 << 2)
DEVICE_BLUETOOTH_HFP (1 << 18)
DEVICE_WIRED_HEADSET (1 << 1)

address

String

デバイスの一意の識別子（Bluetoothアドレスなど）

mode

AudioTelephonyMode

テレフォニーオーディオモード：

MODE_NARROW_BAND (0): 標準的な音質
MODE_WIDE_BAND (1): HDの音質

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_INVALID_OPERATION (-8)：デバイスを利用できません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

stopTelephonyAsync()

static stopTelephonyAsync(device, address): Promise<AudioStatus>

指定されたデバイスのテレフォニーオーディオを停止します。通話が終了したとき、またはテレフォニーオーディオが不要になったときに呼び出す必要があります。

パラメーター

device

AudioDevice

テレフォニーオーディオを停止する対象のデバイス

address

String

デバイスの一意の識別子（Bluetoothアドレスなど）

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_INVALID_OPERATION (-8)：テレフォニーがアクティブではありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

unregisterAudioEventObserverAsync()

static unregisterAudioEventObserverAsync(): Promise<AudioStatus>

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

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_INVALID_OPERATION (-8)：登録されたコールバックはありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

updateActiveVolumeAsync()

static updateActiveVolumeAsync(update, fallbackType): Promise<AudioStatus>

アクティブなストリームの音量を増減して更新します。アクティブなストリームがない場合は、指定されたフォールバックタイプの音量を調整します。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

update

number

更新のタイプ：

UP (0)：音量を1段階上げます
DOWN (1)：音量を1段階下げます

fallbackType

AudioVolumeType

アクティブなストリームがない場合に調整する音量タイプ

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

updateVolumeAsync()

static updateVolumeAsync(type, volume): Promise<AudioStatus>

特定のオーディオタイプの音量を増減して更新します。必要な権限：com.amazon.audio.privilege.settings.control

パラメーター

type

AudioVolumeType

調整するオーディオタイプ。タイプについてはsetVolumeAsyncを参照。

volume

number

更新のタイプ：

UP (0)：音量を1段階上げます
DOWN (1)：音量を1段階下げます

戻り値

Promise<AudioStatus>

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

STATUS_NO_ERROR (0)：成功しました
STATUS_BAD_VALUE (-2)：パラメーターが無効です
STATUS_PERMISSION_DENIED (-9)：権限がありません
STATUS_DEAD_OBJECT (-5)：サーバー接続が失われました

Last updated: 2025年10月2日