TeamsCaptions interface
Estructura de datos para el objeto TeamsCaptions
- Extends
Propiedades
| active |
Indica el idioma actual del título activo en formato ISO 639-1. |
| supported |
Lista de idiomas de título admitidos que se van a usar con el servicio de subtítulos en formato ISO 639-1 |
Propiedades heredadas
| active |
Indica el idioma hablado activo actual en la llamada en formato BCP 47. |
| is |
Indica si los subtítulos están activos en la llamada actual. |
| kind | Indica el tipo captions del objeto captions activo. |
| supported |
Lista de idiomas hablados admitidos que se van a usar con el servicio de subtítulos en formato BCP 47 |
Métodos
| off("Caption |
Función Unsubscribe para cualquiera de los eventos CaptionLanguageChangedEventType |
| off("Captions |
Función Unsubscribe para cualquiera de los eventos CaptionsPropertyChangedEventType |
| off("Captions |
Función Unsubscribe para cualquiera de los eventos CaptionsPropertyChangedEventType |
| off("Spoken |
Función Unsubscribe para cualquiera de los eventos SpokenLanguageChangedEventType |
| on("Caption |
Función Subscribe para cualquiera de los eventos CaptionLanguageChangedEventType |
| on("Captions |
Función Subscribe para cualquiera de los eventos CaptionsPropertyChangedEventType |
| on("Captions |
Función Subscribe para el evento CaptionsReceivedEventType |
| on("Spoken |
Función Subscribe para cualquiera de los eventos SpokenLanguageChangedEventType |
| set |
Actualiza el idioma de la transcripción o los subtítulos en curso. |
Métodos heredados
| set |
Actualiza el idioma de la transcripción o los subtítulos en curso. |
| start |
Inicia el procesamiento de subtítulos en esta llamada con el controlador proporcionado para este cliente. |
| stop |
Detiene la recuperación de datos de subtítulos en la llamada al usuario que inició stopCaptions. |
Detalles de las propiedades
activeCaptionLanguage
Indica el idioma actual del título activo en formato ISO 639-1.
activeCaptionLanguage: stringValor de propiedad
string
supportedCaptionLanguages
Lista de idiomas de título admitidos que se van a usar con el servicio de subtítulos en formato ISO 639-1
supportedCaptionLanguages: string[]Valor de propiedad
string[]
Detalles de las propiedades heredadas
activeSpokenLanguage
Indica el idioma hablado activo actual en la llamada en formato BCP 47.
activeSpokenLanguage: stringValor de propiedad
string
Heredado deCaptionsCommon.activeSpokenLanguage
isCaptionsFeatureActive
Indica si los subtítulos están activos en la llamada actual.
isCaptionsFeatureActive: booleanValor de propiedad
boolean
Heredado deCaptionsCommon.isCaptionsFeatureActive
kind
Indica el tipo captions del objeto captions activo.
kind: CaptionsKindValor de propiedad
Heredado deCaptionsCommon.kind
supportedSpokenLanguages
Lista de idiomas hablados admitidos que se van a usar con el servicio de subtítulos en formato BCP 47
supportedSpokenLanguages: string[]Valor de propiedad
string[]
heredado deCaptionsCommon.supportedSpokenLanguages
Detalles del método
off("CaptionLanguageChanged", PropertyChangedEvent)
Función Unsubscribe para cualquiera de los eventos CaptionLanguageChangedEventType
function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)Parámetros
- event
-
"CaptionLanguageChanged"
nombre del evento
- listener
- PropertyChangedEvent
callback fn que se usó para suscribirse a este evento
off("CaptionsActiveChanged", PropertyChangedEvent)
Función Unsubscribe para cualquiera de los eventos CaptionsPropertyChangedEventType
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parámetros
- event
-
"CaptionsActiveChanged"
nombre del evento
- listener
- PropertyChangedEvent
callback fn que se usó para suscribirse a este evento
off("CaptionsReceived", TeamsCaptionsHandler)
Función Unsubscribe para cualquiera de los eventos CaptionsPropertyChangedEventType
function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)Parámetros
- event
-
"CaptionsReceived"
nombre del evento
- listener
- TeamsCaptionsHandler
callback fn que se usó para suscribirse a este evento
off("SpokenLanguageChanged", PropertyChangedEvent)
Función Unsubscribe para cualquiera de los eventos SpokenLanguageChangedEventType
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parámetros
- event
-
"SpokenLanguageChanged"
nombre del evento
- listener
- PropertyChangedEvent
callback fn que se usó para suscribirse a este evento
on("CaptionLanguageChanged", PropertyChangedEvent)
Función Subscribe para cualquiera de los eventos CaptionLanguageChangedEventType
function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)Parámetros
- event
-
"CaptionLanguageChanged"
nombre del evento
- listener
- PropertyChangedEvent
callback fn que se usó para suscribirse a este evento
on("CaptionsActiveChanged", PropertyChangedEvent)
Función Subscribe para cualquiera de los eventos CaptionsPropertyChangedEventType
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parámetros
- event
-
"CaptionsActiveChanged"
nombre del evento
- listener
- PropertyChangedEvent
callback fn que se usó para suscribirse a este evento
on("CaptionsReceived", TeamsCaptionsHandler)
Función Subscribe para el evento CaptionsReceivedEventType
function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)Parámetros
- event
-
"CaptionsReceived"
nombre del evento
- listener
- TeamsCaptionsHandler
callback fn que se usó para suscribirse a este evento
on("SpokenLanguageChanged", PropertyChangedEvent)
Función Subscribe para cualquiera de los eventos SpokenLanguageChangedEventType
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parámetros
- event
-
"SpokenLanguageChanged"
nombre del evento
- listener
- PropertyChangedEvent
callback fn que se usó para suscribirse a este evento
setCaptionLanguage(string)
Actualiza el idioma de la transcripción o los subtítulos en curso.
function setCaptionLanguage(language: string): Promise<void>Parámetros
- language
-
string
Idioma al que se va a título la voz. Debe tener el formato ISO 639-1 (por ejemplo, "en")
Devoluciones
Promise<void>
Promesa que representa la finalización de la operación Establecer idioma La finalización de esta promesa no indica que el idioma ha cambiado. Se emitirá un evento "CaptionLanguageChanged" cuando el idioma haya cambiado correctamente.
Detalles de los métodos heredados
setSpokenLanguage(string)
Actualiza el idioma de la transcripción o los subtítulos en curso.
function setSpokenLanguage(language: string): Promise<void>Parámetros
- language
-
string
Idioma al que se va a título la voz. Debe tener el formato BCP 47 (por ejemplo, "en-us")
Devoluciones
Promise<void>
Promesa que representa la finalización de la operación Establecer idioma. La finalización de esta promesa no indica que el idioma ha cambiado. Se emitirá un evento "SpokenLanguageChanged" cuando el idioma haya cambiado correctamente.
Se hereda deCaptionsCommon.setSpokenLanguage
startCaptions(StartCaptionsOptions)
Inicia el procesamiento de subtítulos en esta llamada con el controlador proporcionado para este cliente.
function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>Parámetros
- startCaptionsOptions
- StartCaptionsOptions
Opciones adicionales para iniciar subtítulos.
Devoluciones
Promise<void>
Promesa que representa la finalización del proceso de inicialización para la operación Start Caption La finalización de esta promesa no indica que se han iniciado los títulos. Se emitirá un evento "CaptionsActiveChanged" cuando los títulos se hayan iniciado correctamente.
Se hereda deCaptionsCommon.startCaptions
stopCaptions()
Detiene la recuperación de datos de subtítulos en la llamada al usuario que inició stopCaptions.
function stopCaptions(): Promise<void>Devoluciones
Promise<void>
Promesa que representa la finalización de la operación Stop Caption. La finalización de esta promesa no indica que el bot de subtítulos haya dejado la llamada. El participante cancelará la suscripción a la recepción de datos de subtítulos cuando se detenga correctamente.
Heredado deCaptionsCommon.stopCaptions