SKYLINKConnectionConfig Class Reference
Inherits from | NSObject |
---|---|
Declared in | SKYLINKConnection.h SKYLINKConnectionConfig.h |
sendAudio
enable/disable sending audio.
@property (nonatomic, readonly) BOOL sendAudio
Discussion
Default value is NO.
Declared In
SKYLINKConnection.h
receiveAudio
enable/disable receive audio.
@property (nonatomic, readonly) BOOL receiveAudio
Discussion
No default value.
Declared In
SKYLINKConnection.h
sendVideo
enable/disable sending video.
@property (nonatomic, readonly) BOOL sendVideo
Discussion
Default value is NO.
Declared In
SKYLINKConnection.h
receiveVideo
enable/disable receiving video.
@property (nonatomic, readonly) BOOL receiveVideo
Discussion
No default value.
Declared In
SKYLINKConnection.h
isEnableDataChannel
Check if dataChennel is enabled
@property (nonatomic, readonly) BOOL isEnableDataChannel
Discussion
If hasP2PMessaging or hasFileTransfer or hasDataTransfer, the value is true
Declared In
SKYLINKConnection.h
hasP2PMessaging
enable/disable messaging.
@property (nonatomic, assign) BOOL hasP2PMessaging
Discussion
Default value is NO.
Declared In
SKYLINKConnection.h
hasFileTransfer
enable/disable file transfer.
@property (nonatomic, assign) BOOL hasFileTransfer
Discussion
Default value is NO.
Declared In
SKYLINKConnection.h
hasDataTransfer
enable/disable data transfer.
@property (nonatomic, assign) BOOL hasDataTransfer
Discussion
Default value is NO.
Declared In
SKYLINKConnection.h
isMultiTrackCreateEnable
enable/disable multitrack support for creating.
@property (nonatomic, assign) BOOL isMultiTrackCreateEnable
Discussion
Default value is YES.
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
defaultVideoDevice
Default camera device @description Get the default camera device, whether it’s front or back
@property (nonatomic, assign) SKYLINKVideoDevice defaultVideoDevice
Declared In
SKYLINKConnection.h
hasAudioAutoGainControl
Check/set if audio auto gain control by WebRTC is enabled. @description Enabled by default
@property (nonatomic, assign) BOOL hasAudioAutoGainControl
Declared In
SKYLINKConnection.h
hasAudioEchoCancellation
Check/set if audio echo cancellation by WebRTC is enabled. @description Enabled by default
@property (nonatomic, assign) BOOL hasAudioEchoCancellation
Declared In
SKYLINKConnection.h
hasAudioHighPassFilter
Check/set if audio high pass filter by WebRTC is enabled. @description Enabled by default
@property (nonatomic, assign) BOOL hasAudioHighPassFilter
Declared In
SKYLINKConnection.h
hasAudioNoiseSuppression
Check if audio noise suppression by WebRTC is enabled. @description Enabled by default
@property (nonatomic, assign) BOOL hasAudioNoiseSuppression
Declared In
SKYLINKConnection.h
roomSize
Set the room size when creating a new room @description The size of the new room, if not specified, the default size will be small.
@property (nonatomic, assign) SKYLINKRoomSize roomSize
Declared In
SKYLINKConnection.h
isAllowTurn
Whether to allow the TURN server @description Default is YES
@property (nonatomic, assign) BOOL isAllowTurn
Declared In
SKYLINKConnection.h
isAllowStun
Whether to allow the TURN server @description Default is YES
@property (nonatomic, assign) BOOL isAllowStun
Declared In
SKYLINKConnection.h
isAllowHost
Whether to allow the HOST @description Default is YES
@property (nonatomic, assign) BOOL isAllowHost
Declared In
SKYLINKConnection.h
enableDNSPreSolving
Whether to apply the ICE filters @description Default is NO
@property (nonatomic, assign) BOOL enableDNSPreSolving
Declared In
SKYLINKConnection.h
enableIPv6Filter
Whether to filer out all the IPv6 servers @description Default is NO
@property (nonatomic, assign) BOOL enableIPv6Filter
Declared In
SKYLINKConnection.h
isMirrorLocalFrontCameraView
Mirror local front camera view @description Default is NO
@property (nonatomic, assign) BOOL isMirrorLocalFrontCameraView
Declared In
SKYLINKConnection.h
defaultCameraVideoFps
Default values at which to obtain camera video fps when video device is started @description Default is DEFAULT_VIDEO_FPS
@property (nonatomic, assign) NSInteger defaultCameraVideoFps
Declared In
SKYLINKConnection.h
captureSessionPreset
Default values at which to obtain video, when video device is started @description Available values AVCaptureSessionPresetLow, AVCaptureSessionPreset640x480, AVCaptureSessionPreset352x288, AVCaptureSessionPreset1280x720, AVCaptureSessionPresetHigh, AVCaptureSessionPresetPhoto, AVCaptureSessionPreset1920x1080 Default is AVCaptureSessionPreset640x480
@property (nonatomic, copy) AVCaptureSessionPreset _Nullable captureSessionPreset
Declared In
SKYLINKConnection.h
videoResNumWaitMs
Automatic video resolution @description ms to wait before checking again
@property (nonatomic, assign) NSInteger videoResNumWaitMs
Declared In
SKYLINKConnection.h
isReportVideoResolutionOnVideoChange
Automatic video resolution @description Will report when video changes
@property (nonatomic, assign) BOOL isReportVideoResolutionOnVideoChange
Declared In
SKYLINKConnection.h
isAllowIceRestart
Whether to allow the ICE server restart @description Default is NO
@property (nonatomic, assign) BOOL isAllowIceRestart
Declared In
SKYLINKConnection.h
networkTransport
Custom transport values for ICE candidates @description If any invalid value is set, networkTransport will be set to empty
@property (nonatomic, assign) NetworkTransport networkTransport
Declared In
SKYLINKConnection.h
preferredAudioCodec
Preferred audio codec used @description Default is OPUS
@property (nonatomic, assign) SKYLINKAudioCodec preferredAudioCodec
Declared In
SKYLINKConnection.h
preferredVideoCodec
Preferred video codec info used @description Default is info with name kRTCVideoCodecVp8Name
@property (nonatomic, assign) SkylinkVideoCodec preferredVideoCodec
Declared In
SKYLINKConnection.h
reconnectAttempts
xxx @description Default is -1 which is infinite, if you don’t want to reconnect, set it to 0
@property (nonatomic, assign) NSInteger reconnectAttempts
Declared In
SKYLINKConnection.h
reconnectionDelay
xxx @description This should be positive value, otherwise it will be set to 0
@property (nonatomic, assign) CGFloat reconnectionDelay
Declared In
SKYLINKConnection.h
preferredTransport
xxx @description xxx
@property (nonatomic, assign) SocketIOTransport preferredTransport
Declared In
SKYLINKConnection.h
maxVideoUser
xxx @description xxx
@property (nonatomic, assign) NSInteger maxVideoUser
Declared In
SKYLINKConnection.h
localVideoQuality
set quality of local video from 1 to 5 @description default value is 3
@property (nonatomic, assign) NSInteger localVideoQuality
Declared In
SKYLINKConnection.h
– getTimeoutWithEventType:
Get the timeout value for an action
- (CGFloat)getTimeoutWithEventType:(SkylinkAction)skylinkAction
Parameters
skylinkAction |
A pre-defined action like send file request action |
---|
Return Value
The timeout limit
Declared In
SKYLINKConnection.h
– setTimeout:skylinkAction:
Set the timeout value for an action
- (void)setTimeout:(CGFloat)timeout skylinkAction:(SkylinkAction)skylinkAction
Parameters
timeout |
The timeout limit |
---|---|
skylinkAction |
A pre-defined action like send file request action |
Declared In
SKYLINKConnection.h
– setAudioVideoReceiveConfig:
Set config for receive media
- (void)setAudioVideoReceiveConfig:(AudioVideoConfig)audioVideoConfig
Parameters
audioVideoConfig |
Configuration of receive media |
---|
Declared In
SKYLINKConnection.h
– setAudioVideoSendConfig:
Set config for send media
- (void)setAudioVideoSendConfig:(AudioVideoConfig)audioVideoConfig
Parameters
audioVideoConfig |
Configuration of send media |
---|
Declared In
SKYLINKConnection.h
– getMaxRemotePeersConnectedWithAudioVideoConfig:
Get max allowed peers in a room by the config
- (NSInteger)getMaxRemotePeersConnectedWithAudioVideoConfig:(AudioVideoConfig)audioVideoConfig
Parameters
audioVideoConfig |
The config whether the room is audio or video, etc. |
---|
Return Value
The max peer count
Declared In
SKYLINKConnection.h
– setMaxRemotePeersConnected:audioVideoConfig:
Set max allowed peers in a room by the config
- (void)setMaxRemotePeersConnected:(NSInteger)maxPeersConnected audioVideoConfig:(AudioVideoConfig)audioVideoConfig
Parameters
maxPeersConnected |
Max allowed peers in the room |
---|---|
audioVideoConfig |
The config whether the room is audio or video, etc. |
Declared In
SKYLINKConnection.h
– setAdvancedOptionWithKey:value:
Optional configuration for advanced users.
- (void)setAdvancedOptionWithKey:(null_unspecified NSString *)key value:(null_unspecified id)value
Parameters
key |
the key |
---|---|
value |
the bool value |
Discussion
The key and associated settings values which you can get from Temasys support
Declared In
SKYLINKConnection.h