Subtítulos en directo

Utiliza el API de subtítulos en directo para permitir el subtitulado de audio en tiempo real de los editores y abonados conectados a una sesión.

Los subtítulos en directo deben activarse a nivel de sesión a través de la opción API REST.

Los subtítulos en directo sólo se admiten en sesión enrutada.

Publishing live captions

<OTPublisher
  style={{width: 400, height: 300}}
  properties={{
    publishCaptions: true,
    // ... other properties
  }}
/>

Este ajuste es false por defecto.

Puede cambiar dinámicamente esta propiedad (basándose en un cambio de estado de React) para activar o desactivar los subtítulos de la secuencia publicada.

Subscribing to live captions

<OTSubscriber
  style={{width: 200, height: 200}}
  properties={{
    subscribeToCaptions: true,
    // ... other properties
  }}
  eventHandlers={{
    captionReceived: event => {
      console.log('Caption received:', event.text);
      console.log('Caption final:', event.isFinal);
    },
  }}
/>

Puede ajustar el subscribeToCaptions propiedad a true independientemente de si el cliente que publica el flujo está publicando actualmente subtítulos en directo. El suscriptor comenzará a recibir datos de subtítulos una vez que el editor comience a publicar subtítulos.

Los abonados reciben los subtítulos a través de captionReceived (mostrado arriba).

El objeto de evento captionReceived tiene dos properties:

• texto - El texto del pie de foto (una cadena)
• isFinal - Si el texto del pie de foto es final para una frase (true) o parcial (false). El SDK de React Native no muestra el texto de los eventos captions. Puedes crear tu propio elemento UI para renderizar el texto de los subtítulos basado en eventos de subtítulos.

Recibir sus propios subtítulos en directo

El Vonage Client SDK no admite que un editor reciba eventos para sus propios subtítulos. Para renderizar subtítulos para un flujo publicado por el cliente local, crea un suscriptor oculto (al flujo del editor local) para escuchar los eventos de subtítulos. Establezca la propiedad subscribeToSelf de la propiedad OTSubscriber a true. No debe renderizar el vídeo de este abonado (configurando su width y height a 0) y no debe suscribirse al audio (para evitar el eco, configurando subscribeToAudio a falso).

Puede añadir los subtítulos a la interfaz de usuario, como haría con los subtítulos de otros flujos. Consulte Representación personalizada de los abonados.

Enabling live captions

Un editor puede inicializarse con el booleano opcional publishCaptions parámetro. El parámetro se pasa a través de la función properties objeto. Este parámetro será falso por defecto.

const publisher = OT.initPublisher({ publishCaptions: true });

Toggling live captions for a publisher dynamically

Una vez activados los subtítulos en directo, un editor puede iniciar o detener el envío de subtítulos llamando a la función publishCaptions método. Este método acepta un booleano como parámetro.

El código siguiente muestra un ejemplo de detención de subtítulos en directo para un editor.

publisher.publishCaptions(false);

El código siguiente muestra un ejemplo de inicio de subtítulos en directo para un editor.

publisher.publishCaptions(true);

Subscribing to live captions

Un abonado puede elegir comenzar o dejar de recibir subtítulos en directo.

Subscriber subscribeToCaptions Method

Un abonado puede iniciar o detener la recepción de subtítulos llamando a la función asíncrona subscribeToCaptions método. Este método acepta un booleano como parámetro.

Este método puede invocarse independientemente de si el editor está publicando subtítulos en directo. El suscriptor comenzará a recibir datos de subtítulos una vez que el editor comience a publicar subtítulos.

El código siguiente muestra un ejemplo de inicio de subtítulos en directo para un abonado.

try {
    await subscriber.subscribeToCaptions(true);
} catch (err) {
    console.warn(err);
}

El código siguiente muestra un ejemplo de detención de subtítulos en directo para un abonado.

try {
    await subscriber.subscribeToCaptions(false);
} catch (err) {
    console.warn(err);
}

Enabling live captions for a subscriber

Los suscriptores pueden verificar si están suscritos activamente a los subtítulos en directo de un editor utilizando el botón isSubscribedToCaptions método. Este método no tiene parámetros y devuelve un booleano

const isSubscribed = subscriber.isSubscribedToCaptions()
console.log(`${isSubscribed} states whether or not a given subscriber is subscribing to live captions`).

Receiving live captions

Los suscriptores reciben subtítulos a través de eventos. El SDK no muestra el texto de los eventos de subtítulos.

Subscriber captionReceived Event

Un abonado que esté suscrito activamente a subtítulos en directo enviará captionReceived eventos. En captionReceived tiene tres propiedades: caption, streamIdy isFinal. streamId es el ID del flujo, mientras que caption es el texto transcrito. isFinal indica si se ha terminado de transcribir un subtítulo. Este valor sólo es relevante cuando se utilizan subtítulos parciales. El desarrollador puede elegir cómo y dónde mostrar el texto del subtítulo.

subscriber.on('captionReceived', function(event){
    console.log(`Caption received for stream ${event.streamId}`);
    console.log(`Caption text: ${event.caption}`);
    console.log(`Final text: ${event.isFinal}`);
})

A continuación se muestran los registros de la consola cuando se utilizan subtítulos parciales y un editor dice "Esta es mi frase".

subscriber.on('captionReceived', function(event){
    console.log(`The ${event.isFinal ? 'complete' : 'partial'} caption text is: "${event.caption}"`)
})
// The partial caption text is: "This"
// The partial caption text is: "This is"
// The partial caption text is: "This is my" 
// The complete caption text is: "This is my sentence"

Receiving your own live captions

El Vonage Client SDK no admite que un editor reciba eventos para sus propios subtítulos. Para mostrar los subtítulos del orador, crea un suscriptor oculto (al flujo del editor local) para escuchar los eventos de subtítulos. Este suscriptor no debe estar unido al DOM y no debe suscribirse al audio, para evitar el eco. A continuación, puede añadir los subtítulos a la interfaz de usuario.

A continuación se muestra la creación de un abonado oculto para que el editor reciba sus propios subtítulos.

const captionOnlySub = session.subscribe(
    publisher.stream,
    document.createElement('div'),
    {
    audioVolume: 0,
    testNetwork: true, // This option is only needed in OpenTok.js versions below 2.25.1
    },
);

captionOnlySub.on('captionReceived', (event) => {
    // Do something with the event.caption
});

Nota: Para OpenTok.js 2.25.0 y versiones anteriores, es necesario configurar testNetwork a true en las opciones pasadas a Session.subscribe()debido a un error.

Sample

En Muestras web de Vonage Muestra de Basic-Captions utiliza subtítulos en vivo en una aplicación web creada con Vonage Client SDK.

Publishing live captions

Un editor puede iniciar o detener la publicación de subtítulos en directo en tiempo real llamando a la función setPublishCaptions() del objeto PublisherKit:

publisher.setPublishCaptions(true);

Si el editor no incluye una pista de audio, el PublisherKit.PublisherListener.onError() se llama con un error (con el método code del error establecida en PublisherMissingAudioTrack).

El SDK de Android no admite que un editor reciba eventos para sus propios subtítulos. Para renderizar los subtítulos propios del orador, cree un suscriptor oculto (al flujo del editor) para escuchar los eventos de subtítulos. (Véase la siguiente sección).

Subscribing to live captions

Un abonado puede iniciar o detener la recepción de subtítulos llamando a la tecla subscribeToCaptions() método del objeto SubscriberKit:

subscriber.setSubscribeToCaptions(true);

Puede llamar a este método independientemente de si el editor de la secuencia está publicando actualmente subtítulos en directo. El suscriptor comenzará a recibir datos de subtítulos una vez que el editor comience a a publicar subtítulos.

Para dejar de recibir subtítulos, pase false en el método:

subscriber.setSubscribeToCaptions(false);

Los suscriptores pueden verificar si están suscritos activamente a los subtítulos en directo de una emisión utilizando el botón isSubscribedToCaptions() método:

boolean isSubscribed = subscriber.getSubscribeToCaptions();

Los suscriptores reciben los subtítulos a través de eventos. El SDK no muestra el texto de los subtítulos en la interfaz de usuario. Utilice la función SubscriberKit.CaptionsListener para configurar un receptor de eventos de subtítulos:

SubscriberKit.CaptionsListener captionsListener = new SubscriberKit.CaptionsListener() {
    @Override
    public void onCaptionText(SubscriberKit subscriber, String text, boolean isFinal) {
        // Display the text in the UI.
    }
}

En hasCaptions() de un objeto Stream indica si el flujo tiene subtítulos:

boolean hasCaptions = stream.hasCaptions();

Aplicar la onStreamHasCaptionsChanged() método del Session.StreamPropertiesListener para controlar cuándo un flujo tiene subtítulos activados y desactivados:

Session.StreamPropertiesListener captioningListener = new Session.StreamPropertiesListener() {
    @Override
    public void onStreamHasCaptionsChanged(Session session, Stream stream, boolean hasCaptions) {
        // Adjust UI to indicate that captions are or are not available.
    }
}

Publishing live captions

Un editor puede iniciar o detener la publicación de subtítulos en directo en tiempo real configurando la opción publishCaptions del objeto OTPublisherKit:

publisher.publishCaptions = true

Si el editor no incluye una pista de audio, el [PublisherKit publisher:didFailWithError:] con el mensaje code del error establecida en OTPublisherMissingAudioTrack.

El SDK para iOS de Vonage no admite que un editor reciba eventos para sus propios subtítulos. Para renderizar los subtítulos propios del orador, crea un suscriptor oculto (al flujo del editor) para escuchar los eventos de subtítulos. (Consulta la siguiente sección).

Subscribing to live captions

Un abonado puede iniciar o detener la recepción de subtítulos configurando la opción subscribeToCaptions propiedad del objeto OTSubscriberKit:

subscriber.subscribeToCaptions = true

Puede llamar a este método independientemente de si el editor de la secuencia está publicando actualmente subtítulos en directo. El suscriptor comenzará a recibir datos de subtítulos una vez que el editor comience a a publicar subtítulos.

Para dejar de recibir subtítulos, ajuste la propiedad a false:

subscriber.setSubscribeToCaptions = false

En OTSubscriberKitCaptionsDelegate(_:subscriber:caption:isFinal:) se envía cuando un recibe subtítulos:

// OTSubscriberKitDelegate callbacks:
func subscriber(_ subscriber: OTSubscriberKit, caption text: NSString, isFinal final: Bool) {
  // Display caption text in UI.
}

Puede configurar un observador clave-valor para la función hasCaptions de un objeto OTStream para ver cuándo el flujo tiene subtítulos habilitados y deshabilitados.

//add observer on a stream of interest
let hasCaptionsObservation: NSKeyValueObservation = subscriber.stream.observe(\.hasCaptions, options: [.old, .new]) { object, change in
	guard let oldValue = change.oldValue else { return }
	guard let newValue = change.newValue else { return }
	print("KVO change for \(subscriber.stream.streamId) hasCaptions: \(newValue)")
	//manipulate GUI element
}

Publishing live captions

Un editor puede iniciar o detener la publicación de subtítulos en directo en tiempo real configurando la opción publishCaptions del objeto OTPublisherKit:

publisher.publishCaptions = YES;

Si el editor no incluye una pista de audio, el [PublisherKit publisher:didFailWithError:] con el mensaje code del error establecida en OTPublisherMissingAudioTrack.

El SDK para iOS de Vonage no admite que un editor reciba eventos para sus propios subtítulos. Para renderizar los subtítulos propios del orador, crea un suscriptor oculto (al flujo del editor) para escuchar los eventos de subtítulos. (Consulta la siguiente sección).

Subscribing to live captions

Un abonado puede iniciar o detener la recepción de subtítulos configurando la opción subscribeToCaptions propiedad del objeto OTSubscriberKit:

subscriber.subscribeToCaptions = YES;

Puede llamar a este método independientemente de si el editor de la secuencia está publicando actualmente subtítulos en directo. El suscriptor comenzará a recibir datos de subtítulos una vez que el editor comience a a publicar subtítulos.

Para dejar de recibir subtítulos, ajuste la propiedad a NO:

subscriber.setSubscribeToCaptions = NO;

En [OTSubscriberKitCaptionsDelegate subscriber:caption:isFinal:] se envía cuando un recibe subtítulos:

// OTSubscriber delegate callbacks:
-(void) subscriber:(OTSubscriberKit *)subscriber caption:(NSString *)text isFinal:(BOOL)final {
    // Display caption text in UI.
}

Puede configurar un observador clave-valor para la función hasCaptions de un OTStream para ver cuándo el flujo tiene subtítulos activados y desactivados:

//add observer on a stream of interest
[_subscriber.stream addObserver:self forKeyPath:@"hasCaptions" options:NSKeyValueObservingOptionNew context:NULL];
    
- (void)observeValueForKeyPath:(NSString *)keyPath
                      ofObject:(id)object
                        change:(NSDictionary *)change
                       context:(void *)context {
    NSLog(@"KVO change for %@ = %@",keyPath, change); 
    //manipulate GUI element
}

Publishing live captions

Un editor puede iniciar o detener la publicación de subtítulos en directo en tiempo real configurando la opción PublishCaptions del objeto Editor:

publisher.PublishCaptions = true;

Si el editor no incluye una pista de audio, el PublisherKit.Error , con el ErrorCode del objeto ErrorEventArgs con el valor PublisherMissingAudioTrack.

El SDK para Windows de Vonage no admite que un editor reciba eventos para sus propios subtítulos. Para representar los subtítulos propios del orador, crea un suscriptor oculto (al flujo del editor) para escuchar los eventos de subtítulos. (Consulta la siguiente sección).

Subscribing to live captions

Un abonado puede iniciar o detener la recepción de subtítulos configurando la opción SubscribeToCaptions propiedad del objeto Suscriptor:

subscriber.SubscribeToCaptions = true;

Puede establecer esta propiedad independientemente de si el editor del flujo está publicando actualmente subtítulos en directo. El suscriptor comenzará a recibir datos de subtítulos una vez que el editor comience a a publicar subtítulos.

Para dejar de recibir subtítulos, ajuste la propiedad a false:

subscriber.SubscribeToCaptions = false;

Los suscriptores reciben los subtítulos a través de eventos. El SDK no muestra el texto de los subtítulos en la interfaz de usuario. Añada un receptor de eventos para la función Subscriber.CaptionText evento:

subscriber.CaptionText += (object sender, Subscriber.CaptionTextArgs e) =>
{
	// Display the text in the UI.
};

En HasCaptions de un objeto Stream indica si el flujo tiene subtítulos:

stream.HasCaptions;

En Session.StreamHasCaptionsChanged cuando un flujo tiene subtítulos activados y desactivados:

session.StreamHasCaptionsChanged += (object sender, StreamEventArgs e) =>
{
	// Adjust UI to indicate that captions are or are not available.
};

Publishing live captions

Un editor puede iniciar o detener la publicación de subtítulos en directo en tiempo real llamando a la función otc_publisher_set_publish_captions() función:

otc_publisher_set_publish_captions(publisher, OTC_FALSE);

Si el editor no incluye una pista de audio, el otc_publisher_callbacks.on_error() devolución de llamada con un error, con el código de error establecido en OTC_PUBLISHER_MISSING_AUDIO_TRACK.

El SDK para macOS de Vonage no admite que un editor reciba eventos para sus propios subtítulos. Para reproducir los subtítulos del orador, crea un suscriptor oculto (en el flujo del editor) para escuchar los eventos de subtítulos. (Véase la sección siguiente).

Subscribing to live captions

Un abonado puede iniciar o detener la recepción de subtítulos llamando a la tecla otc_subscriber_set_subscribe_to_captions() función:

otc_subscriber_set_subscribe_to_captions(subscriber, OTC_TRUE);

Puede llamar a esta función independientemente de si el editor del flujo está publicando actualmente subtítulos en directo. El suscriptor comenzará a recibir datos de subtítulos una vez que el editor comience a a publicar subtítulos.

Para dejar de recibir subtítulos, pase OTC_FALSE en la función:

otc_subscriber_set_subscribe_to_captions(subscriber, OTC_FALSE);

Los suscriptores pueden verificar si están suscritos activamente a los subtítulos en directo de una emisión utilizando el botón otc_subscriber_get_subscribe_to_captions() función:

otc_bool isSubscribed = otc_subscriber_get_subscribe_to_captions(subscriber);

Los suscriptores reciben los subtítulos a través de eventos. El SDK no muestra el texto de los subtítulos en la interfaz de usuario. Establezca el on_caption_text() de la función otc_subscriber_callbacks instancia para configurar un receptor de eventos de subtítulos:

static void on_caption_text(otc_subscriber *subscriber,
                                      void *user_data,
                                      const char* text) {
    // Display the text in the UI.
}

subscriber_callbacks.on_caption_text = on_caption_text;

En otc_stream_has_captions() informa de si un flujo tiene subtítulos:

otc_bool hasCaptions = otc_stream_has_captions(stream);

Aplicar la on_stream_has_captions_changed() de la función otc_session_callbacks para supervisar cuándo un flujo tiene subtítulos activados y desactivados:

static void on_stream_has_captions_changed(otc_session* session,
                                                   void *user_data,
                                             otc_stream *stream,
                                                  otc_bool has_captions) {
  // Adjust UI to indicate that captions are or are not available.
}

session_callbacks.on_stream_has_captions_changed = on_stream_has_captions_changed;

Publishing live captions

Un editor puede iniciar o detener la publicación de subtítulos en directo en tiempo real llamando a la función otc_publisher_set_publish_captions() función:

otc_publisher_set_publish_captions(publisher, OTC_FALSE);

Si el editor no incluye una pista de audio, el otc_publisher_callbacks.on_error() devolución de llamada con un error, con el código de error establecido en OTC_PUBLISHER_MISSING_AUDIO_TRACK.

Vonage Linus SDK no admite que un editor reciba eventos para sus propios subtítulos. Para representar los subtítulos propios del orador, crea un suscriptor oculto (en el flujo del editor) para escuchar los eventos de subtítulos. (Ver la siguiente sección).

Subscribing to live captions

Un abonado puede iniciar o detener la recepción de subtítulos llamando a la tecla otc_subscriber_set_subscribe_to_captions() función:

otc_subscriber_set_subscribe_to_captions(subscriber, OTC_TRUE);

Puede llamar a esta función independientemente de si el editor del flujo está publicando actualmente subtítulos en directo. El suscriptor comenzará a recibir datos de subtítulos una vez que el editor comience a a publicar subtítulos.

Para dejar de recibir subtítulos, pase OTC_FALSE en la función:

otc_subscriber_set_subscribe_to_captions(subscriber, OTC_FALSE);

Los suscriptores pueden verificar si están suscritos activamente a los subtítulos en directo de una emisión utilizando el botón otc_subscriber_get_subscribe_to_captions() función:

otc_bool isSubscribed = otc_subscriber_get_subscribe_to_captions(subscriber);

Los suscriptores reciben los subtítulos a través de eventos. El SDK no muestra el texto de los subtítulos en la interfaz de usuario. Establezca el on_caption_text() de la función otc_subscriber_callbacks instancia para configurar un receptor de eventos de subtítulos:

static void on_caption_text(otc_subscriber *subscriber,
                                      void *user_data,
                                      const char* text) {
    // Display the text in the UI.
}

subscriber_callbacks.on_caption_text = on_caption_text;

En otc_stream_has_captions() informa de si un flujo tiene subtítulos:

otc_bool hasCaptions = otc_stream_has_captions(stream);

Aplicar la on_stream_has_captions_changed() de la función otc_session_callbacks para supervisar cuándo un flujo tiene subtítulos activados y desactivados:

static void on_stream_has_captions_changed(otc_session* session,
                                                   void *user_data,
                                             otc_stream *stream,
                                                  otc_bool has_captions) {
  // Adjust UI to indicate that captions are or are not available.
}

session_callbacks.on_stream_has_captions_changed = on_stream_has_captions_changed;