Captions interface
Estrutura de dados para o objeto Captions
- Extends
Propriedades Herdadas
| active |
Indica a língua falada ativa 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 legends ativo |
| supported |
Lista de idiomas falados suportados para usar com o serviço de legenda no formato BCP 47 |
Métodos
| off("Captions |
Função de cancelamento de inscrição para qualquer um dos eventos CaptionsPropertyChangedEventType |
| off("Captions |
Função de cancelamento de inscrição para qualquer um dos eventos CaptionsPropertyChangedEventType |
| off("Spoken |
Função de cancelamento de inscriçã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 curso |
| 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 da Propriedade Herdada
activeSpokenLanguage
Indica a língua falada ativa atual na chamada no formato BCP 47
activeSpokenLanguage: stringValor de Propriedade
string
herdado deCaptionsCommon.activeSpokenLanguage
isCaptionsFeatureActive
Indica se as legendas estão ativas na chamada atual
isCaptionsFeatureActive: booleanValor de Propriedade
boolean
herdado deCaptionsCommon.isCaptionsFeatureActive
kind
Indica o tipo Captions para o objeto legends ativo
kind: CaptionsKindValor de Propriedade
herdado deCaptionsCommon.kind
supportedSpokenLanguages
Lista de idiomas falados suportados para usar com o serviço de legenda no formato BCP 47
supportedSpokenLanguages: string[]Valor de Propriedade
string[]
herdado deCaptionsCommon.supportedSpokenLanguages
Detalhes de Método
off("CaptionsActiveChanged", PropertyChangedEvent)
Função de cancelamento de inscrição para qualquer um dos eventos CaptionsPropertyChangedEventType
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"CaptionsActiveChanged"
Nome do evento
- listener
- PropertyChangedEvent
retorno de chamada fn que foi usado para se inscrever neste evento
off("CaptionsReceived", CaptionsHandler)
Função de cancelamento de inscrição para qualquer um dos eventos CaptionsPropertyChangedEventType
function off(event: "CaptionsReceived", listener: CaptionsHandler)Parâmetros
- event
-
"CaptionsReceived"
Nome do evento
- listener
- CaptionsHandler
retorno de chamada fn que foi usado para se inscrever neste evento
off("SpokenLanguageChanged", PropertyChangedEvent)
Função de cancelamento de inscrição para qualquer um dos eventos SpokenLanguageChangedEventType
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"SpokenLanguageChanged"
Nome do evento
- listener
- PropertyChangedEvent
retorno de chamada fn que foi usado para se inscrever neste 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
retorno de chamada fn que foi usado para se inscrever neste 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
retorno de chamada fn que foi usado para se inscrever neste 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
retorno de chamada fn que foi usado para se inscrever neste evento
Detalhes do Método Herdado
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.
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 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.
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>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.
herdado deCaptionsCommon.stopCaptions