Error クラスは、コンプリートハンドラに渡されるエラーオブジェクトを定義するために使用されます。 以下に示す各メソッドは非同期で実行され、それぞれに completionHandler パラメータが必要だ:

Error クラスは、以下のいずれかのメソッドによって返されたプロミスが 拒否された際にスローされる Error も定義しています:

について completionHandler パラメータは、 非同期メソッドの呼び出しが成功または失敗した際に呼び出される関数です。非同期呼び出しが失敗した場合、 完了ハンドラ関数にはエラーオブジェクト(Error クラスで定義されているもの)が渡されます。 code そして message エラーオブジェクトのプロパティには、エラーに関する詳細情報が含まれています。

非推奨に関するお知らせ: OT.Error Vonage Video APIの次期バージョンでは定義されなくなります。その場合、 SDKから出力されるエラーは、単に標準的な Error オブジェクト。 もし現在のコードで if (error instanceof OT.Error) これを置き換えてください if (/^OT_/.test(error.name)). (The name 「」で始まるすべてのVonage Video API エラーに対するプロパティ 'OT_'.) ただし、このコードは スムーズなアップグレードを目的としたものであり、処理したい特定のエラーと単純に照合する方が、 あなたのコードにはより適している可能性があります。例えば、 if (error.name === 'OT_USER_MEDIA_ACCESS_DENIED').

プロパティ

名称 タイプ 説明
code Numbers 非推奨 — エラーコード。代わりに name プロパティであり、 code プロパティを使用して、プログラムからエラーを特定します。この code Error オブジェクトのこのプロパティは、以下に挙げる値のいずれかに設定できます。このプロパティは他の値に設定される場合もあり、Vonage API サポートに問題について相談する際には、この値を報告することをお勧めします。呼び出し時のエラー Session.connect(): --- --- code 説明 1004 認証エラーです。詳細はエラーメッセージを確認してください。このエラーは、セッションに接続しようとしたときに、期限切れのトークンを渡した場合に発生します。また、無効なトークンまたはAPIキーを渡した場合にも発生する可能性があります。トークンを生成する際に、現在のバージョンの Vonage Video API サーバー用 SDK. 1005 セッションIDが無効です。セッションIDを生成する際に、現在のバージョンの Vonage Video API サーバー用 SDK. 1006 接続に失敗しました。セッションに接続できません。クライアントにネットワーク接続を確認させてください。 1026 利用規約違反:輸出コンプライアンス。詳しくは 利用規約. 1027 接続制限を超えました。クライアントが、同時接続数の制限を超えているセッションに接続しようとしました。 2001 接続に失敗しました。Vonage Video API サーバーから予期しない応答が返されました。しばらくしてから再度接続をお試しください。 呼び出し後のエラー Session.connect(): --- --- code 説明 3001 - 3007 エラー名「OT_HTTP_ERROR」をご確認ください。 4020 セッションが切断されました。インターネット接続が切れたようです。 呼び出し時のエラー Session.forceDisconnect(): --- --- code 説明 1010 クライアントはVonage Video APIセッションに接続されていません。forceDisconnect()を呼び出す前に、クライアントが正常に接続されており、切断されていないことを確認してください。 1520 強制切断できません。クライアントのトークンにモデレーターのロールが設定されていません。クライアントがセッションに接続すると capabilities プロパティは、クライアントの能力を一覧表示します。 呼び出し時のエラー Session.forceUnpublish(): --- --- code 説明 1010 クライアントはVonage Video APIセッションに接続されていません。forceUnpublish()を呼び出す前に、クライアントが正常に接続されており、接続が切断されていないことを確認してください。 1530 強制アンパブリッシュできません。クライアントのトークンにモデレーターのロールが設定されていません。クライアントがセッションに接続すると capabilities プロパティは、クライアントの能力を一覧表示します。 呼び出し時のエラー Session.publish(): --- --- code 説明 1010 クライアントがVonage Video APIセッションに接続されていません。公開を試みる前に、クライアントが正常に接続されていることを確認してください。また、公開を試みる前に、クライアントが切断されていないことを確認してください。 1500 公開できません。この現象は、以下の原因による可能性があります。 - クライアントのトークンに、「publish」または「moderator」のロールが設定されていない。クライアントがセッションに接続すると、 capabilities Session オブジェクトのプロパティには、クライアントの機能が一覧表示されます。 - エンドユーザーがカメラまたはマイクへのアクセスを拒否しています。 - ページが Chrome で HTTP 経由で読み込まれており、カメラやマイクにアクセスするには HTTPS が必要です。 1553 WebRTC ICE ワークフローのエラーです。これは、セッション内のクライアント間で通信を確立しようとした際に発生するエラーです。再度パブリッシュするか、セッションに再接続してみてください。 2001 公開に失敗しました。Vonage Video API サーバーから予期しない応答が返されました。しばらくしてから再度公開を試みてください。 呼び出し時のエラー Session.signal(): --- --- code 説明 400 シグナルのプロパティ(data、type、または to)のいずれかが無効です。あるいは、データをJSONとして解析できません。 404 「to」への接続は存在しません。 413 型文字列が最大長(128 バイト)を超えているか、データ文字列が最大サイズ(8 kB)を超えています。 500 クライアントがVonage Video APIセッションに接続されていません。シグナリングを試みる前に、クライアントが正常に接続されていることを確認してください。また、シグナリングを試みる前に、クライアントが切断されていないことを確認してください。 2001 シグナル送信に失敗しました。Vonage Video API サーバーから予期しない応答が返されました。しばらくしてから再度シグナルを送信してください。 呼び出し時のエラー Session.subscribe(): --- --- code 説明 0009 このメディア形式はサポートされていません。 0011 デコードエラー。 1013 WebRTCのPeerConnectionエラーが発生しました。ストリームの再公開、ストリームへの再登録、またはセッションへの再接続を試みてください。 1501 妥当な時間内にストリームの購読ができませんでした。 1502 このブラウザでは、この動画形式はサポートされていません。 1554 WebRTC ICE ワークフローのエラーです。これは、セッション内のクライアント間で通信を確立しようとした際に発生するエラーです。ストリームへの再登録、またはセッションへの再接続を試みてください。 1600 内部エラー -- WebRTC 加入者エラー。ストリームに再登録するか、セッションに再接続してください。 1605 ストリームの制限を超えました。クライアントが、同時ストリーム数の制限を超えているセッション内でストリームの購読を試みました。 2001 登録に失敗しました。Vonage Video API サーバーから予期しない応答が返されました。しばらくしてから再度登録をお試しください。 呼び出し時のエラー OT.initPublisher(): --- --- code 説明 1004 認証エラーです。詳細はエラーメッセージを確認してください。このエラーは、セッションに接続しようとしたときに、期限切れのトークンを渡した場合に発生します。また、無効なトークンまたはAPIキーを渡した場合にも発生する可能性があります。トークンを生成する際に、現在のバージョンの Vonage Video API サーバー用 SDK. 呼び出し時のエラー OT.reportIssue(): --- --- code 説明 2011 OT.reportIssue() の呼び出し中にエラーが発生しました。クライアントのネットワーク接続を確認してください。 呼び出し時のエラー OT.setProxyUrl(): --- --- code 説明 2021 Session オブジェクトまたは Publisher オブジェクトの初期化後に、プロキシ URL を設定しようとしないでください。 2022 すでに(以前の呼び出しによって)プロキシURLが設定されている状態で、そのプロキシURLを再度設定しようとすると、 OT.setProxyUrl()). 呼び出し時のエラー Publisher.setVideoSource(): --- --- code 説明 1040 パブリッシャーのビデオソースを変更しようとしても、カメラ入力は使用されません。 1041 について videoSourceId パラメータが文字列ではないか、有効な映像入力デバイスのデバイスIDではありません。 任意のメソッドを呼び出すときに発生する可能性のある一般的なエラー: --- --- code 説明 1011 パラメータが無効です。メソッド呼び出しに有効なパラメータ値を渡しているか確認してください。 2000 内部エラーが発生しました。Vonage Video API セッションに再接続し、操作をもう一度お試しください。
message ストリング メッセージ文字列には、エラーの詳細が記載されています。 name プロパティ(ただし、 message プロパティ)を使用して、プログラムからエラーを特定します。
name ストリング エラーを識別する文字列。このプロパティを使用してください( code プロパティ)を使用してエラーを特定します。なお、すべてのエラーにおいて、この文字列は 'OT_'. その name Error オブジェクトのこのプロパティは、以下に挙げる値のいずれかに設定できます。予期しないエラーが発生した場合、このプロパティは未定義になるか、その他の値に設定されることがあります。Vonage API サポートと問題について話し合う際には、この値を報告することをお勧めします。呼び出し時に発生する可能性のあるエラー OT.initPublisher(): --- --- name 説明 'OT_HARDWARE_UNAVAILABLE' ユーザーのメディア要求を処理するためのハードウェアは存在するようですが、取得できませんでした。別のアプリケーションによって使用中である可能性があります。 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_MEDIA_ENDED' video要素の「終了」イベントが発生しました。 'OT_MEDIA_ERR_ABORTED' video要素のストリームの取得が中止されました。 'OT_MEDIA_ERR_DECODE' video要素でストリームを再生しようとした際に、デコードエラーが発生しました。 'OT_MEDIA_ERR_NETWORK' ネットワークエラーが発生したため、ストリームの取得が停止しました。 'OT_MEDIA_ERR_SRC_NOT_SUPPORTED' このストリームは、再生に適していないことが確認されました。 'OT_NOT_SUPPORTED' ユーザーメディアリクエストに含まれる一部の項目がサポートされていません。 'OT_NO_DEVICES_FOUND' メディアストリームを配信できるデバイスは見つかりませんでした。 'OT_NO_VALID_CONSTRAINTS' 動画と音声の両方が無効になっています。少なくとも片方を有効にする必要があります。 'OT_PROXY_URL_ALREADY_SET_ERROR' proxyUrl はすでに設定されています。再度設定しても何の効果もありません。 'OT_REQUESTED_DEVICE_PERMISSION_DENIED' 指定されたオーディオデバイスには、使用するための権限がありません。 'OT_SCREEN_SHARING_NOT_SUPPORTED' このブラウザでは画面共有はサポートされていません。 'OT_UNABLE_TO_CAPTURE_SCREEN' 画面共有はサポートされていません(また、 videoSource プロパティの options パラメータ OT.initPublisher() への "application", "screen"あるいは "window"). 呼び出す前に OT.initPublisher()を呼び出すことができる。 OT.checkScreenSharingCapability() 画面共有がサポートされているかどうかを確認するには。 'OT_SCREEN_SHARING_EXTENSION_NOT_REGISTERED' このブラウザで画面共有機能を利用するには拡張機能が必要ですが、登録されているものはありません。 'OT_SCREEN_SHARING_EXTENSION_NOT_INSTALLED' このブラウザで画面共有機能を利用するには拡張機能が必要ですが、その拡張機能がインストールされていません。 呼び出し時に発生する可能性のあるエラー OT.reportIssue(): --- --- name 説明 'OT_REPORT_ISSUE_FAILED' OT.reportIssue() の呼び出し中にエラーが発生しました。クライアントのネットワーク接続を確認してください。 を呼び出す際に発生する可能性のあるエラーは、 OT.setProxyUrl() メソッドを使用する: --- --- name 説明 'SET_PROXY_URL_TIMING_ERROR' Session オブジェクトまたは Publisher オブジェクトの初期化後に、プロキシ URL を設定しようとしないでください。 'PROXY_URL_ALREADY_SET_ERROR' すでに(以前の呼び出しによって)プロキシURLが設定されている状態で、そのプロキシURLを再度設定しようとすると、 OT.setProxyUrl()). 呼び出し時に発生する可能性のあるエラー Publisher.setVideoSource(): --- --- name 説明 'OT_INVALID_VIDEO_SOURCE' について videoSourceId パラメータが文字列ではないか、有効な映像入力デバイスのデバイスIDではありません。 'OT_SET_VIDEO_SOURCE_FAILURE' パブリッシャーのビデオソースを変更しようとしても、カメラ入力は使用されません。 呼び出し時に発生する可能性のあるエラー Session.connect(): --- --- name 説明 'OT_AUTHENTICATION_ERROR' APIキーがトークンまたはセッションと一致しません。 'OT_BADLY_FORMED_RESPONSE' Vonage Video API サーバーからの JSON レスポンスの形式が不正でした。 'OT_CONNECT_FAILED' セッションへの接続に失敗しました。 'OT_CONNECTION_LIMIT_EXCEEDED' クライアントは、同時接続数の制限を超えているセッションに接続しようとしました。 'OT_EMPTY_RESPONSE_BODY' Vonage Video API サーバーから予期せぬ空の応答を受け取りました。 'OT_INVALID_SESSION_ID' セッションIDが無効でした。 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 'OT_TERMS_OF_SERVICE_FAILURE' 利用規約違反のため、接続できませんでした。 'OT_INVALID_HTTP_STATUS' 予期しないHTTPステータスを受け取りました。 'OT_XDOMAIN_OR_PARSING_ERROR' クロスドメインエラーが発生したか、サーバーから無効なJSONが返されました。 'OT_INVALID_ENCRYPTION_SECRET' 暗号化の秘密鍵が無効です。 'OT_UNSUPPORTED_BROWSER' お使いのブラウザはエンドツーエンドの暗号化に対応していません。 呼び出し時に発生する可能性のあるエラー Session.forceDisconnect(): --- --- name 説明 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 'OT_PERMISSION_DENIED' このトークンではこの操作を行うことはできません。ロールは少なくとも「モデレーター」である必要があります。 呼び出し時に発生する可能性のあるエラー Session.forceMuteAll(): --- --- name 説明 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 'OT_PERMISSION_DENIED' このトークンではこの操作を行うことはできません。ロールは少なくとも「モデレーター」である必要があります。 'OT_UNEXPECTED_SERVER_RESPONSE' サーバー内部エラーが発生しました。 呼び出し時に発生する可能性のあるエラー Session.forceMuteStream(): --- --- name 説明 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 'OT_NOT_FOUND' このセッションでは、そのストリームIDが見つかりませんでした。 'OT_PERMISSION_DENIED' このトークンではこの操作を行うことはできません。ロールは少なくとも「モデレーター」である必要があります。 'OT_UNEXPECTED_SERVER_RESPONSE' サーバー内部エラーが発生しました。 呼び出し時に発生する可能性のあるエラー Session.forceUnpublish(): --- --- name 説明 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 'OT_PERMISSION_DENIED' このトークンではこの操作を行うことはできません。ロールは少なくとも「モデレーター」である必要があります。 呼び出し時に発生する可能性のあるエラー Session.publish(): --- --- name 説明 'OT_CHROME_MICROPHONE_ACQUISITION_ERROR' Chromeのエラーにより、マイクへのアクセスに失敗しています。この問題を回避するには、エンドユーザーがChromeを再起動し、サイトを再読み込みする必要があります。これは 既知の問題 Chromeで修正される予定です。 'OT_CONSTRAINTS_NOT_SATISFIED' ユーザーメディアを取得するための条件を満たすことができませんでした。 'OT_CREATE_PEER_CONNECTION_FAILED' このクライアントとサブスクライバー、またはVonage Video APIメディアルーターとの間で接続を確立できませんでした。 'OT_HARDWARE_UNAVAILABLE' ユーザーのメディア要求を処理するためのハードウェアは存在するようですが、取得できませんでした。別のアプリケーションによって使用中である可能性があります。 'OT_STREAM_CREATE_FAILED' ユーザーは、暗号化キーを指定せずに、エンドツーエンド暗号化が有効になっているセッションで公開しようとしました。 'OT_ICE_WORKFLOW_FAILED' WebRTC接続の確立中に問題が発生しました。 'OT_INVALID_AUDIO_OUTPUT_SOURCE' 無効な出力オーディオデバイスIDです。有効なビデオ出力デバイスIDである必要があります。 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_MEDIA_ERR_ABORTED' video要素のストリームの取得が中止されました。 'OT_MEDIA_ERR_DECODE' video要素でストリームを再生しようとした際に、デコードエラーが発生しました。 'OT_MEDIA_ERR_NETWORK' ネットワークエラーが発生したため、ストリームの取得が停止しました。 'OT_MEDIA_ERR_SRC_NOT_SUPPORTED' このストリームは、再生に適していないことが確認されました。 'OT_NO_DEVICES_FOUND' メディアストリームを配信できるデバイスは見つかりませんでした。 'OT_NO_VALID_CONSTRAINTS' 動画と音声の両方が無効になっています。少なくとも片方を有効にする必要があります。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 'OT_NOT_SUPPORTED' ユーザーメディアリクエストに含まれる一部の項目がサポートされていません。 'OT_PERMISSION_DENIED' このトークンでは公開を行うことはできません。この機能を利用するには、ロールが少なくとも「パブリッシャー」である必要があります。 'OT_SCREEN_SHARING_NOT_SUPPORTED' このブラウザでは画面共有はサポートされていません。 'OT_SCREEN_SHARING_EXTENSION_NOT_REGISTERED' このブラウザで画面共有機能を利用するには拡張機能が必要ですが、登録されているものはありません。 'OT_SCREEN_SHARING_EXTENSION_NOT_INSTALLED' このブラウザで画面共有機能を利用するには拡張機能が必要ですが、その拡張機能がインストールされていません。 'OT_SET_REMOTE_DESCRIPTION_FAILED' setDescription の実行中に WebRTC 接続に失敗しました。 'OT_STREAM_CREATE_FAILED' サーバーモデルでストリームの作成に失敗しました。 'OT_TIMEOUT' 妥当な時間内に公開できませんでした。 'OT_USER_MEDIA_ACCESS_DENIED' エンドユーザーがハードウェアデバイスへのアクセスを許可しなかったか、または(画面共有ストリームの場合)エンドユーザーが画面へのアクセスを拒否しました。 'OT_UNABLE_TO_CAPTURE_MEDIA' メディアをキャプチャできませんでした。不明なエラーが発生しました。 'OT_UNEXPECTED_SERVER_RESPONSE' これは、Vonage Video API サーバーから予期しないエラーが発生したことを示しています。 呼び出し時に発生する可能性のあるエラー Session.signal(): --- --- name 説明 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 'OT_NOT_FOUND' リソースが見つかりませんでした。 'OT_RATE_LIMIT_EXCEEDED' レート制限のため、信号を送信できませんでした。 呼び出し時に発生する可能性のあるエラー Session.subscribe(): --- --- name 説明 'OT_CREATE_PEER_CONNECTION_FAILED' このクライアントと、ストリームのパブリッシャーまたはVonage Video APIメディアルーターとの間で接続を確立できませんでした。 'OT_DISCONNECTED' クライアントがセッションに接続されていないため、操作は失敗しました。 'OT_UNABLE_TO_SUBSCRIBE' ユーザーは、暗号化シークレットを指定せずに、エンドツーエンド暗号化が有効になっているセッションで購読を試みました。 'OT_INVALID_PARAMETER' 1つ以上のパラメータが無効であるか、指定されていません。 'OT_ICE_WORKFLOW_FAILED' WebRTC接続の確立中に問題が発生しました。 'OT_MEDIA_ERR_ABORTED' video要素のストリームの取得が中止されました。 'OT_MEDIA_ERR_DECODE' video要素でストリームを再生しようとした際に、デコードエラーが発生しました。 'OT_MEDIA_ERR_NETWORK' ネットワークエラーが発生したため、ストリームの取得が停止しました。 'OT_MEDIA_ERR_SRC_NOT_SUPPORTED' このストリームは、再生に適していないことが確認されました。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 'OT_SET_REMOTE_DESCRIPTION_FAILED' setDescription の実行中に WebRTC 接続に失敗しました。 'OT_STREAM_DESTROYED' そのストリームは、購読される前に削除されてしまいました。 'OT_STREAM_LIMIT_EXCEEDED' クライアントは、同時ストリーム数の上限を超えているセッション内で、ストリームの購読を試みました。 'OT_STREAM_NOT_FOUND' ストリームが見つからなかったため、購読できませんでした。 'OT_UNABLE_TO_SUBSCRIBE' 予期せぬエラーが発生したため、ストリーミングの購読ができませんでした。 呼び出し時に発生する可能性のあるエラー Subscriber.getStats(): --- --- name 説明 'OT_HTTP_ERROR' 操作に失敗しました。Vonage Video API サーバーから無効な応答を受け取りました。 'OT_NOT_CONNECTED' ネットワークに接続されていないため、操作を実行できませんでした。 によって返されるPromiseで発生する可能性のあるエラーは、 OT.unblockAudio() メソッドが拒否されました: --- --- name 説明 'OT_MEDIA_ERR_ABORTED' オーディオストリームの取得が中止されました。 'OT_MEDIA_ERR_NETWORK' ネットワークエラーが発生したため、ストリームの取得が停止しました。 'OT_MEDIA_ERR_DECODE' ストリームの再生中にデコードエラーが発生しました。 'OT_MEDIA_ERR_SRC_NOT_SUPPORTED' 再生に適さないストリームが検出されました。 によって返されるPromiseで発生する可能性のあるエラーは、 Publisher.getRtcStatsReport() または Subscriber.getRtcStatsReport() メソッドが拒否されました: --- --- name 説明 'OT_PEER_CONNECTION_NOT_CONNECTED' について PeerConnection 発行者または購読者が接続されていません。 'OT_GET_RTC_STATS_REPORT_NOT_SUPPORTED' このブラウザはこのメソッドをサポートしていません(たとえば、Chrome バージョン 57 以前では、 RTCPeerConnection.getStats() (標準)。

方法

名称 説明
isDefaultPrevented() → {Boolean} デフォルトのイベント動作が、以下の呼び出しによって阻止されたかどうか preventDefault() (true)または(false).
preventDefault() そのイベントに関連するデフォルトの動作が行われるのを防ぎます。

isDefaultPrevented() →{Boolean}

デフォルトのイベント動作が、以下の呼び出しによって阻止されたかどうか preventDefault() (true)または(false). 参照 preventDefault().

リターンズ

preventDefault()

そのイベントに関連するデフォルトの動作が行われるのを防ぎます。

イベントにデフォルトの動作があるかどうかを確認するには、 cancelable イベントオブジェクトの プロパティ。

に電話する。 preventDefault() そのイベントのコールバック関数内のメソッド。

以下のイベントには、デフォルトの動作が設定されています: