iOS SDK API リファレンス

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

SFU ルームクラス [詳解]

#import <SKWSFURoom.h>

SKWSFURoom の継承関係図
SKWRoom

実体メソッド

(void) - close
 ルームを退出し、ルーム内のすべてのユーザーとのコネクションをcloseします。
 
(void) - replaceStream:
 送信中のMediaStreamを変更します。カメラデバイスや画質の変更などに用います。

注意)MediaStreamを送信しない状態から送信する状態に変更することはできません。その逆の変更もできません。
   また、「映像か音声のどちらかのみを持つMediaStream」と「映像・音声の両方を持つMediaStream」を入れ替えることはできません。 [詳解]
 
(BOOL) - send:
 現在のルームに入室中のピアにデータを送信します。NSString* または NSData* を送信できます。送信するデータサイズの上限は20MBです。送信頻度は100msecに1回に制限されています。送信頻度の制限を超えた送信データはキューに入り、100msec毎に順次送信されます。 [詳解]
 
(void) - on:callback:
 SKWRoom のイベントコールバック block を設定します。 [詳解]
 
(void) - offAll
 SKWRoom の設定済みイベントコールバック block を解除します。 [詳解]
 
(void) - getLog
 シグナリングサーバにルームのログ取得を要求します。結果は SKW_ROOM_EVENT_LOG イベントで返されます。 [詳解]
 

プロパティ

NSString *__nullable name
 ルーム名
 

詳解

SFU ルームクラス

SFU接続でのルームを提供するルームクラスです。

メソッド詳解

◆ getLog

- (void) getLog

シグナリングサーバにルームのログ取得を要求します。結果は SKW_ROOM_EVENT_LOG イベントで返されます。

SKWRoom* room;
[room on:SKW_ROOM_EVENT_LOG callback:^(NSObject* obj) {
NSArray* logs = (NSArray*)obj;
[logs enumerateObjectsUsingBlock:^(id obj, NSUInteger idx, BOOL* stop) {
NSString* logStr = (NSString*)obj;
NSError* error = nil;
id logData = [NSJSONSerialization JSONObjectWithData:[logStr dataUsingEncoding:NSUTF8StringEncoding]
options:0
error:&error];
if (nil == error)
{
NSLog(@"SKW_ROOM_EVENT_LOG: %@", logData);
}
}];
}];
[room getLog];

◆ offAll

- (void) offAll

SKWRoom の設定済みイベントコールバック block を解除します。

SKWRoom* room;
[room offAll];

◆ on:callback:

- (void) on: (SKWRoomEventEnum event
callback: (SKWRoomEventCallback __nullable)  callback 

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

SKWRoom* room;
[room on:SKW_ROOM_EVENT_STREAM callback:^(NSObject* obj) {
SKWMediaStream* stream = (SKWMediaStream*)obj;
}];
[room on:SKW_ROOM_EVENT_REMOVE_STREAM callback:^(NSObject* obj) {
SKWMediaStream* stream = (SKWMediaStream*)obj;
}];
[room on:SKW_ROOM_EVENT_OPEN callback:^(NSObject* obj) {
NSString* roomName = (NSString*)obj;
}];
[room on:SKW_ROOM_EVENT_CLOSE callback:^(NSObject* obj) {
NSString* roomName = (NSString*)obj;
}];
[room on:SKW_ROOM_EVENT_PEER_JOIN callback:^(NSObject* obj) {
NSString* peerId = (NSString*)obj;
}];
[room on:SKW_ROOM_EVENT_PEER_LEAVE callback:^(NSObject* obj) {
NSString* peerId = (NSString*)obj;
}];
[room on:SKW_ROOM_EVENT_ERROR callback:^(NSObject* obj) {
SKWPeerError* error = (SKWPeerError*)obj;
}];
[room on:SKW_ROOM_EVENT_DATA callback:^(NSObject* obj) {
SKWRoomDataMessage* msg = (SKWRoomDataMessage*)obj;
NSString* peerId = msg.src;
if ([msg.data isKindOfClass:[NSString class]]) {
NSString* data = (NSString*)msg.data;
}
else if ([msg.data isKindOfClass:[NSData class]]) {
NSData* data = (NSData*)msg.data;
}
}];
[room on:SKW_ROOM_EVENT_LOG callback:^(NSObject* obj) {
NSArray* logs = (NSArray*)obj;
}];
引数
event設定するイベント種別を指定します。
callbackイベント発生時に実行する Block を設定します。

◆ replaceStream:

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

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

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

SKWSFURoom* room;
[room replaceStream:stream];
引数
newStream交換対象となる新しいMediaStream

◆ send:

- (BOOL) send: (NSObject *__nonnull)  data

現在のルームに入室中のピアにデータを送信します。NSString* または NSData* を送信できます。送信するデータサイズの上限は20MBです。送信頻度は100msecに1回に制限されています。送信頻度の制限を超えた送信データはキューに入り、100msec毎に順次送信されます。

SKWRoom* room;
[room send:@"Hello."];
引数
data送信データ
戻り値
呼び出し結果
-[SKWRoom send:]
BOOL send:(NSObject *__nonnull data)
現在のルームに入室中のピアにデータを送信します。NSString* または NSData* を送信できます。送信するデータサイズの上限は20MBです。送信頻度は100msecに1回に制限されています。送...
SKWRoomDataMessage
ルームで受信するデータメッセージです
Definition: SKWRoomDataMessage.h:14
SKWPeerError
エラー情報クラス
Definition: SKWPeerError.h:76
-[SKWRoom on:callback:]
void on:callback:(SKWRoomEventEnum event,[callback] SKWRoomEventCallback __nullable callback)
SKWRoom のイベントコールバック block を設定します。
-[SKWRoom offAll]
void offAll()
SKWRoom の設定済みイベントコールバック block を解除します。
-[SKWRoom getLog]
void getLog()
シグナリングサーバにルームのログ取得を要求します。結果は SKW_ROOM_EVENT_LOG イベントで返されます。
SKWMediaStream
メディアストリーム
Definition: SKWMediaStream.h:18
SKWRoom
SKWMeshRoom / SKWSFURoom の基底クラスです。
Definition: SKWRoom.h:70
SKWSFURoom
SFU ルームクラス
Definition: SKWSFURoom.h:24
-[SKWSFURoom replaceStream:]
void replaceStream:(SKWMediaStream *__nullable newStream)
送信中のMediaStreamを変更します。カメラデバイスや画質の変更などに用います。 注意)MediaStreamを送信しない状態から送信する状態に変更することはできません。その逆の変更もできません...