iOS SDK API Reference

Properties | List of all members
SKWPeerOption Class Reference

SKWPeer initialize option class. More...

#import <SKWPeerOption.h>

Inheritance diagram for SKWPeerOption:

Properties

SKWPeerTypeEnum type
 Type of the PeerServer. More...
 
NSString *__nullable key
 API key for the cloud PeerServer.
 
NSString *__nullable host
 PeerServer host. More...
 
NSInteger port
 PeerServer port.
 
NSString *__nullable path
 The path where your self-hosted PeerServer is running. More...
 
BOOL secure
 Set to true if you're using SSL.
 
NSArray *__nullable config
 This contains any custom ICE/TURN server configuration.
 
SKWDebugLevelEnum debug
 Prints log messages depending on the debug level passed in. More...
 
NSString *__nullable domain
 Domain related to the SkyWay API Key.
 
BOOL turn
 Using SkyWay TURN server. More...
 
BOOL useH264
 Using Hardware codec H.264 (iOS 8.0 later)
 
BOOL tryReconnectMedia
 Set the value to YES to try to reconnect automatically when the SKWMediaConnection with the other side is lost. More...
 
BOOL tryReconnectData
 Set the value to YES to try to reconnect automatically when the data connection is lost. More...
 
SKWPeerCredential *__nullable credential
 

Detailed Description

SKWPeer initialize option class.

Property Documentation

◆ debug

- (SKWDebugLevelEnum) debug
readwritenonatomicassign

Prints log messages depending on the debug level passed in.

Defaults to PEER_DEBUG_LEVEL_NO_LOGS.

◆ host

- (NSString* __nullable) host
readwritenonatomicassign

PeerServer host.

Defaults to 0.peerjs.com. Also accepts '/' to signify relative hostname

◆ path

- (NSString* __nullable) path
readwritenonatomicassign

The path where your self-hosted PeerServer is running.

Defaults to '/'.

◆ tryReconnectData

- (BOOL) tryReconnectData
readwritenonatomicassign

Set the value to YES to try to reconnect automatically when the data connection is lost.

The default value is NO.

◆ tryReconnectMedia

- (BOOL) tryReconnectMedia
readwritenonatomicassign

Set the value to YES to try to reconnect automatically when the SKWMediaConnection with the other side is lost.

The default value is NO..

Attention
If you use SKWMediaConnection and this option is set to YES, it may take some time until the close event is fired on the peer after a remote peer executes the close method. To avoid this, please set the forceClose option of the close method to YES on the remote peer.

◆ turn

- (BOOL) turn
readwritenonatomicassign

Using SkyWay TURN server.

(Need to request for a TURN server use to SkyWay)

◆ type

- (SKWPeerTypeEnum) type
readwritenonatomicassign

Type of the PeerServer.

Defaults to PEER_TYPE_SKYWAY.