iOS SDK API Reference

SKWRoom.h
Go to the documentation of this file.
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, // arg1 = added stream
25  SKW_ROOM_EVENT_REMOVE_STREAM, // arg1 = removed stream
29  SKW_ROOM_EVENT_OPEN, // arg1 = room name
33  SKW_ROOM_EVENT_CLOSE, // arg1 = room name
37  SKW_ROOM_EVENT_PEER_JOIN, // arg1 = src
41  SKW_ROOM_EVENT_PEER_LEAVE, // arg1 = src
45  SKW_ROOM_EVENT_ERROR,
49  SKW_ROOM_EVENT_DATA, // arg1 = data
53  SKW_ROOM_EVENT_LOG, // arg1 = logs
54 };
55 
59 typedef void (^SKWRoomEventCallback)(NSObject* __nullable arg);
60 
64 @interface SKWRoom : NSObject
65 
69 @property (nonatomic, readonly) NSString* __nullable name;
70 
71 #ifndef DOXYGEN_SKIP_THIS
72 - (__nullable instancetype)init __attribute__((unavailable("init is not a supported initializer for this class.")));
73 #endif // !DOXYGEN_SKIP_THIS
74 
92 - (BOOL)send:(NSObject* __nonnull)data;
93 
152 - (void)on:(SKWRoomEventEnum)event callback:(SKWRoomEventCallback __nullable)callback;
153 
162 - (void)offAll;
163 
188 - (void)getLog;
189 
190 @end
-[SKWRoom offAll]
void offAll()
Cancels the set event callback block of SKWRoom.
-[SKWRoom getLog]
void getLog()
Start getting room's logs from signaling server.
SKWMediaStream
Media stream.
Definition: SKWMediaStream.h:18
SKWRoom
Room base class.
Definition: SKWRoom.h:64
SKWRoomEventEnum
SKWRoomEventEnum
Room events.
Definition: SKWRoom.h:16
SKWRoom::name
NSString *__nullable name
Room name.
Definition: SKWRoom.h:69
SKWRoomEventCallback
void(^ SKWRoomEventCallback)(NSObject *__nullable arg)
Room Event Callback signature.
Definition: SKWRoom.h:59