SKYLINKConnectionConfig Class Reference

Inherits from NSObject
Declared in SKYLINKConnection.h

Overview

The class representing the conversation configuration.

  audio

enable/disable audio.

@property (nonatomic, assign) BOOL audio

Discussion

Default value is NO. This is a convinience property to set both sendAudio and receiveAudio to the same value.

Declared In

SKYLINKConnection.h

  video

enable/disable video.

@property (nonatomic, assign) BOOL video

Discussion

Default value is NO. This is a convinience property to set both sendVideo and receiveVideo to the same value.

Declared In

SKYLINKConnection.h

  sendAudio

enable/disable sending audio.

@property (nonatomic, assign) BOOL sendAudio

Discussion

Default value is NO.

Declared In

SKYLINKConnection.h

  receiveAudio

enable/disable sending audio.

@property (nonatomic, assign) BOOL receiveAudio

Discussion

Default value is NO.

Declared In

SKYLINKConnection.h

  sendVideo

enable/disable sending video.

@property (nonatomic, assign) BOOL sendVideo

Discussion

Default value is NO.

Declared In

SKYLINKConnection.h

  receiveVideo

enable/disable receiving video.

@property (nonatomic, assign) BOOL receiveVideo

Discussion

Default value is NO.

Declared In

SKYLINKConnection.h

  dataChannel

enable/disable dataChannel.

@property (nonatomic, assign) BOOL dataChannel

Discussion

Default value is NO.

Declared In

SKYLINKConnection.h

  fileTransfer

enable/disable file transfer.

@property (nonatomic, assign) BOOL fileTransfer

Discussion

Default value is NO.

Declared In

SKYLINKConnection.h

  timeout

number of seconds for file transfer timeout.

@property (nonatomic, assign) NSInteger timeout

Discussion

Default value is 60.

Declared In

SKYLINKConnection.h

  maxAudioBitrate

Used to limit remote peers audio media bitrate.

@property (nonatomic, assign) NSInteger maxAudioBitrate

Discussion

Default value is 0, meaning not bitrate limit.

Declared In

SKYLINKConnection.h

  maxVideoBitrate

Used to limit remote peers video media bitrate.

@property (nonatomic, assign) NSInteger maxVideoBitrate

Discussion

Default value is 512.

Declared In

SKYLINKConnection.h

  maxDataBitrate

Used to limit remote peers data bitrate.

@property (nonatomic, assign) NSInteger maxDataBitrate

Discussion

Default value is 0, meaning not bitrate limit.

Declared In

SKYLINKConnection.h

  )

Optional configuration for advanced users. (Deprecated: Use -(BOOL)advancedSetting:(NSString *)settingKey setValue:(id)value instead.)

@property (nonatomic, weak) NSDictionary *userInfo DEPRECATED_MSG_ATTRIBUTE ( "Use -(BOOL)advancedSetting:(NSString *)settingKey setValue:(id)value instead." )

Parameters

userInfo

NSDictionary carrying the desired settings. Read the discussion for details.

Discussion

The userInfo dictionnary key and associated settings are: @“STUN” key (NSNumber value): set @“STUN” to @YES to DISABLE STUN server. @“TURN” key (NSNumber value): set @“TURN” to @YES to DISABLE TURN server. @“disableHOST” key, set @YES to disable HOST. @“transport” key (NSString value): expected values are @“TCP” or @“UDP”. @“audio” key (NSString value): preferred audio codec, expected values are @“Opus” or @“iLBC”.

Declared In

SKYLINKConnection.h

– advancedSettingKey:setValue:

Optional configuration for advanced users.

- (BOOL)advancedSettingKey:(null_unspecified NSString *)settingKey setValue:(null_unspecified id)settingValue

Return Value

YES if the setting was sucessfully set (valid setting key and associated value).

Discussion

The settingKey and associated settings values are: @“STUN” key, (NSNumber value): set @“disableSTUN” to @YES to disable STUN server. @“TURN” key, (NSNumber value): set @“disableTURN” to @YES to disable TURN server. @“disableHOST” key, set @YES to disable HOST. @“transport” key, (NSString value): expected values are @“TCP” or @“UDP”. @“audio” key, (NSString value): preferred audio codec, expected values are @“Opus” or @“iLBC”. @“startWithBackCamera” key, (NSNumber value): if you send the camera, this will determine the local camera to start the video capture. Default is @NO (ie: use front camera) @“preferedCaptureSessionPresets” key, (NSArray value): ordered array of AVCaptureSessionPreset for the video capture, the first if any that can be used for the device will be picked.

Declared In

SKYLINKConnection.h