Compartir a través de

AudioEffectsFeature interface

  • Referencia
Paquete:
@azure/communication-calling

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Interfaz de API para la característica AudioEffects

Extends
AudioStreamFeature

Propiedades

activeEffects

Objeto de solo lectura que representa los efectos de audio activos actuales

Propiedades heredadas

name

Nombre de la característica.

Métodos

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Método para comprobar si se admite un efecto en el entorno actual.
off("effectsError", AudioEffectsFeatureErrorListener)

Cancelar la suscripción a funciones: se desencadena en caso de error mientras se usan efectos
off("effectsStarted", AudioEffectsFeatureListener)

Funciones de cancelación de la suscripción: se desencadena cuando se inician los efectos
off("effectsStopped", AudioEffectsFeatureListener)

Funciones de cancelación de la suscripción: se activa cuando se detienen los efectos
on("effectsError", AudioEffectsFeatureErrorListener)

Funciones de suscripción: se desencadena en caso de error al usar efectos
on("effectsStarted", AudioEffectsFeatureListener)

Funciones de suscripción: se activa cuando se inician los efectos
on("effectsStopped", AudioEffectsFeatureListener)

Funciones de suscripción: se desencadena cuando se detienen los efectos
startEffects(AudioEffectsStartConfig)

Efectos de inicio
stopEffects(AudioEffectsStopConfig)

Efectos de detención

Métodos heredados

dispose()

Detalles de las propiedades

activeEffects

Objeto de solo lectura que representa los efectos de audio activos actuales

activeEffects: ActiveAudioEffects

Valor de propiedad

ActiveAudioEffects

Detalles de las propiedades heredadas

name

Nombre de la característica.

name: string

Valor de propiedad

string

heredado deAudioStreamFeature.name

Detalles del método

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Método para comprobar si se admite un efecto en el entorno actual.

function isSupported(effect: "BrowserNoiseSuppression" | DeepNoiseSuppressionEffect): Promise<boolean>

Parámetros

effect

"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect

Instancia del efecto o del "Browser.". efecto para comprobar la compatibilidad de .

Devoluciones

Promise<boolean>

true si se admite el efecto en el entorno actual.

off("effectsError", AudioEffectsFeatureErrorListener)

Cancelar la suscripción a funciones: se desencadena en caso de error mientras se usan efectos

function off(event: "effectsError", listener: AudioEffectsFeatureErrorListener)

Parámetros

event

"effectsError"

Evento de tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

Devolución de llamada de un agente de escucha

off("effectsStarted", AudioEffectsFeatureListener)

Funciones de cancelación de la suscripción: se desencadena cuando se inician los efectos

function off(event: "effectsStarted", listener: AudioEffectsFeatureListener)

Parámetros

event

"effectsStarted"

Evento de tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Devolución de llamada de un agente de escucha

off("effectsStopped", AudioEffectsFeatureListener)

Funciones de cancelación de la suscripción: se activa cuando se detienen los efectos

function off(event: "effectsStopped", listener: AudioEffectsFeatureListener)

Parámetros

event

"effectsStopped"

Evento de tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Devolución de llamada de un agente de escucha

on("effectsError", AudioEffectsFeatureErrorListener)

Funciones de suscripción: se desencadena en caso de error al usar efectos

function on(event: "effectsError", listener: AudioEffectsFeatureErrorListener)

Parámetros

event

"effectsError"

Evento de tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

Devolución de llamada de un agente de escucha

on("effectsStarted", AudioEffectsFeatureListener)

Funciones de suscripción: se activa cuando se inician los efectos

function on(event: "effectsStarted", listener: AudioEffectsFeatureListener)

Parámetros

event

"effectsStarted"

Evento de tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Devolución de llamada de un agente de escucha

on("effectsStopped", AudioEffectsFeatureListener)

Funciones de suscripción: se desencadena cuando se detienen los efectos

function on(event: "effectsStopped", listener: AudioEffectsFeatureListener)

Parámetros

event

"effectsStopped"

Evento de tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Devolución de llamada de un agente de escucha

startEffects(AudioEffectsStartConfig)

Efectos de inicio

function startEffects(audioEffects: AudioEffectsStartConfig): Promise<void>

Parámetros

audioEffects
AudioEffectsStartConfig

Objeto que representa los efectos de audio que se van a iniciar

Devoluciones

Promise<void>

stopEffects(AudioEffectsStopConfig)

Efectos de detención

function stopEffects(audioEffects: AudioEffectsStopConfig): Promise<void>

Parámetros

audioEffects
AudioEffectsStopConfig

Devoluciones

Promise<void>

Detalles de los métodos heredados

dispose() 

function dispose()

heredado deAudioStreamFeature.dispose