iOS SDK API リファレンス

実体メソッド | プロパティ | 全メンバ一覧
SKWMediaConnection クラス

MediaConnection 相当のクラスです。 [詳解]

#import <SKWMediaConnection.h>

SKWMediaConnection の継承関係図
SKWConnection

実体メソッド

(void) - answer
 call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer を呼び出せます。 [詳解]
 
(void) - answer:
 call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer を呼び出せます。 [詳解]
 
(void) - answer:options:
 call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer をオプション付きで呼び出せます。 [詳解]
 
(void) - close
 SKWMediaConnection を閉じます。 [詳解]
 
(void) - on:callback:
 SKWMediaConnection のイベントコールバック Block を設定します。 [詳解]
 
(void) - replaceStream:
 送信しているメディアストリームを更新します。 受信のみモードから双方向に切り替えることもできます。 [詳解]
 
(void) - getStats:
 コネクションの統計情報を取得します [詳解]
 

プロパティ

NSString *__nullable connectionId
 コネクション ID
 
NSString *__nullable metadata
 コネクションに関連するメタデータ文字列
 
BOOL isOpen
 コネクションの読み書き状態
 
NSString *__nullable peer
 リモートピア ID
 
NSString *__nullable type
 コネクション種別
 
NSString *__nullable label
 コネクションラベル文字列
 
BOOL reliable
 送信されるデータ形式種別です。コネクション作成時に定義されます。(データ接続でのみ有効です)
 
SKWSerializationEnum serialization
 送信されるデータ形式種別です。 コネクション作成時に定義されます。(データ接続でのみ有効です)
 
SKWPeer *__nullable provider
 この接続を作成したピアオブジェクトです
 

詳解

MediaConnection 相当のクラスです。

このオブジェクトを取得するには、SKWPeer の callWithId メソッドを使用するか、 SKW_PEER_EVENT_CALL イベント発生時に渡されるオブジェクトを使用してください。

メソッド詳解

◆ answer

- (void) answer

call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer を呼び出せます。

送信するメディアストリームは使用せず、応答します。

[peer on:SKW_PEER_EVENT_CALL callback:^(NSObject* obj) {
[media answer];
}];

◆ answer:

- (void) answer: (SKWMediaStream *__nullable)  stream

call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer を呼び出せます。

送信するメディアストリームを指定して、応答します。

SKWMediaConstraints* constraints = [[SKWMediaConstraints alloc] init];
SKWMediaStream* stream = [SKWNavigator getUserMedia:constraints];
[peer on:SKW_PEER_EVENT_CALL callback:^(NSObject* obj) {
SKWMediaConnection* media = (SKWMediaConnection *)obj;
[media answer:stream];
}];
引数
streamSKWNavigator の getUserMedia によって取得される SKWMediaStream を指定します。

◆ answer:options:

- (void) answer: (SKWMediaStream *__nullable)  stream
options: (SKWAnswerOption *__nullable)  options 

call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer をオプション付きで呼び出せます。

送信するメディアストリームとオプションを指定して、応答します。

SKWMediaConstraints* constraints = [[SKWMediaConstraints alloc] init];
SKWMediaStream* stream = [SKWNavigator getUserMedia:constraints];
[peer on:SKW_PEER_EVENT_CALL callback:^(NSObject* obj) {
SKWMediaConnection* media = (SKWMediaConnection *)obj;
SKWAnswerOption* options = [[SKWAnswerOption alloc] init];
options.videoBandwidth = 768;
options.audioBandwidth = 64;
[media answer:stream options:options];
}];
引数
streamSKWNavigator の getUserMedia によって取得される SKWMediaStream を指定します。
options応答時のオプションを指定します。

◆ close

- (void) close

SKWMediaConnection を閉じます。

[media close];
media = nil;

◆ getStats:

- (void) getStats: (SKWConnectionGetStatsCallback __nullable)  callback

コネクションの統計情報を取得します

引数
callback統計情報取得後のBlock を設定します。
SKWMediaConnection *connection;
[connection getStats:^(NSArray * _Nullable stats) {
// Do something
}];

◆ on:callback:

- (void) on: (SKWMediaConnectionEventEnum event
callback: (SKWMediaConnectionEventCallback __nullable)  callback 

SKWMediaConnection のイベントコールバック Block を設定します。

[media on:SKW_MEDIACONNECTION_EVENT_STREAM callback:^(NSObject* obj) {
SKWMediaStream *stream = (SKWMediaStream *)obj;
}];
[media on:SKW_MEDIACONNECTION_EVENT_REMOVE_STREAM callback:^(NSObject* obj) {
SKWMediaStream *stream = (SKWMediaStream *)obj;
}];
[media on:SKW_MEDIACONNECTION_EVENT_CLOSE callback:^(NSObject* obj) {
// クローズ時の処理を記述
}];
[media on:SKW_MEDIACONNECTION_EVENT_ERROR callback:^(NSObject* obj) {
SKWPeerError* err = (SKWPeerError*)obj;
NSLog(@"%@", err);
}];
引数
event設定するイベント種別を指定します。
callbackイベント発生時に実行する Block を設定します。

◆ replaceStream:

- (void) replaceStream: (SKWMediaStream *__nullable)  newStream

送信しているメディアストリームを更新します。 受信のみモードから双方向に切り替えることもできます。

SKWMediaConnection* connection;
[connection replaceStream:stream];
引数
newStream対向のピアに送るメディアストリーム
-[SKWPeer on:callback:]
void on:callback:(SKWPeerEventEnum event,[callback] SKWPeerEventCallback __nullable callback)
SKWPeer のイベントコールバック Block を設定します。
-[SKWMediaConnection replaceStream:]
void replaceStream:(SKWMediaStream *__nullable newStream)
送信しているメディアストリームを更新します。 受信のみモードから双方向に切り替えることもできます。
SKWPeerError
エラー情報クラス
Definition: SKWPeerError.h:55
SKWPeer
ピアクラス
Definition: SKWPeer.h:98
SKWMediaStream
メディアストリーム
Definition: SKWMediaStream.h:18
SKWMediaConnection
MediaConnection 相当のクラスです。
Definition: SKWMediaConnection.h:52
SKWNavigator
Web ブラウザの navigator 相当のクラスになります。
Definition: SKWNavigator.h:18
SKWMediaConstraints
SKWNavigator の getUserMedia 実行時のオプション設定クラスです。
Definition: SKWMediaConstraints.h:49
+[SKWNavigator initialize:]
void initialize:(SKWPeer *__nonnull peer)
初期化を行います。
SKWAnswerOption
SKWMediaConnection answer オプション
Definition: SKWAnswerOption.h:14
-[SKWMediaConnection close]
void close()
SKWMediaConnection を閉じます。
-[SKWMediaConnection on:callback:]
void on:callback:(SKWMediaConnectionEventEnum event,[callback] SKWMediaConnectionEventCallback __nullable callback)
SKWMediaConnection のイベントコールバック Block を設定します。
SKWConnection::peer
NSString *__nullable peer
リモートピア ID
Definition: SKWConnection.h:87
+[SKWNavigator getUserMedia:]
SKWMediaStream *__nullable getUserMedia:(SKWMediaConstraints *__nonnull constraints)
-[SKWConnection getStats:]
void getStats:(SKWConnectionGetStatsCallback __nullable callback)
コネクションの統計情報を取得します