継承元： : Object

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

概要

OpenTokのアーカイブを扱うためのクラス。

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

• #add_stream(archive_id, stream_id, options) ⇒ オブジェクト

  streamMode が「manual」に設定されて開始された、現在実行中の複合アーカイブにストリームを追加します。

• #すべて(options = {}) ⇒ ArchiveList

  指定されたAPIキーに対応する、完了済みおよび進行中のアーカイブの配列であるArchiveListを返します。

• #作成する(session_id, options = {}) ⇒ Archive

  OpenTokセッションのアーカイブを開始します。

• #delete_by_id(archive_id) ⇒ オブジェクト

  OpenTokのアーカイブを削除します。

• #検索(archive_id) ⇒ アーカイブ

  指定されたアーカイブ ID に対応する Archive オブジェクトを取得します。

• #レイアウト(archive_id, options = {}) ⇒ Object

  構成済みアーカイブのレイアウトタイプを設定します。

• #remove_stream(archive_id, stream_id) ⇒ オブジェクト

  streamMode が「manual」に設定されて開始された、現在実行中の複合アーカイブからストリームを削除します。

• #stop_by_id(archive_id) ⇒ アーカイブ

  録画中のOpenTokアーカイブを停止します。

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

#add_stream(archive_id, stream_id, options) ⇒ オブジェクト

streamMode が「manual」に設定されて開始された、現在実行中の複合アーカイブにストリームを追加します。この機能の詳細については、<https://tokbox.com/developer/rest/#selecting-archive-streams>.

add_stream に同じストリーム ID を指定してこのメソッドを繰り返し呼び出すことで、アーカイブ内のストリームの音声または動画をオン／オフに切り替えることができます。has_audio と has_video の両方を false に設定すると、エラー応答が返されます。

パラメータ：

• archive_id (文字列) —

  アーカイブID。

• stream_id (文字列) —

  アーカイブに追加するストリームのID

• opts (ハッシュ) —

  カスタマイズ可能なオプションのセット

引き上げ：

• (ArgumentError) —

  archive_id パラメータが空です。

• (ArgumentError) —

  stream_id パラメータが空です。

• (ArgumentError) —

  options パラメータの has_audio および has_video プロパティは、いずれも「false」に設定されています。

#すべて(options = {}) ⇒ アーカイブ一覧

指定されたAPIキーに対応する、完了済みおよび進行中のアーカイブの配列であるArchiveListを返します。

パラメータ：

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

  取得するアーカイブの範囲を定義するキーを含むハッシュ。

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

• :offset (整数)

  -

  オプション。最初のアーカイブのインデックスオフセット。0 は、最も最近開始されたアーカイブのオフセットです。1 は、その直前に開始されたアーカイブのオフセットです。オフセットを指定しない場合は、0 が使用されます。

• :count (整数)

  -

  オプション。返すアーカイブの数。返されるアーカイブの最大数は1000です。

• :session_id (文字列)

  -

  省略可能。アーカイブが属するセッション ID。これは、ある 自動的にアーカイブされたセッション.

リターンズ

• (アーカイブ一覧) —

  ArchiveList オブジェクト。これは、Archive オブジェクトの配列です。

引き上げ：

• (ArgumentError)

#作成する(session_id, options = {}) ⇒ アーカイブ

OpenTokセッションのアーカイブを開始します。

アーカイブの録画を正常に開始するには、クライアントがOpenTokセッションにアクティブに接続されている必要があります。

1つのセッションにつき、一度にアーカイブを1つしか記録できません。記録できるのは、OpenTok Media Router を使用しているセッション（メディアモードが「routed」に設定されているセッション）のアーカイブのみです。メディアモードが「relayed」に設定されているセッションはアーカイブできません。

アーカイブの詳細については OpenTokのアーカイブ機能 プログラミングガイド

パラメータ：

• session_id (文字列) —

  アーカイブするOpenTokセッションのセッションID。

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

  「name」、「has_audio」、「has_video」、「output_mode」というキーを持つハッシュ。

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

• :name (文字列)

  -

  これはアーカイブの名前です。この名前を使用して、アーカイブを識別することができます。これは Archive オブジェクトのプロパティであり、OpenTok クライアント SDK におけるアーカイブ関連のイベントのプロパティでもあります。

• :has_audio (true, false)

  -

  アーカイブに音声トラックが含まれるかどうかは（true) かどうか false).デフォルト値は true （音声トラックが含まれています）。両方を設定すると has_audio そして has_video への false, への呼び出し create() このメソッドを実行するとエラーが発生します。

• :has_video (true, false)

  -

  アーカイブに動画トラックが含まれるかどうかは（true) かどうか false).デフォルト値は true （ビデオトラックが含まれています）。両方を設定すると has_audio そして has_video への false, への呼び出し create() このメソッドを実行するとエラーが発生します。

• :multi_archive_tag (文字列)

  — デフォルト: 省略可 —

  同じセッションに対して複数のアーカイブを同時に記録できるようにするには、これを設定してください。進行中のセッションの同時アーカイブごとに、一意の文字列を設定してください。また、手動でアーカイブを開始する場合も、このオプションを設定する必要があります。 自動的にアーカイブされました. なお、「multiArchiveTag」についてはvalue is not included in the response for the methods to [list archives](https://tokbox.com/developer/rest/#listing_archives) and [retrieve archive information](https://tokbox.com/developer/rest/#retrieve_archive_info). If you do not specify a unique`multi_archive_tag` を使用する場合、1回のセッションで記録できるアーカイブは1つだけです。 「同時アーカイブ」を参照.

• :output_mode (文字列)

  -

  アーカイブ内のすべてのストリームが1つのファイルに記録されるかどうか（:composed（デフォルト）または個々のファイル（:individual)。アーカイブおよびアーカイブファイル形式の詳細については、 OpenTokのアーカイブ機能 プログラミングガイド

• :resolution (文字列)

  -

  アーカイブの解像度は、「640x480」（SD 横向き、デフォルト）、「1280x720」（HD 横向き）、「1920x1080」 （FHD 横向き）、「480x640」（SD 縦向き）、「720x1280」（HD 縦向き）、または「1080x1920」（FHD 縦向き）のいずれかです。このプロパティは、合成されたアーカイブにのみ適用されます。 このプロパティを設定し、かつ outputMode プロパティを「individual」に設定している場合、このメソッドを呼び出すとエラーが発生します。

• :stream_mode (文字列)

  — デフォルト: 省略可 —

  アーカイブに含まれるストリームを、自動的に（「auto」、デフォルト）選択するか、手動で（「manual」）選択するか。 ストリームが自動的に選択される場合（「auto」）、セッション内のすべてのストリームをアーカイブに含めることができます。ストリームが手動で選択される場合（「manual」）、 #add_stream メソッド。アーカイブにストリームの音声、動画、あるいはその両方を含めるかどうかを指定できます。自動モードおよび手動モードのいずれにおいても、アーカイブ作成機能では、以下の基準に基づいてストリームをアーカイブに含めます。 ストリーム優先ルール. 重要：この機能は現在、Standard環境でのみ利用可能です。

• :layout (ハッシュ)

  -

  アーカイブの初期レイアウトタイプを指定するには、これを指定します。これは、構成済みアーカイブにのみ適用されます。これは、3つのキーを含むハッシュです： :type, :stylesheet<code> and <code>:screenshare_type. の有効な値は :type 「bestFit」（最適適合）、「custom」（カスタム）、

  コピー

  "horizontalPresentation" (horizontal presentation),
  

  「pip」（ピクチャー・イン・ピクチャー）および「verticalPresentation」（縦向き表示）。「custom」レイアウトタイプを指定する場合は、 :stylesheet スタイルシート（CSS）のキー。（その他のレイアウトタイプの場合は、 :stylesheet key。）有効な値は :screenshare_type は「bestFit」、「pip」、「verticalPresentation」、「horizontalPresentation」です。このプロパティはオプションです。指定された場合、 :type プロパティ マスト 「bestFit」に設定してください。初期のレイアウトタイプを指定しない場合、アーカイブは最適なレイアウトタイプを使用します。詳細については、以下を参照してください。 構成されたアーカイブのビデオレイアウトをカスタマイズする.

• :max_bitrate (整数)

  — デフォルト: 省略可 —

  アーカイブの最大動画ビットレート（ビット/秒）。最小値は 100,000、最大値は 6,000,000 です。このオプションは、合成アーカイブでのみ有効です。 合成アーカイブのサイズを制御するために、動画の最大ビットレートを設定します。この最大ビットレートは、動画のビットレートにのみ適用されます。出力アーカイブに音声が含まれている場合、そのビットは制限の対象外となります。

リターンズ

• (アーカイブ) —

  Archiveオブジェクト。これには、アーカイブIDを含む、アーカイブを定義するプロパティが含まれています。

引き上げ：

• (OpenTokArchiveError) —

  アーカイブを開始できませんでした。リクエストが無効であるか、セッションに接続中のクライアントがありません。

• (OpenTok認証エラー) —

  アーカイブの開始中に認証に失敗しました。APIキーが無効です。

• (OpenTokArchiveError) —

  アーカイブを開始できませんでした。セッション ID が存在しません。

• (OpenTokArchiveError) —

  アーカイブを開始できませんでした。セッションがピアツーピアであるか、またはすでに録画されている可能性があります。

• (OpenTokArchiveError) —

  アーカイブの起動に失敗しました。

#delete_by_id(archive_id) ⇒ オブジェクト

OpenTokのアーカイブを削除します。

「利用可能」、「アップロード済み」、または「削除済み」の状態にあるアーカイブのみ削除できます。 アーカイブを削除すると、アーカイブ一覧からその記録が削除されます。「利用可能」なアーカイブの場合、アーカイブファイルも削除されるため、ダウンロードできなくなります。「削除済み」のアーカイブの場合、アーカイブは削除されたままとなります。

パラメータ：

• archive_id (文字列) —

  削除したいアーカイブのアーカイブID。

引き上げ：

• (OpenTok認証エラー) —

  認証に失敗しました、または無効なアーカイブIDが指定されました。

• (OpenTokArchiveError) —

  アーカイブを削除できませんでした。ステータスは「利用可能」、「削除済み」、または「アップロード済み」である必要があります。

• (OpenTokArchiveError) —

  アーカイブを削除できませんでした。

#検索(archive_id) ⇒ アーカイブ

指定されたアーカイブ ID に対応する Archive オブジェクトを取得します。

パラメータ：

• archive_id (文字列) —

  アーカイブID。

リターンズ

• (アーカイブ) —

  Archive オブジェクト。

引き上げ：

• (OpenTokArchiveError) —

  アーカイブを取得できませんでした。アーカイブIDが無効です。

• (OpenTok認証エラー) —

  アーカイブの取得中に認証に失敗しました。APIキーが無効です。

• (OpenTokArchiveError) —

  アーカイブを取得できませんでした。

#レイアウト(archive_id, options = {}) ⇒ Object

構成済みアーカイブのレイアウトタイプを設定します。レイアウトタイプの詳細については、以下を参照してください。 構成されたアーカイブのビデオレイアウトをカスタマイズする.

パラメータ：

• archive_id (文字列) —

  アーカイブID。

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

  カスタマイズ可能なオプションのセット

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

• :type (文字列)

  -

  レイアウトの種類。これを「bestFit」、「pip」、「verticalPresentation」、「horizontalPresentation」、「focus」、または「custom」に設定します。

• :stylesheet (文字列)

  -

  カスタムレイアウト用のスタイルシート。以下の設定を行う場合は、このパラメータを設定してください。 type への "custom". それ以外の場合は、未定義のままにしておきます。

• :screenshare_type (文字列)

  -

  画面共有のレイアウトタイプです。これを「bestFit」、「pip」、「verticalPresentation」、または「horizonalPresentation」に設定します。これが定義されている場合、 type パラメータは、次のように設定する必要があります。 "bestFit".

引き上げ：

• (ArgumentError) —

  archive_id または options パラメータが空です。あるいは、スタイルシートオプションを指定せずに「custom」タイプが指定されました。あるいは、custom 以外のタイプに対してスタイルシートが渡されました。あるいは、無効なタイプが渡されました。

• (OpenTok認証エラー) —

  認証に失敗しました。

• (ArgumentError) —

  archive_id または options パラメータが空です。

• (ArgumentError) —

  「custom」タイプが、スタイルシートオプションを指定せずに指定されました。

• (ArgumentError) —

  「custom」以外の型に対してスタイルシートが渡されました。あるいは、無効な型が渡されました。

• (ArgumentError) —

  無効なレイアウトタイプが渡されました。

• (OpenTokエラー) —

  OpenTokサーバーエラー。

• (OpenTokArchiveError) —

  レイアウトの設定に失敗しました。

#remove_stream(archive_id, stream_id) ⇒ オブジェクト

streamMode が「manual」に設定されて開始された、現在実行中の複合アーカイブからストリームを削除します。この機能の詳細については、<https://tokbox.com/developer/rest/#selecting-archive-streams>.

パラメータ：

• archive_id (文字列) —

  アーカイブID。

• stream_id (文字列) —

  アーカイブから削除するストリームのID

引き上げ：

• (ArgumentError) —

  archive_id パラメータの値が空です。

• (ArgumentError) —

  stream_id パラメータが空です。

#stop_by_id(archive_id) ⇒ アーカイブ

録画中のOpenTokアーカイブを停止します。

アーカイブは、120分経過するか、アーカイブ対象のセッションからすべてのクライアントが切断されると、自動的に記録を停止します。

パラメータ：

• archive_id (文字列) —

  記録を停止したいアーカイブのアーカイブID。

リターンズ

• (アーカイブ) —

  停止されるアーカイブに対応するArchiveオブジェクト。

引き上げ：

• (OpenTokArchiveError) —

  アーカイブを停止できませんでした。リクエストが無効でした。

• (OpenTok認証エラー) —

  アーカイブの停止中に認証に失敗しました。

• (OpenTokArchiveError) —

  アーカイブを停止できませんでした。アーカイブIDが存在しません。

• (OpenTokArchiveError) —

  アーカイブを停止できませんでした。現在、アーカイブの記録は行われていません。

• (OpenTokArchiveError) —

  アーカイブの起動に失敗しました。