継承元： : Object

定義場所： : lib/opentok/captions.rb

概要

OpenTokのキャプションを扱うためのクラス。

インスタンスメソッドの概要

インスタンスメソッドの詳細

#スタート(session_id, token, options = {}) ⇒ Object

指定された OpenTok セッションのライブキャプションを開始します。詳しくは、 / OpenTok Live Captions 開発者ガイド.

例を挙げよう：

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)

パラメータ：

  • session_id (文字列) —

    字幕の再生が開始されるセッションに対応するセッションID。

  • token (String) —

    SIPユーザーが接続に使用するセッションIDのトークン。

  • オプション (ハッシュ) （デフォルトは：{}） —

    キャプションのオプションを定義するハッシュ。例：

オプションハッシュ (options):

  • :language_code (文字列)

    -

    この通話で使用される話し言葉のBCP-47コード。デフォルト値は「en-US」です。以下の言語コードがサポートされています：

    - "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 (整数)

    -

    音声キャプションの最大再生時間（秒単位）。デフォルト値は 14,400 秒（4 時間）で、これが許可される最大再生時間です。

  • :partial_captions (ブール値)

    -

    ある程度の不正確さを許容して、キャプション生成を高速化するために、これを有効にするかどうか。デフォルト値は「true」です。

  • :status_callback_url (文字列)

    -

    顧客が管理し、ユーザーの操作なしに表示されるコンテンツを生成できる、一般に公開されているURLです。URLの最小文字数は15文字、最大文字数は2048文字です。詳細については、以下を参照してください。 ライブキャプションのステータス更新.

#ストップ(captions_id) ⇒ オブジェクト

指定された OpenTok セッションのライブキャプションを開始します。詳しくは、 / OpenTok Live Captions 開発者ガイド.

例を挙げよう：

response = opentok.captions.stop(captions_id)

パラメータ：

  • captions_id (文字列) —

    停止対象のキャプションのID（「start」リクエストから返される値）。