Compartir a través de

CaptionsCommon interface

  • Referencia
Paquete:
@azure/communication-calling

Estructura de datos para el objeto CaptionsCommon

Propiedades

activeSpokenLanguage

Indica el idioma hablado activo actual en la llamada en formato BCP 47.
isCaptionsFeatureActive

Indica si los subtítulos están activos en la llamada actual.
kind

Indica el tipo captions del objeto captions activo.
supportedSpokenLanguages

Lista de idiomas hablados admitidos que se van a usar con el servicio de subtítulos en formato BCP 47

Métodos

setSpokenLanguage(string)

Actualiza el idioma de la transcripción o los subtítulos en curso.
startCaptions(StartCaptionsOptions)

Inicia el procesamiento de subtítulos en esta llamada con el controlador proporcionado para este cliente.
stopCaptions()

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 del objeto captions activo.

kind: CaptionsKind

Valor de propiedad

CaptionsKind

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[]

Detalles del método

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.

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>

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.