SKWMediaConnection クラス

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

#import <SKWMediaConnection.h>

SKWMediaConnection の継承関係図

実体メソッド
(void)	- answer
	call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer を呼び出せます。 [詳解]
(void)	- answer:
	call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer を呼び出せます。 [詳解]
(void)	- answer:options:
	call イベントを受信した場合に、応答するためのコールバックにて与えられる SKWMediaConnection にて answer をオプション付きで呼び出せます。 [詳解]
(void)	- close
	SKWMediaConnection を閉じます。forceClose オプションを NO として実行します。将来のバージョンから YES に変更される可能性があります。 [詳解]
(void)	- close:
	forceClose オプションを指定して、 SKWMediaConnection を閉じます。 [詳解]
(void)	- on:callback:
	SKWMediaConnection のイベントコールバック Block を設定します。 [詳解]
(void)	- replaceStream:
	送信中のMediaStreamを変更します。カメラデバイスや画質の変更などに用います。 注意）MediaStreamを送信しない状態から送信する状態に変更することはできません。その逆の変更もできません。 　　　また、「映像か音声のどちらかのみを持つMediaStream」と「映像・音声の両方を持つMediaStream」を入れ替えることはできません。 [詳解]
(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 を呼び出せます。

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

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

answer:

- (void) answer:

(SKWMediaStream *__nullable)

stream

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

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

SKWPeer* peer;
 
[SKWNavigator initialize:peer];
 
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];
}];

引数

stream

SKWNavigator の getUserMedia によって取得される SKWMediaStream を指定します。

answer:options:

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

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

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

SKWPeer* peer;
 
[SKWNavigator initialize:peer];
 
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];
}];

引数

stream	SKWNavigator の getUserMedia によって取得される SKWMediaStream を指定します。
options	応答時のオプションを指定します。

close

- (void) close

SKWMediaConnection を閉じます。forceClose オプションを NO として実行します。将来のバージョンから YES に変更される可能性があります。

SKWMediaConnection* media;
 
[media close];
media = nil;

close:

- (void) close:

(BOOL)

forceClose

forceClose オプションを指定して、 SKWMediaConnection を閉じます。

SKWMediaConnection* media;
 
[media close:YES];
media = nil;

引数

forceClose

この値がYESの場合、相手の MediaConnection も即座に close します。NOの場合、相手は ice 再接続が失敗してから MediaConnection を close します。

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 を設定します。

SKWMediaConnection* media;
 
[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

送信中のMediaStreamを変更します。カメラデバイスや画質の変更などに用います。

注意）MediaStreamを送信しない状態から送信する状態に変更することはできません。その逆の変更もできません。
　　　また、「映像か音声のどちらかのみを持つMediaStream」と「映像・音声の両方を持つMediaStream」を入れ替えることはできません。

SKWMediaConnection* connection;
SKWMediaStream* stream;
 
[connection replaceStream:stream];

引数

newStream

対向のピアに送るメディアストリーム