Captions interface
Nota
Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Estructura de datos para el objeto Captions
- Extends
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 de subtítulos activo. |
| supported |
Lista de idiomas hablados admitidos que se van a usar con el servicio subtítulo en formato BCP 47 |
Métodos
| 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 De cancelación de suscripción para cualquiera de los eventos SpokenLanguageChangedEventType |
| 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 |
Métodos heredados
| set |
Novedades 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 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 de subtítulos activo.
kind: CaptionsKindValor de propiedad
Heredado deCaptionsCommon.kind
supportedSpokenLanguages
Lista de idiomas hablados admitidos que se van a usar con el servicio subtítulo en formato BCP 47
supportedSpokenLanguages: string[]Valor de propiedad
string[]
Heredado deCaptionsCommon.supportedSpokenLanguages
Detalles del método
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", CaptionsHandler)
Función Unsubscribe para cualquiera de los eventos CaptionsPropertyChangedEventType
function off(event: "CaptionsReceived", listener: CaptionsHandler)Parámetros
- event
-
"CaptionsReceived"
Nombre del evento
- listener
- CaptionsHandler
callback fn que se usó para suscribirse a este evento
off("SpokenLanguageChanged", PropertyChangedEvent)
Función De cancelación de suscripción 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("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", CaptionsHandler)
Función Subscribe para el evento CaptionsReceivedEventType
function on(event: "CaptionsReceived", listener: CaptionsHandler)Parámetros
- event
-
"CaptionsReceived"
Nombre del evento
- listener
- CaptionsHandler
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
Detalles de los métodos heredados
setSpokenLanguage(string)
Novedades el idioma de la transcripción o los subtítulos en curso
function setSpokenLanguage(language: string): Promise<void>Parámetros
- language
-
string
Idioma que se va a subtítulo voz como. Debe tener el formato BCP 47 (por ejemplo, "en-us")
Devoluciones
Promise<void>
Promesa que representa la finalización de la operación Establecer lenguaje. La finalización de esta promesa NO indica que el idioma ha cambiado. Se emitirá un evento "SpokenLanguageChanged" cuando el idioma haya cambiado correctamente.
Heredado 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 subtítulos. Se emitirá un evento "CaptionsActiveChanged" cuando los subtítulos se hayan iniciado correctamente.
Heredado 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>
Una 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 ha dejado la llamada. El participante cancelará la suscripción de la recepción de datos de subtítulos cuando se detenga correctamente.
Heredado deCaptionsCommon.stopCaptions