Partilhar via

CaptionsCommon interface

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

Estrutura de dados para o objeto CaptionsCommon

Propriedades

activeSpokenLanguage

Indica a língua falada ativa atual na chamada no formato BCP 47
isCaptionsFeatureActive

Indica se as legendas estão ativas na chamada atual
kind

Indica o tipo Captions para o objeto legends ativo
supportedSpokenLanguages

Lista de idiomas falados suportados para usar com o serviço de legenda no formato BCP 47

Métodos

setSpokenLanguage(string)

Atualiza o idioma da transcrição / legendas em curso
startCaptions(StartCaptionsOptions)

Inicia o processamento de legendas nesta chamada com o manipulador fornecido para este cliente
stopCaptions()

Interrompe a recuperação de dados de legendas na chamada para o usuário que iniciou stopCaptions

Detalhes de Propriedade

activeSpokenLanguage

Indica a língua falada ativa atual na chamada no formato BCP 47

activeSpokenLanguage: string

Valor de Propriedade

string

isCaptionsFeatureActive

Indica se as legendas estão ativas na chamada atual

isCaptionsFeatureActive: boolean

Valor de Propriedade

boolean

kind

Indica o tipo Captions para o objeto legends ativo

kind: CaptionsKind

Valor de Propriedade

CaptionsKind

supportedSpokenLanguages

Lista de idiomas falados suportados para usar com o serviço de legenda no formato BCP 47

supportedSpokenLanguages: string[]

Valor de Propriedade

string[]

Detalhes de Método

setSpokenLanguage(string)

Atualiza o idioma da transcrição / legendas em curso

function setSpokenLanguage(language: string): Promise<void>

Parâmetros

language

string

A linguagem para legendar a fala como. Deve ser formato BCP 47 (por exemplo, "en-us")

Devoluções

Promise<void>

Uma Promise que representa a conclusão da operação set Language. O cumprimento desta promessa NÃO indica que a linguagem mudou. Um evento 'SpokenLanguageChanged' será emitido quando o idioma tiver sido alterado com sucesso.

startCaptions(StartCaptionsOptions)

Inicia o processamento de legendas nesta chamada com o manipulador fornecido para este cliente

function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>

Parâmetros

startCaptionsOptions
StartCaptionsOptions

Opções adicionais para legendas iniciais.

Devoluções

Promise<void>

Uma promessa que representa a conclusão do processo de inicialização para a operação Start Caption A conclusão desta promessa NÃO indica que as legendas foram iniciadas. Um evento 'CaptionsActiveChanged' será emitido quando as legendas tiverem sido iniciadas com êxito.

stopCaptions()

Interrompe a recuperação de dados de legendas na chamada para o usuário que iniciou stopCaptions

function stopCaptions(): Promise<void>

Devoluções

Promise<void>

Uma promessa que representa a conclusão da operação Stop Caption A conclusão dessa promessa NÃO indica que o bot captions deixou a chamada. O participante cancelará a inscrição do recebimento de dados de legendas após a interrupção bem-sucedida.