Heredan de: : Object

Definido en: : lib/opentok/captions.rb

Visión general

Una clase para trabajar con los subtítulos de OpenTok.

Resumen de los métodos de instancia

Detalles del método de instancia

#iniciar(session_id, token, options = {}) ⇒ Objeto

Activa los subtítulos en directo para la sesión de OpenTok especificada. Consulta la / Guía para desarrolladores de OpenTok Live Captions.

Ejemplos:

opts = { "language_code" => "en-GB",
         "max_duration" => 5000,
         "partial_captions" => false,
         "status_callback_url" => status_callback_url
       }
response = opentok.captions.start(session_id, token, opts)

Parámetros:

  • session_id (Cadena) —

    El ID de la sesión correspondiente a la sesión en la que se iniciarán los subtítulos.

  • token (Cadena) —

    El token correspondiente al identificador de sesión que utilizará el usuario SIP para conectarse.

  • opciones (Hash) (valor por defecto: {}) —

    Un hash que define las opciones para los subtítulos. Por ejemplo:

Hash de opciones (options):

  • :language_code (Cadena)

    -

    El código BCP-47 del idioma hablado que se utiliza en esta llamada. El valor por defecto es «en-US». Se admiten los siguientes códigos de idioma:

    - "en-AU" (English, Australia)
- "af-ZA" (Afrikaans))
- "ar-AE" (Arabic, Gulf)
- "ar-SA" (Arabic, Modern Standard)
- "eu-ES" (Basque)
- "ca-ES" (Catalan)
- "zh-HK" (Chinese, Simplified)
- "zh-CN" (Chinese, Cantonese)
- "zh-TW" (Chinese, Traditional)
- "hr-HR" (Croatian)
- "cs-CZ" (Czech)
- "da-DK" (Danish)
- "nl-NL" (Dutch)
- "en-AU" (English, Australian)
- "en-GB" (English, British)
- "en-IN" (English, Indian)
- "en-IE" (English, Irish)
- "en-NZ" (English, New Zealand)
- "en-AB" (English, Scottish)
- "en-ZA" (English, South African)
- "en-US" (English, US)
- "en-WL" (English, Welsh)
- "fa-IR" (Farsi)
- "fi-FI" (Finnish)
- "fr-FR" (French)
- "fr-CA" (French, Canadian)
- "gl-ES" (Galician)
- "de-DE" (German)
- "de-CH" (German, Swiss)
- "el-GR" (Greek)
- "he-IL" (Hebrew)
- "hi-IN" (Hindi, Indian)
- "id-ID" (Indonesian)
- "it-IT" (Italian)
- "ja-JP" (Japanese)
- "ko-KR" (Korean)
- "lv-LV" (Latvian)
- "ms-MY" (Malay)
- "no-NO" (Norwegian Bokmål)
- "pl-PL" (Polish)
- "pt-PT" (Portuguese)
- "pt-BR" (Portuguese, Brazilian)
- "ro-RO" (Romanian)
- "ru-RU" (Russian)
- "sr-RS" (Serbian)
- "sk-SK" (Slovak)
- "so-SO" (Somali)
- "es-ES" (Spanish)
- "es-US" (Spanish, US)
- "sv-SE" (Swedish)
- "tl-PH" (Tagalog/Filipino)
- "th-TH" (Thai)
- "uk-UA" (Ukrainian)
- "vi-VN" (Vietnamese)
- "zu-ZA" (Zulu

  • :max_duration (Número entero)

    -

    La duración máxima de los subtítulos de audio, en segundos. El valor por defecto es 14 400 segundos (4 horas), que es la duración máxima permitida.

  • :partial_captions (booleano)

    -

    Si se debe activar esta opción para acelerar la generación de subtítulos a cambio de un cierto grado de imprecisión. El valor por defecto es «true».

  • :status_callback_url (Cadena)

    -

    Una URL accesible públicamente, controlada por el cliente y capaz de generar el contenido que se va a mostrar sin intervención del usuario. La longitud mínima de la URL es de 15 caracteres y la máxima, de 2048 caracteres. Para obtener más información, consulta Actualizaciones del estado de los subtítulos en directo.

#stop(captions_id) ⇒ Objeto

Activa los subtítulos en directo para la sesión de OpenTok especificada. Consulta la / Guía para desarrolladores de OpenTok Live Captions.

Ejemplos:

response = opentok.captions.stop(captions_id)

Parámetros:

  • captions_id (Cadena) —

    El ID de los subtítulos que se van a detener (devuelto por la solicitud «start»).