Compartilhar via

AudioEffectsFeature interface

  • Referência
Pacote:
@azure/communication-calling

Interface de API para o recurso AudioEffects

Extends
AudioStreamFeature

Propriedades

activeEffects

Objeto somente leitura que representa os efeitos de áudio ativos atuais

Propriedades herdadas

name

O nome do recurso.

Métodos

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Método para verificar se há suporte para um efeito no ambiente atual.
off("effectsError", AudioEffectsFeatureErrorListener)

Cancelar assinatura de funções – aciona o erro ao usar efeitos
off("effectsStarted", AudioEffectsFeatureListener)

Cancelar assinatura de funções – é acionada quando os efeitos são iniciados
off("effectsStopped", AudioEffectsFeatureListener)

Cancelar assinatura de funções – é acionada quando os efeitos são interrompidos
on("effectsError", AudioEffectsFeatureErrorListener)

Funções de assinatura – aciona o erro ao usar efeitos
on("effectsStarted", AudioEffectsFeatureListener)

Funções de assinatura – é acionada quando os efeitos são iniciados
on("effectsStopped", AudioEffectsFeatureListener)

Funções de assinatura – é acionada quando os efeitos são interrompidos
startEffects(AudioEffectsStartConfig)

Efeitos de início
stopEffects(AudioEffectsStopConfig)

Efeitos de parada

Métodos herdados

dispose()

Detalhes da propriedade

activeEffects

Objeto somente leitura que representa os efeitos de áudio ativos atuais

activeEffects: ActiveAudioEffects

Valor da propriedade

ActiveAudioEffects

Detalhes das propriedades herdadas

name

O nome do recurso.

name: string

Valor da propriedade

string

herdado deAudioStreamFeature.name

Detalhes do método

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Método para verificar se há suporte para um efeito no ambiente atual.

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

Parâmetros

effect

"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect

Instância do efeito ou do 'Navegador'. efeito do qual verificar o suporte.

Retornos

Promise<boolean>

true se houver suporte para efeito no ambiente atual.

off("effectsError", AudioEffectsFeatureErrorListener)

Cancelar assinatura de funções – aciona o erro ao usar efeitos

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

Parâmetros

event

"effectsError"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

Um retorno de chamada do ouvinte

off("effectsStarted", AudioEffectsFeatureListener)

Cancelar assinatura de funções – é acionada quando os efeitos são iniciados

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

Parâmetros

event

"effectsStarted"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Um retorno de chamada do ouvinte

off("effectsStopped", AudioEffectsFeatureListener)

Cancelar assinatura de funções – é acionada quando os efeitos são interrompidos

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

Parâmetros

event

"effectsStopped"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Um retorno de chamada do ouvinte

on("effectsError", AudioEffectsFeatureErrorListener)

Funções de assinatura – aciona o erro ao usar efeitos

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

Parâmetros

event

"effectsError"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

Um retorno de chamada do ouvinte

on("effectsStarted", AudioEffectsFeatureListener)

Funções de assinatura – é acionada quando os efeitos são iniciados

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

Parâmetros

event

"effectsStarted"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Um retorno de chamada do ouvinte

on("effectsStopped", AudioEffectsFeatureListener)

Funções de assinatura – é acionada quando os efeitos são interrompidos

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

Parâmetros

event

"effectsStopped"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Um retorno de chamada do ouvinte

startEffects(AudioEffectsStartConfig)

Efeitos de início

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

Parâmetros

audioEffects
AudioEffectsStartConfig

Objeto que representa os efeitos de áudio a serem iniciados

Retornos

Promise<void>

stopEffects(AudioEffectsStopConfig)

Efeitos de parada

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

Parâmetros

audioEffects
AudioEffectsStopConfig

Retornos

Promise<void>

Detalhes do método herdado

dispose() 

function dispose()

Herdado deAudioStreamFeature.dispose