chrome.audio

説明

chrome.audio API は、ユーザーがシステムに接続されているオーディオ機器に関する情報を取得してコントロールできるようにするために提供されます。この API は現在、ChromeOS のキオスクモードでのみ使用できます。

権限

audio

対象

Chrome 59 以降 ChromeOS のみ をご覧ください。

型

AudioDeviceInfo

プロパティ

  • deviceName

    文字列

    デバイス名。

  • deviceType

    DeviceType

    端末のタイプ。

  • displayName

    文字列

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

  • id

    文字列

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

  • isActive

    ブール値

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

  • level

    数値

    デバイスの音量、出力の音量、入力のゲイン。

  • stableDeviceId

    文字列（省略可）

    固定/永続的なデバイス ID の文字列（利用可能な場合）。

  • streamType

    StreamType

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

DeviceFilter

プロパティ

  • isActive

    ブール値（省略可）

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

  • streamTypes

    StreamType[] 省略可

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

DeviceIdLists

プロパティ

  • 入力

    文字列 [] 省略可

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

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

  • output

    文字列 [] 省略可

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

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

DeviceProperties

プロパティ

  • level

    数値（省略可）

    オーディオ機器の望ましい音量レベル。デフォルトは、デバイスの現在の音量です。

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

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

DeviceType

使用可能なオーディオ デバイスタイプ。

列挙型

"HEADPHONE"

「マイク」

「USB」

「BLUETOOTH」

"HDMI"

"INTERNAL_SPEAKER"

「INTERNAL_MIC」

「FRONT_MIC」

「REAR_MIC」

「KEYBOARD_MIC」

"HOTWORD"

LINEOUT

"POST_MIX_LOOPBACK"

"POST_DSP_LOOPBACK"

"ALSA_LOOPBACK"

「OTHER」

LevelChangedEvent

プロパティ

  • deviceId

    文字列

    音量が変更されたデバイスの ID。

  • level

    数値

    デバイスの新しい音量。

MuteChangedEvent

プロパティ

  • isMuted

    ブール値

    ストリーミングがミュートされているかどうか。

  • streamType

    StreamType

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

StreamType

オーディオ機器が提供するストリームのタイプ。

列挙型

「入力」

「出力」

メソッド

getDevices()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.audio.getDevices(
  filter?: DeviceFilter,
  callback?: function,
)

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

パラメータ

  • フィルタ

    DeviceFilter（省略可）

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

  • callback

    関数（省略可）

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

    (devices: AudioDeviceInfo[]) => void

戻り値

  • Promise&lt;AudioDeviceInfo[]&gt;

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getMute()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.audio.getMute(
  streamType: StreamType,
  callback?: function,
)

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

パラメータ

  • streamType

    StreamType

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

  • callback

    関数（省略可）

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

    (value: boolean) => void

    • 値

      ブール値

戻り値

  • Promise&lt;boolean&gt;

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

setActiveDevices()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
  callback?: function,
)

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

パラメータ

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

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

setMute()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
  callback?: function,
)

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

パラメータ

  • streamType

    StreamType

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

  • isMuted

    ブール値

    新しいミュート値。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

setProperties()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
  callback?: function,
)

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

パラメータ

  • id

    文字列

  • プロパティ

    DeviceProperties

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onDeviceListChanged

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

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

パラメータ

onLevelChanged

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

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

パラメータ

onMuteChanged

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

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

パラメータ