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 en ChromeOS

Tipos

AudioDeviceInfo

Propiedades

  • deviceName

    string

    Nombre del dispositivo.

  • deviceType

    DeviceType

    Tipo del dispositivo.

  • displayName

    string

    Es el nombre descriptivo (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

    Nivel de sonido del dispositivo, volumen de salida y ganancia de entrada.

  • stableDeviceId

    cadena opcional

    Es la cadena del ID del dispositivo estable o persistente cuando está disponible.

  • streamType

    StreamType

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

DeviceFilter

Propiedades

  • Está activo

    booleano opcional

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

  • streamTypes

    StreamType[] opcional

    Si se configura, solo los dispositivos de audio cuyo tipo de transmisión se incluya 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 deben verse 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 deben verse 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

Son los 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

    Es el nuevo nivel de sonido del dispositivo.

MuteChangedEvent

Propiedades

  • isMuted

    booleano

    Indica si la transmisión ahora está silenciada.

  • streamType

    StreamType

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

StreamType

Tipo de transmisión que proporciona un dispositivo de audio.

Enum

"INPUT"

"OUTPUT"

Métodos

getDevices()

chrome.audio.getDevices(
  filter?: DeviceFilter,
): Promise<AudioDeviceInfo[]>

Obtiene una lista de dispositivos de audio filtrados según filter.

Parámetros

  • filtrar

    DeviceFilter opcional

    Son las propiedades del dispositivo por las que se filtrará la lista de dispositivos de audio devueltos. Si el filtro no está configurado o se establece en {}, la lista de dispositivos que se muestra contendrá todos los dispositivos de audio disponibles.

Muestra

getMute()

chrome.audio.getMute(
  streamType: StreamType,
): Promise<boolean>

Obtiene el estado de silencio de 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 silencio.

Muestra

  • Promise<boolean>

    Chrome 116 y versiones posteriores

setActiveDevices()

chrome.audio.setActiveDevices(
  ids: DeviceIdLists,
): Promise<void>

Establece listas de dispositivos de entrada o salida activos.

Parámetros

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

    Es un error pasar un ID de dispositivo que no existe.

Muestra

  • Promise<void>

    Chrome 116 y versiones posteriores

setMute()

chrome.audio.setMute(
  streamType: StreamType,
  isMuted: boolean,
): Promise<void>

Establece el estado de silencio para un tipo de transmisión. El estado de silencio 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 silencio.

  • isMuted

    booleano

    Es el nuevo valor de silencio.

Muestra

  • Promise<void>

    Chrome 116 y versiones posteriores

setProperties()

chrome.audio.setProperties(
  id: string,
  properties: DeviceProperties,
): Promise<void>

Establece las propiedades del dispositivo de entrada o salida.

Parámetros

Muestra

  • Promise<void>

    Chrome 116 y versiones posteriores

Eventos

onDeviceListChanged

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

Se activa cuando cambian los dispositivos de audio, ya sea porque se agregaron dispositivos nuevos o se quitaron dispositivos 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 silencio de la entrada o salida de audio. Ten en cuenta que el estado de silencio es para todo el sistema y el nuevo valor se aplica a todos los dispositivos de audio con el tipo de transmisión especificado.

Parámetros