chrome.audio

説明

chrome.audio API は、システムにアタッチされているオーディオ デバイスに関する情報の取得と制御を可能にするために提供されています。現在、この API は ChromeOS のキオスクモードでのみ使用できます。

権限

audio

対象

Chrome 59 以降 ChromeOS のみ

型

AudioDeviceInfo

プロパティ

  • deviceName

    文字列

    デバイス名。

  • deviceType

    DeviceType

    デバイスのタイプ。

  • displayName

    文字列

    わかりやすい名前（「USB マイク」など）。

  • id

    文字列

    オーディオ機器の一意の識別子。

  • isActive

    boolean

    現在アクティブなデバイスの場合は true。

  • level

    数値

    デバイスのサウンドレベル、出力の音量、入力のゲイン。

  • stableDeviceId

    string（省略可）

    使用可能な場合の、永続的なデバイス ID の文字列。

  • streamType

    StreamType

    このデバイスに関連付けられているストリーム タイプ。

DeviceFilter

プロパティ

  • isActive

    ブール値（省略可）

    設定すると、アクティブな状態がこの値と一致するオーディオ機器のみがフィルタの要件を満たします。

  • streamTypes

    StreamType[] 省略可

    設定すると、このリストにストリーム タイプが含まれているオーディオ機器のみがフィルタの要件を満たします。

DeviceIdLists

プロパティ

  • 入力

    string[] 省略可

    ID で指定された入力デバイスのリスト。

    入力デバイスが影響を受けないように指定するには、このプロパティを未設定のままにします。

  • 出力

    string[] 省略可

    ID で指定された出力デバイスのリスト。

    出力デバイスが影響を受けないように指定するには、このプロパティを未設定のままにします。

DeviceProperties

プロパティ

  • level

    number（省略可）

    オーディオ機器が求める音のレベル。デフォルトは、デバイスの現在のサウンドレベルです。

    オーディオ入力デバイスで使用する場合、オーディオ デバイスのゲインを表します。

    オーディオ出力デバイスで使用する場合、オーディオ デバイスの音量を表します。

DeviceType

利用可能なオーディオ機器のタイプ。

Enum

"HEADPHONE"

LevelChangedEvent

プロパティ

  • deviceId

    文字列

    サウンドレベルが変更されたデバイスの ID。

  • level

    数値

    デバイスの新しい音レベル。

MuteChangedEvent

プロパティ

  • isMuted

    boolean

    配信が現在ミュートされているかどうか。

  • streamType

    StreamType

    ミュート値が変更されたストリームのタイプ。更新されたミュート値は、このストリーム タイプのすべてのデバイスに適用されます。

StreamType

オーディオ機器が提供するストリームの種類。

Enum

Methods

getDevices()

Promise 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

filter に基づいてフィルタされたオーディオ機器のリストを取得します。

パラメータ

  • フィルタ

    DeviceFilter 省略可

    返されたオーディオ機器のリストをフィルタするデバイス プロパティ。フィルタを設定しないか {} に設定した場合、返されるデバイスリストには利用可能なすべてのオーディオ機器が含まれます。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (devices: AudioDeviceInfo[])=>void

戻り値

  • Promise<AudioDeviceInfo[]>

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

getMute()

Promise 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

指定されたストリーム タイプのシステム全体のミュート状態を取得します。

パラメータ

  • streamType

    StreamType

    ミュート状態を取得するストリーム タイプ。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (value: boolean)=>void

    • value

      boolean

戻り値

  • Promise<boolean>

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

setActiveDevices()

Promise 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

アクティブな入力/出力デバイスのリストを設定します。

パラメータ

  • アクティブにするデバイスの ID を指定します。入力リストまたは出力リストのいずれかが設定されていない場合、そのカテゴリのデバイスは影響を受けません。

    存在しないデバイス ID を渡すとエラーになります。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

setMute()

Promise 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

ストリーム タイプのミュート状態を設定します。ミュート状態は、指定された音声ストリーム タイプのすべてのオーディオ機器に適用されます。

パラメータ

  • streamType

    StreamType

    ミュート状態を設定するストリーム タイプ。

  • isMuted

    boolean

    新しいミュート値。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

setProperties()

Promise 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

入出力デバイスのプロパティを設定します。

パラメータ

  • id

    文字列

  • プロパティ

    DeviceProperties

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

イベント

onDeviceListChanged

chrome.audio.onDeviceListChanged.addListener(
  callback: function,
)

オーディオ デバイスが変更されたとき、または新しいデバイスの追加や既存のデバイスの削除が行われたときに呼び出されます。

パラメータ

onLevelChanged

chrome.audio.onLevelChanged.addListener(
  callback: function,
)

アクティブなオーディオ デバイスのサウンドレベルが変化したときに呼び出されます。

パラメータ

onMuteChanged

chrome.audio.onMuteChanged.addListener(
  callback: function,
)

オーディオの入力または出力のミュート状態が変更されたときに呼び出されます。ミュート状態はシステム全体であり、新しい値は、指定されたストリーム タイプを持つすべてのオーディオ機器に適用されます。

パラメータ