Partilhar via

AudioEffectsFeature interface

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

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Interface de API para a funcionalidade AudioEffects

Extends
AudioStreamFeature

Propriedades

activeEffects

Objeto só de leitura que representa os efeitos de áudio ativos atuais

Propriedades Herdadas

name

O nome da funcionalidade.

Métodos

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

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

Anular a subscrição de funções – aciona o erro ao utilizar efeitos
off("effectsStarted", AudioEffectsFeatureListener)

Anular a subscrição de funções – aciona quando os efeitos são iniciados
off("effectsStopped", AudioEffectsFeatureListener)

Anular a subscrição de funções – aciona quando os efeitos são parados
on("effectsError", AudioEffectsFeatureErrorListener)

Funções de subscrição – aciona o erro ao utilizar efeitos
on("effectsStarted", AudioEffectsFeatureListener)

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

Funções de subscrição – aciona quando os efeitos são parados
startEffects(AudioEffectsStartConfig)

Efeitos de início
stopEffects(AudioEffectsStopConfig)

Efeitos de paragem

Métodos Herdados

dispose()

Detalhes de Propriedade

activeEffects

Objeto só de leitura que representa os efeitos de áudio ativos atuais

activeEffects: ActiveAudioEffects

Valor de Propriedade

ActiveAudioEffects

Detalhes da Propriedade Herdada

name

O nome da funcionalidade.

name: string

Valor de Propriedade

string

Herdado deAudioStreamFeature.name

Detalhes de Método

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Método para verificar se um efeito é suportado no ambiente atual.

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

Parâmetros

effect

"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect

Instância do efeito ou do "Browser". para verificar o suporte de.

Devoluções

Promise<boolean>

true se o efeito for suportado no ambiente atual.

off("effectsError", AudioEffectsFeatureErrorListener)

Anular a subscrição de funções – aciona o erro ao utilizar efeitos

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

Parâmetros

event

"effectsError"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

Uma chamada de retorno do serviço de escuta

off("effectsStarted", AudioEffectsFeatureListener)

Anular a subscrição de funções – aciona quando os efeitos são iniciados

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

Parâmetros

event

"effectsStarted"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

off("effectsStopped", AudioEffectsFeatureListener)

Anular a subscrição de funções – aciona quando os efeitos são parados

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

Parâmetros

event

"effectsStopped"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

on("effectsError", AudioEffectsFeatureErrorListener)

Funções de subscrição – aciona o erro ao utilizar efeitos

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

Parâmetros

event

"effectsError"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

Uma chamada de retorno do serviço de escuta

on("effectsStarted", AudioEffectsFeatureListener)

Funções de subscrição – aciona quando os efeitos são iniciados

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

Parâmetros

event

"effectsStarted"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

on("effectsStopped", AudioEffectsFeatureListener)

Funções de subscrição – aciona quando os efeitos são parados

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

Parâmetros

event

"effectsStopped"

Evento do tipo AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

startEffects(AudioEffectsStartConfig)

Efeitos de início

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

Parâmetros

audioEffects
AudioEffectsStartConfig

Objeto que representa os efeitos de áudio a iniciar

Devoluções

Promise<void>

stopEffects(AudioEffectsStopConfig)

Efeitos de paragem

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

Parâmetros

audioEffects
AudioEffectsStopConfig

Devoluções

Promise<void>

Detalhes do Método Herdado

dispose() 

function dispose()

Herdado deAudioStreamFeature.dispose