public class

SkylinkConfig

extends Object
implements Serializable
java.lang.Object
   ↳ sg.com.temasys.skylink.sdk.config.SkylinkConfig

Class Overview

Configuration class used to configure the parameters of real time communication.

Summary

Nested Classes
enum SkylinkConfig.AudioVideoConfig List of enums that specify an audio video setting. 
Public Constructors
SkylinkConfig()
Creates a new SkylinkConfig object.
SkylinkConfig(SkylinkConfig config)
Creates a new SkylinkConfig (Copy constructor).
Public Methods
Map<String, Object> getAdvancedOptions()
int getTimeout()
String getTransport()
boolean hasAudioReceive()
boolean hasAudioSend()
boolean hasFileTransfer()
boolean hasPeerMessaging()
boolean hasVideoReceive()
boolean hasVideoSend()
boolean isStunDisabled()
boolean isTurnDisabled()
void setAdvancedOptions(Map<String, Object> advancedOptions)
Sets advanced options.
void setAudioVideoSendConfig(SkylinkConfig.AudioVideoConfig audioVideoConfig)
Sets the audio video send and receive flag to the indicated boolean value.
void setHasFileTransfer(boolean fileTransfer)
Sets the fileTransfer is enabled.
void setHasPeerMessaging(boolean peerMessaging)
Sets if peerMessaging is enabled.
void setTimeout(int timeout)
Sets the timeout value (in seconds) for various operations in the SDK, for e.g.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SkylinkConfig ()

Creates a new SkylinkConfig object.

public SkylinkConfig (SkylinkConfig config)

Creates a new SkylinkConfig (Copy constructor).

Parameters
config Configuration object with settings to copy from.

Public Methods

public Map<String, Object> getAdvancedOptions ()

Returns
  • Map of Advanced Options.

public int getTimeout ()

Returns
  • Timeout config value.

public String getTransport ()

Returns
  • transport used. Possible values are "UDP" or "TCP"

public boolean hasAudioReceive ()

Returns
  • true if receiving remote peer's audio stream is enabled

public boolean hasAudioSend ()

Returns
  • true if sending user's audio stream is enabled

public boolean hasFileTransfer ()

Returns
  • FileTransfer config value.

public boolean hasPeerMessaging ()

Returns
  • PeerMessaging config value.

public boolean hasVideoReceive ()

Returns
  • true if receiving remote peer's video stream is enabled

public boolean hasVideoSend ()

Returns
  • true if sending user's video stream is enabled

public boolean isStunDisabled ()

Returns
  • STUN is enabled or not

public boolean isTurnDisabled ()

Returns
  • TURN is enabled or not

public void setAdvancedOptions (Map<String, Object> advancedOptions)

Sets advanced options. (For advanced users only).

Parameters
advancedOptions A map containing optional entries as follows: "STUN":"boolean" or "STUN",boolean "TURN":"boolean", or "TURN":boolean "transport":"UDP" or "transport":"TCP"

public void setAudioVideoSendConfig (SkylinkConfig.AudioVideoConfig audioVideoConfig)

Sets the audio video send and receive flag to the indicated boolean value.

Parameters
audioVideoConfig Audio video send config value

public void setHasFileTransfer (boolean fileTransfer)

Sets the fileTransfer is enabled.

Parameters
fileTransfer FileTransfer config value

public void setHasPeerMessaging (boolean peerMessaging)

Sets if peerMessaging is enabled.

Parameters
peerMessaging PeerMessaging config value

public void setTimeout (int timeout)

Sets the timeout value (in seconds) for various operations in the SDK, for e.g. file transfer waiting time for remote peer's response.

Parameters
timeout Timeout config value

public String toString ()