OpenTok iOS SDK リファレンス

OpenTokのiOS SDKには、以下のクラスが含まれています:

クラス 説明
OTAudioBus オーディオバスは、ネットワークとオーディオデバイス間のオーディオデータを中継します。[OTAudioDevice setAudioBus:] メソッドを呼び出して、OTAudioBus プロトコルを実装するオブジェクトを定義します。オーディオデバイスは、キャプチャしたオーディオサンプルをオーディオバスにプッシュし、オーディオバスからレンダリングされていないオーディオサンプルを取得します。
OTAudioData [OTCustomAudioTransformer transform:] メソッドに渡されるオーディオデータを定義します。
OTAudioDevice セッションで使用するオーディオデバイスを定義します。[OTAudioDeviceManager setAudioDevice:] を参照してください。
OTAudioDeviceManager AudioDeviceManager を使用して、アプリで使用するカスタムオーディオデバイスを設定します。このオーディオデバイスは、オーディオのキャプチャおよびレンダリングを行うハードウェアへのアクセスを管理します。
OTAudioFormat カスタムオーディオドライバを使用する場合のオーディオのフォーマットを定義します。
OTAudioSessionManager CallKit などの通話サービスで使用するためのオーディオセッションマネージャを定義します。このプロトコルの実装は任意です。カスタムオーディオデバイスは、これらのメソッドを実装して AVAudioSession を管理することができます。SDK に含まれるデフォルトのオーディオデバイスは、正常に動作する実装を提供しています。
OTAudioTransformer オーディオストリームのトランスフォーマーを定義します。
OTCameraCaptureFrameRate [OTPublisher initWithDelegate:name:cameraResolution:cameraFrameRate:] メソッドの cameraFrameRate パラメータの値を定義します。
OTCameraCaptureResolution [OTPublisher initWithDelegate:name:cameraResolution:cameraFrameRate:] メソッドの cameraResolution パラメータの値を定義します。
OTConnection OpenTok セッションへの接続を表します。OTSession クラスには、OTConnection オブジェクトである connection プロパティが含まれています。また、OTStream クラスにも、OTConnection オブジェクトである connection プロパティが含まれています。
OTCustomAudioTransformer オーディオストリーム用のカスタムトランスフォーマーを定義します。これは、[OTAudioTransformer initWithName:transformer:] メソッドに渡されます。
OTCustomVideoTransformer ビデオストリーム用のカスタムトランスフォーマーを定義します。これは、[OTVideoTransformer initWithName:transformer:] メソッドに渡されます。
OT分解の優先度 デフォルト値。ビデオエンジンが最適な画質低下設定を決定します。
OTError OpenTok iOS SDK のエラーを定義します。
OTMuteForcedInfo [OTSessionDelegate session:muteForced:] メッセージの muteForced パラメータを定義します。
OTネットワークの状態 輸送便のネットワーク状態スコアの推定値。
OTネットワークの性能低下の原因 セッションにおける動画またはネットワークの品質低下の原因を示します。
OTネットワークの理由 ネットワークの状態に影響を与えている主な原因について説明します。
OTPixelFormat OTVideoFrame オブジェクトの pixelFormat プロパティに対するピクセル形式の値を定義します。
OTPublisher(出版社 パブリッシャーは、デバイスのマイクとカメラからオーディオ・ビデオストリームを取得します。その後、[OTSession publish:error:] メッセージを送信することで、そのオーディオ・ビデオストリームを OpenTok セッションに公開することができます。
OTPublisherDelegate OTPublisherインスタンスへのメッセージ送信に使用されます。
OTPublisherErrorCode [OTPublisherKitDelegate publisher:didFailWithError:] で使用されるエラーコード値の一覧。
OTPublisherKit パブリッシャーは、指定したソースからオーディオ・ビデオストリームを取得します。その後、[OTSession publish:error:] メッセージを送信することで、そのオーディオ・ビデオストリームを OpenTok セッションに公開することができます。
OTPublisherKitAudioLevelDelegate パブリッシャーのオーディオレベルを監視するために使用されます。
OTPublisherKitAudioNetworkStats パブリッシャーのオーディオ統計情報を説明します。[OTPublisherKit setNetworkStatsDelegate:] を参照してください。
OTPublisherKitDelegate OTPublisherインスタンスへのメッセージ送信に使用されます。OTPublisherクラスには、デリゲートプロパティが含まれています。[OTPublisherKit initWithDelegate:] メッセージまたは [OTPublisherKit initWithDelegate:settings:] メッセージを送信する際には、OTPublisherKitDelegate オブジェクトを指定します。
OTPublisherKitMediaLinkStats ローカル転送に関するメトリクスを含む、パブリッシャーのメディアリンク統計情報を提供します。
OTPublisherKitNetworkStatsDelegate パブリッシャーのオーディオおよびビデオの統計情報を監視するために使用されます。[OTPublisherKit networkStatsDelegate] を参照してください。
OTPublisherKitRtcStatsReportDelegate パブリッシャーのRTC統計情報を報告するメッセージの送信に使用されます。 このデリゲートを使用するには、[OTPublisherKit rtcStatsReportDelegate] プロパティを設定してください。[OTPublisherKit getRtcStatsReport] メソッドを呼び出した後、[OTPublisherKitRtcStatsReportDelegate publisher:rtcStatsReport:] メッセージが送信され、統計情報が報告されます。
OTPublisherKitの設定 [OTPublisherKit initWithDelegate:settings:] メソッドを使用してパブリッシャーを初期化する際に使用する設定を定義します。
OTPublisherKitVideoLayerStats 公開済みの単一の動画レイヤーに関する統計情報を説明します。
OTPublisherKitVideoNetworkStats パブリッシャーの動画統計情報を説明します。[OTPublisherKit setNetworkStatsDelegate:] を参照してください。
OTPublisherKitVideoType [OTPublisherKit videoType] プロパティの値を定義します。
OTPublisherRtcStats パブリッシャーによって公開されたメディアストリームに関するRTC統計情報を表します。
OTPublisherSettings [OTPublisher initWithDelegate:settings:] メソッドを使用してパブリッシャーを初期化する際に使用する設定を定義します。
OTPublisherVideoEventReason ビデオの有効化および無効化イベントには、ビデオトラックが有効化/無効化された理由を特定するための理由コードが付随しています。
OTSenderStats 送信側から報告された、ビットレートの推定値などの動画統計情報を表します。
オセッション OpenTok iOS SDK を使用する最初のステップは、API キーと有効なセッション ID を使用して OTSession オブジェクトを初期化することです。OTSession オブジェクトを使用して、開発者用 API キーと有効なトークンを用いて OpenTok に接続します。
OTSessionCapabilities [OTSession capabilities] プロパティを定義します。セッションに接続し、[OTSessionDelegate sessionDidConnect:] メソッドが呼び出された後、このプロパティは、使用されるトークンに割り当てられたロールに基づいて、クライアントがそのセッション内でストリームのパブリッシュおよびサブスクライブが可能かどうかを識別します。
OTSessionConnectionStatus [OTSession sessionConnectionStatus] を通じて取得できる接続ステータスコード。
OTSessionDelegate OTSessionインスタンスにメッセージを送信するために使用されます。OTSessionクラスには、デリゲートプロパティが含まれています。[OTSession initWithApiKey:sessionId:delegate:] メッセージを送信する際には、OTSessionDelegateオブジェクトを指定します。
OTSessionErrorCode [OTSessionDelegate session:didFailWithError:] で使用されるエラーコード値の一覧。
OTSessionICEConfig プロパティを定義します。これにより、セッション中にクライアントが使用するTURNサーバーが指定されます。
OTSessionICEIncludeServers カスタムTURNサーバーのみを使用するか、OpenTok TURNサーバーに加えてそれらのサーバーも使用するかを設定します。このプロパティの値を定義します。
OTSessionICETransportPolicy メディア接続の確立に、すべてのICEトランスポートタイプ(host、srflx、TURNなど)を使用するか、TURNのみを使用するかを設定します。[OTSessionICEConfig transportPolicy] 設定で使用されます。
OTSessionSettings [OTSession initWithApiKey:sessionId:delegate:settings:] メソッドを使用して OTSession オブジェクトを初期化する際に使用する設定を定義します。
OTStream OTStream オブジェクトは、ビデオデータやオーディオデータを含む可能性のあるマルチメディアストリームを表します。
OTStreamVideoType [OTStream videoType] プロパティの値を定義します。
OTS購読者 OpenTokのストリームをレンダリングし、動画を表示するとともに、エンドユーザー向けの簡単な操作機能を提供するUIViewを提供します。
OTSubscriberDelegate OTSubscriberDelegate は OTSubscriberKitDelegate を拡張し、OTSubscriber の実装に固有の追加のオプションコールバックを提供します。現時点では追加のコールバックは 1 つしかありませんが、今後のリリースでさらに追加される可能性があります。
OTSubscriberErrorCode [OTSubscriberKitDelegate subscriber:didFailWithError:] で使用されるエラーコード値の一覧。
OTSubscriberKit OTSubscriberKit(subscriber)オブジェクトは、OTStream にバインドされたメディアデータをレンダリングします。OTSubscriberKit クラスを使用すると、ビデオストリームに対してカスタムビデオレンダラーを設定できます。独自のビデオ処理およびレンダリングの実装を提供したい場合は、このクラスを使用してください。それ以外の場合は、OTSubscriberKit を使用してください。
OTSubscriberKitAudioLevelDelegate 加入者の音声レベルを監視するために使用されます。
OTSubscriberKitAudioNetworkStats 加入者のオーディオ統計情報を説明します。[OTSubscriberKit setNetworkStatsDelegate:] を参照してください。
OTSubscriberKitCaptionsDelegate 加入者のストリームのキャプションを受信するために使用されます。
OTSubscriberKitDelegate OTSubscriberインスタンスにメッセージを送信するために使用されます。[OTSubscriberKit initWithStream:delegate:] メッセージを送信する際には、OTSubscriberKitDelegateオブジェクトを指定します。
OTSubscriberKitMediaLinkStats ローカルおよびリモートのトランスポート指標やネットワーク品質の低下に関する情報など、加入者のメディアリンクに関する統計情報を提供します。
OTSubscriberKitNetworkStatsDelegate 加入者のオーディオおよびビデオの統計情報を監視するために使用されます。[OTSubscriberKit networkStatsDelegate] を参照してください。
OTSubscriberKitRtcStatsReportDelegate 加入者のRTC統計情報を報告するメッセージの送信に使用されます。 このデリゲートを使用するには、[OTSubscriberKit rtcStatsReportDelegate] プロパティを設定してください。[OTSubscriberKit getRtcStatsReport] メソッドを呼び出すと、[OTSubscriberKitRtcStatsReportDelegate subscriber:rtcStatsReport:] メッセージが repo に送信されます。
OTSubscriberKitVideoNetworkStats サブスクライバーの動画統計情報を説明します。[OTSubscriberKit setNetworkStatsDelegate:] を参照してください。
OTSubscriberVideoEventReason ビデオの有効化および無効化イベントには、ビデオトラックが有効化/無効化された理由を特定するための理由コードが付随しています。
OTTransportStats ネットワークレベルの転送統計情報を提供します。
OTVideoBitratePreset パブリッシャーのストリームにおける動画ビットレートを制御するためのプリセット戦略。
OTVideoCapture OTPublisherKit オブジェクトで使用されるビデオキャプチャ機能を定義します。OTPublisherKit オブジェクトの videoCapture プロパティを参照してください。
OTVideoCaptureConsumer OTVideoCapture オブジェクトのコンシューマーを定義します。
OTVideoCodecPreference @class OTVideoCodecPreference
OTVideoCodecType [OTVideoCodecPreference codecs] プロパティの値、および [OTVideoCodecPreference manualWithCodecs:] メソッドで使用される配列の各要素の値を定義します。
OTVideoContentHint このメソッドの値を定義します。
OTVideoFormat OTVideoFrame オブジェクトのインスタンスに割り当てられたビデオ形式を定義します。
OTVideoFrame ビデオのフレームを定義します。[OTVideoRender renderVideoFrame:] および [OTVideoCaptureConsumer consumeFrame:] を参照してください。
OTVideoOrientation OTVideoFrame オブジェクトの orieintation プロパティに対する、動画の向き(上、下、左、右)の値を定義します。
OTVideoRender OTPublisherKit オブジェクトまたは OTSubscriberKit オブジェクトで使用されるビデオレンダラーを定義します。OTPublisherKit オブジェクトおよび OTSubscriberKit の videoRender プロパティを参照してください。
OTVideoTransformer ビデオストリームのトランスフォーマーを定義します。
OTVideoViewScaleBehavior [OTSubscriber viewScaleBehavior] および [OTPublisher viewScaleBehavior] プロパティの値を定義します。