java.lang.Object | |
↳ | sg.com.temasys.skylink.sdk.rtc.SkylinkConnection |
Main class to connect to the skylink infrastructure.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
SkylinkConnection.ConnectionState | List of Connection state types |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | API_SERVER | ||||||||||
int | DEFAULT_DURATION | Duration in hours after the start time when the room will be closed by the signalling server. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Connects to a room with SkylinkConnectionString
| |||||||||||
Connects to a room with the default duration of 24 hours and with the current time
It is encouraged to use the method connectToRoom(String connectionString, Object userData)
| |||||||||||
Disconnects from the room we are currently in.
| |||||||||||
Retrieves the user defined data object associated with a remote peer.
| |||||||||||
Creates a new SkylinkConnection object with the specified parameters.
| |||||||||||
Mutes the local user's audio and notifies all the peers in the room.
| |||||||||||
Mutes the local user's video and notifies all the peers in the room.
| |||||||||||
Sends request(s) to share file with a specific remote peer or to all remote peers in a direct
peer to peer manner in the same room.
| |||||||||||
Call this method to accept or reject the file share request from a remote peer.
| |||||||||||
Sends local user data related to oneself, to all remote peers in our room.
| |||||||||||
Sends a user defined message to a specific remote peer or to all remote peers in a direct
peer to peer manner.
| |||||||||||
Sends a user defined message to a specific remote peer or to all remote peers via a server.
| |||||||||||
Sets the specified file transfer listener object.
| |||||||||||
Sets the specified life cycle listener object.
| |||||||||||
Sets the specified media listener object that will receive callbacks related to Media
Stream.
| |||||||||||
Sets the specified messages listener object.
| |||||||||||
Sets the specified remote peer listener object.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Duration in hours after the start time when the room will be closed by the signalling server.
Connects to a room with SkylinkConnectionString
skylinkConnectionString | SkylinkConnectionString Generated with room name, apiKey, secret, startTime and duration |
---|---|
userData | User defined data relating to oneself. May be a 'java.lang.String', 'org.json.JSONObject' or 'org.json.JSONArray'. |
Connects to a room with the default duration of 24 hours and with the current time It is encouraged to use the method connectToRoom(String connectionString, Object userData)
secret | The secret associated with the key as registered with the Skylink Developer Console |
---|---|
roomName | The name of the room |
userData | User defined data relating to oneself. May be a 'java.lang.String', 'org.json.JSONObject' or 'org.json.JSONArray'. |
Disconnects from the room we are currently in.
Retrieves the user defined data object associated with a remote peer.
remotePeerId | The id of the remote peer whose data is to be retrieved. |
---|
Creates a new SkylinkConnection object with the specified parameters.
apiKey | The api key from the Skylink Developer Console |
---|---|
config | The SkylinkConfig object to configure the type of call. |
context | The application context |
Mutes the local user's audio and notifies all the peers in the room.
isMuted | Flag that specifies whether audio should be mute |
---|
Mutes the local user's video and notifies all the peers in the room.
isMuted | Flag that specifies whether video should be mute |
---|
Sends request(s) to share file with a specific remote peer or to all remote peers in a direct peer to peer manner in the same room.
remotePeerId | The id of the remote peer to send the file to. Use 'null' if the file is to be broadcast to all remote peers in the room. |
---|---|
fileName | The name of the file that is to be shared. |
filePath | The absolute path of the file in the filesystem |
Call this method to accept or reject the file share request from a remote peer.
remotePeerId | The id of the remote peer that requested to share with us a file. |
---|---|
filePath | The absolute path of the file where we want it to be saved. |
isPermitted | Whether permission was granted for the file share to proceed. |
Sends local user data related to oneself, to all remote peers in our room.
userData | User defined data relating to the peer. May be a 'java.lang.String', 'org.json.JSONObject' or 'org.json.JSONArray'. |
---|
Sends a user defined message to a specific remote peer or to all remote peers in a direct peer to peer manner.
remotePeerId | Id of the remote peer to whom we will send a message. Use 'null' if the message is to be broadcast to all remote peers in the room. |
---|---|
message | User defined data. May be a 'java.lang.String', 'org.json.JSONObject' or 'org.json.JSONArray'. |
SkylinkException | if the system was unable to send the message. |
---|
Sends a user defined message to a specific remote peer or to all remote peers via a server.
remotePeerId | Id of the remote peer to whom we will send a message. Use 'null' if the message is to be broadcast to all remote peers in the room. |
---|---|
message | User defined data. May be a 'java.lang.String', 'org.json.JSONObject' or 'org.json.JSONArray'. |
Sets the specified file transfer listener object.
fileTransferListener | The file transfer listener object that will receive callbacks related to FileTransfer |
---|
Sets the specified life cycle listener object.
lifeCycleListener | The life cycle listener object that will receive callbacks related to the SDK's Lifecycle. |
---|
Sets the specified media listener object that will receive callbacks related to Media Stream.
Callbacks include those for the local user and remote peers.mediaListener | The media listener object |
---|
Sets the specified messages listener object.
messagesListener | The messages listener object that will receive callbacks related to Message Transmissions. |
---|
Sets the specified remote peer listener object.
remotePeerListener | The remote peer listener object that will receive callbacks related to the RemotePeer. |
---|