iOS SDK API Reference

SKWPeerOption.h
Go to the documentation of this file.
1 // SKWPeerOption.h
3 // SkyWay SDK
5 #import <Foundation/Foundation.h>
6 #import "SKWCommon.h"
7 
12 @class SKWPeerCredential;
13 
14 #ifndef DOXYGEN_SKIP_THIS
15 
18 typedef NS_ENUM(NSUInteger, SKWPeerTypeEnum)
19 {
21  SKW_PEER_TYPE_SKYWAY = 0,
23  SKW_PEER_TYPE_PEERJS = 1,
24 } SKYWAY_API_DEPRECATED;
25 #endif // !DOXYGEN_SKIP_THIS
26 
30 typedef NS_ENUM(NSUInteger, SKWDebugLevelEnum)
31 {
48 };
49 
53 @interface SKWPeerOption : NSObject < NSCopying >
54 
58 @property (nonatomic) SKWPeerTypeEnum type SKYWAY_API_DEPRECATED;
59 
63 @property (nonatomic) NSString* __nullable key;
64 
68 @property (nonatomic) NSString* __nullable host;
69 
73 @property (nonatomic) NSInteger port;
74 
78 @property (nonatomic) NSString* __nullable path SKYWAY_API_DEPRECATED;
79 
83 @property (nonatomic) BOOL secure;
84 
88 @property (nonatomic) NSArray* __nullable config;
89 
93 @property (nonatomic) SKWDebugLevelEnum debug;
94 
98 @property (nonatomic) NSString* __nullable domain;
99 
103 @property (nonatomic) BOOL turn;
104 
111 @property (nonatomic) BOOL useH264 SKYWAY_API_DEPRECATED;
112 
113 @property (nonatomic) SKWPeerCredential* __nullable credential;
114 
115 @end
SKWPeerOption::path
NSString *__nullable path
The path where your self-hosted PeerServer is running.
Definition: SKWPeerOption.h:78
SKWPeerOption::secure
BOOL secure
Set to true if you're using SSL.
Definition: SKWPeerOption.h:83
SKW_DEBUG_LEVEL_ONLY_ERROR
@ SKW_DEBUG_LEVEL_ONLY_ERROR
Prints only errors.
Definition: SKWPeerOption.h:39
SKWDebugLevelEnum
SKWDebugLevelEnum
Debug output level.
Definition: SKWPeerOption.h:30
SKWPeerOption::key
NSString *__nullable key
API key for the cloud PeerServer.
Definition: SKWPeerOption.h:63
SKWPeerOption::useH264
BOOL useH264
Using Hardware codec H.264 (iOS 8.0 later)
Definition: SKWPeerOption.h:111
SKWPeerCredential
The credential used to authenticate peer.
Definition: SKWPeerCredential.h:14
SKWPeerOption::domain
NSString *__nullable domain
Domain related to the SkyWay API Key.
Definition: SKWPeerOption.h:98
SKWPeerOption::port
NSInteger port
PeerServer port.
Definition: SKWPeerOption.h:73
SKWPeerOption::type
SKWPeerTypeEnum type
Type of the PeerServer.
Definition: SKWPeerOption.h:58
SKW_DEBUG_LEVEL_NO_LOGS
@ SKW_DEBUG_LEVEL_NO_LOGS
Prints no logs.
Definition: SKWPeerOption.h:35
SKWPeerOption::debug
SKWDebugLevelEnum debug
Prints log messages depending on the debug level passed in.
Definition: SKWPeerOption.h:93
SKWPeerOption::turn
BOOL turn
Using SkyWay TURN server.
Definition: SKWPeerOption.h:103
SKW_DEBUG_LEVEL_ERROR_AND_WARNING
@ SKW_DEBUG_LEVEL_ERROR_AND_WARNING
errors and warnings.
Definition: SKWPeerOption.h:43
SKWPeerOption
SKWPeer initialize option class.
Definition: SKWPeerOption.h:53
SKW_DEBUG_LEVEL_ALL_LOGS
@ SKW_DEBUG_LEVEL_ALL_LOGS
Prints all logs.
Definition: SKWPeerOption.h:47
SKWPeerOption::config
NSArray *__nullable config
This contains any custom ICE/TURN server configuration.
Definition: SKWPeerOption.h:88
SKWPeerOption::host
NSString *__nullable host
PeerServer host.
Definition: SKWPeerOption.h:68