Captions interface
Estrutura de dados do objeto Captions
- Extends
Propriedades herdadas
active |
Indica o idioma falado ativo atual na chamada no formato BCP 47 |
is |
Indica se as legendas estão ativas na chamada atual |
kind | Indica o tipo Captions para o objeto de legendas ativas |
supported |
Lista de idiomas falados com suporte a serem usados com o serviço de legenda no formato BCP 47 |
Métodos
off("Captions |
Cancelar assinatura de função para qualquer um dos eventos CaptionsPropertyChangedEventType |
off("Captions |
Cancelar assinatura de função para qualquer um dos eventos CaptionsPropertyChangedEventType |
off("Spoken |
Cancelar assinatura de função para qualquer um dos eventos SpokenLanguageChangedEventType |
on("Captions |
Função Subscribe para qualquer um dos eventos CaptionsPropertyChangedEventType |
on("Captions |
Função Subscribe para o evento CaptionsReceivedEventType |
on("Spoken |
Função Subscribe para qualquer um dos eventos SpokenLanguageChangedEventType |
Métodos herdados
set |
Atualiza o idioma da transcrição/legendas em andamento |
start |
Inicia o processamento de legendas nesta chamada com o manipulador fornecido para este cliente |
stop |
Interrompe a recuperação de dados de legendas na chamada para o usuário que iniciou stopCaptions |
Detalhes das propriedades herdadas
activeSpokenLanguage
Indica o idioma falado ativo atual na chamada no formato BCP 47
activeSpokenLanguage: string
Valor da propriedade
string
herdado decaptionsCommon.activeSpokenLanguage
isCaptionsFeatureActive
Indica se as legendas estão ativas na chamada atual
isCaptionsFeatureActive: boolean
Valor da propriedade
boolean
Herdado deCaptionsCommon.isCaptionsFeatureActive
kind
Indica o tipo Captions para o objeto de legendas ativas
kind: CaptionsKind
Valor da propriedade
herdado decaptionsCommon.kind
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[]
Herdado deCaptionsCommon.supportedSpokenLanguages
Detalhes do método
off("CaptionsActiveChanged", PropertyChangedEvent)
Cancelar assinatura de função para qualquer um dos eventos CaptionsPropertyChangedEventType
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"CaptionsActiveChanged"
nome do evento
- listener
- PropertyChangedEvent
fn de retorno de chamada que foi usado para assinar este evento
off("CaptionsReceived", CaptionsHandler)
Cancelar assinatura de função para qualquer um dos eventos CaptionsPropertyChangedEventType
function off(event: "CaptionsReceived", listener: CaptionsHandler)
Parâmetros
- event
-
"CaptionsReceived"
nome do evento
- listener
- CaptionsHandler
fn de retorno de chamada que foi usado para assinar este evento
off("SpokenLanguageChanged", PropertyChangedEvent)
Cancelar assinatura de função para qualquer um dos eventos SpokenLanguageChangedEventType
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"SpokenLanguageChanged"
nome do evento
- listener
- PropertyChangedEvent
fn de retorno de chamada que foi usado para assinar este evento
on("CaptionsActiveChanged", PropertyChangedEvent)
Função Subscribe para qualquer um dos eventos CaptionsPropertyChangedEventType
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"CaptionsActiveChanged"
nome do evento
- listener
- PropertyChangedEvent
fn de retorno de chamada que foi usado para assinar este evento
on("CaptionsReceived", CaptionsHandler)
Função Subscribe para o evento CaptionsReceivedEventType
function on(event: "CaptionsReceived", listener: CaptionsHandler)
Parâmetros
- event
-
"CaptionsReceived"
nome do evento
- listener
- CaptionsHandler
fn de retorno de chamada que foi usado para assinar este evento
on("SpokenLanguageChanged", PropertyChangedEvent)
Função Subscribe para qualquer um dos eventos SpokenLanguageChangedEventType
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"SpokenLanguageChanged"
nome do evento
- listener
- PropertyChangedEvent
fn de retorno de chamada que foi usado para assinar este evento
Detalhes do método herdado
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.
Herdado deCaptionsCommon.setSpokenLanguage
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.
herdado decaptionsCommon.startCaptions
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.
herdado decaptionsCommon.stopCaptions