Erbt von: : Object

Definiert in: : lib/opentok/captions.rb

Übersicht

Eine Klasse zur Arbeit mit OpenTok-Untertiteln.

Zusammenfassung der Instanzmethoden

Details zur Instanzmethode

#Start(session_id, token, options = {}) ⇒ Objekt

Startet die Live-Untertitel für die angegebene OpenTok-Sitzung. Siehe die / OpenTok Live Captions – Entwicklerhandbuch.

Beispiele:

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)

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID der Sitzung, für die die Untertitel angezeigt werden sollen.

  • Token (Zeichenkette) —

    Das Token für die Sitzungs-ID, mit der sich der SIP-Benutzer verbinden wird.

  • Optionen (Hash) (Standardwert: {}) —

    Ein Hash, der Optionen für die Bildunterschriften definiert. Zum Beispiel:

Options-Hash (options):

  • :language_code (Zeichenkette)

    -

    Der BCP-47-Code für die bei diesem Anruf verwendete gesprochene Sprache. Der Standardwert lautet „en-US“. Folgende Sprachcodes werden unterstützt:

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

    -

    Die maximale Dauer der Audiobeschriftung in Sekunden. Der Standardwert beträgt 14.400 Sekunden (4 Stunden) – dies ist die maximal zulässige Dauer.

  • :partial_captions (Boolescher Wert)

    -

    Ob diese Option aktiviert werden soll, um eine schnellere Untertitelung zu ermöglichen, wobei dies mit gewissen Ungenauigkeiten einhergeht. Der Standardwert ist „true“.

  • :status_callback_url (Zeichenkette)

    -

    Eine öffentlich zugängliche URL, die vom Kunden verwaltet wird und die den darzustellenden Inhalt ohne Benutzereingriff generieren kann. Die Mindestlänge der URL beträgt 15 Zeichen, die maximale Länge 2048 Zeichen. Weitere Informationen finden Sie unter Statusaktualisierungen zu Live-Untertiteln.

#stoppen(captions_id) ⇒ Objekt

Startet die Live-Untertitel für die angegebene OpenTok-Sitzung. Siehe die / OpenTok Live Captions – Entwicklerhandbuch.

Beispiele:

response = opentok.captions.stop(captions_id)

Parameter:

  • captions_id (Zeichenkette) —

    Die ID der Untertitel, die angehalten werden sollen (wird von der „start“-Anfrage zurückgegeben).