Hérite de : : Object

Défini dans : : lib/opentok/captions.rb

Vue d'ensemble

Une classe permettant de gérer les sous-titres OpenTok.

Résumé des méthodes d'instance

Détails de la méthode d'instance

#commencer(session_id, token, options = {}) ⇒ Objet

Active le sous-titrage en direct pour la session OpenTok indiquée. Voir la / Guide du développeur OpenTok Live Captions.

Exemples :

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)

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de session correspondant à la session pour laquelle les sous-titres vont démarrer.

  • jeton (chaîne de caractères) —

    Le jeton correspondant à l'identifiant de session que l'utilisateur SIP utilisera pour se connecter.

  • options (Hash) (valeur par défaut : {}) —

    Un hachage définissant les options relatives aux légendes. Par exemple :

Table de hachage des options (options) :

  • :code_langue (Chaîne de caractères)

    -

    Code BCP-47 correspondant à la langue parlée utilisée lors de cet appel. La valeur par défaut est « en-US ». Les codes de langue suivants sont pris en charge :

    - "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 (Entier)

    -

    Durée maximale du sous-titrage audio, en secondes. La valeur par défaut est de 14 400 secondes (4 heures), soit la durée maximale autorisée.

  • :partial_captions (Booléen)

    -

    Il convient de déterminer s'il faut activer cette option pour accélérer la création des sous-titres, au prix d'un certain degré d'inexactitudes. La valeur par défaut est « true ».

  • :status_callback_url (Chaîne de caractères)

    -

    Une URL accessible au public, gérée par le client et capable de générer le contenu à afficher sans intervention de l'utilisateur. La longueur minimale de l'URL est de 15 caractères et sa longueur maximale est de 2 048 caractères. Pour plus d'informations, consultez Mises à jour sur l'état du sous-titrage en direct.

#arrêter(captions_id) ⇒ Objet

Active le sous-titrage en direct pour la session OpenTok indiquée. Voir la / Guide du développeur OpenTok Live Captions.

Exemples :

response = opentok.captions.stop(captions_id)

Paramètres :

  • captions_id (Chaîne de caractères) —

    L'identifiant des sous-titres à désactiver (renvoyé par la requête « start »).