WebクライアントSDK

概要

Vonage Video APIを使用するアプリケーションはすべて2つの部分で構成されています：

• クライアント側は、Vonage VideoクライアントSDKを使用し、ユーザーのブラウザまたはモバイルアプリで実行されます。
• サーバー側は VonageビデオサーバーSDK サーバ上で実行され、認証情報をクライアントに渡す。

Vonage Video API を使用する Web ベースのアプリケーションを構築するための Client SDK は次のとおりです。 OpenTok.js.このJavaScriptライブラリは、アプリのコア機能のほとんどを提供する：

• セッションへの接続
• セッションへのストリームの公開
• セッション内でストリームを購読する

すべてのVonage VideoクライアントSDKは相互に作用できるようになります。Vonage Videoクライアント、サーバ、セッションなどの基本的な情報については、Vonage VideoクライアントSDKをご覧ください。 Video API概要 ページを参照されたい。

現在のバージョンのOpenTok.jsライブラリは、Vonage VideoクライアントSDKのバージョン2.32以上で書かれたVonage Videoアプリと相互運用できます：

• OpenTok.js (ウェブ)
• アンドロイドSDK
• iOS SDK
• Windows SDK
• macOS SDK
• Linux SDK
• リアクト・ネイティブSDK

OpenTok.jsの読み込み

ウェブページにOpenTok.jsを読み込むには、以下のスクリプト・タグを追加します：

<script src="https://video.standard.vonage.com/v2/js/opentok.min.js"></script>

を使用してインストールすることもできます。 Vonage/クライアントSDKビデオ npm パッケージ。

GitHubパッケージによるインストール

npmレジストリからのインストールに加えて、Vonage Video API Client SDKパッケージは、以下の方法でも入手可能です。 GitHub PackagesのNPMレジストリ.これは、GitHubベースのパッケージ管理を必要とするエンタープライズ環境に、別の配布チャネルを提供する。

利用可能なパッケージ

以下のパッケージはGitHub Packagesに公開されています：

• @vonage/client-sdk-video - 下記にて入手可能 GitHub パッケージ (Vonage org)

セットアップ方法

GitHub PackagesのNPMレジストリからパッケージをインストールするには、GitHubと認証するようにnpmを設定する必要があります：

1.GitHub Personal Access Token (PAT) を作成する。

で個人アクセストークンを生成する。 read:packages スコープを GitHub アカウントの設定に追加します。

2.あなたの .npmrc ファイル

プロジェクトの .npmrc ファイルまたはユーザーレベルの ~/.npmrc ファイル：

//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
@vonage:registry= https://npm.pkg.github.com

交換 YOUR_GITHUB_TOKEN に GitHub パーソナルアクセストークンを追加します。

3.パッケージをインストールする

いったん設定したら、標準のnpm installコマンドを使ってパッケージをインストールできる：

パッケージの在庫について

従来の npm レジストリと GitHub Packages レジストリの両方が同期されます。組織のパッケージ管理の好みに応じて、どちらかの配布方法を選ぶことができます。伝統的な npm インストール方法 ( npm install @vonage/client-sdk-video デフォルトのレジストリから）完全にサポートされたままであり、追加の設定は必要ない。

GitHub Packages の NPM レジストリの使い方については GitHub Packages ドキュメント.

ブラウザサポート

OpenTok.jsライブラリは現在、以下の言語でサポートされています：

• グーグル・クローム（最新版）
• Android版Google Chrome（最新リリース版）
• iOS版Google Chrome（最新バージョン）
• Firefox（最新バージョン）
• Android版Firefox（最新リリース版）
• iOS版Firefoxのベータサポート（最新リリース版）
• Windows および macOS 用 Microsoft Edge バージョン 79 以上（Chromium ベースの Edge バージョン）
• macOSおよびiOSのSafari 11+。ビデオの相互運用性やその他の問題については サファリ・ブラウザ対応 ページを参照されたい。
• Opera (デスクトップ版の最新リリースのみ)
• エレクトロン（最新バージョン）
• サムスンインターネット（最新バージョン）
• WebView Android API レベル36以上
• iOS 18.6+でのWebView

サファリ対応

アップルはmacOSのSafari 11とiOS 11のSafariでWebRTCのサポートを追加し、Safari上でOpenTok.jsアプリを使用できるようになった。

さらに、Safari 12.1はH.264に加えてVP8ビデオコーデックをサポートします。Safari 12.1のVP8サポートはmacOS 10.14.4で出荷され、macOS 10.13.6と10.12.6でも利用可能です。また、最新のiOS 12.2リリースでも利用可能です。

SafariでVP8ビデオコーデックを使用するには、バージョン2.16.0以降のOpenTok.jsを使用する必要があります。

ビデオコーデックのサポートについては、以下を参照してください。 開発者ガイド.

制限事項

以下は Safari での OpenTok.js の制限事項です：

• スクリーン共有ビデオの公開は、iOSのSafari、およびmacOSのSafari 12以前ではサポートされていません。macOSのSafari 13以上ではサポートされています。
• Safariは、http:(安全でない)またはfile:(ファイルシステム)URIスキームを使用してロードされたページでのカメラアクセス(またはストリームパブリッシング)をサポートしていません。https:（セキュア）でページを提供する必要があります。ただし、HTTPをサポートするフラグを切り替えることができます（テスト用）。
• Safariはlocalhostでのカメラアクセスをサポートしていません。0.0.0.0:xx（xxは80などのポート番号）を使用する必要があります。
• Safariで開発者ツールを開くと、End-to-End暗号化が機能しない。

古いバージョン

古いバージョンのSafariはH.264ビデオコーデックのみを使用しているため、VP8ビデオコーデックをサポートしていません。

で ルーティングセッション (メディアルータを使用するセッション) では、古いバージョンの Safari でも動画の公開と購読ができるように、優先コーデックを H.264 に設定したプロジェクトを使用する必要があります。Video API Account の Project ページで、プロジェクトの優先動画コーデックを設定します。

においてである。 ルーティングセッション (OpenTokメディア・ルータを使用するセッション)で、優先ビデオ・コーデックを(H.264ではなく)VP8に設定したプロジェクトでは、古いバージョンのSafariを使用しているクライアントはVonageビデオ・プラットフォームを使用できますが、ビデオはサポートされません。

システム要件

最新のブラウザで信頼性の高いビデオストリーミングを行うには、お使いのデバイスが以下の推奨スペックを満たしていることをご確認ください：

• CPU：最近のデュアルコアプロセッサ、1080pや重いマルチタスクにはクアッドコア（例：Intel Core i5 / Ryzen 5）以上。
• GPU1080p対応の最新統合グラフィックス（Intel UHD/Iris XeまたはAMD RadeonまたはNvidia Graphics）。ビデオコーディングのハードウェアデコーディング対応を強く推奨。
• RAM：日常的なストリーミングには最低8GB、多くのタブやアプリを開く場合は16GBを推奨。
• ストレージ：高速ロードとシステム応答性のためにSSDを推奨。
• ネットワーク信頼性の高いインターネット接続。Wi-Fi、イーサネット、携帯電話で動作。
• その他最適なパフォーマンスを得るためには、ブラウザのハードウェアアクセラレーションを有効にする必要があります。

これらの推奨事項により、ビデオストリーミング時の安定した再生、CPU使用率の低下、スムーズなパフォーマンスが保証されます。

バージョン番号

WebページにOpenTok.jsライブラリをインクルードするには <script> タグを付けている：

<script src="https://video.standard.vonage.com/v2/js/opentok.min.js"></script>

OpenTok.jsのバージョン番号は3つの部分で構成されています：

• メジャーバージョン番号 - この番号（最初の番号）は、後方互換性のないAPIの変更を含む新しいバージョンが出たときにインクリメントされる。
• マイナーバージョン番号 - この番号（2番目の番号）は、新しい機能が追加された新しいバージョンがあるときにインクリメントされます。
• パッチ番号 - この番号（3番目）は、新しい機能が追加されることなく、バグが修正されたり、パフォーマンスが改善されたりする新しいバージョンが出たときにインクリメントされます。

たとえば、v2.4.0はメジャーバージョン2、マイナーバージョン4（メジャーバージョン2の）、リビジョン0（v2.4の）です。リビジョンがリリースされると、変更はルートマイナーリビジョンに含まれます。例えば、v2.2.3がリリースされると、その変更はv2.2に含まれます。

特定のリビジョンを参照するには、完全なバージョン番号（"v2.4.0 "など）を src 属性で指定します。ただし、メジャーバージョン番号のみを指定することをお勧めします。Vonage はライブラリの現行バージョンを公式にサポートしています。古いバージョンを読み込んでいる場合は、Vonageビデオ・プラットフォームの最新のバグ修正や機能を利用するためにアップグレードすることをお勧めします。

OpenTok.jsの新しいバージョンが利用可能になったら、Vonage Video APIを購読してください。 お知らせ フォーラムに参加している。