SKWPeer Class Reference

A peer class. More...

#import <SKWPeer.h>

Inheritance diagram for SKWPeer:

Instance Methods
(instancetype __nullable)	- initWithOptions:
	A peer can connect to other peers and listen for connections. More...
(instancetype __nullable)	- initWithId:options:
	A peer can connect to other peers and listen for connections. More...
(SKWDataConnection *__nullable)	- connectWithId:
	Connects to the remote peer specified by id and returns a data connection. More...
(SKWDataConnection *__nullable)	- connectWithId:options:
	Connects to the remote peer specified by id and returns a data connection. More...
(SKWMediaConnection *__nullable)	- callWithId:stream:
	Calls the remote peer specified by id and returns a media connection. More...
(SKWMediaConnection *__nullable)	- callWithId:stream:options:
	Calls the remote peer specified by id and returns a media connection. More...
(void)	- on:callback:
	Set blocks for peer events. More...
(BOOL)	- disconnect
	(deprecated) Close the connection to the signaling server. More...
(void)	- reconnect
	(deprecated) Reconnect to the signaling server. More...
(BOOL)	- destroy
	Close the connection to the signaling server and the already connected mediaConnection and dataConnection. More...
(void)	- listAllPeers:
	Listing peer ID. More...
(void)	- fetchPeerExistsWithPeerId:success:error:
	Fetch whether Peer specified by Peer ID exists from the signaling server. More...
(SKWRoom *__nullable)	- joinRoomWithName:options:
	Full mesh room example: More...
(void)	- updateCredential:

Class Methods
(nonnull NSString *)	+ sdkVersion
	Getting current SDK version.

Properties
NSString *__nullable	identity
	The brokering ID of this peer. More...
NSDictionary *__nullable	connections
	A object array of all connections this peer, keyed by the remote peer's ID.
BOOL	isDisconnected
	false if there is an active connection to the PeerServer.
BOOL	isDestroyed
	true if this peer and all of its connections can no longer be used.

Detailed Description

A peer class.

Method Documentation

callWithId:stream:

- (SKWMediaConnection* __nullable) callWithId:		(NSString *__nonnull)	peerId
stream:		(SKWMediaStream *__nullable)	stream

Calls the remote peer specified by id and returns a media connection.

Be sure to listen on the error event in case the connection fails.

SKWPeer* peer;
SKWMediaStream* stream;
NSString* destId;
 
SKWMediaConnection* media = [peer callWithId:destId stream:stream];

Parameters

peerId	Remote peer ID
stream	Video stream

Returns

Media connection object

callWithId:stream:options:

- (SKWMediaConnection* __nullable) callWithId:		(NSString *__nonnull)	peerId
stream:		(SKWMediaStream *__nullable)	stream
options:		(SKWCallOption *__nullable)	options

Calls the remote peer specified by id and returns a media connection.

Be sure to listen on the error event in case the connection fails.

SKWPeer* peer;
SKWMediaStream* stream;
NSString* destId;
SKWCallOption* options = [[SKWCallOption alloc] init];
options.metadata = @"yourMetadata";
 
SKWMediaConnection* media = [peer callWithId:destId stream:stream options:options];

Parameters

peerId	Remote peer ID
stream	Video stream
options	Option seeting dictionary

Returns

Media connection object

connectWithId:

- (SKWDataConnection* __nullable) connectWithId:

(NSString *__nonnull)

peerId

Connects to the remote peer specified by id and returns a data connection.

Be sure to listen on the error event in case the connection fails.

SKWPeer* peer;
 
SKWDataConnection* data = [peer connectWithId:destId];

Parameters

peerId

The brokering ID of the remote peer (their peer.id).

Returns

Data connection object

connectWithId:options:

- (SKWDataConnection* __nullable) connectWithId:		(NSString *__nonnull)	peerId
options:		(SKWConnectOption *__nullable)	options

Connects to the remote peer specified by id and returns a data connection.

Be sure to listen on the error event in case the connection fails.

SKWPeer* peer;
 
SKWConnectOption* options = [[SKWConnectOption alloc] init];
options.label = @"chat";
options.metadata = @"hi !!!";
options.serialization = SKW_SERIALIZATION_NONE;
 
SKWDataConnection* data = [peer connectWithId:destId options:options];

Parameters

peerId	The brokering ID of the remote peer (their peer.id).
options	Option setting dictionary

Returns

Data connection object

destroy

- (BOOL) destroy

Close the connection to the signaling server and the already connected mediaConnection and dataConnection.

SKWPeer* peer;
 
[peer destroy];

Returns

Processing result

disconnect

- (BOOL) disconnect

(deprecated) Close the connection to the signaling server.

In addition, the connected mediaConnection and dataConnection are continued.

Deprecated:

This method is now deprecated. Use [SKWPeer -destroy] instead.

fetchPeerExistsWithPeerId:success:error:

- (void) fetchPeerExistsWithPeerId:		(NSString *__nonnull)	peerId
success:		(void(^)(BOOL))	successCallback
error:		(void(^)(NSString *__nonnull))	errorCallback

Fetch whether Peer specified by Peer ID exists from the signaling server.

SKWPeer* peer;
NSString* peerId;
 
[peer fetchPeerExistsWithPeerId:peerId success:^(BOOL exists) {
    // something to do.
} error:^(NSString* __nonnull message) {
    // something to do.
}];

Parameters

peerId	Specify the Peer ID of the Peer whose existence you want to check.
success	Set the callback to be executed when the existence of the Peer is fetched.
error	Set the callback to be executed when an error is occured.

initWithId:options:

- (instancetype __nullable) initWithId:		(NSString *__nullable)	peerId
options:		(SKWPeerOption *__nullable)	options

A peer can connect to other peers and listen for connections.

NSString* curtomPeerId = @"my-peer-id";
SKWPeerOption* options = [[SKWPeerOption alloc] init];
options.key = @"{your-dev-key}";
options.domain = @”{your-domain}”;
options.debug = SKW_PEER_DEBUG_LEVEL_ALL_LOGS;
options.turn = YES;
options.tryReconnectMedia = YES:
options.tryReconnectData = YES:
 
SKWPeer* peer = [[SKWPeer alloc] initWithId:curtomPeerId options:options];

Parameters

peerId	Other peers can connect to this peer using the provided ID. If no ID is given, one will be generated by the brokering server.
options	Option seetings.

Returns

PeerObjC object

initWithOptions:

- (instancetype __nullable) initWithOptions:

(SKWPeerOption *__nullable)

options

A peer can connect to other peers and listen for connections.

ID is retrieve from brokering server.

SKWPeerOption* options = [[SKWPeerOption alloc] init];
options.key = @"{your-dev-key}";
options.domain = @”{your-domain}”;
options.debug = SKW_PEER_DEBUG_LEVEL_ALL_LOGS;
options.turn = YES;
options.tryReconnectMedia = YES:
options.tryReconnectData = YES:
 
SKWPeer* peer = [[SKWPeer alloc] initWithOptions:options];

Parameters

options

Option seetings.

Returns

PeerObjC object

joinRoomWithName:options:

- (SKWRoom* __nullable) joinRoomWithName:		(NSString *__nonnull)	roomName
options:		(SKWRoomOption *__nonnull)	option

Full mesh room example:

SKWPeer* peer;
SKWMediaStream* localStream;
 
NSString* roomName = @"fullmesh_videochat_room";
 
SKWRoomOption* options = [[SKWRoomOptions alloc] init];
option.mode = SKW_ROOM_MODE_MESH;
option.stream = localStream;
 
SKWMeshRoom* meshRoom = (SKWMeshRoom*)[peer joinRoomWithName:roomName options:options];

SFU room example:

SKWPeer* peer;
 
NSString* roomName = @"sfu_textchat_room";
 
SKWRoomOption* options = [[SKWRoomOptions alloc] init];
option.mode = SKW_ROOM_MODE_SFU;
 
SKWSFURoom* sfuRoom = (SKWSFURoom*)[peer joinRoomWithName:roomName options:options];

Parameters

roomName	Room name
option	Room option

Returns

Room object

listAllPeers:

- (void) listAllPeers:

(void(^)(NSArray *__nullable))

callback

Listing peer ID.

SKWPeer* peer;
 
[peer listAllPeers:^(NSArray* aryPeers) {
   for (NSString* strPeer in aryPeers) {
       // something to do.
   }
}];

Parameters

callback

Callback block

on:callback:

- (void) on:		(SKWPeerEventEnum)	event
callback:		(SKWPeerEventCallback __nullable)	callback

Set blocks for peer events.

(Block Literal Syntax)

SKWPeer* peer;
 
[peer on:SKW_PEER_EVENT_OPEN callback:^(NSObject* obj) {
    if (YES == [obj isKindOfClass:[NSString class]]) {
        NSString* ownId = (NSString *)obj;
    }
}];
 
[peer on:SKW_PEER_EVENT_CONNECTION callback:^(NSObject* obj) {
    SKWDataConnection* data = (SKWDataConnection *)obj;
}];
 
[peer on:SKW_PEER_EVENT_CALL callback:^(NSObject* obj) {
    SKWMediaConnection* media = (SKWMediaConnection *)obj;
}];
 
[peer on:SKW_PEER_EVENT_CLOSE callback:^(NSObject* obj) {
    // ...
}];
 
[peer on:SKW_PEER_EVENT_DISCONNECTED callback:^(NSObject* obj) {
    // ...
}];
 
[peer on:SKW_PEER_EVENT_ERROR callback:^(NSObject* obj) {
    SKWPeerError* err = (SKWPeerError *)obj;
    NSLog(@"%@", err);
}];

Parameters

event	Event type
callback	Callback block literal

reconnect

- (void) reconnect

(deprecated) Reconnect to the signaling server.

Use the assigned Peer ID when reconnecting.

Deprecated:

This method is now deprecated. Recreate peer instance instead.

updateCredential:

- (void) updateCredential:

(SKWPeerCredential *__nonnull)

newCredential

SKWPeer* peer;
 
SKWPeerCredential* credential = [[SKWPeerCredential alloc] init];
credential.timestamp = [[NSDate date] timeIntervalSince1970];
credential.ttl = 86400;
credential.authToken = @"calculated auth token";
 
[peer updateCredential:credential];

Parameters

newCredential

new credential

Property Documentation

identity

- (NSString* __nullable) identity

readnonatomicassign

The brokering ID of this peer.

If no ID was specified in the constructor, this will be undefined until the open event is emitted.