SKYLINKConnection Class Reference

Inherits from	NSObject
Declared in	SKYLINKConnection.h

`lifeCycleDelegate`

delegate related to life cycle, implementing the SKYLINKConnectionLifeCycleDelegate protocol.

@property (nonatomic, weak) id<SKYLINKConnectionLifeCycleDelegate> _Null_unspecified lifeCycleDelegate

Declared In

SKYLINKConnection.h

`remotePeerDelegate`

delegate related to remote peer activities, implementing the SKYLINKConnectionRemotePeerDelegate protocol.

@property (nonatomic, weak) id<SKYLINKConnectionRemotePeerDelegate> _Null_unspecified remotePeerDelegate

Declared In

SKYLINKConnection.h

`mediaDelegate`

delegate related to audio/video media, implementing the SKYLINKConnectionMediaDelegate protocol.

@property (nonatomic, weak) id<SKYLINKConnectionMediaDelegate> _Null_unspecified mediaDelegate

Declared In

SKYLINKConnection.h

`messagesDelegate`

delegate related to various type of custom messages, implementing the SKYLINKConnectionMessagesDelegate protocol.

@property (nonatomic, weak) id<SKYLINKConnectionMessagesDelegate> _Null_unspecified messagesDelegate

Declared In

SKYLINKConnection.h

`fileTransferDelegate`

delegate related to file transfer, implementing the SKYLINKConnectionFileTransferDelegate protocol.

@property (nonatomic, weak) id<SKYLINKConnectionFileTransferDelegate> _Null_unspecified fileTransferDelegate

Declared In

SKYLINKConnection.h

`recordingDelegate`

delegate related to room recording, implementing the SKYLINKConnectionRecordingDelegate protocol.

@property (nonatomic, weak) id<SKYLINKConnectionRecordingDelegate> _Null_unspecified recordingDelegate

Declared In

SKYLINKConnection.h

`localPeerId`

peer id of the current local user

@property (nonatomic, copy, readonly) NSString *localPeerId

Declared In

SKYLINKConnection.h

`maxPeerCount`

Maximun number of peers.

@property (nonatomic, assign) NSInteger maxPeerCount

Discussion

The default value depends on the configuration.

Declared In

SKYLINKConnection.h

`userName`

The use name of the peer.

@property (nonatomic, copy, readonly) NSString *userName

Discussion

This is obtained from the server.

Declared In

SKYLINKConnection.h

`enableLogs`

Wether enable the logs.

@property (nonatomic, assign) BOOL enableLogs

Discussion

Set the debugging mode for tracing etc.

Declared In

SKYLINKConnection.h

`encryptSecrets`

Map of secretId and encryption secret for generating key for SDK encryption.

@property (nonatomic, copy) NSDictionary *encryptSecrets

Discussion

SDK now allows AES encryption/decryption of certain user provided information.

Declared In

SKYLINKConnection.h

`selectedSecretId`

Selected secretId of the secret to use when SDK needs to perform encryption.

@property (nonatomic, copy) NSString *selectedSecretId

Discussion

SDK now allows AES encryption/decryption of certain user provided information.

Declared In

SKYLINKConnection.h

`messagePersist`

whether the next public server message sent should be persisted.

@property (nonatomic, assign) BOOL messagePersist

Declared In

SKYLINKConnection.h

`– initWithConfig:callback:`

Initialize and return a newly allocated connection object

- (null_unspecified instancetype)initWithConfig:(null_unspecified SKYLINKConnectionConfig *)config callback:(nullable ErrorBlock)callback

Parameters

`config`	The connection configuration object
`callback`	Skylink callback with an error message

Discussion

Changes in config after creating the object won’t affect the connection

Declared In

SKYLINKConnection.h

`– connectToRoomWithAppKey:secret:roomName:userData:callback:`

Join the room specifiying the shared secret, room name and user info

- (void)connectToRoomWithAppKey:(null_unspecified NSString *)appKey secret:(null_unspecified NSString *)secret roomName:(null_unspecified NSString *)roomName userData:(null_unspecified id)userData callback:(nullable ErrorBlock)callback

Parameters

`appKey`	Shared appKey
`secret`	Shared secret
`roomName`	Name of the room to join
`userData`	User defined information (relating to oneself). May be an NSString, NSDictionary or NSArray
`callback`	Skylink callback with an error message

Discussion

It is recommended to use connectToRoomWithCredentials:roomName:userInfo: after calculating the credentials on a server, but if the client application has no server implementation then this one should be used

Declared In

SKYLINKConnection.h

`– connectToRoomWithStringURL:userData:callback:`

Join the room specifiying the calculated string URL and user info.

- (void)connectToRoomWithStringURL:(null_unspecified NSString *)stringURL userData:(null_unspecified id)userData callback:(nullable ErrorBlock)callback

Parameters

`stringURL`	Generated with room name, appKey, secret, startTime and duration. Typed NSString (not NSURL).
`userData`	User defined information (relating to oneself). May be an NSString, NSDictionary or NSArray.
`callback`	Skylink callback with an error message.

Discussion

Use this method when you calculate the URL on your server with your API key, secret and room name. Allows you to avoid having those parameters in the iOS app code.

Declared In

SKYLINKConnection.h

`– disconnect:`

Leave the room

- (void)disconnect:(nullable ErrorBlock)callback

Parameters

`callback`	Skylink callback with an error message

Discussion

Leave the room and remove any video renderers and PeerConnections

Declared In

SKYLINKConnection.h

`– createLocalMediaWithMediaDevice:mediaMetadata:callback:`

Start a local media with a media device

- (void)createLocalMediaWithMediaDevice:(SKYLINKMediaDevice)mediaDevice mediaMetadata:(id _Nullable)mediaMetadata callback:(nullable ErrorBlock)callback

Parameters

`mediaDevice`	The type of Skylink media device you want to start
`mediaMetadata`	Some label associated with the new media, can be NSString, NSDictionary, NSArray
`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– createLocalMediaWithMediaDevice:mediaMetadata:customVideoCapturer:captureSessionPreset:fps:callback:`

Start a custom local media with a media device, customVideoCapturer, captureSessionPreset, and fps

- (void)createLocalMediaWithMediaDevice:(SKYLINKMediaDevice)mediaDevice mediaMetadata:(id _Nullable)mediaMetadata customVideoCapturer:(RTCCameraVideoCapturer *_Nonnull)customVideoCapturer captureSessionPreset:(AVCaptureSessionPreset _Null_unspecified)captureSessionPreset fps:(NSInteger)fps callback:(nullable ErrorBlock)callback

Parameters

`mediaDevice`	The type of Skylink media device you want to start
`mediaMetadata`	Some label associated with the new media, can be NSString, NSDictionary, NSArray
`customVideoCapturer`	Using custom videoCapturer
`captureSessionPreset`	AVCaptureSessionPreset will be accepted
`fps`	The framerate using by the custom video capturer
`callback`	Skylink callback with an error message

Discussion

Available values for captureSessionPreset AVCaptureSessionPresetLow, AVCaptureSessionPreset640x480, AVCaptureSessionPreset352x288, AVCaptureSessionPreset1280x720, AVCaptureSessionPresetHigh, AVCaptureSessionPresetPhoto, AVCaptureSessionPreset1920x1080

Declared In

SKYLINKConnection.h

`– createLocalMediaWithMediaDevice:mediaMetadata:captureSessionPreset:fps:callback:`

Start a local media with a media device, custom captureSessionPreset and fps

- (void)createLocalMediaWithMediaDevice:(SKYLINKMediaDevice)mediaDevice mediaMetadata:(id _Nullable)mediaMetadata captureSessionPreset:(AVCaptureSessionPreset _Null_unspecified)captureSessionPreset fps:(NSInteger)fps callback:(nullable ErrorBlock)callback

Parameters

`mediaDevice`	The type of Skylink media device you want to start
`mediaMetadata`	Some label associated with the new media, can be NSString, NSDictionary, NSArray
`captureSessionPreset`	AVCaptureSessionPreset will be accepted
`fps`	The framerate using by the custom video capturer
`callback`	Skylink callback with an error message

Discussion

Available values for captureSessionPreset AVCaptureSessionPresetLow, AVCaptureSessionPreset640x480, AVCaptureSessionPreset352x288, AVCaptureSessionPreset1280x720, AVCaptureSessionPresetHigh, AVCaptureSessionPresetPhoto, AVCaptureSessionPreset1920x1080

Declared In

SKYLINKConnection.h

`– createLocalMediaWithMediaDevice:mediaMetadata:fromViewController:callback:`

Start a local media with a media device and a custom view controller

- (void)createLocalMediaWithMediaDevice:(SKYLINKMediaDevice)mediaDevice mediaMetadata:(id _Nullable)mediaMetadata fromViewController:(UIViewController *_Null_unspecified)viewController callback:(nullable ErrorBlock)callback

Parameters

`mediaDevice`	The type of Skylink media device you want to start
`mediaMetadata`	Some label associated with the new media, can be NSString, NSDictionary, NSArray
`viewController`	Screenshare with specific ViewController, if you don’t provide a view controller, the top view controller will be used
`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– changeLocalMediaStateWithMediaId:mediaState:callback:`

Change a local media state by the mediaId

- (void)changeLocalMediaStateWithMediaId:(NSString *_Nonnull)mediaId mediaState:(SKYLINKMediaState)mediaState callback:(nullable ErrorBlock)callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`mediaState`	The SkyinkMediaState you want to change to
`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– destroyLocalMediaWithMediaId:callback:`

Stop and remove a local media by the mediaId

- (void)destroyLocalMediaWithMediaId:(NSString *_Nonnull)mediaId callback:(nullable ErrorBlock)callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– getSkylinkMediaWithMediaId:`

Get specific SkylinkMedia via MediaId

- (nullable SKYLINKMedia *)getSkylinkMediaWithMediaId:(nonnull NSString *)mediaId

Parameters

`mediaId`	The unique mediaId of a Skylink media object

Return Value

The required media, if cannot find, nil will be returned

Declared In

SKYLINKConnection.h

`– getSkylinkMediaListWithMediaType:peerId:`

Get list of SkylinkMedia via MediaType

- (nullable NSArray<SKYLINKMedia*> *)getSkylinkMediaListWithMediaType:(SKYLINKMediaType)mediaType peerId:(NSString *_Nullable)peerId

Parameters

`mediaType`	The SkylinkMediaType you want to get
`peerId`	The peerId you want to get from

Return Value

The array of the required media, if cannot find, nil will be returned

Discussion

If mediaType is NOT in the SKYLINKMediaType enum, all SM of peerId will be returned. If peerId is nil, all SM of mediaType will be returned. If peerId is null and mediaType is NOT in the SKYLINKMediaType enum all SM will be returned

Declared In

SKYLINKConnection.h

`– switchCamera:`

Switches between front and back camera. By default the front camera input is captured.

- (void)switchCamera:(nullable ErrorBlock)callback

Declared In

SKYLINKConnection.h

`– getCurrentCaptureFormat`

Get the current camera captured format

- (nullable AVCaptureDeviceFormat *)getCurrentCaptureFormat

Return Value

The current capturer format

Declared In

SKYLINKConnection.h

`– getAllCaptureFormats`

Get all the supported camera capture formats

- (nullable NSArray<AVCaptureDeviceFormat*> *)getAllCaptureFormats

Return Value

All the supported capturer formats

Declared In

SKYLINKConnection.h

`– getCurrentVideoDevice`

Get the current video device

- (nullable AVCaptureDevice *)getCurrentVideoDevice

Return Value

The current video device

Declared In

SKYLINKConnection.h

`– getAllVideoDevices`

Get all available video devices

- (nullable NSArray<AVCaptureDevice*> *)getAllVideoDevices

Return Value

The array of all video devices

Declared In

SKYLINKConnection.h

`– getCurrentCameraName`

Get the current camera name

- (nullable NSString *)getCurrentCameraName

Return Value

The current camera name

Declared In

SKYLINKConnection.h

`– getAllCameraNames`

Get all the available camera names

- (nullable NSArray<NSString*> *)getAllCameraNames

Return Value

The array of all camera names

Declared In

SKYLINKConnection.h

`– setInputVideoResolutionOfMedia:toWidth:height:fps:callback:`

You may use this to set your local input stats

- (void)setInputVideoResolutionOfMedia:(nonnull NSString *)mediaId toWidth:(NSUInteger)width height:(NSUInteger)height fps:(NSUInteger)fps callback:(nullable ErrorBlock)callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`width`	Width you want to set
`height`	Height you want to set
`fps`	Frame rate you want to set
`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– getInputVideoResolutionWithMediaId:callback:`

Get all the stats for your local input video

- (void)getInputVideoResolutionWithMediaId:(nonnull NSString *)mediaId callback:(ResolutionResultBlock _Null_unspecified)callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`callback`	Skylink callback contains the width height frame rate and an error message, if everything is fine, the error can be nil

Declared In

SKYLINKConnection.h

`– getReceivedVideoResolutionWithMediaId:callback:`

Get all the stats of your received remote video

- (void)getReceivedVideoResolutionWithMediaId:(nonnull NSString *)mediaId callback:(ResolutionResultBlock _Null_unspecified)callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`callback`	Skylink callback contains the width height frame rate and an error message, if everything is fine, the error can be nil

Declared In

SKYLINKConnection.h

`– getSentVideoResolutionOfRemotePeerId:mediaId:callback:`

Get all the stats you sent to the remote peer

- (void)getSentVideoResolutionOfRemotePeerId:(nonnull NSString *)remotePeerId mediaId:(nonnull NSString *)mediaId callback:(ResolutionResultBlock _Null_unspecified)callback

Parameters

`remotePeerId`	The remote peer id
`mediaId`	The unique mediaId of a Skylink media object
`callback`	Skylink callback contains the width height frame rate and an error message, if everything is fine, the error can be nil

Declared In

SKYLINKConnection.h

`– muteAudio:`

Mute/unmute own audio and trigger mute/unmute audio call back for all other peers.

- (void)muteAudio:(BOOL)isMuted

Parameters

`isMuted`	Flag to set if audio should be muted. Set to true to mute and false to unmute.

Declared In

SKYLINKConnection.h

`– muteVideo:`

Mute/unmute own video and trigger mute/unmute video call back for all other peers.

- (void)muteVideo:(BOOL)isMuted

Parameters

`isMuted`	Flag to set if video should be muted. Set to true to mute and false to unmute.

Declared In

SKYLINKConnection.h

`– isAudioMuted`

Checks if own audio is currently muted.

- (BOOL)isAudioMuted

Return Value

true if audio is muted and false otherwise.

Declared In

SKYLINKConnection.h

`– isVideoMuted`

Checks if own video is currently muted.

- (BOOL)isVideoMuted

Return Value

true if video is muted and false otherwise.

Declared In

SKYLINKConnection.h

`– isMultiTrackEnable`

Checks the value in the SDK, which was set by the SkylinkConfig in SDK’s init

- (BOOL)isMultiTrackEnable

Return Value

Whethe enabled or not

Discussion

This value does not change once set

Declared In

SKYLINKConnection.h

`– setAudioOutput:`

set audio output to speaker

- (void)setAudioOutput:(BOOL)isSpeaker

Discussion

This value does not change once set

Declared In

SKYLINKConnection.h

`– getSentTransferSpeedByMediaId:remotePeerId:callback:`

Get the full WebRTC stats

- (void)getSentTransferSpeedByMediaId:(nonnull NSString *)mediaId remotePeerId:(null_unspecified NSString *)remotePeerId callback:(void ( ^ _Null_unspecified ) ( CGFloat speed , NSError *_Nullable error ))callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`remotePeerId`	The remote peer id
`callback`	Skylink callback with an object containing the transfer speed (Kbps) and an error, the error can be nil if everything is fine

Declared In

SKYLINKConnection.h

`– getReceivedTransferSpeedByMediaId:callback:`

Get the full WebRTC stats

- (void)getReceivedTransferSpeedByMediaId:(nonnull NSString *)mediaId callback:(void ( ^ _Null_unspecified ) ( CGFloat speed , NSError *_Nullable error ))callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`callback`	Skylink callback with an object containing the transfer speed (Kbps) and an error, the error can be nil if everything is fine

Declared In

SKYLINKConnection.h

`– getSentWebRtcStatsWithMediaId:remotePeerId:callback:`

Get the full WebRTC stats for sent

- (void)getSentWebRtcStatsWithMediaId:(nonnull NSString *)mediaId remotePeerId:(null_unspecified NSString *)remotePeerId callback:(void ( ^ _Nullable ) ( id _Nullable responseObject , NSError *_Nullable error ))callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`remotePeerId`	The remote peer id
`callback`	Skylink callback with an object containing all the WebRTC stats

Declared In

SKYLINKConnection.h

`– getReceivedWebRtcStatsWithMediaId:callback:`

Get the full WebRTC stats for receive

- (void)getReceivedWebRtcStatsWithMediaId:(nonnull NSString *)mediaId callback:(void ( ^ _Nullable ) ( id _Nullable responseObject , NSError *_Nullable error ))callback

Parameters

`mediaId`	The unique mediaId of a Skylink media object
`callback`	Skylink callback with an object containing all the WebRTC stats

Declared In

SKYLINKConnection.h

`– startRecording:`

Start the recording of the room

- (void)startRecording:(nullable ErrorBlock)callback

Parameters

`callback`	Skylink callback with an error message

Discussion

Warning: This feature is in BETA

This is a Skylink Media Relay only feature, it needs to be enable for the API Key in Temasys developer console

Declared In

SKYLINKConnection.h

`– stopRecording:`

Stop the recording of the room

- (void)stopRecording:(nullable ErrorBlock)callback

Parameters

`callback`	Skylink callback with an error message

Discussion

Warning: This feature is in BETA

This is a Skylink Media Relay only feature, it needs to be enable for the API Key in Temasys developer console

Declared In

SKYLINKConnection.h

`– isRecording`

Check recording status.

- (BOOL)isRecording

Return Value

The recording status bool value

Discussion

This is a Skylink Media Relay only feature

Declared In

SKYLINKConnection.h

`– sendServerMessage:toRemotePeerId:callback:`

Send a server message (dictionary, array or string) to a peer via signaling server

- (void)sendServerMessage:(null_unspecified id)message toRemotePeerId:(nullable NSString *)remotePeerId callback:(nullable ErrorBlock)callback

Parameters

`message`	User defined message to be sent. May be an NSString, NSDictionary or NSArray
`remotePeerId`	The unique id of the peer to whom the message is sent
`callback`	Skylink callback with an error message

Discussion

If the ‘peerId’ is not given then the message is broadcasted to all the peers

Declared In

SKYLINKConnection.h

`– sendP2PMessage:toRemotePeerId:callback:`

Send a peer to peer message (dictionary, array or string) to a peer via data channel

- (void)sendP2PMessage:(null_unspecified id)message toRemotePeerId:(nullable NSString *)remotePeerId callback:(nullable ErrorBlock)callback

Parameters

`message`	User defined message to be sent. May be an NSString, NSDictionary, NSArray
`remotePeerId`	The unique id of the peer to whom the message is sent
`callback`	Skylink callback with an error message

Discussion

If the ‘peerId’ is not given then the message is broadcasted to all the peers

Declared In

SKYLINKConnection.h

`– getStoredMessages:`

The sending Peer sends this to get storedMessages of the room

- (void)getStoredMessages:(void ( ^ _Null_unspecified ) ( NSArray *_Nullable storedMessages , NSDictionary *_Nullable errors ))callback

Discussion

Can only get all public messages

Declared In

SKYLINKConnection.h

`– sendData:toRemotePeerId:callback:`

Send binary data to a peer via data channel

- (void)sendData:(null_unspecified NSData *)data toRemotePeerId:(null_unspecified NSString *)remotePeerId callback:(nullable ErrorBlock)callback

Parameters

`data`	Binary data to be sent to the peer. The maximum size the method expects is 65456 bytes
`remotePeerId`	The unique id of the peer to whom the data is sent
`callback`	Skylink callback with an error message

Discussion

If the ‘peerId’ is not given then the data is sent to all the peers. If the caller passes data object exceeding the maximum length i.e. 65456, excess bytes are truncated to the limit before sending the data on to the channel

Declared In

SKYLINKConnection.h

`– sendFileTransferWithFileURL:assetType:fileName:remotePeerId:callback:`

This will trigger a file permission event at a peer

- (void)sendFileTransferWithFileURL:(null_unspecified NSURL *)fileURL assetType:(SKYLINKAssetType)assetType fileName:(NSString *_Nullable)fileName remotePeerId:(null_unspecified NSString *)remotePeerId callback:(nullable ErrorBlock)callback

Parameters

`fileURL`	The url of the file to send
`assetType`	The type of the asset to send
`fileName`	The unique id of the peer to whom the file would be sent
`remotePeerId`	The unique id of the peer to whom the file would be sent, if it is nil, broadcast the sending
`callback`	Skylink callback with an error message

Exceptions

`exception`	An exception will be raised if there is already a file transfer being done with the same peer

Declared In

SKYLINKConnection.h

`– acceptFileTransferWithFileName:fromRemotePeerId:callback:`

Accept the file transfer request from a peer

- (void)acceptFileTransferWithFileName:(null_unspecified NSString *)fileName fromRemotePeerId:(null_unspecified NSString *)remotePeerId callback:(nullable ErrorBlock)callback

Parameters

`fileName`	The name of the file in request, you can specify a file name, if it is nil, then then file name will be the original file name
`remotePeerId`	The unique id of the peer from whom the file would be received
`callback`	Skylink callback with an error message

Discussion

You can specify a local file name, for the file receiving from the remote peer, if don’t want to specify a local name, just send a nil, then the original file name will be used to save to your local disk

Declared In

SKYLINKConnection.h

`– rejectFileTransferFromRemotePeerId:callback:`

Reject a File (uses WRQ) from remote user

- (void)rejectFileTransferFromRemotePeerId:(null_unspecified NSString *)remotePeerId callback:(nullable ErrorBlock)callback

Parameters

`remotePeerId`	The unique id of the peer from whom the file would be received
`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– cancelFileTransferWithRemotePeerId:forSending:callback:`

Cancel the existing on going transfer at anytime

- (void)cancelFileTransferWithRemotePeerId:(null_unspecified NSString *)remotePeerId forSending:(BOOL)forSending callback:(nullable ErrorBlock)callback

Parameters

`forSending`	The BOOL value indicates if you are to send the file
`callback`	Skylink callback with an error message

Discussion

If you are the sender, this is true, you can cancel the sending anytime(before or after it starts), if you are the receiver, this is false, you may also cancel the receiving anytime

Declared In

SKYLINKConnection.h

`– lockTheRoom:`

Lock the room

- (void)lockTheRoom:(nullable ErrorBlock)callback

Parameters

`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– unlockTheRoom:`

Unlock the room

- (void)unlockTheRoom:(nullable ErrorBlock)callback

Parameters

`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– isRoomLocked`

Check if room is locked

- (BOOL)isRoomLocked

Declared In

SKYLINKConnection.h

`– getRoomId`

Get roomId

- (nonnull NSString *)getRoomId

Return Value

RoomId

Discussion

This is generally not needed

Declared In

SKYLINKConnection.h

`– getPeerIdList`

Get list of Peers connected

- (nullable NSArray<NSString*> *)getPeerIdList

Return Value

The array of connected remote peers

Declared In

SKYLINKConnection.h

`– sendLocalUserData:callback:`

Update user information for every other peer and triggers user info call back at all the other peer’s end

- (void)sendLocalUserData:(null_unspecified id)localUserData callback:(nullable ErrorBlock)callback

Parameters

`localUserData`	User defined information. May be an NSString, NSDictionary or NSArray
`callback`	Skylink callback with an error message

Declared In

SKYLINKConnection.h

`– getUserInfo:`

Get the cached user info for a particular peer

- (nonnull id)getUserInfo:(nullable NSString *)peerId

Parameters

`peerId`	The unique id of the peer, if the peerId is inl, then get self userInfo

Return Value

User defined information. May be an NSString, NSDictionary or NSArray

Declared In

SKYLINKConnection.h

`– refreshConnectionWithRemotePeerId:doIceRestart:callback:`

Refresh peer connection with a specified peer

- (void)refreshConnectionWithRemotePeerId:(nullable NSString *)remotePeerId doIceRestart:(BOOL)doIceRestart callback:(nullable ErrorBlock)callback

Parameters

`remotePeerId`	The unique id of the peer with whom the connection is being refreshed
`doIceRestart`	Is this restart an ICE restart
`callback`	Skylink callback with an error message

Discussion

This method is provided as a convenience method. So that one can call if a peer streams are not behaving correctly

Declared In

SKYLINKConnection.h

`+ getSkylinkVersion`

Get the version string of this Skylink SDK for iOS

+ (nonnull NSString *)getSkylinkVersion

Return Value

Version string of this Skylink SDK for iOS

Declared In

SKYLINKConnection.h

`+ calculateCredentials:duration:startTime:secret:`

Calculate credentials to be used by the connection

+ (nonnull NSString *)calculateCredentials:(null_unspecified NSString *)roomName duration:(null_unspecified NSNumber *)duration startTime:(null_unspecified NSDate *)startTime secret:(null_unspecified NSString *)secret

Parameters

`roomName`	Name of the room
`duration`	Duration of the call in hours
`startTime`	Start time of the call as per client application time zone
`secret`	The shared secret

Return Value

The calculated credential string

Declared In

SKYLINKConnection.h

`+ getErrorFrom:`

Get NSError of SDK error list from Error code

+ (null_unspecified NSError *)getErrorFrom:(int)errorCode

Parameters

`errorCode`	code of error

Return Value

The NSError

Declared In

SKYLINKConnection.h

SKYLINKConnection Class Reference

Overview

Delegates

Declared In

Declared In

Declared In

Declared In

Declared In

Declared In

Peer

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Declared In

Lifecycle

Parameters

Discussion

Declared In

Room connection

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Media create remove

Parameters

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In

Media get

Parameters

Return Value

Declared In

Parameters

Return Value

Discussion

Declared In

Media video devices

Declared In

Return Value

Declared In

Return Value

Declared In

Return Value

Declared In

Return Value

Declared In

Return Value

Declared In

Return Value

Declared In

Media video resolutions

Parameters

Declared In

Parameters

Declared In

Parameters

Declared In