CaptionsCommon interface
Estructura de datos para el objeto CaptionsCommon
Propiedades
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 para el objeto de subtítulos activos. |
supported |
Lista de idiomas hablados admitidos que se usarán con el servicio subtítulo en formato BCP 47 |
Métodos
set |
Novedades el idioma de las transcripciones o 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
activeSpokenLanguage
Indica el idioma hablado activo actual en la llamada en formato BCP 47.
activeSpokenLanguage: string
Valor de propiedad
string
isCaptionsFeatureActive
Indica si los subtítulos están activos en la llamada actual.
isCaptionsFeatureActive: boolean
Valor de propiedad
boolean
kind
Indica el tipo captions para el objeto de subtítulos activos.
kind: CaptionsKind
Valor de propiedad
supportedSpokenLanguages
Lista de idiomas hablados admitidos que se usarán con el servicio subtítulo en formato BCP 47
supportedSpokenLanguages: string[]
Valor de propiedad
string[]
Detalles del método
setSpokenLanguage(string)
Novedades el idioma de las transcripciones o 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.
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.
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 Detener título La finalización de esta promesa no indica que el bot de subtítulos haya dejado la llamada. El participante cancelará la suscripción de recibir datos de subtítulos cuando se detenga correctamente.