Partilhar via

TeamsCaptions interface

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

Estrutura de dados para o objeto TeamsCaptions

Extends
CaptionsCommon

Propriedades

activeCaptionLanguage

Indica o idioma atual da legenda ativa no formato ISO 639-1
supportedCaptionLanguages

Lista de idiomas de legenda suportados para usar com o serviço de legenda no formato ISO 639-1

Propriedades Herdadas

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

off("CaptionLanguageChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para qualquer um dos eventos CaptionLanguageChangedEventType
off("CaptionsActiveChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para qualquer um dos eventos CaptionsPropertyChangedEventType
off("CaptionsReceived", TeamsCaptionsHandler)

Função de cancelamento de inscrição para qualquer um dos eventos CaptionsPropertyChangedEventType
off("SpokenLanguageChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para qualquer um dos eventos SpokenLanguageChangedEventType
on("CaptionLanguageChanged", PropertyChangedEvent)

Função Subscribe para qualquer um dos eventos CaptionLanguageChangedEventType
on("CaptionsActiveChanged", PropertyChangedEvent)

Função Subscribe para qualquer um dos eventos CaptionsPropertyChangedEventType
on("CaptionsReceived", TeamsCaptionsHandler)

Função Subscribe para o evento CaptionsReceivedEventType
on("SpokenLanguageChanged", PropertyChangedEvent)

Função Subscribe para qualquer um dos eventos SpokenLanguageChangedEventType
setCaptionLanguage(string)

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

Métodos Herdados

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

activeCaptionLanguage

Indica o idioma atual da legenda ativa no formato ISO 639-1

activeCaptionLanguage: string

Valor de Propriedade

string

supportedCaptionLanguages

Lista de idiomas de legenda suportados para usar com o serviço de legenda no formato ISO 639-1

supportedCaptionLanguages: string[]

Valor de Propriedade

string[]

Detalhes da Propriedade Herdada

activeSpokenLanguage

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

activeSpokenLanguage: string

Valor de Propriedade

string

herdado deCaptionsCommon.activeSpokenLanguage

isCaptionsFeatureActive

Indica se as legendas estão ativas na chamada atual

isCaptionsFeatureActive: boolean

Valor de Propriedade

boolean

herdado deCaptionsCommon.isCaptionsFeatureActive

kind

Indica o tipo Captions para o objeto legends ativo

kind: CaptionsKind

Valor de Propriedade

CaptionsKind

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("CaptionLanguageChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para qualquer um dos eventos CaptionLanguageChangedEventType

function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)

Parâmetros

event

"CaptionLanguageChanged"

Nome do evento

listener
PropertyChangedEvent

retorno de chamada fn que foi usado para se inscrever neste evento

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", TeamsCaptionsHandler)

Função de cancelamento de inscrição para qualquer um dos eventos CaptionsPropertyChangedEventType

function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)

Parâmetros

event

"CaptionsReceived"

Nome do evento

listener
TeamsCaptionsHandler

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("CaptionLanguageChanged", PropertyChangedEvent)

Função Subscribe para qualquer um dos eventos CaptionLanguageChangedEventType

function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)

Parâmetros

event

"CaptionLanguageChanged"

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", TeamsCaptionsHandler)

Função Subscribe para o evento CaptionsReceivedEventType

function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)

Parâmetros

event

"CaptionsReceived"

Nome do evento

listener
TeamsCaptionsHandler

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

setCaptionLanguage(string)

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

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

Parâmetros

language

string

A linguagem para legendar a fala como. Deve ter o formato ISO 639-1 (por exemplo, "en")

Devoluções

Promise<void>

Uma promessa que representa a conclusão da operação set Language A conclusão desta promessa NÃO indica que o idioma foi alterado. Um evento 'CaptionLanguageChanged' será emitido quando o idioma tiver sido alterado com êxito.

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