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 modo kiosco para ChromeOS.
Permisos
audio
Disponibilidad
Tipos
AudioDeviceInfo
Propiedades
-
deviceName
cadena
Nombre del dispositivo.
-
deviceType
Tipo del dispositivo.
-
displayName
cadena
El nombre fácil de usar (p.ej., "Micrófono USB").
-
id
cadena
Es el identificador único del dispositivo de audio.
-
isActive
boolean
Verdadero si este es el dispositivo activo actualmente.
-
level
número
El nivel de sonido del dispositivo, el volumen de salida y la ganancia para la entrada.
-
stableDeviceId
cadena opcional
La cadena de ID de dispositivo estable o persistente cuando está disponible
-
streamType
Tipo de transmisión asociado con este dispositivo.
DeviceFilter
Propiedades
-
isActive
booleano opcional
Si se establece, solo los dispositivos de audio cuyo estado activo coincida con este valor cumplirán con el filtro.
-
streamTypes
StreamType[] opcional
Si se establece, solo los dispositivos de audio cuyo tipo de transmisión se incluye en esta lista cumplirán con el filtro.
DeviceIdLists
Propiedades
-
entrada
string[] opcional
Lista de dispositivos de entrada especificados por su ID.
Para indicar que los dispositivos de entrada no deben verse afectados, no establezcas esta propiedad.
-
salida
string[] opcional
Lista de dispositivos de salida especificados por su ID.
Para indicar que los dispositivos de salida no deben verse afectados, no establezcas esta propiedad.
DeviceProperties
Propiedades
-
level
número opcional
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 utiliza con un dispositivo de salida de audio, representa el volumen del dispositivo de audio.
DeviceType
Tipos de dispositivos de audio disponibles.
Enum
"HEADPHONE"
"INTERNAL_SPEAKER"
"INTERNAL_MIC"
"HOTWORD"
"OTHER"
LevelChangedEvent
Propiedades
-
deviceId
cadena
ID del dispositivo cuyo nivel de sonido cambió.
-
level
número
El nuevo nivel de sonido del dispositivo.
MuteChangedEvent
Propiedades
-
isMuted
boolean
Indica si la transmisión está silenciada o no.
-
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
Métodos
getDevices()
chrome.audio.getDevices(
filter?: DeviceFilter,
callback?: function,
)
Obtiene una lista de dispositivos de audio filtrados en función de filter
.
Parámetros
-
filter
DeviceFilter opcional
Propiedades del dispositivo por las que se filtra la lista de dispositivos de audio que se muestran Si no estableces el filtro o lo estableces como
{}
, la lista de dispositivos devueltos contendrá todos los dispositivos de audio disponibles. -
callback
Función opcional
El parámetro
callback
se ve de la siguiente manera:(devices: AudioDeviceInfo[]) => void
-
dispositivos
-
Devuelve
-
Promise<AudioDeviceInfo[]>
Chrome 116 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
getMute()
chrome.audio.getMute(
streamType: StreamType,
callback?: function,
)
Obtiene el estado de silencio en todo el sistema para el tipo de transmisión especificado.
Parámetros
-
streamType
Es el tipo de transmisión para la que se debe recuperar el estado de silencio.
-
callback
Función opcional
El parámetro
callback
se ve de la siguiente manera:(value: boolean) => void
-
value
boolean
-
Devuelve
-
Promise<boolean>
Chrome 116 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
setActiveDevices()
chrome.audio.setActiveDevices(
ids: DeviceIdLists,
callback?: function,
)
Establece listas de dispositivos de entrada o salida activos.
Parámetros
-
ids
Especifica los ID de los dispositivos que deben estar activos. Si no se configura 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.
-
callback
Función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Devuelve
-
Promise<void>
Chrome 116 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
setMute()
chrome.audio.setMute(
streamType: StreamType,
isMuted: boolean,
callback?: function,
)
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
Es el tipo de transmisión para la que se debe establecer el estado de silencio.
-
isMuted
boolean
Nuevo valor de silencio.
-
callback
Función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Devuelve
-
Promise<void>
Chrome 116 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
setProperties()
chrome.audio.setProperties(
id: string,
properties: DeviceProperties,
callback?: function,
)
Establece las propiedades del dispositivo de entrada o salida.
Parámetros
-
id
cadena
-
properties
-
callback
Función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Devuelve
-
Promise<void>
Chrome 116 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones 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
-
callback
la función
El parámetro
callback
se ve de la siguiente manera:(devices: AudioDeviceInfo[]) => void
-
dispositivos
-
onLevelChanged
chrome.audio.onLevelChanged.addListener(
callback: function,
)
Se activa cuando cambia el nivel de sonido de un dispositivo de audio activo.
Parámetros
-
callback
la función
El parámetro
callback
se ve de la siguiente manera:(event: LevelChangedEvent) => void
-
event
-
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 silenciamiento se aplica a todo el sistema y el valor nuevo se aplica a cada dispositivo de audio con el tipo de transmisión especificado.
Parámetros
-
callback
la función
El parámetro
callback
se ve de la siguiente manera:(event: MuteChangedEvent) => void
-
event
-