iOS SDK API リファレンス

SKWRoom.h
[詳解]
1 // SKWRoom.h
3 // SkyWay SDK
5 #import <Foundation/Foundation.h>
6 
11 @class SKWMediaStream;
12 
16 typedef NS_ENUM(NSUInteger, SKWRoomEventEnum)
17 {
21  SKW_ROOM_EVENT_STREAM, // arg = added stream
31  SKW_ROOM_EVENT_REMOVE_STREAM __attribute__((deprecated("Use PEER_LEAVE event instead."))), // arg = removed stream
35  SKW_ROOM_EVENT_OPEN, // arg = room name
39  SKW_ROOM_EVENT_CLOSE, // arg = room name
55  SKW_ROOM_EVENT_DATA, // arg = msg
59  SKW_ROOM_EVENT_LOG, // arg = logs
60 };
61 
65 typedef void (^SKWRoomEventCallback)(NSObject* __nullable arg);
66 
70 @interface SKWRoom : NSObject
71 
75 @property (nonatomic, readonly) NSString* __nullable name;
76 
77 #ifndef DOXYGEN_SKIP_THIS
78 - (__nullable instancetype)init __attribute__((unavailable("init is not a supported initializer for this class.")));
79 #endif // !DOXYGEN_SKIP_THIS
80 
98 - (BOOL)send:(NSObject* __nonnull)data;
99 
159 - (void)on:(SKWRoomEventEnum)event callback:(SKWRoomEventCallback __nullable)callback;
160 
169 - (void)offAll;
170 
195 - (void)getLog;
196 
197 @end
SKW_ROOM_EVENT_PEER_LEAVE
@ SKW_ROOM_EVENT_PEER_LEAVE
現在のルームからリモートピアが退室した時のイベントです
Definition: SKWRoom.h:47
-[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
SKW_ROOM_EVENT_DATA
@ SKW_ROOM_EVENT_DATA
現在のルームにリモートピアがらデータが送信された時のイベントです
Definition: SKWRoom.h:55
SKWRoomEventEnum
SKWRoomEventEnum
ルームイベント
Definition: SKWRoom.h:16
SKW_ROOM_EVENT_STREAM
@ SKW_ROOM_EVENT_STREAM
現在のルームに新しいメディアストリームが追加された時のイベントです
Definition: SKWRoom.h:21
SKWRoom::name
NSString *__nullable name
ルーム名
Definition: SKWRoom.h:75
SKW_ROOM_EVENT_ERROR
@ SKW_ROOM_EVENT_ERROR
エラーが発生した時のイベントです
Definition: SKWRoom.h:51
SKW_ROOM_EVENT_OPEN
@ SKW_ROOM_EVENT_OPEN
ルームに自分が入室した時のイベントです
Definition: SKWRoom.h:35
SKW_ROOM_EVENT_REMOVE_STREAM
@ SKW_ROOM_EVENT_REMOVE_STREAM
現在のルームから既存のメディアストリームが削除された時のイベントです (非推奨)
Definition: SKWRoom.h:31
SKW_ROOM_EVENT_CLOSE
@ SKW_ROOM_EVENT_CLOSE
現在のルームから自分が退室した時、および SFU サーバーから切断されたとき時のイベントです
Definition: SKWRoom.h:39
SKWRoomEventCallback
void(^ SKWRoomEventCallback)(NSObject *__nullable arg)
ルームイベントコールバックシグネチャ
Definition: SKWRoom.h:65
SKW_ROOM_EVENT_PEER_JOIN
@ SKW_ROOM_EVENT_PEER_JOIN
現在のルームにリモートピアが入室した時のイベントです
Definition: SKWRoom.h:43
SKW_ROOM_EVENT_LOG
@ SKW_ROOM_EVENT_LOG
現在のルームのログが取得できた時のイベントです
Definition: SKWRoom.h:59