chrome.audio

Descripción

La API de chrome.audio se proporciona para permitir que los usuarios obtengan información sobre los dispositivos de audio conectados al sistema y los controlen. Actualmente, esta API solo está disponible en el modo kiosco para ChromeOS.

Permisos

audio

Disponibilidad

Chrome 59 y versiones posteriores Solo para ChromeOS

Tipos

AudioDeviceInfo

Propiedades

  • deviceName

    string

    Nombre del dispositivo.

  • deviceType

    DeviceType

    Tipo del dispositivo.

  • displayName

    string

    Es el nombre fácil de usar (p.ej., "Micrófono USB").

  • id

    string

    Es el identificador único del dispositivo de audio.

  • Está activo

    booleano

    Es verdadero si este es el dispositivo activo actual.

  • level

    número

    El nivel de sonido del dispositivo, el volumen de la salida y la ganancia de la entrada

  • stableDeviceId

    cadena opcional

    La cadena de ID de dispositivo estable o persistente cuando esté disponible

  • streamType

    StreamType

    Es el tipo de transmisión asociado con este dispositivo.

DeviceFilter

Propiedades

  • Está activo

    booleano opcional

    Si se establece, solo los dispositivos de audio cuyo estado activo coincida con este valor satisfarán el filtro.

  • streamTypes

    StreamType[] opcional

    Si se establece, solo los dispositivos de audio cuyo tipo de transmisión se incluye en esta lista satisfarán el filtro.

DeviceIdLists

Propiedades

  • entrada

    string[] opcional

    Es la lista de dispositivos de entrada especificados por su ID.

    Para indicar que los dispositivos de entrada no se deben ver afectados, deja esta propiedad sin configurar.

  • output

    string[] opcional

    Es la lista de dispositivos de salida especificados por su ID.

    Para indicar que los dispositivos de salida no se deben ver afectados, deja esta propiedad sin configurar.

DeviceProperties

Propiedades

  • level

    número opcional

    Es el nivel de sonido deseado del dispositivo de audio. El valor predeterminado es el nivel de sonido actual del dispositivo.

    Si se usa con un dispositivo de entrada de audio, representa la ganancia del dispositivo de audio.

    Si se usa con un dispositivo de salida de audio, representa el volumen del dispositivo de audio.

DeviceType

Tipos de dispositivos de audio disponibles.

Enum

"HEADPHONE"

"MIC"

"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

Propiedades

  • deviceId

    string

    Es el ID del dispositivo cuyo nivel de sonido cambió.

  • level

    número

    El nuevo nivel de sonido del dispositivo

MuteChangedEvent

Propiedades

  • isMuted

    booleano

    Indica si la transmisión está silenciada o no.

  • streamType

    StreamType

    Es el tipo de transmisión para el que cambió el valor de silenciamiento. El valor de silenciamiento actualizado se aplica a todos los dispositivos con este tipo de transmisión.

StreamType

Es el tipo de transmisión que proporciona un dispositivo de audio.

Enum

"INPUT"

"OUTPUT"

Métodos

getDevices()

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

Obtiene una lista de dispositivos de audio filtrada en función de filter.

Parámetros

  • filter

    DeviceFilter opcional

    Son las propiedades del dispositivo con las que se filtra la lista de dispositivos de audio que se muestran. Si el filtro no está establecido o se establece en {}, la lista de dispositivos que se muestra contendrá todos los dispositivos de audio disponibles.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (devices: AudioDeviceInfo[]) => void

Muestra

  • Promise<AudioDeviceInfo[]>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getMute()

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

Obtiene el estado de silenciamiento en todo el sistema para el tipo de transmisión especificado.

Parámetros

  • streamType

    StreamType

    Es el tipo de transmisión para el que se debe recuperar el estado de silenciamiento.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (value: boolean) => void

    • valor

      booleano

Muestra

  • Promise<boolean>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setActiveDevices()

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

Establece listas de dispositivos de entrada o salida activos.

Parámetros

  • Especifica los IDs de los dispositivos que deberían estar activos. Si no se establece la lista de entrada o salida, los dispositivos de esa categoría no se verán afectados.

    Pasar un ID de dispositivo inexistente es un error.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promise<void>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setMute()

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

Establece el estado de silenciamiento para un tipo de transmisión. El estado de silenciamiento se aplicará a todos los dispositivos de audio con el tipo de transmisión de audio especificado.

Parámetros

  • streamType

    StreamType

    Es el tipo de transmisión para el que se debe establecer el estado de silenciamiento.

  • isMuted

    booleano

    Nuevo valor de silenciamiento.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promise<void>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setProperties()

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

Establece las propiedades del dispositivo de entrada o salida.

Parámetros

  • id

    string

  • properties

    DeviceProperties

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promise<void>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

Eventos

onDeviceListChanged

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

Se activa cuando cambian los dispositivos de audio, ya sea que se agreguen dispositivos nuevos o se quiten los existentes.

Parámetros

onLevelChanged

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

Se activa cuando cambia el nivel de sonido de un dispositivo de audio activo.

Parámetros

onMuteChanged

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

Se activa cuando cambia el estado de silenciamiento de la entrada o salida de audio. Ten en cuenta que el estado de silenciamiento es para todo el sistema y el valor nuevo se aplica a todos los dispositivos de audio con el tipo de transmisión especificado.

Parámetros