iOS SDK API リファレンス

SKWPeerOption.h
[詳解]
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 
120 @property (nonatomic) BOOL tryReconnectMedia;
121 
125 @property (nonatomic) BOOL tryReconnectData;
126 
127 
128 @property (nonatomic) SKWPeerCredential* __nullable credential;
129 
130 @end
SKWPeerOption::path
NSString *__nullable path
自身のシグナリングサーバが動作している場所のパスです。(現在は指定しても無視されます。)
Definition: SKWPeerOption.h:78
SKWPeerOption::secure
BOOL secure
サーバとの SSL 接続を行うか指定します。デフォルトは YES となります。
Definition: SKWPeerOption.h:83
SKW_DEBUG_LEVEL_ONLY_ERROR
@ SKW_DEBUG_LEVEL_ONLY_ERROR
エラーのみのログを出力します
Definition: SKWPeerOption.h:39
SKWPeerOption::tryReconnectData
BOOL tryReconnectData
データ通信が切れた際に自動で再接続を試行する場合は YES を設定します。デフォルトでは NO となります。
Definition: SKWPeerOption.h:125
SKWDebugLevelEnum
SKWDebugLevelEnum
デバッグアウトプットレベル
Definition: SKWPeerOption.h:30
SKWPeerOption::key
NSString *__nullable key
SkyWay API キーを指定します
Definition: SKWPeerOption.h:63
SKWPeerOption::useH264
BOOL useH264
H.264 ハードウェアコーデックを利用するかどうか指定します。 デフォルトは YES となります。 (現在は常に利用するようになっており、NO を指定しても無視されます。)
Definition: SKWPeerOption.h:111
SKWPeerCredential
Peerを認証するためのクレデンシャル
Definition: SKWPeerCredential.h:14
SKWPeerOption::domain
NSString *__nullable domain
SkyWay API に関連するドメインを指定します
Definition: SKWPeerOption.h:98
SKWPeerOption::port
NSInteger port
サーバのポート番号です。指定が無い場合は、SkyWay シグナリングサーバによって自動的に接続先が決定されます。
Definition: SKWPeerOption.h:73
SKWPeerOption::type
SKWPeerTypeEnum type
接続先シグナリングサーバの種別を指定します。(現在は SkyWay のみが有効であり、指定しても無視されます。)
Definition: SKWPeerOption.h:58
SKW_DEBUG_LEVEL_NO_LOGS
@ SKW_DEBUG_LEVEL_NO_LOGS
ログを出力しません
Definition: SKWPeerOption.h:35
SKWPeerOption::debug
SKWDebugLevelEnum debug
ログレベルを指定します。デフォルトは PEER_DEBUG_LEVEL_NO_LOGS です。
Definition: SKWPeerOption.h:93
SKWPeerOption::tryReconnectMedia
BOOL tryReconnectMedia
対向とのメディア通信が切れた際に自動で再接続を試行する場合は YES を設定します。デフォルトでは NO となります。
Definition: SKWPeerOption.h:120
SKWPeerOption::turn
BOOL turn
SkyWay TURN サーバを使用します (TURN サーバの利用を申請する必要があります)
Definition: SKWPeerOption.h:103
SKW_DEBUG_LEVEL_ERROR_AND_WARNING
@ SKW_DEBUG_LEVEL_ERROR_AND_WARNING
エラーと警告のログを出力します
Definition: SKWPeerOption.h:43
SKWPeerOption
SKWPeer 初期化オプションクラス
Definition: SKWPeerOption.h:53
SKW_DEBUG_LEVEL_ALL_LOGS
@ SKW_DEBUG_LEVEL_ALL_LOGS
全てのログを出力します
Definition: SKWPeerOption.h:47
SKWPeerOption::config
NSArray *__nullable config
ICE/TURN サーバ設定を指定します
Definition: SKWPeerOption.h:88
SKWPeerOption::host
NSString *__nullable host
サーバのホスト名です。指定が無い場合は、SkyWay シグナリングサーバによって自動的に接続先が決定されます。
Definition: SKWPeerOption.h:68