Compartilhar via

CaptionsCommon interface

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

Estrutura de dados do objeto CaptionsCommon

Propriedades

activeSpokenLanguage

Indica o idioma falado ativo 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 de legendas ativas
supportedSpokenLanguages

Lista de idiomas falados com suporte a serem usados com o serviço de legenda no formato BCP 47

Métodos

setSpokenLanguage(string)

Atualiza o idioma da transcrição/legendas em andamento
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 da propriedade

activeSpokenLanguage

Indica o idioma falado ativo atual na chamada no formato BCP 47

activeSpokenLanguage: string

Valor da propriedade

string

isCaptionsFeatureActive

Indica se as legendas estão ativas na chamada atual

isCaptionsFeatureActive: boolean

Valor da propriedade

boolean

kind

Indica o tipo Captions para o objeto de legendas ativas

kind: CaptionsKind

Valor da propriedade

CaptionsKind

supportedSpokenLanguages

Lista de idiomas falados com suporte a serem usados com o serviço de legenda no formato BCP 47

supportedSpokenLanguages: string[]

Valor da propriedade

string[]

Detalhes do método

setSpokenLanguage(string)

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

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

Parâmetros

language

string

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

Retornos

Promise<void>

Uma promessa que representa a conclusão da operação Definir Idioma. A conclusão dessa promessa NÃO indica que o idioma foi alterado. Um evento 'SpokenLanguageChanged' será emitido quando o idioma for realmente alterado com êxito.

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 iniciar legendas.

Retornos

Promise<void>

Uma promessa que representa a conclusão do processo de intialização para a operação Iniciar Legenda A conclusão dessa promessa NÃO indica que as legendas foram iniciadas. Um evento 'CaptionsActiveChanged' será emitido quando as legendas forem 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>

Retornos

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 de legendas deixou a chamada. O participante cancelará a assinatura do recebimento de dados de legendas após ser interrompido com êxito.