授業
struct オーディオデータ
オーディオサンプルのバッチに関連するいくつかのパラメータを定義します。 続きを読む...
クラス AudioDevice
パブリッシャーおよびサブスクライバーが使用するオーディオデバイスを設定するためのメソッドを含むクラス。 続きを読む...
クラス AudioDeviceSettings
から取得した設定を定義します。 IAudioDevice.GetAudioCapturerSettings() そして IAudioDevice.GetAudioRendererSettings() メソッド。 続きを読む...
クラス AudioTransformer
で使用するオーディオ変換を定義します。 発行元.AudioTransformers 配列。 続きを読む...
クラス 能力
の値を定義します。 Capabilities プロパティの セッション セッションへの接続に使用されたトークンに割り当てられたロールに基づいて、オブジェクトを決定します。 続きを読む...
クラス 接続
クライアントとVonage Video APIセッション間の接続を表します。 続きを読む...
クラス コンテクスト
以下のリソースを管理するために使用されます セッション, 出版社そして 購読者 オブジェクト。 続きを読む...
クラス DedicatedWorkerDispatcher
の導入 IDispatcher イベントの配信に専用のワーカースレッドを使用します。すべてのプレゼンテーションフレームワーク(WinForms、WPFなど)で利用可能です。配信順序は保証されます。このインスタンスの各 IDispatcher 別のスレッドを使用するため、同じキューを使用する必要がある場合は、 DedicatedWorkerDispatcher そして、それを一人ひとりに回して オープントーク を受け取るオブジェクト IDispatcher. 専用スレッドは他の目的には使用されないため、イベントハンドラ内ではCPU負荷の高いタスクや長時間実行されるタスクを実行することができます。ただし、イベントハンドラ内ではUIを直接操作することはできません。UIの操作が必要な場合は、まずイベントをUIスレッドにディスパッチする必要があります。 続きを読む...
クラス DirectDispatcher
の導入 IDispatcher イベントを一切スケジュールしません。下位層がイベントを配信するために使用しているのと同じスレッドを使用します。すべてのプレゼンテーション・フレームワーク(WinForms、WPFなど)で利用可能です。配信順序は保証されます。これはノーオペレーションであるため IDispatcher、それが同じであるかどうかは問題ではありません DirectDispatcher が常に使用されるか、その都度新しいものが作成されます。CPU負荷が高いタスクや長時間実行されるタスクは、ネイティブAPIのメインスレッドをブロックし、パフォーマンスや応答性に影響を与えるため、イベントハンドラ内で実行すべきではありません。 また、イベントハンドラから otkit API 関数を直接呼び出すと、インターロッキングが発生する可能性があるため、それが必要な場合は、まず別のスレッドで実行するように再スケジュールしてください。イベントハンドラ内では UI を直接操作することはできません。これが必要な場合は、まずイベントを UI スレッドにスケジュールする必要があります。 重要:この種の IDispatcher これにより、Applicationsには大きな責任が課せられます。Applicationsは、呼び出し元スレッドをブロックしてはならず、APIへの直接呼び出しも一切行えず、まず再スケジューリングを行う必要があります。 一方で、アプリケーションがコールバックをどのように処理するかについて、より詳細な制御が可能になります。これにより、不要な再スケジューリングを回避したり、異なる種類のイベントの優先順位を管理したりすることができ、アプリケーションのパフォーマンス向上につながります。 続きを読む...
インターフェース IAudioDevice
すべてのパブリッシャーおよびサブスクライバーが使用するオーディオデバイスを定義します。 続きを読む...
クラス IceConfig
カスタムICE設定を行うためのクラス。 続きを読む...
struct IceServer
リストに追加するオブジェクトを定義します。 CustomIceServers プロパティの IceConfig クラス。 続きを読む...
インターフェース ICustomAudioTransformer
AudioTransformer(string name, ICustomAudioTransformer transformer) コンストラクタで使用される、カスタムオーディオトランスフォーマーを定義するために使用されるインターフェース。 続きを読む...
インターフェース ICustomVideoTransformer
で使用するカスタムビデオトランスフォーマーを定義するために使用されるインターフェース VideoTransformer.VideoTransformer(string name, ICustomVideoTransformer transformer) コンストラクタ。 続きを読む...
インターフェース IDispatcher
によって使用されるクラスのインターフェース セッション, 出版社そして 購読者 イベントを別のスレッドで実行するようにスケジュールする例。 続きを読む...
インターフェース IVideoCapturer
インターフェース IVideoFrameConsumer
によって使用されるビデオフレームコンシューマーを定義します。 VideoCapturer出版社. 続きを読む...
インターフェース IVideoRenderer
が使用するビデオレンダラーを定義します。 出版社 または 購読者 オブジェクトがある。 続きを読む...
クラス ロガー
SDKで使用されるログレベルの設定を可能にし、必要に応じてログ処理用のカスタムコールバックを指定できるヘルパークラスです。このクラスを使用することで、DllImportを介してネイティブC APIを直接呼び出すよりも、ネイティブのログ処理をより安全に管理できます。警告:アプリケーションを終了する前に、必ずDisable()を呼び出して、終了時の例外が発生しないようにしてください。
クラス MMAudioDevice
mmdeviceapi に基づくカスタムオーディオデバイスの実装です。このカスタムオーディオデバイスは、が提供するデフォルトの内部オーディオデバイスの代わりに使用できます。 OpenTok.AudioDevice. 続きを読む...
クラス OpenTokException
Vonage Video API Windows SDK によってスローされるエラーを定義します。 続きを読む...
クラス 推奨ビデオコーデック
特定の 出版社の配信。 続きを読む...
クラス 出版社
パブリッシャーは、指定したソースからオーディオ・ビデオストリームを取得します。 続きを読む...
クラス セッション
クライアントが参加しているVonage Video APIセッションを表します。 続きを読む...
クラス ストリーム
Vonage Video API セッションにおけるオーディオ・ビデオストリームの状態を表します。最新情報を取得するには、 Stream プロパティの 出版社 または 購読者 ストリームのプロパティにアクセスする前に。 続きを読む...
クラス 購読者
Vonage Video API セッション内でオーディオ・ビデオストリームを再生するために使用されます。 続きを読む...
クラス ThreadPoolDispatcher
の導入 IDispatcher マネージドのThreadPoolとは別のスレッドを使用してイベントを配信します。すべてのプレゼンテーションフレームワーク(WinForms、WPFなど)で利用可能です。 重要だ: 配送注文は 違う 保証されています。すべての事例において ThreadPoolDispatcher イベントを同じスレッドプールにディスパッチするため、同じ ThreadPoolDispatcher は常に使用されるか、または毎回新しいものが作成される IDispatcher が必要です。基盤となるスレッドプールシステムはこれに対応できるよう設計されているため、イベントハンドラ内ではCPU負荷の高いタスクや長時間実行されるタスクを実行できます。ただし、イベントハンドラ内ではUIを直接操作することはできません。UI操作が必要な場合は、まずイベントをUIスレッドにスケジュールする必要があります。 続きを読む...
クラス VideoCapturer
システム上で利用可能なカメラのいずれかから映像をキャプチャする、ビデオキャプチャ機能の実装。 続きを読む...
クラス VideoCaptureSettings
VideoCapturer.UpdateCaptureSettings(ref VideoCaptureSettings) メソッドに渡される設定を定義します。 続きを読む...
クラス ビデオフレーム
のビデオフレームを定義します。 IVideoRenderer.RenderFrame(VideoFrame) そして IVideoFrameConsumer.Consume(VideoFrame) メソッド。 続きを読む...
クラス VideoTransformer
で使用する動画変換を定義します。 発行元:VideoTransformers 配列。 続きを読む...
クラス WinFormsDispatcher
の導入 IDispatcher Windows Formsのメインスレッド/UIスレッドを使用してイベントをディスパッチするものです。Windows Forms Applicationsでのみ利用可能です。配信順序は保証されています。すべてのインスタンスは WinFormsDispatcher イベントをメインアプリケーションスレッドに送信するため、同じ WinFormsDispatcher は常に使用されるか、または毎回新しいものが作成される IDispatcher が必要です。CPU負荷が高いタスクや長時間実行されるタスクは、UIスレッドをブロックし、パフォーマンスや応答性に影響を与えるため、ハンドラ内では実行しないでください。 続きを読む...
クラス WPFDispatcher
の導入 IDispatcher WPFのメインスレッド/UIスレッドを使用してイベントをディスパッチするものです。WPFアプリケーションでのみ利用可能です。配信順序は保証されます。すべてのインスタンスは WPFDispatcher イベントをメインアプリケーションスレッドに送信するため、同じ WPFDispatcher は常に使用されるか、または毎回新しいものが作成される IDispatcher が必要です。CPU負荷が高いタスクや長時間実行されるタスクは、UIスレッドをブロックし、パフォーマンスや応答性に影響を与えるため、ハンドラ内では実行しないでください。 続きを読む...
列挙型
enum エラーコード : int {   不明なエラー = -1 , GenericSDKError = 1 , 認証失敗 = 1004 , 無効なセッションID = 1005 ,   接続に失敗しました = 1006 , NoMessagingServer = 1503 , 接続拒否 = 1023 , SessionStateFailed = 1020 ,   P2PSessionMaxParticipants = 1403 , セッション接続タイムアウト = 1021 , SessionInternalError = 2000 , SessionInvalidSignalType = 1461 ,   セッション信号データが長すぎます = 1413 , SessionSignalTypeTooLong = 1414 , 接続が切断されました = 1022 , セッションが切断されました = 1010 ,   PublisherInternalError = 2000 , PublisherWebRTCError = 1610 , PublisherUnableToPublish = 1500 , 発行元:予期せぬピア接続の切断 = 1710 ,   PublisherCannotAccessCamera = 1650 , PublisherCameraAccessDenied = 1670 , 接続タイムアウト = 1542 , SubscriberWebRTCError = 1600 ,   SubscriberServerCannotFindStream = 1604 , SubscriberStreamLimitExceeded = 1605 , SubscriberInternalError = 2000 , 不明なパブリッシャーインスタンス = 2003年 ,   不明なサブスクライバーインスタンス = 2004年 , SessionNullOrInvalidParameter = 1011 , VideoCaptureFailed = 3000 , カメラエラー = 3010 ,   VideoRenderFailed = 4000 , SessionSubscriberが見つかりません = 1112 , SessionPublisherが見つかりません = 1113 , PublisherTimeout = 1541 ,   セッションがブロックされた国 = 1026 , セッション接続制限を超えました = 1027 , SessionUnexpectedGetSessionInfoResponse = 2001年 , SessionIllegalState = 1015 ,   SessionUnableToForceDisconnect = 1520 , SessionUnableToForceMute = 1540 , SessionUnableToSendSignal = 1550 , 暗号化シークレットが見つかりません = 6000 ,   暗号化内部エラー = 6001 , DecryptionInternalError = 6002 , 暗号化秘密鍵の不一致 = 6003 , InvalidEncryptionSecret = 6004 ,   暗号化非対応コーデック = 6005 , 復号非対応コーデック = 6006 , MediaTransformerInternalError = 0x0A000000 , MediaTransformerInvalidType ,   MediaTransformerNameNotProvided , MediaTransformerのカスタムコールバックが指定されていません , MediaTransformerPropertiesNotProvided , MediaTransformerModelNotFound ,   MediaTransformerOpenTokTransformersLibraryNotLoaded , MediaTransformerOpenTokTransformersSymbolNotFound , OpenTokTransformersInternalError = 0x0B000000 , OpenTokTransformersInvalidParam ,   OpenTokTransformersNameNotProvided , OpenTokTransformersInvalidName , OpenTokTransformersPropertiesNotProvided , OpenTokTransformersInvalidPropertiesFormat ,   OpenTokTransformersModelFileNotFound , OpenTokTransformersRadiusPropertyNotProvided , OpenTokTransformersInvalidRadiusProperty , OpenTokTransformersCustomRadiusPropertyNotProvided ,   OpenTokTransformersInvalidCustomRadiusProperty , OpenTokTransformersImageFilePathプロパティが指定されていません , OpenTokTransformersImageFilePathNotFound , OpenTokTransformersMlTransformerInitError }
OpenTokException オブジェクトのエラーコードの値を定義します。 続きを読む...
enum 動画コンテンツのヒント : int { NONE = 0 , MOTION = 1 , DETAIL = 2 , TEXT = 3 }
VideoCapturer.SetVideoContentHint(VideoContentHint contentHint) メソッドに渡される設定を定義します。 続きを読む...
enum VideoSourceType : int { カメラ = 1 , 画面 = 2 , カスタム = 3 }
Publisher.VideoSourceType プロパティのオプションを定義します。 続きを読む...
enum 動画ビットレートプリセット : int { デフォルト = 0 , BwSaver = 1 , ExtraBwSaver = 2 , カスタム = 3 }
パブリッシャーのストリームにおけるビデオのビットレートを制御するためのプリセット戦略を定義します(Publisher.VideoBitratePreset を参照)。これらのプリセットを使用すると、ビットレートを手動で指定することなく、あらかじめ定義された帯域幅戦略を適用できます。プリセットは、手動によるビットレート設定とは互いに排他的です。 続きを読む...
enum 劣化優先度 : int {   未設定 = -1 , フレームレートと解像度の維持 = 0 , フレームレートの維持 = 1 , 解像度の維持 = 2 ,   バランスが取れている = 3 }
帯域幅やCPUリソースが限られている場合に、ビデオエンジンがフレームレートや解像度を調整する際に従おうとするポリシーについて説明します。これは「ベストエフォート」方式のポリシーです。フレームレートについては保証されるものではなく、その他の理由により一部のフレームがスキップされる可能性があります。 続きを読む...
enum ICEIncludeServers : int { すべて = 0 , カスタム = 1 }
の値を定義します。 IncludeServers IceConfig クラスのプロパティ。 続きを読む...
enum ICETransport : int { すべて = 0 , 中継 = 1 }
の値を定義します。 TransportPolicy IceConfig クラスのプロパティ。 続きを読む...
enum PixelFormat : int {   不明 = 0 , フォーマット:YUV 420p = 1 , FormatNv12 = 2 , FormatNv21 = 3 ,   FormatYuy2 = 4 , FormatUyvy = 5 , FormatArgb32 = 6 , FormatBgra32 = 7 ,   FormatRgb24 = 8 , FormatAbgr32 = 9 , フォーマット:MJPEG = 10 , FormatRgba32 = 11 }
動画フレームのフォーマット。 続きを読む...
機能
delegate void OnFrame (IntPtr フレーム)

列挙型のドキュメント

劣化優先度

帯域幅やCPUリソースが限られている場合に、ビデオエンジンがフレームレートや解像度を調整する際に従おうとするポリシーについて説明します。これは「ベストエフォート」方式のポリシーです。フレームレートについては保証されるものではなく、その他の理由により一部のフレームがスキップされる場合があります。

詳しくは 分解の優先順位.

調査員
未設定 デフォルト値。ビデオエンジンが最適な画質低下設定を決定します。
フレームレートと解像度の維持 ビデオエンジンは解像度を下げず、フレームレートを安定させようとします。規格のバージョンによっては、このオプションは「DISABLED」と呼ばれており、リソースが限られている場合でも、画質の低下は一切生じないことを意味します。
フレームレートの維持 ビデオエンジンはフレームレートを一定に保つよう努めますが、必要に応じて解像度を下げる場合があります。
解像度の維持 ビデオエンジンは解像度を下げることはありませんが、必要に応じてフレームレートを下げる場合があります。
バランスが取れている ビデオエンジンは、必要に応じて解像度とフレームレートの両方を調整し、バランスを取るよう努めます。

エラーコード

enum OpenTok.ErrorCode : int

以下のエラーコードの値を定義します。 OpenTokException オブジェクトがある。

調査員
不明なエラー 不明なエラーが発生した場合に使用されます。
GenericSDKError 一般的なエラーに使用されます。記載されているエラーの説明を参照してください。
認証失敗 無効なAPIキーまたはトークンが指定されました。
無効なセッションID 接続できません:無効なセッション ID が指定されました。
接続に失敗しました セッションの接続に失敗しました。
NoMessagingServer に接続する際にエラーが発生しました。 オープントーク メッセージングサーバー。
接続拒否 以下の宛先へのソケットを開くことができませんでした。 オープントーク メッセージングサーバー。送信ポートの443および8080にアクセスできることを確認してください。
SessionStateFailed セッションの状態を取得しようとした際に、接続がタイムアウトしました。ネットワーク接続を確認してください。
P2PSessionMaxParticipants ピア・ツー・ピア対応のセッションには、参加者が2人しか参加できません。
セッション接続タイムアウト セッションへの接続を試みた際、接続タイムアウトが発生しました。ネットワーク接続を確認してください。
SessionInternalError セッションへの接続中に内部エラーが発生しました。もう一度接続してみてください。
SessionInvalidSignalType 無効な信号タイプです。
セッション信号データが長すぎます 無効な信号 – データ文字列が長すぎます。最大長は 8196 です。
SessionSignalTypeTooLong 無効な信号 – タイプ文字列が長すぎます。最大長は128です。
接続が切断されました との接続は オープントーク メッセージングサーバーが切断されました。ネットワーク接続を確認してください。
セッションが切断されました 接続が切断されたセッションへの公開を試みています。
PublisherInternalError 公開中に内部エラーが発生しました。再度公開してみてください。
PublisherWebRTCError 出版社 WebRTCの失敗。
PublisherUnableToPublish 出版社は出版することができません。
発行元:予期せぬピア接続の切断 パブリッシャーのストリーム用のPeerConnectionが予期せず切断されました。
PublisherCannotAccessCamera 発行元は、指定されたカメラにアクセスできません。
PublisherCameraAccessDenied そのユーザーはカメラへのアクセスを拒否しました。
接続タイムアウト 購読者 ストリームへの接続中にタイムアウトが発生しました。ストリームへの再登録をお試しください。
SubscriberWebRTCError 購読者 WebRTCの失敗。
SubscriberServerCannotFindStream ストリームが存在しないため、サブスクライバーの作成に失敗しました。これは、ストリームがセッションから削除されたのと同時にサブスクライバーが作成された場合に発生することがあります。
SubscriberStreamLimitExceeded サーバーがサポートする登録者数の上限に達したため、登録に失敗しました。
SubscriberInternalError 購読中に内部エラーが発生しました。もう一度購読をお試しください。
不明なパブリッシャーインスタンス 公開を取り消せません:不明 出版社 インスタンスが Session.Unpublish(Publisher) メソッドを使用する。
不明なサブスクライバーインスタンス 購読解除できません:不明 購読者 インスタンスが Session.Unsubscribe(Subscriber) メソッドを使用する。
SessionNullOrInvalidParameter 無効なパラメータを渡したか、あるいは セッション nullです。
VideoCaptureFailed ビデオキャプチャ機能でエラーが発生しました。
カメラエラー カメラからの動画取得中にエラーが発生しました。
VideoRenderFailed ビデオレンダラーでエラーが発生しました。
SessionSubscriberが見つかりません このセッションでは、この加入者は認識されていません。これは通常、以下の呼び出しが原因です。 Session.Unsubscribe(Subscriber) そのセッションに関連付けられていない加入者に対して。
SessionPublisherが見つかりません このセッションでは、発行元が不明です。これは通常、 Session.Unpublish(Publisher) そのセッションへのストリームを配信していないパブリッシャーと。
PublisherTimeout 公開中にタイムアウトが発生しました。
セッションがブロックされた国 セッションに接続できません。利用規約違反:輸出コンプライアンス。
セッション接続制限を超えました サーバーがサポートする接続数の上限に達したため、接続に失敗しました。
SessionUnexpectedGetSessionInfoResponse セッションに接続できませんでした。もう一度接続してみてください。
SessionIllegalState すでに接続済みのセッションに接続できません。または、そのセッションに存在しなくなったストリームを購読できません。
SessionUnableToForceDisconnect 強制切断できませんでした。おそらく、クライアントの機能が制限されているためです。
SessionUnableToForceMute クライアントの機能に制限があるためか、強制ミュートを行うことができません。
SessionUnableToSendSignal シグナルを送信できませんでした。おそらく、クライアントの機能が制限されているためです(例:パブリッシャー専用トークン)。
暗号化シークレットが見つかりません 暗号化シークレットなしで、エンドツーエンド暗号化セッションに参加しようとしました
暗号化内部エラー パケットの暗号化中に内部エラーが発生しました
DecryptionInternalError パケットの復号中に内部エラーが発生しました
暗号化秘密鍵の不一致 パケットの復号中に発生した秘密鍵の不一致
InvalidEncryptionSecret 無効な暗号化シークレット
暗号化非対応コーデック 暗号化に対応していないメディアコーデック
復号非対応コーデック 復号に使用するメディアコーデックがサポートされていません

ICEIncludeServers

の値を定義します。 IncludeServers プロパティの IceConfig クラスである。

調査員
すべて クライアントは以下を使用します オープントーク ユーザーが指定したカスタム TURN サーバーに加え、TURN サーバーも利用できます。
カスタム クライアントは、お客様が提供するカスタムTURNサーバーのみを使用します。

ICETransport

の値を定義します。 TransportPolicy プロパティの IceConfig クラスである。

調査員
すべて クライアントは、メディア接続を確立するために、ICEのすべてのルーティングタイプ(host、srflx、TURNなど)を使用します。
中継 クライアントは常にTURNを介して接続を確立し、その他のすべてのICE/候補を無視します。

PixelFormat

enum OpenTok.PixelFormat : int

動画フレームのフォーマット。

調査員
不明 不明な形式です。
フォーマット:YUV 420p YUV420p。
FormatNv12 NV12。
FormatNv21 NV21。
FormatYuy2 YUY2.
FormatUyvy UYVY。
FormatArgb32 32ビットARGB
FormatBgra32 32ビット BGRA
FormatRgb24 24ビットRGB
FormatAbgr32 32ビット ABGR
フォーマット:MJPEG M-JPEG。
FormatRgba32 32ビット RGBA

動画ビットレートプリセット

パブリッシャーのストリームにおける動画のビットレートを制御するためのプリセット戦略を定義します(参照: Publisher.VideoBitratePreset). これらのプリセットを使用すると、手動でビットレートを指定することなく、あらかじめ定義された帯域幅戦略を適用できます。プリセットは、手動でのビットレート設定とは互いに排他的です。

詳しくは パブリッシャー最大ビットレート.

調査員
デフォルト デフォルトのプリセット。追加の制限は適用されません。これがデフォルトのモードです。
BwSaver 帯域幅節約プリセット。適度な制限を設け、妥当な動画品質を維持しつつ、帯域幅の使用量を削減します。
ExtraBwSaver 追加の帯域幅節約プリセット。帯域幅の使用量を最小限に抑えるため、厳しい制限を適用します。
カスタム カスタムビットレート。MaxVideoBitrate プロパティを使用して手動で設定されたビットレートを表します。追跡目的で返されますが、直接設定することはできません。

動画コンテンツのヒント

に渡しされる設定を定義します。 VideoCapturer.SetVideoContentHint(VideoContentHint contentHint) メソッドを使用する。

調査員
NONE ヒントは表示されません(デフォルト)。
MOTION このトラックは、動きが重要な映像が含まれているものとして扱う必要があります。
DETAIL このトラックでは、動画の詳細が特に重要であるかのように扱う必要があります。たとえば、テキストコンテンツ、絵画、または線画を含むストリームには、この設定を使用するとよいでしょう。
TEXT このトラックでは、映像の詳細が特に重要であり、鋭いエッジや均一な色の領域が頻繁に現れる可能性があるものとして扱う必要があります。たとえば、テキストコンテンツを含むストリームには、この設定を使用するとよいでしょう。

VideoSourceType

のオプションを定義します。 Publisher.VideoSourceType 財産である。

調査員
カメラ カメラの映像ソース。
画面 画面共有の動画ソース。
カスタム カスタム動画ソース。カスタムストリーム動画タイプは、Webで生成されたストリームにのみ適用されます。