継承元： : Object

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

概要

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

"1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).
 You may want to use a portrait aspect ratio for archives that include video streams from mobile devices (which often use the portrait aspect ratio).
 This property is only set for composed archives.

インスタンス属性の概要

• #作成日時 ⇒ int

  アーカイブが作成された時刻（UNIXエポックからの経過時間、ミリ秒単位）。

• #存続期間 ⇒ 文字列

  アーカイブの保存期間（秒単位）。

• #has_audio ⇒ 真、偽

  アーカイブに音声トラックが含まれているか（true）か、含まれていないか（false）か。

• #has_video ⇒ 真、偽

  アーカイブにビデオトラックが含まれているか（true）含まれていないか（false）。

• #id ⇒ 文字列

  アーカイブID。

• #multi_archive_tag ⇒ オブジェクト 読み取り専用

  属性「multi_archive_tag」の値を返します。

• #名称 ⇒ 文字列

  アーカイブの名前。

• #出力モード ⇒ 文字列

  アーカイブ内のすべてのストリームが1つのファイルに記録されるかどうか（:composed) または個々のファイル (:individual).

• #projectId ⇒ 文字列

  アーカイブに関連付けられたAPIキー。

• #理由 ⇒ 文字列

  ステータスが「停止」または「失敗」となっているアーカイブの場合、この文字列には、アーカイブが停止した理由（「最大実行時間を超過した」など）や失敗した理由が記載されています。

• #決議 ⇒ 文字列

  アーカイブの解像度は、「640x480」（SD 横向き、デフォルト）または「1280x720」（HD 横向き）のいずれかです。

• #session_id ⇒ 文字列

  このアーカイブに関連付けられている OpenTok セッションのセッション ID。

• #サイズ ⇒ float

  MP4ファイルのサイズ。

• #ステータス ⇒ 文字列

  アーカイブのステータスは、以下のいずれかになります。

• #stream_mode ⇒ オブジェクト 読み取り専用

  属性 stream_mode の値を返します。

• #streamMode ⇒ 文字列

  アーカイブに含まれるストリームが、自動的に選択されるか（「auto」、デフォルト）、手動で選択されるか（「manual」）。

• #url ⇒ 文字列

  利用可能なMP4ファイルのダウンロードURL。

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

• #add_stream(stream_id, opts = {}) ⇒ オブジェクト

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

• #削除 ⇒ オブジェクト

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

• #レイアウト(opts = {}) ⇒ オブジェクト

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

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

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

• #ストップ ⇒ オブジェクト

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

• #to_json ⇒ オブジェクト

  アーカイブをJSON形式でエンコードした文字列表現。

動的メソッド処理

このクラスは、method_missing メソッドを通じて動的メソッドを処理します

#method_missing(method, *args, &block) ⇒ Object

インスタンス属性の詳細

#作成日時 ⇒ int

アーカイブが作成された時刻（UNIXエポックからの経過時間、ミリ秒単位）。

リターンズ

• (int) —

  created_at の現在の値

#存続期間 ⇒ 文字列

アーカイブの保存期間（秒単位）。

リターンズ

• (文字列) —

  デュレーションの現在値

#has_audio ⇒ 真、偽

アーカイブに音声トラックが含まれているか（true）か、含まれていないか（false）か。

リターンズ

• (true, false) —

  has_audio の現在の値

#has_video ⇒ 真、偽

アーカイブにビデオトラックが含まれているか（true）含まれていないか（false）。

リターンズ

• (true, false) —

  has_video の現在の値

#id ⇒ 文字列

アーカイブID。

リターンズ

• (文字列) —

  id の現在の値

#multi_archive_tag ⇒ オブジェクト（読み取り専用）

属性「multi_archive_tag」の値を返します。

#名称 ⇒ 文字列

アーカイブの名前。アーカイブの作成時に名前が指定されなかった場合、これはnullに設定されます。

リターンズ

• (文字列) —

  name の現在の値

#出力モード ⇒ 文字列

アーカイブ内のすべてのストリームが1つのファイルに記録されるかどうか（:composed) または個々のファイル (:individual).

リターンズ

• (文字列) —

  output_mode の現在の値

#projectId ⇒ 文字列

アーカイブに関連付けられたAPIキー。

リターンズ

• (文字列) —

  projectId の現在の値

#理由 ⇒ 文字列

ステータスが「停止」または「失敗」となっているアーカイブの場合、この文字列には、アーカイブが停止した理由（「最大実行時間を超過した」など）や失敗した理由が記載されています。

リターンズ

• (文字列) —

  理性の現在の価値

#決議 ⇒ 文字列

アーカイブの解像度は、「640x480」（SD 横向き、デフォルト）、「1280x720」（HD 横向き）、

リターンズ

• (文字列) —

  解像度の現在の値

#session_id ⇒ 文字列

このアーカイブに関連付けられている OpenTok セッションのセッション ID。

リターンズ

• (文字列) —

  session_id の現在の値

#サイズ ⇒ float

MP4ファイルのサイズ。まだ生成されていないアーカイブの場合、この値は0に設定されます。

リターンズ

• (float) —

  size の現在の値

#ステータス ⇒ 文字列

アーカイブのステータスは、以下のいずれかになります：

• 「利用可能」 – このアーカイブは、OpenTokクラウドからダウンロードできます。
• 「有効期限切れ」 – このアーカイブは、OpenTokクラウドからダウンロードできなくなりました。
• 「失敗」 – アーカイブの記録に失敗しました。
• 「一時停止中」 – アーカイブが進行中であり、セッションに対してストリームを配信しているクライアントはいません。アーカイブが進行中にクライアントがストリームの配信を開始すると、ステータスは「開始」になります。アーカイブが一時停止中の場合、何も記録されません。クライアントがストリームの配信を開始すると、記録が開始（または再開）されます。 アーカイブ中のセッションからすべてのクライアントが切断されると、ステータスは「一時停止中」に変わり、60秒後にアーカイブの記録が停止します（そしてステータスは「停止」に変わります）。
• 「開始」 – アーカイブが開始され、現在記録中です。
• 「停止」 – アーカイブの記録が停止しました。
• 「アップロード済み」 – アーカイブは、設定したアップロード先である Amazon S3 バケットまたは Windows Azure コンテナからダウンロードできます。 OpenTokプロジェクト.

リターンズ

• (文字列) —

  ステータスの現在の値

#stream_mode ⇒ オブジェクト（読み取り専用）

属性 stream_mode の値を返します。

#streamMode ⇒ 文字列

アーカイブに含まれるストリームが、自動的に選択されるか（「auto」、デフォルト）、手動で選択されるか（「manual」）。

リターンズ

• (文字列) —

  streamMode の現在の値

#url ⇒ 文字列

利用可能な MP4 ファイルのダウンロード URL です。これは、ステータスが「利用可能」に設定されているアーカイブに対してのみ設定されます。その他のアーカイブ（ステータスが「アップロード済み」のアーカイブを含む）については、このプロパティは null に設定されます。ダウンロード URL は難読化されており、ファイルはこの URL から 10 分間のみ利用可能です。 新しいURLを生成するには、Archive.listArchives() または OpenTok.getArchive() メソッドを呼び出してください。

リターンズ

• (文字列) —

  URLの現在の値

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

#add_stream(stream_id, opts = {}) ⇒ オブジェクト

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

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

パラメータ：

• stream_id (文字列) —

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

• opts (ハッシュ) （デフォルトは：{}） —

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

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

• :has_audio (true, false)

  — デフォルト: ブール値、省略可 —

  — 生成されたアーカイブに、ストリームの音声を含めるかどうか（true：デフォルト、false：含めない）。

• :has_video (true, false)

  — デフォルト: ブール値、省略可 —

  — 生成されたアーカイブに、ストリームの動画を含めるかどうか（true：デフォルト、false：含めない）。

引き上げ：

• (OpenTokArchiveError) —

  アーカイブの streamMode が「manual」に設定されていません。

#削除 ⇒ オブジェクト

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

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

#レイアウト(opts = {}) ⇒ オブジェクト

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

パラメータ：

• オプション (ハッシュ) —

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

引き上げ：

• (ArgumentError) —

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

• (OpenTok認証エラー) —

  認証に失敗しました。

• (ArgumentError) —

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

• (ArgumentError) —

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

• (ArgumentError) —

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

• (ArgumentError) —

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

• (OpenTokエラー) —

  OpenTokサーバーエラー。

• (OpenTokArchiveError) —

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

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

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

パラメータ：

• stream_id (文字列) —

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

引き上げ：

• (OpenTokArchiveError) —

  アーカイブの streamMode が「manual」に設定されていません。

#ストップ ⇒ オブジェクト

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

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

#to_json ⇒ オブジェクト

アーカイブをJSON形式でエンコードした文字列表現。