アーカイブ

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

addStreamToArchive() : bool : 現在実行中のアーカイブに、 streamMode が StreamMode.Manual に設定されて開始されたストリームを追加します。同じストリーム ID に対してこのメソッドを繰り返し呼び出すことで、アーカイブ内のそのストリームの音声または映像の表示/非表示を切り替えることができます。

delete() : 混合 : OpenTokのアーカイブを削除します。

getPermittedResolutions() : 混合

jsonSerialize() : 混合

removeStreamFromArchive() : bool : 現在実行中のアーカイブから、 streamMode が StreamMode.Manual に設定されて開始されたストリームを削除します。

stop() : 混合 : OpenTokのアーカイブが録画中の場合、その録画を停止します。

toArray() : mixed : このArchiveオブジェクトを連想配列として表したものを返します。

toJson() : mixed : このArchiveオブジェクトのJSON表現を返します。

定数

PERMITTED_AUTO_RESOLUTIONS

private mixed|null PERMITTED_AUTO_RESOLUTIONS = ['480x640', "640x480", "720x1280", "1280x720", "1080x1920", "1920x1080"]

プロパティ

$createdAt

public int $createdAt

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

$duration

public string $duration

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

$hasAudio

public bool $hasAudio

そのアーカイブに音声トラックが含まれているかどうか（true)または(false).

$hasVideo

public bool $hasVideo

そのアーカイブにビデオトラックが含まれているかどうか（true)または(false).

$id

public string $id

アーカイブID。

$multiArchiveTag

public string $multiArchiveTag

「Multiple Archive」が有効になっているかどうか。有効になっている場合、進行中のセッションの同時アーカイブごとに一意の文字列が割り当てられます。参照 https://tokbox.com/developer/guides/archiving/#simultaneous-archives をご覧ください。

$name

public string $name

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

$outputMode

public string $outputMode

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

$partnerId

public string $partnerId

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

$reason

public string $reason

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

$resolution

public string $resolution

アーカイブの解像度は、「640x480」（SD 横向き、デフォルト）、「1280x720」（HD 横向き）、「1920x1080」（FHD 横向き）、「480x640」（SD 縦向き）、「720x1280」（HD 縦向き）、または「1080x1920」（FHD 縦向き）のいずれかです。モバイルデバイスからの動画ストリーム（多くの場合、縦向きアスペクト比が使用されます）を含むアーカイブについては、縦向きアスペクト比を使用することをお勧めします。

$sessionId

public string $sessionId

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

$size

public string $size

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

$status

public string $status

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

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

$streamMode

public string $streamMode

アーカイブに含まれるストリームが自動的に選択されるかどうか（StreamMode.AUTO) または手動で (StreamMode.MANUAL). ストリームが自動的に選択される場合（StreamMode.AUTO), そのセッション内のすべてのストリームをアーカイブに含めることができます。ストリームを手動で選択する場合 (StreamMode.MANUAL)、` Archive.addStreamToArchive() そして Archive.removeStreamFromArchive() メソッド。手動モードでは、ストリームの音声、動画、あるいはその両方をアーカイブに含めるかどうかを指定できます。自動モードと手動モードのいずれにおいても、アーカイブコンポーザーは以下に基づいてストリームを含めます。ストリーム優先順位付けルール.

$url

public string $url

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

方法

addStreamToArchive()

現在実行中のアーカイブに、 streamMode が StreamMode.Manual に設定されて開始されたストリームを追加します。同じストリーム ID を使用してこのメソッドを繰り返し呼び出すことで、アーカイブ内のそのストリームの音声または映像の表示/非表示を切り替えることができます。

public addStreamToArchive(string $streamId, bool $hasAudio, bool $hasVideo) : bool

パラメータ

$streamId : string : ストリームID。

$hasAudio : bool : アーカイブにストリームの音声を包含するかどうか（true：デフォルト）または含まないか（false）。

$hasVideo : bool : アーカイブにストリームの動画を包含するかどうか（true：デフォルト）または含まないか（false）。

戻り値

bool —

成功した場合は true を返します。

delete()

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

public delete() : mixed

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

戻り値

混合 —

getPermittedResolutions()

public static getPermittedResolutions() : mixed

戻り値

混合 —

jsonSerialize()

public jsonSerialize() : mixed

戻り値

混合 —

removeStreamFromArchive()

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

public removeStreamFromArchive(string $streamId) : bool

パラメータ

$streamId : string : ストリームID。

戻り値

bool —

成功した場合は true を返します。

stop()

OpenTokのアーカイブが録画中の場合、その録画を停止します。

public stop() : mixed

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

戻り値

混合 —

toArray()

このArchiveオブジェクトを連想配列として返します。

public toArray() : mixed

戻り値

混合 —

toJson()

このArchiveオブジェクトのJSON表現を返します。

public toJson() : mixed

戻り値

混合 —