アーカイブ

OpenTokアーカイブを表すオブジェクト。

を呼ばないでください。 new() コンストラクタ。アーカイブの記録を開始するには、 OpenTok.startArchive() メソッドを使用する。

特性：

名称	タイプ	説明
`createdAt`	Numbers	アーカイブが作成された時刻（UNIXエポックからの経過時間、ミリ秒単位）。
`duration`	ストリング	アーカイブの保存期間（秒単位）。
`hasAudio`	ブーリアン	そのアーカイブに音声トラックが含まれているかどうか（`true`)または(`false`). 以下の設定を行うことで、音声の録音を防止できます。 `hasAudio` への `false` での `options` パラメータに渡す OpenTok.startArchive() メソッドを使用する。
`hasVideo`	ブーリアン	そのアーカイブにビデオトラックが含まれているかどうか（`true`)または(`false`). 以下の設定を行うことで、動画の録画を防ぐことができます。 `hasVideo` への `false` での `options` パラメータに渡す OpenTok.startArchive() メソッドを使用する。
`id`	ストリング	アーカイブID。
`name`	ストリング	アーカイブの名前。アーカイブの作成時に名前が指定されなかった場合、これはnullに設定されます。
`streamMode`	ストリング	アーカイブのストリームモード。以下のいずれかに設定できます。 - 「auto」 — アーカイブに含まれるストリームが自動的に選択されます（デフォルト）。 - 「manual」 — への呼び出しに基づいて、含めるストリームを指定します。 OpenTok.addArchiveStream() そして OpenTok.removeArchiveStream() のメソッドがある。
`outputMode`	ストリング	このアーカイブに対して生成される出力モードは、以下のいずれかになります。 - 「composed」 -- アーカイブ内のすべてのストリームが、1つの（合成された）ファイルに記録されます。 - 「individual」 -- アーカイブ内の各ストリームが、それぞれ個別のファイルに記録されます。詳細は OpenTok.startArchive() メソッドを使用する。
`projectId`	ストリング	アーカイブに関連付けられたAPIキー。
`reason`	ストリング	ステータスが「停止」または「失敗」となっているアーカイブの場合、この文字列には、アーカイブが停止した理由（「最大実行時間を超過した」など）や失敗した理由が記載されます。
`resolution`	ストリング	アーカイブの解像度（「640x480」、「1280x720」、または「1920x1080」のいずれか）。このプロパティは、合成アーカイブに対してのみ設定されます。
`sessionId`	ストリング	このアーカイブに関連付けられている OpenTok セッションのセッション ID。
`size`	Numbers	MP4ファイルのサイズ。まだ生成されていないアーカイブの場合、この値は0に設定されます。
`status`	ストリング	アーカイブのステータスは、以下のいずれかになります。 - 「利用可能」 -- OpenTok クラウドからアーカイブをダウンロードできます。 - 「有効期限切れ」 -- OpenTok クラウドからアーカイブをダウンロードできなくなりました。 - 「失敗」 -- アーカイブの録画に失敗しました。 - 「一時停止中」 -- アーカイブが進行中であり、セッションに対してストリームを配信しているクライアントがいない状態です。アーカイブが進行中にクライアントがストリームを配信すると、ステータスは「開始済み」になります。アーカイブが「一時停止中」の場合、何も記録されません。クライアントがストリームの配信を開始すると、録画が開始（または再開）されます。アーカイブ中のセッションからすべてのクライアントが切断されると、ステータスは「paused」に変わり、60 秒後にアーカイブの録画が停止します（ステータスは「stopped」に変わります）。 - 「開始済み」 -- アーカイブが開始され、録画が進行中です。 - 「停止済み」 -- アーカイブの録画が停止しました。 - 「アップロード済み」 -- アーカイブは、設定したアップロード先である Amazon S3 バケットまたは Windows Azure コンテナからダウンロード可能です。 OpenTokプロジェクト.
`url`	ストリング	利用可能な MP4 ファイルのダウンロード URL。これは、ステータスが「利用可能」に設定されているアーカイブに対してのみ設定されます。その他のアーカイブ（ステータスが「アップロード済み」のアーカイブを含む）については、このプロパティは null に設定されます。ダウンロード URL は難読化されており、ファイルはこの URL から 10 分間のみ入手可能です。新しいURLを生成するには、 OpenTok.getArchive() または OpenTok.listArchives() メソッドを使用する。
`multiArchiveTag`	ストリング	同じセッションに対して複数のアーカイブを同時に記録できるようにするには、この設定を行います。進行中のセッションの同時アーカイブごとに、一意の文字列を指定してください。また、自動的にアーカイブされるアーカイブを手動で開始する場合も、このオプションを設定する必要があります。なお、アーカイブの一覧表示やアーカイブ情報の取得を行うメソッドのレスポンスには、multiArchiveTag の値は含まれません。一意の multiArchiveTag を指定しない場合、特定のセッションに対して一度に記録できるアーカイブは 1 つだけです。詳しくは同時アーカイブ.

方法

名称	説明
`delete(callback)`	OpenTokのアーカイブを削除します。
`stop(callback)`	アーカイブの記録を停止します。

delete(callback)

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

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

パラメータ：

名称	タイプ	説明
`callback`	機能	操作の完了時に呼び出される関数。アーカイブの削除に成功した場合、この関数は引数なしで呼び出されます。失敗した場合は、エラーオブジェクトが関数に渡されます。

stop(callback)

アーカイブの記録を停止します。

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

パラメータ：

名称	タイプ	説明
`callback`	機能	操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - `error` — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - `archive` — Archive オブジェクト。