SkylinkConfig

Default maximum number of messages that will be cached per Skylink Room

Default Frame rate: 30 fps

Default maximum bandwidth in kbps allowed for audio: -1 Negative value means that by default audio is not subjected to a maximum bandwidth.

Default maximum bandwidth in kbps allowed for data: -1 Negative value means that by default data bitrate is not subjected to a maximum bandwidth.

Default maximum bandwidth in kbps allowed for video: 512

Default maximum number of video can be handled for mobile device

Full HD Video Height: 1080

HD Ready Video Height: 720

QVGA Video Height: 240

VGA Video Height: 480

Default number of milliseconds to wait before automatically calling video resolution check again.

Default number of times that video resolutions check return the same resolutions to consider that video resolutions as stable.

Full HD Video Width: 1920

HD Ready Video Width: 1280

QVGA Video Width: 320

VGA Video Width: 640

Creates a new SkylinkConfig object.

Create a SkylinkConfig instance that has the exact same properties as that of the provided SkylinkConfig object.

Add a new device model that is not supporting hardware echo cancellation to the black list If the device model is added into the list, SDK will disable hardware echo cancellation on that model and use software echo cancellation instead

Gets the Map of setting advanced options.

Get the maximum bandwidth in kbps allowed for audio. Negative value indicates that no maximum bandwidth will be imposed.

Get the approximate maximum bandwidth in kbps allowed for data. Negative value indicates that no maximum bandwidth will be imposed.

Gets the maximum number of remote Peers that we can connect to at one time. Notes: - Use NO_AUDIO_NO_VIDEO for chat/file transfer/ data transfer, AUDIO_ONLY for allowing only audio, VIDEO_ONLY for allowing only video, AUDIO_AND_VIDEO for allowing both audio and video. - VIDEO_ONLY and AUDIO_AND_VIDEO can be considered similarly for getting max peers - Default max peers (if not set) for NO_AUDIO_NO_VIDEO is 16, Default max peers (if not set) for AUDIO_ONLY is 8, Default max peers (if not set) for VIDEO_ONLY is 4, Default max peers (if not set) for AUDIO_AND_VIDEO is 4,

Get the maximum bandwidth in kbps allowed for video. Negative value indicates that no maximum bandwidth will be imposed.

Get the maximum number of videos can be handled for mobile devices

Gets maximum number of messages that will be cached per Skylink Room.

First SkylinkConfig.SocketTransport to be tried when connecting to room. Default value is WEBSOCKET.

The maximum number of times to try to reconnect to room if reconnection is allowed. If allowed, the SDK automatically tries to reconnect to room in following situations: - Connect to room attempt fails, - Disconnected from room unexpectedly. Default value is -1. If value = 0, no reconnection will be done. If value < 0, max reconnection attempt is taken to be infinite.

The minimum delay in ms before trying next reconnection. Default value is 1000. If value <= 0, no delay will be used between reconnections.

Get current SkylinkRoomSize

Get maximum time (ms) allowed for each action before the action is terminated and/or considered as failed. if not set before, return the default timeout Following are the timeout values for each SkylinkConfig.SkylinkAction used for setting timeouts: FILE_SEND_REQUEST - Default: 60,000 - If value <= 0, default value will be used. CONNECT_TO_ROOM - Default: 0 - If value <= 0, no timeout will be set. GET_MESSAGE_STORED - Default: 30,000 - If value <= 0, no timeout will be set.

Get the list of devices models that do not support hardware echo cancellation from user setting in addUnsupportedAECModel(String)

Get the value that setVideoResNumCheckStable(int) would set.

Get the value that setVideoResNumWaitMs(int) would set.

Check if audio auto gain control by WebRTC is enabled. Enabled by default.

Check if audio echo cancellation by WebRTC is enabled. Enabled by default.

Check if audio high pass filter by WebRTC is enabled. Enabled by default.

Check if audio noise suppression by WebRTC is enabled. Enabled by default.

Checks if HOST candidates are allowed in Peer handshake.

Checks whether we allow ICE restart to occur. Note that ICE restart will occur ONLY if: - Both Peers involved in the connection allow it. - It was requested it in the refreshPeerConnection API call. Default is true. Note that ICE restart has to be explicitly requested in refreshConnection(String, boolean, SkylinkCallback). Skylink Media Relay is not allow Ice restart even it is set to true

Checks if STUN candidates are allowed in Peer handshake.

Checks if TURN candidates are allowed in Peer handshake.

Checks if DataChannel can be enabled based on this SkylinkConfig. Note that both this SkylinkConfig and the remote Peer's SkylinkConfig need to have DataChannel enabled in order for the PeerConnection to have DataChannel enabled. DataChannel is to use P2P message, file transfer and data transfer functions

Checks whether it is allowed to use H264 High Profile when it is supported.

Checks whether it is allowed to use Intel Vp8 encoder when it is supported.

Checks whether it is allowed to use video codec hardware acceleration when it is supported.

Is message caching feature enabled?

Check if video resolutions are automatically reported as defined in setReportVideoResolutionOnVideoChange(boolean).

Check if video resolutions are automatically reported as defined in setReportVideoResolutionUntilStable(boolean).

Set key-value for advanced options that are not commonly used. the default advancedOptions can be obtained via getAdvancedOptions()

Sets whether HOST candidates are allowed or not. Default is allowed. If HOST is not allowed, HOST candidates (even if obtained) will not be used in Peer handshake.

Set whether we allow ICE restart to occur. Note that ICE restart will occur ONLY if: - Both Peers involved in the connection allow it. - It was requested it in the refreshPeerConnection API call. Default is true. Note that ICE restart has to be explicitly requested in refreshConnection(String, boolean, SkylinkCallback). Media Relay server is not allow Ice restart even it is set to true

Sets whether STUN candidates are allowed or not. Default is allowed. If STUN is not allowed, STUN candidates (even if obtained) will not be used in Peer handshake.

Sets whether TURN candidates are allowed or not. Default is allowed. If TURN is not allowed, TURN candidates (even if obtained) will not be used in Peer handshake.

Set if audio auto gain control by WebRTC should be enabled.

Set if audio echo cancellation by WebRTC should be enabled.

Set if audio high pass filter by WebRTC should be enabled.

Set if audio noise suppression by WebRTC should be enabled.

Sets if audio stereo is enabled.

Sets the audio and video (AV) receive config to the SkylinkConfig.AudioVideoConfig value. By default (if this method was not called), all AV media sent by remote Peer are received. This method can be used to not receive either audio or video, or both.

Sets the audio and video (AV) send config to the SkylinkConfig.AudioVideoConfig value. By default (if this method was not called), both Audio and Video media can be sent to remote Peers. This method can be used to not send of either audio or video, or both.

Sets if dataTransfer is enabled.

Sets the default video framerate in frames per second (FPS) at which to obtain video. Same notes at setDefaultVideoHeight(int) apply.

Sets the default video height at which to obtain video, the next time camera is started. Skylink default is VIDEO_HEIGHT_VGA (480). Notes: - Using video resolution and frame rate not supported by the active camera (device dependent) may result in unexpected video resolution and frame rate or video errors, including not being able to obtain local video. - During actual video streaming WebRTC may still modulate video resolution and frame rate, based on bandwidth available. - If camera is already started, this will not change any video dimension immediately. - Camera input video resolution can be set dynamically via setInputVideoResolution(String, int, int, int, SkylinkCallback).

Sets the default video width at which to obtain video. Skylink default is VIDEO_WIDTH_VGA (640). Same notes at setDefaultVideoHeight(int) apply.

Set whether it is allowed to use H264 High Profile when it is supported. Default value is true.

Set whether it is allowed to use Intel Vp8 encoder when it is supported. Default value is true.

Set whether it is allowed to use video codec hardware acceleration when it is supported. Default value is true.

Sets the fileTransfer is enabled.

Set the approximate maximum bandwidth in kbps allowed for audio. If not set, no bandwidth restriction will be made for audio. To not impose a limit on audio bandwidth, use a negative value.

Set the approximate maximum bandwidth in kbps allowed for data. If not set, no bandwidth restriction will be made for data. To not impose a limit on data bandwidth, use a negative value.

Sets the maximum number of remote Peers that we can connect to at one time. Notes: - Use NO_AUDIO_NO_VIDEO for chat/file transfer/ data transfer, AUDIO_ONLY for allowing only audio, VIDEO_ONLY for allowing only video, AUDIO_AND_VIDEO for allowing both audio and video. - VIDEO_ONLY and AUDIO_AND_VIDEO can be considered similarly for setting max peers - If not set, default is: 16 for room without any audio and any video, 8 for room with audio only, 4 for room with video,

Set the approximate maximum bandwidth in kbps allowed for video. If not set, default will be 512 kbps. To not impose a limit on video bandwidth, use a negative value.

Set max number of video can be handled or received/displayed on mobile devices

Enables or disables message caching feature depending on the input argument.

Sets the maximum number of messages that will be cached per Skylink Room.

Sets whether local view rendered is a mirror image of the actual video. Default is false. Notes: - Only front (and not back) camera local view will be mirrored. - This will not change (e.g. mirror) the remote video view of us as seen by a remote Peer - Will create a new GLSurfaceView (at onLocalMediaCapture) each time camera is switched. - User need to handle this new GLSurfaceView to display self video correctly.

Set if this SkylinkConfig supports multitrack in the SDK after it has been set into the SDK via SkylinkConfig at init(SkylinkConfig, Context, SkylinkCallback). To interop with SDKs that do not support multitrack, this should be set to false. If not enabled: - SDK can only create and hold at most 1 audio and 1 video local media at one time. - To have a different local media from the current existing one, user would need to remove current local media before creating the new one. If enabled: - SDK can potentially create and hold more than 1 local media type at a time, depending also on device capability. Once set into the SDK: - Changing this SkylinkConfig's value no longer affects the SDK's value. - To check SDK's value, use isMultiTrackCreateEnable(). By default, this is set as true.

Specifies customised transports for ICE candidates. Set as null (default value) to not customise transports of ICE candidates.

Sets if P2P messaging is enabled. Note that P2P messaging uses DataChannel.

Sets the preferredAudioCodec. Possible values SkylinkConfig.AudioCodec

Setter for getPreferredSocketTransport()

Setter for getReconnectAttempts()

Setter for getReconnectionDelay()

Set if video resolutions are automatically reported when video change. For local video, this includes opening and closing of camera, usage of different org.webrtc.CameraEnumerationAndroid.CaptureFormat, etc. For remote video, this includes starting of video and changes in video dimensions. By default, this is set as true. If true, the video resolution will be resulted in onObtainInputVideoResolution(int, int, int, SkylinkCaptureFormat, String) if input video resolution has been changed, onObtainReceivedVideoResolution(int, int, int, String, String) if received video resolution has been changed, onObtainSentVideoResolution(int, int, int, String, String) if sent video resolution has been changed

Set whether to automatically continue reporting the currently reported video resolutions until video resolutions (width, height, or fps) stop changing within the latest #videoResNumCheckStable number of times. By default, this is set as false.

Set room size for current connecting room

Sets the timeout value (in milli seconds) for various operations in the SDK, for e.g. file transfer waiting time for remote peer's response. If input timeout is not valid, the default value will be set instead

Set a list of unsupportedAECModels to the SDK if the user wants to input a list of the device models, not add individual item as addUnsupportedAECModel(String)

Set number of consecutive automatic checks where video resolutions remain the same whereby video resolutions is considered to be stable. The default value is given by VIDEO_RES_NUM_CHECK_STABLE.

Set number of milliseconds between consecutive automatic checks of video resolutions. The default value is given by VIDEO_RES_MS_BEFORE_CHECK.

Generate a string that show some basic parameters of this SkylinkConfig object.