Video API でアーカイブ録画を開始する

Vonage Video APIでは、セッションのアーカイブ、保存、取得が可能です。

基本的なワークフロー

レコーディングのコア・ワークフロー

のいずれかを使用して、セッションのアーカイブ録音を作成できます。 サーバーSDK.アーカイブを作成すると録画が始まります。

アーカイブを作成できるのは、少なくとも1人のクライアントが接続しているセッションのみです。(クライアントが1分以内にストリームの公開を開始しないと、アーカイブの録画が停止します)。

クライアントがストリームの公開を開始したり停止したりすると、ストリームが記録される。

ただし、録画できるアーカイブの数に制限はありません、 自動的にアーカイブされたセッション は録画が停止するまで、4時間ごとに新しい録画を再開します。

サーバーSDKには以下のメソッドが含まれている：

• アーカイブ録画の開始
• アーカイブ録画の停止
• アーカイブ録画のリストアップ
• アーカイブ記録情報の検索
• アーカイブの削除

アーカイブの録画を停止すると、VonageビデオプラットフォームはMP4ファイルまたは（個々のストリームアーカイブの場合）ZIPファイルを作成します。参照 個々のストリームと構成されたアーカイブ.)

クライアント・イベントとUIハンドオフ

アーカイブの録画が開始したり停止したりすると、クライアントでイベントが発生する。例えば OpenTok.js ライブラリには archiveStarted そして archiveStopped イベントがディスパッチされます。

コンポジションと個別アーカイブの比較

• 構成アーカイブ がデフォルトです。Vonageは、すべての公開ストリームと設定したレイアウトルールを使用して、単一のMP4（H.264/AAC）をレンダリングします。これらはすぐに再生可能で、自動的に 自動的にアーカイブされたセッション.コンポーズド・アーカイブは、最大16のビデオストリーム（および最大50のオーディオストリーム）を同時に記録します。
• 個別のストリーム・アーカイブ 各ストリームのメディア・ファイル ( .webm または .mkv) と JSON マニフェストを追加します。ストリームを後処理またはリミックスする場合は、これを選択します。個々のアーカイブは、最大 50 のビデオ ストリーム（および最大 50 のオーディオ ストリーム）をキャプチャできますが、再生前にダウンストリーム処理が必要であり、自動アーカイブには対応していません。
• を設定してフォーマットを指定する。 outputMode への composed (デフォルト）または individual アーカイブREST APIまたはサーバーSDKを呼び出した場合。以下の比較では、その違いについて説明します。

アーカイブ録画時間

アーカイブ録画の最大録画時間は4時間（14,400秒）です。この録画時間は、ストリームが公開されている（録画されている）累積時間を意味します。

ストリームが公開（および録画）されている間、アーカイブのステータスは "started".参照 アーカイブステータスの変更).

ストリームが公開されていない状態でアーカイブが記録されている場合、ステータスは次のように設定されます。 "paused".

最大 合計 開始」と「一時停止」の状態を含むアーカイブ録画の長さは、12時間（43,200秒）です。1時間（3,600秒）操作がない場合（クライアントがストリームを公開していない場合）、録画は自動的にタイムアウト（録画を停止）します。

注釈

• セッションを自動的にアーカイブ その結果、1回または複数回の連続録画となり、1回の録画時間は最長4時間となる。
• 進行中のアーカイブはサーバーのローテーション中に終了します（自動アーカイブは例外で、サーバーのローテーション中にセッションが移行すると自動的に再開されます）。サーバー ローテーションの通知イベントに応じて、アーカイブを再開できます。参照 サーバーのローテーションとセッションの移行.

アーカイブ・レコーディング・ストレージ

あなたの Vonageアカウント で、完成したアーカイブ録画ファイルのアップロード先を指定します。

これは、あなた自身のAmazon S3バケット、Amazon以外のS3準拠のストレージ・プロバイダのバケット、またはWindows Azureコンテナにすることができる。

Amazon S3以外のS3互換ストレージプロバイダーについては、CloudianとGoogle Cloud Storageをサポートしています（AWS S3 APIを使用してアクセスします）。その他のS3互換サービスには機能制限がある場合があります。

参照 Vonage Video API アーカイブと S3 ストレージの使用 そして Windows AzureコンテナとVonage Video APIアーカイブの使用.

アーカイブ録画が完了したら (アーカイブの録画ステータスの変更 に設定されている。 "stopped"など)にアップロードしようとします。 S3バケット または アジュールコンテナ)のアーカイブ録画が作成されてから最大72時間(フォールバックが有効な場合は少なくとも6時間)、分散アップロードスケジューリングポリシーによって複数回再試行する。

指定したターゲットへのアップロードが成功した場合、アーカイブ録画のステータスは "uploaded".

もし アマゾンS3バケット または アジュールコンテナまたは指定したバケット/コンテナへのアップロードに失敗した場合（再試行後）、録画されたアーカイブはVonageクラウドからダウンロードできます。この場合、アーカイブの録画ステータスは "available".Vonage クラウド上で利用可能になったアーカイブは、作成されてから 72 時間ダウンロードできます。また、Vonageアカウントに登録されているメールアドレスにアップロードの失敗を報告するメールが届きます。

Vonageクラウドへのフォールバック・ストレージを防ぐには、以下の方法でログインします。 Vonageアカウントアプリケーション > ビデオアプリケーションを選択し、アーカイブ録画保存オプションを無効に設定します。

指定されたターゲットへのアップロードが失敗し（再試行を試みた後）、Vonageストレージへのフォールバックが無効になっている場合、アーカイブ録画のステータスは次のように設定されます。 "failed".

指定したターゲットにアップロードされるか、Vonageストレージで利用可能になるまでは、アーカイブ録画にアクセスできません。

Vonageクラウドに保存されているアーカイブの場合、ダウンロードURLは url プロパティは、ステータスが "available".

アーカイブ録画ストレージのフォールバックで使用される各ダウンロードURLは、セキュリティ認証情報を使用して、アーカイブをダウンロードするための時間制限付きの許可を付与する、事前に署名されたURLです。

10分後、署名済みURLは失効し、ダウンロードURLを取得するためにREST APIまたはサーバーメソッドを使用して新しい署名済みURLを要求する必要があります。

セキュリティのため、ダウンロードURLは、以下のREST APIコールまたはサーバーSDKメソッドからのみ利用可能です。 リスト・アーカイブ (アカウント認証が必要です）。

音声のみ、映像のみのアーカイブ

Vonage Video Server SDK のいずれかを使用してアーカイブ録画を作成する場合、オーディオ、ビデオ、またはその両方を録画するかどうかを指定できます。(デフォルトは両方です）。

個々のストリームと構成されたアーカイブ

アーカイブ録画の出力ファイルは、以下のいずれかの形式になります：

Vonageに録画終了と同時に再生可能なMP4を配信したい場合は、コンポジション・アーカイブを選択してください。編集、コンプライアンス、または特注の再生体験のために生のストリーム・キャプチャが必要な場合は、個別のストリーム・アーカイブを選択してください。

構成アーカイブ

アーカイブ録画は、すべてのストリームで構成される単一のMP4ファイルです。これはデフォルトの設定です。また 自動的にアーカイブされたセッション.

MP4ファイルは、H.264ビデオとAACオーディオ（128Kbps、48Khzサンプルレート）を使用しています。

構成されたアーカイブのレイアウトをカスタマイズして、ストリームの視覚的な配置や表示するストリームを調整できます。参照 構成されたアーカイブのビデオレイアウトをカスタマイズする.

デフォルトでは、コンポジションアーカイブの解像度は640x480ピクセル（SDランドスケープ）です。コンポジション・アーカイブの解像度を480x640（SDポートレート）、1280x720（HDランドスケープ）、720x1280（HDポートレート）、1920x1080（FHDランドスケープ）、1080x1920（FHDポートレート）に設定するには resolution プロパティ 480x640, 1280x720, 1920x1080, 720x1280あるいは 1080x1920 を使用して、Vonage Video server SDK の start archive メソッドを呼び出します。モバイル デバイスからのビデオ ストリーム（多くの場合、縦アスペクト比を使用）を含むアーカイブを録画する場合は、縦アスペクト比を使用することをお勧めします。

コンポジットアーカイブ録画の最大ビデオビットレートを設定し、アーカイブのサイズを制御することができます。設定する maxBitrate オプションを呼び出すときに 新しいアーカイブを作成する メソッドで指定します。ビットレートを100,000から6,000,000の間で、1秒あたりのビット数で指定する。この設定は ビデオ アーカイブのビットレート。出力アーカイブに音声がある場合、それらのビットは制限から除外されます。このオプションは、コンポジットアーカイブでのみ使用できます（個別のストリームアーカイブでは使用できません）。最大ビットレートを設定すると、アーカイブは一定のビットレートを使用します。

コンポジットアーカイブの量子化パラメータ(QP)を設定することで、ビデオの画質とファイルサイズのトレードオフを調整することができます。QPを設定する quantizationParameter オプションを呼び出すときに 新しいアーカイブを作成する メソッドを使用します。量子化パラメータを設定すると、アーカイブは可変ビットレートと一定の圧縮量子化を使用するようになり、その結果、シーンが変わっても一貫した品質レベルが得られます。有効な値は15から40であり、20から30は大きな知覚的な品質差なしに合理的な結果を生成します。QP値が低いほど、ビデオ圧縮の量子化が細かくなり、ビデオ品質が向上（ビデオの詳細が保持される）し、ファイルサイズが大きくなります。QP値を高くすると、ビデオ圧縮の量子化が粗くなり、ビデオ品質が低下し、ファイルサイズが小さくなります。の両方を設定することはできません。 quantizationParameter プロパティと maxBitrate プロパティを使用するとエラーになります。

注： 現在、量子化パラメータ設定は REST API でのみ利用可能で、Vonage Video API サーバー SDK では利用できません。

デフォルトでは quantizationParameter または maxBitrate 構成されたアーカイブを作成する場合、アーカイブは量子化パラメータ19（超高品質）の可変ビットレートエンコーディングを使用します。

個別ストリーム・アーカイブ録画

アーカイブは、各ストリームの複数の個別メディアファイルと、ビデオ同期用のJSONメタデータファイルを含むZIPコンテナファイルです。

このフォーマットは、Vonage Video server SDK のいずれかを使用してアーカイブを開始するときに指定できます。このフォーマットは 自動的にアーカイブされたセッション.

個々のストリーム・アーカイブ録画の操作

個別ストリーム・アーカイブ・モードは、アプリケーションによって生成されたカスタマイズされたコンテンツを生成するために、後処理ツールと共に使用することを目的としています。この機能を使用する場合、開発者が評価すべきいくつかの考慮事項があります。

個別ストリーム・コンテナ

個々のストリームアーカイブメディアは、各オーディオ・ビデオストリームのファイルを含むZIPアーカイブとして配信されます：

• アーカイブ内の各ストリームコンテナは、Vonageビデオプラットフォームに公開されたストリームに対応しています。パブリッシャのストリーム ID は対応するファイル名と一致し、各ストリーム ID は アーカイブマニフェスト.

自動再接続によってストリームが中断され再開された場合、またはストリームが マニュアル・ストリーム・モード・アーカイブこの場合、ZIPアーカイブには、ストリームの各セグメントごとに別々のファイルが含まれることになる。

• ストリームコンテナは .webmあるいは .mkvアプリケーションの設定によって異なります。VP8を 優先ビデオコーデック 持つ webm コンテナや、H.264を優先ビデオコーデックに設定したアプリケーションでは、次のように使用します。 mkv フォーマットを参照してください。参照 VP9ビデオのアーカイブに関する注意事項 個々のVP9ビデオに関する重要な詳細については、以下を参照のこと。

• 個々のストリームアーカイブコンテナは、アーカイブサーバーによって受信されたすべてのビデオとオーディオのキャプチャです。このメディアは処理されないため、ほとんどの場合、コンテナは直接再生には適していません。

ストリーム・コンテナはトランスポート・ストリームのように扱われ、アーカイブ・サーバーで受信されたメディアはすべて、検査や後処理を行わずに直接ファイルに書き込まれる。この設計は、ストリームコンテナのダウンストリームでの消費に影響を与える。ほとんどの場合、個々のストリーム・アーカイブ・コンテナの直接再生は不可能か、コンテナの内容によって問題が発生します：

• ストリームヘッダーの寸法が正しいことはほとんどない。現在、コンテナのヘッダは、エンコードされたビデオフレームの寸法に関係なく、640x480ピクセルの寸法のビデオトラックを表示する。

• ビデオフレームは、時間の経過とともに寸法が変化します。これには、特に画面共有ストリームでのアスペクト比の変化も含まれます。

• オーディオとビデオのフレームは、単調なタイムスタンプで到着するとは限りません。これは特に、ビデオトラックかオーディオトラックのどちらかが、次のいずれかを使って一時的に無効化されている場合に関連する。 publishVideo または publishAudio 出版社のプロパティ。

フレームプレゼンテーションタイムスタンプ（PTS）は、最初の受信フレームのタイムスタンプでオフセットされた、キャプチャ時に取得されたNTPタイムスタンプに基づいて書き込まれます。トラックがミュートされ、後にミュートが解除された場合でも、タイムスタンプのオフセットは、ストリーム全体の期間を通じて一貫している必要があります。後処理でデコードする場合、連続するフレーム間のPTSのギャップは、トラックのミュート期間中存在します。

個々のストリームアーカイビングファイルから視聴可能なコンテンツを作成するには、メディアをポストプロセッサーに通して、個々のストリームコンテナを修復するか、複数のコンテナを最終製品に多重化／合成する必要がある。

個別ストリーム記録マニフェスト

個々のストリームアーカイブには、アーカイブに含まれるストリーム録画の情報を提供するJSONメタデータファイルが含まれます。これは以下の形式です：

{
  "createdAt" : 1429305105162,
  "files" : [
    {
      "connectionData" : "connection data for this stream's connection",
      "filename" : "a1475893-99f5-4f02-b697-5d69e8e30d19.webm",
      "size" : 5558064,
      "startTimeOffset" : 3119,
      "stopTimeOffset" : 48765,
      "streamId" : "a1475893-99f5-4f02-b697-5d69e8e30d19",
      "videoType": "camera"
    },
    {
      "connectionData" : "connection data for this stream's connection",
      "filename" : "5ab71b7b-d998-4683-ad2b-7769d6533666.webm",
      "size" : 5396527,
      "startTimeOffset" : 2799,
      "stopTimeOffset" : 48764,
      "streamId" : "5ab71b7b-d998-4683-ad2b-7769d6533666",
      "videoType": "screen"
    }
  ],
  "id" : "297b9c62-78b3-4152-9e98-7e167354c9e6",
  "name" : "archive name",
  "partnerId" : 123456,
  "sessionId" : "2_MX4xMDB-fjE0MjkzMDQ3NzY3NTZ-WUpRUGVFUmhFSkRmVGljeU5zVnJpaXYxfn4"
}

アーカイブに含めるストリームを選択する

アーカイブの開始時に streamMode への manualアーカイブに含めるストリームを選択できます。

アーカイブ録画中にストリームを追加したり削除したりできます。また、アーカイブ録画にストリームのオーディオとビデオ（または両方）を含めるかどうかを指定できます。

それ以外の場合は streamMode に設定する。 auto (デフォルト）では、すべてのストリームが（音声と映像とともに）アーカイブに含まれます。アーカイブ録画を開始する」および「アーカイブに含めるストリームを選択する」を参照してください。

ただし、構成されたアーカイブでは、一度に含まれるビデオストリームは16本まで、オーディオストリームは50本までという制限があります（自動ストリームモードと手動ストリームモードの両方で）。 ストリーム優先ルール.手動ストリームモードのアーカイブでは、ストリームの更新は次のように送信されます。 アーカイブステータスの変更.

録音セッションを自動的にアーカイブ

Vonage Video server SDKのいずれかを使用して、セッションを作成するときにこれを指定することで、セッションを自動的にアーカイブすることができます。

自動的にアーカイブされたセッションのアーカイブは、クライアントがセッションに接続するとすぐに始まります。

自動的にアーカイブされるセッションにはオーディオとビデオの両方が含まれ、すべてのストリームが同じ（構成された）MP4ファイルに記録されます。

ただし、録画が4時間（14,400秒）を超えると、録画が停止されるまで、セッションは最大4時間ずつ、複数の連続したMP4ファイルに録画されます。セッションの連続した自動アーカイブは、記録データの取りこぼしがないように、わずかに重なります。

Vonage Video サーバーサイド SDK メソッドを呼び出し、アーカイブを一覧表示します。 sessionID パラメータを使用して、指定したセッション ID のアーカイブを一覧表示します。

そして、MP4ファイルの順番は createdAt プロパティが返されます。

サーバーSDKを使用して自動アーカイブを停止することはできません。自動アーカイブは、最後のクライアントがセッションから切断してから60秒後、または最後のクライアントがセッションへのストリームの公開を停止してから60分後に停止します。

自動アーカイブを使用する場合、セッションIDの再利用は厳密に避けるべきです。セッションIDを再利用すると、そのセッションの以前の自動アーカイブがタイムアウトした場合に、自動アーカイブが失敗することがあります。

自動アーカイブは、通話前テストや接続テストなどの短時間のセッションには使用しないでください。自動アーカイブは、最後のクライアントがセッションから切断してから60秒後、または最後のクライアントがセッションへのストリームの公開を停止してから60分後に停止するため（公開後もクライアントが接続されている場合）、アーカイブリソースの過剰な使用に対する請求が発生します。

構成されたアーカイブの後処理

ビデオ・アーカイブの録画には アーカイブ録画時間 最大4時間14,400秒。そのため、長いビデオセッションは1つのアーカイブファイルには記録されません。セッションの一部が失われないようにするには 自動的にアーカイブされたセッション 機能を使えば、セッション全体をカバーする複数のファイルを生成することができる。あるいは 同時アーカイブ 機能を使って、前の録音を終了する前に2回目の録音を開始する。どちらの場合も、1つのファイルの終わりと次のファイルの始まりの間に短いオーバーラップがある状態でアーカイブが生成される。

セッション全体を1つのファイルに収めたい場合は 構成済みアーカイブの後処理 このツールは、連続するオーバーラップする録音をマージし、知覚的に可能な限りスムーズな移行を試みます。このツールを使って、複数の短いアーカイブファイルのメディアを含む、1つの長いファイルを生成することができます。詳しくは、デベロッパーガイド 合成アーカイブのポスト処理.このツールは次のサイトで入手できる。 https://github.com/Vonage/archive-post-processing.

このツールは、Vonage Video アーカイブとして作成されていないビデオ録画でも使用できます、 メディアの重複があり、ビデオとオーディオにそれぞれ H264 および AAC LC コーデックを使用しているなど、一連の特性を満たすビデオ録画であれば、Vonage Video アーカイブとして作成されていないビデオ録画でもこのツールを使用できます。

アーカイブ同時録音

同じセッションの複数のアーカイブを同時に録画するには multiArchiveTag オプションを指定します。進行中のセッションの同時アーカイブ録画ごとに、一意の文字列に設定する必要があります。

異なるレイアウトを使用し、それぞれの同時アーカイブ録画に異なるストリームを割り当てることができます。

で 自動的にアーカイブされたセッションを設定する。 multiArchiveTag オプションを使用して、自動アーカイブと同時にアーカイブされる新しい同時アーカイブを開始します。自動アーカイブの開始と終了は、セッションの開始と終了時に（自動アーカイブのルールに従って）独自に行われ、手動で開始したアーカイブは個別に停止されます。

アーカイブ録画ステータスの変更

アーカイブのステータスが変更されたときに通知するコールバック URL を登録できます。アーカイブのステータスは以下のいずれかに設定されます：

Vonage Account を使用してコールバック URL を指定します。アーカイブ・ステータスが変更されると、サーバは指定したURLにHTTP POSTリクエストを送信します。このとき Content-Type リクエストは application/json.リクエストのデータは、以下の形式のJSONオブジェクトである：

{
    "id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
    "event": "archive",
    "createdAt" : 1384221380000,
    "duration" : 328,
    "name" : "Foo",
    "partnerId" : 123456,
    "reason" : "",
    "resolution" : "640x480",
    "sessionId" : "2_MX40NzIwMzJ-flR1ZSBPY3QgMjkgMTI6MTM6MjMgUERUIDIwMTN-MC45NDQ2MzE2NH4",
    "size" : 18023312,
    "status" : "available",
    "url" : "https://tokbox.com.archive2.s3.amazonaws.com/123456/b40ef09b-3811-4726-b508-e41a0f96c68f/archive.mp4"
}

JSONオブジェクトには以下のプロパティが含まれる：

また、Vonage Accountでアーカイブのステータスを確認することもできます：

1. Vonage Accountダッシュボードに移動します。
2. ページ左側のアプリケーションリストから、アーカイブするセッションを含むアプリケーションを選択します。
3. アーカイブ・セクションで、アーカイブ・リスト・タブをクリックします。アプリケーション内のアーカイブの詳細が一覧表示されます。

アーカイブ録画のセキュリティ

以下の方法でアーカイブを保護することができます：

• アーカイブ録画ストレージのフォールバックをオフにする - デフォルトでは、Vonageは指定したS3またはAzureサーバーにファイルをアップロードできなかった場合、Vonageサーバーにアーカイブファイルを保存します。このフォールバック・ストレージ（デフォルトで有効）を防ぐには、Vonage Accountにログインし、アプリケーションを選択し、アーカイブ・ストレージのフォールバックを無効にするオプションを設定します。
• Vonageの暗号化を使用する - これにより、データが暗号化されていない状態で保存されることのないVonageアーカイブを作成することができます。Vonageの録音を保護するために利用可能な方法の中で、これは最高レベルのセキュリティを提供します。これはアドオン機能としてご利用いただけます。詳細については、Vonage暗号化のドキュメントを参照してください。
• Amazon S3のサーバーサイド暗号化を使用する - これは、暗号化のためにAmazon S3が管理する暗号鍵を使用します。Amazon S3のサーバーサイド暗号化について学ぶ これ.

アーカイブとエクスペリエンス・コンポーザーの組み合わせ

アーカイブと エクスペリエンス・コンポーザー.