SKWMediaConnection Class Reference

Alternative class as MediaConnection. More...

#import <SKWMediaConnection.h>

Inheritance diagram for SKWMediaConnection:

Instance Methods
(void)	- answer
	When receiving a call event on a peer, you can call .answer on the media connection provided by the callback to accept the call. More...
(void)	- answer:
	When receiving a call event on a peer, you can call .answer on the media connection provided by the callback to accept the call. More...
(void)	- answer:options:
	When receiving a call event on a peer, you can call .answer on the media connection provided by the callback to accept the call with options. More...
(void)	- close
	Closes the media connection. More...
(void)	- close:
	Closes the media connection with the forceClose option. More...
(void)	- on:callback:
	Set callbacks for media connection events. More...
(void)	- replaceStream:
	Change the MediaStream that is being sent. More...
(void)	- getStats:
	Get statistics of the connection. More...

Properties
NSString *__nullable	connectionId
	Connection ID.
NSString *__nullable	metadata
	Any type of metadata associated with the connection, passed in by whoever initiated the connection.
BOOL	isOpen
	This is true if the connection is open and ready for read/write.
NSString *__nullable	peer
	The ID of the peer on the other end of this connection.
NSString *__nullable	type
	For type of connection.
NSString *__nullable	label
	The optional label passed in or assigned by PeerJS when the connection was initiated.
BOOL	reliable
	Whether the underlying data channels are reliable; defined when the connection was initiated.
SKWSerializationEnum	serialization
	The serialization format of the data sent over the connection. More...
SKWPeer *__nullable	provider
	Provider PeerObjC object.

Detailed Description

Alternative class as MediaConnection.

Method Documentation

answer

- (void) answer

When receiving a call event on a peer, you can call .answer on the media connection provided by the callback to accept the call.

SKWPeer* peer;
 
[peer on:SKW_PEER_EVENT_CALL callback:^(NSObject* obj) {
    [media answer];
}];

answer:

- (void) answer:

(SKWMediaStream *__nullable)

stream

When receiving a call event on a peer, you can call .answer on the media connection provided by the callback to accept the call.

SKWPeer* peer;
 
[SKWNavigator initialize:peer];
 
SKWMediaConstraints* constraints = [[SKWMediaConstraints alloc] init];
SKWMediaStream* stream = [SKWNavigator getUserMedia:constraints];
 
[peer on:SKW_PEER_EVENT_CALL callback:^(NSObject* obj) {
    SKWMediaConnection* media = (SKWMediaConnection *)obj;
    [media answer:stream];
}];

Parameters

stream

Video stream

answer:options:

- (void) answer:		(SKWMediaStream *__nullable)	stream
options:		(SKWAnswerOption *__nullable)	options

When receiving a call event on a peer, you can call .answer on the media connection provided by the callback to accept the call with options.

SKWPeer* peer;
 
[SKWNavigator initialize:peer];
 
SKWMediaConstraints* constraints = [[SKWMediaConstraints alloc] init];
SKWMediaStream* stream = [SKWNavigator getUserMedia:constraints];
 
[peer on:SKW_PEER_EVENT_CALL callback:^(NSObject* obj) {
    SKWMediaConnection* media = (SKWMediaConnection *)obj;
    SKWAnswerOption* options = [[SKWAnswerOption alloc] init];
    options.videoBandwidth = 768;
    options.audioBandwidth = 64;
    [media answer:stream options:options];
}];

Parameters

stream	Video stream
options	Answer Options

close

- (void) close

Closes the media connection.

Run the forceClose option as NO. May be changed to YES from a future version.

SKWMediaConnection* media;
 
[media close];
media = nil;

close:

- (void) close:

(BOOL)

forceClose

Closes the media connection with the forceClose option.

SKWMediaConnection* media;
 
[media close:YES];
media = nil;

Parameters

forceClose

Set to YES and the connection on remote peer will close immediately. When set to NO, the connection on remote peer will close after the end of the ICE reconnect by the browser.

getStats:

- (void) getStats:

(SKWConnectionGetStatsCallback __nullable)

callback

Get statistics of the connection.

Parameters

callback

Callback block literal

SKWMediaConnection *connection;
 
[connection getStats:^(NSArray * _Nullable stats) {
       // Do something
}];

on:callback:

- (void) on:		(SKWMediaConnectionEventEnum)	event
callback:		(SKWMediaConnectionEventCallback __nullable)	callback

Set callbacks for media connection events.

(Block Literal Syntax)

SKWMediaConnection* media;
 
[media on:SKW_MEDIACONNECTION_EVENT_STREAM callback:^(NSObject* obj) {
    SKWMediaStream *stream = (SKWMediaStream *)obj;
}];
 
[media on:SKW_MEDIACONNECTION_EVENT_REMOVE_STREAM callback:^(NSObject* obj) {
    SKWMediaStream *stream = (SKWMediaStream *)obj;
}];
 
[media on:SKW_MEDIACONNECTION_EVENT_CLOSE callback:^(NSObject* obj) {
    // クローズ時の処理を記述
}];
 
[media on:SKW_MEDIACONNECTION_EVENT_ERROR callback:^(NSObject* obj) {
    SKWPeerError* err = (SKWPeerError*)obj;
    NSLog(@"%@", err);
}];

Parameters

event	Event type
callback	Callback block literal

replaceStream:

- (void) replaceStream:

(SKWMediaStream *__nullable)

newStream

Change the MediaStream that is being sent.

For example, you can use it to change the camera device or the image quality.

Note: It is not possible to change the state of a MediaStream from not sending to sending.You cannot change the state of MediaStream from not sending to sending and vice versa.
It is also not possible to interchange "MediaStream with either video or audio only" and "MediaStream with both video and audio".

SKWMediaConnection* connection;
SKWMediaStream* stream;
 
[connection replaceStream:stream];

Parameters

newStream

Property Documentation

serialization

- (SKWSerializationEnum) serialization

readnonatomicassigninherited

The serialization format of the data sent over the connection.

Can be binary (default), binary-utf8, json, or none.