SkylinkConnection

Duration in hours after the start time when the room will be closed by the signalling server.

Call this method to accept the file share request from a remote peer. This can be only process if config has file transfer

Call this method to cancel the file share request from/to a remote peer. Note: This function is not yet supported in Skylink v2.0.0

Change the state of the local media and notifies all the peers in the room, including mute/unmute, stop/start the media.

For MUTED: mute the local media, however, black frames will still be transferred to the remote peers. For e.g. remote peer will receive black frame video from self peer

For STOPPED: stops the local media resource like media capturer, so no media content will be captured or transferred to the remote peers. When media is toggled to stopped, media device is accessible by other apps, for e.g. camera can be used to take pictures by other apps. Toggling media off and on is a little bit slower than muting and unmuting

Method will trigger errorCallback.onError if an error occurs, for e.g. with: MEDIA_STATE_CHANGE_FAILED if local media is not available.

Clears all properties of SkylinkConnection instance, including services, config and media objects SkylinkConnection instance remains (not set to null), as per Singleton pattern. It should not be done if SkylinkConnection is expected to continue to operate in the current configuration. This should be called when SkylinkConnection is not expected to be used any more in the current application, or if the user wants to apply a different SkylinkConfig for the SkylinkSDK. To reuse the SkylinkConnection instance after this process, please use init(SkylinkConfig, Context, SkylinkCallback) to create a new session.

Connects to a room with the default duration of 24 hours and with the current time. Local media will not be started by this method. To create local media, call createLocalMedia(SkylinkConfig.MediaDevice, Object, SkylinkCallback). It is encouraged to use the method connectToRoom(String, Object, SkylinkCallback) If process is failed, the detail error will be return in errorCallback if it was provided and result callback onConnectToRoomFailed(String) will be triggered If process is successful, the result callback LifeCycleListener#onConnectToRoomSuccessful() will be triggered

Connects to a room using a SkylinkConnectionString that caller MUST ensure is URL safe. Local media will not be started by this method. To create local media, call createLocalMedia(SkylinkConfig.MediaDevice, Object, SkylinkCallback). If process is failed, the detail error will be return in errorCallback if it was provided and result callback onConnectToRoomFailed(String) will be triggered If process is successful, the result callback LifeCycleListener#onConnectToRoomSuccessful() will be triggered.

Create local media using the provided SkylinkConfig.MediaDevice Valid condition for the process are: - SkylinkConfig allows to send it. - Media of the same SkylinkMedia.MediaType as SkylinkConfig.MediaDevice is not currently started. Media will be started by default the SDK that matches the SkylinkConfig.MediaDevice provided.

If successful, local media object will be returned in the callback onCreateLocalMedia(SkylinkMedia)

Create local media using the provided SkylinkConfig.MediaDevice Valid condition for the process are: - SkylinkConfig allows to send it. - Media of the same SkylinkMedia.MediaType as SkylinkConfig.MediaDevice is not currently started. Media will be started by default the SDK that matches the SkylinkConfig.MediaDevice provided. If mediaDevice is an VideoDevice, user can input desired width, desired height and desired frameRate for the local video The SDK will try to create the media that most fit the desired input dimension from the user, but sometimes the actual media will be different from the input as WebRTC will adjust the video resolution automatically.

Default values from SkylinkConfig will be used if: - For width or height: If any of them has a negative value, both will get default values. - Fps has a negative value.

If successful, local media object will be returned in the callback onCreateLocalMedia(SkylinkMedia)

Create local media using the provided SkylinkConfig.MediaDevice Valid condition for the process are: - SkylinkConfig allows to send it. - Media of the same SkylinkMedia.MediaType as SkylinkConfig.MediaDevice is not currently started. If a custom VideoCapturer is desired, provide an implementation of VideoCapturer. Otherwise, by default the SDK will provide an appropriate VideoCapturer that matches the SkylinkConfig.MediaDevice provided.

If mediaDevice is an VideoDevice, user can input desired width, desired height and desired frameRate for the local video The SDK will try to create the media that most fit the desired input dimension from the user, but sometimes the actual media will be different from the input as WebRTC will adjust the video resolution automatically.

Default values from SkylinkConfig will be used if: - For width or height: If any of them has a negative value, both will get default values. - Fps has a negative value.

If successful, local media object will be returned in the callback onCreateLocalMedia(SkylinkMedia)

Destroy a specific local media object by media id Result will be informed in onDestroyLocalMedia(SkylinkMedia) if local media is removed successfully OR onReceiveWarning(SkylinkError, HashMap) if local media can not be removed or any error occurs

The destroyed media object is not actually removed from SDK, but the media track is disposed and media state is changed to UNAVAILABLE

Disconnects from the room we are currently in, all local media and SkylinkConnection instance are still kept locally

Once disconnect is complete, onDisconnectFromRoom(SkylinkEvent, String) will be triggered.

To reconnect to the room after this, connectToRoom(String, Object, SkylinkCallback) will have to be called. To start a new SkylinkConnection or change the config, call init(SkylinkConfig, Context, SkylinkCallback) and connectToRoom(String, Object, SkylinkCallback)

Get the possible capture format(s) of the specified camera device in an array. Return null if current VideoDevice is not a defined camera, or if it was not possible to get the capture formats.

Get the CameraEnumerator to use. If Camera2 is supported, use Camera2Enumerator. Otherwise use Camera1Enumerator.

Get the actual Android camera name for the given SkylinkConfig.VideoDevice.

Get the name of the current camera being used. If no camera or if a custom VideoCapturer is being used, return null.

Return the SkylinkCaptureFormat that is currently being used by the camera. Note that the current CaptureFormat may change whenever the video resolution dimensions change.

Get the current VideoDevice being used. If none are active, return null.

Get the encryption secret map set in the SDK, if any.

Get the current resolution of the input video being captured by the local camera or local screen and the SkylinkCaptureFormat used. If resolution is available, it will be returned in onObtainInputVideoResolution(int, int, int, SkylinkCaptureFormat) asynchronously Note: - Resolution may not always be available, e.g. if no video is captured or mediaId provided is not existing - This might be different from the resolution of the video actually sent to Peers as WebRTC may adjust resolution dynamically to try to match its bandwidth criteria.

Get our PeerId, or return null if not available. Before connecting to the room, the returned result will be "SelfPeer" After connecting to the room, the returned result will be specific self peer id that was generated by the server

Return a String array of PeerIds of connected Peers, including selfPeer. Size of array is number of Peers connected, including self. PeerId of the local user (i.e. ourselves) is "SelfPeer" if we do not yet have a room based PeerId, for e.g. when we are not connected to the room.

Request for the instantaneous receiving transfer speed(s) of a remote media track, at the moment of request. It is calculated from the WebRTC provided statistics of the specified media track, over a short time interval. Result will be delivered via callback onReceiveTransferSpeed(double)

Get the current resolution of the video received from a specific Peer. If resolution is available, it will be returned in onObtainReceivedVideoResolution(int, int, int) asynchronously Note: - Resolution may not always be available, e.g. if no video is received or mediaId is invalid.

Request for WebRTC statistics of the specified remote media track which we are receiving from remote peer Result will be delivered via callback onReceiveWebRtcStats(HashMap)

Provides the room ID of the room currently connected to. This is sometimes also referred to as the meeting ID.

Get the secretId of the secret to use when SDK needs to perform encryption.

Request for the instantaneous sending transfer speed(s) of a local media track to a specific remote peer, at the moment of request. It is calculated from the WebRTC provided statistics of the specified media track, over a short time interval. Result will be delivered via callback onReceiveTransferSpeed(double)

Get the current resolution of the video being sent to a specific Peer. If resolution is available, it will be returned in onObtainSentVideoResolution(int, int, int) asynchronously Note: - Resolution may not always be available, e.g. if no video is sent or remote peer id is invalid. - This might be different from the resolution of the video actually captured by camera as WebRTC may adjust resolution dynamically to try to match its bandwidth criteria.

Request for WebRTC statistics of the specified local media track which streams to a specific remote peer Result will be delivered via callback onReceiveWebRtcStats(HashMap)

Get a specific SkylinkMedia based on mediaId, applied for both local and remote media

Get a list of SkylinkMedia objects based on media type and peer id

Gets the current SkylinkState of the current SkylinkConnection instance.

Gets the version of this Skylink SDK for Android as a String, for e.g. "0.9.8".

Get the current list of message(s) stored on server. Notes: - To use this function, Persistent Message must be active on Temasys console. - Each message stored correspond to a message sent successfully with setMessagePersist(boolean) or the corresponding API from other Skylink SDKs.

Retrieves the UserInfo object of a Peer, including user data.

Initialize a SkylinkConnection instance with the specified parameters. Any Listeners set before will be removed (i.e. set to null). Any media resources was used before will be removed to start a new session. Can only be done while disconnected from room.

Checks if logging is enabled for SDK.

Checks whether the next public server message sent should be persisted, as described at setMessagePersist(boolean).

Check the SDK currently supports for multitracks or not.

Checks if we are currently performing recording. Notes: - Recording status may change immediately after query. - If recording was on and we just tried to stop recording, it would be considered as recording is still on, even if the Recording Server had stopped recording, but whose signal had yet to reach us. This is to avoid accidental recording of unintended material when a user believed that recording had stopped before it actually does.

Checks if the room is locked.

Locks the room if it is not locked

Process Android Intent based permission result received by App via Android callback android.app.Activity#onActivityResult(int, int, Intent). The permission request may or may not have been prompted by the Skylink SDK.

• If it was, the SDK will take actions depending on whether permission requested was granted.
• If it was not, the SDK will not process the permission results and will return false. The user should then process the permission result in the App.

Process Android Runtime permission result received by App via Android callback android.app.Activity#onRequestPermissionsResult. The permission request may or may not have been prompted by the Skylink SDK.

• If it was, the SDK will take actions depending on whether permission requested was granted.
• If it was not, the SDK will not process the permission results and will return false. The user should then process the permission result in the App.

Refreshes a connection with a specific peer or all connections with peers in room. Able to indicate preference for ICE restart. ICE will only restart if both the Peers of the connection being restarted allow ICE restart. Note that when Skylink Media Relay is active: - Refresh will be done with all Peers, even if a specific remotePeerId was provided. - ICE restart will not occur, even if it was set to true.

Call this method to reject the file share request from a remote peer. This can be only process if config has file transfer

Sends a byte array to a specified remotePeer or to all remote peers in the room. The byte array cannot be null, and its maximum size is 65456 bytes.

The data transfer can only be processed if config has dataTransfer

Sends request(s) to share file with a specific remote peer or to all remote peers in the same room. Only 1 file may be sent to the same Peer at the same time. Sending and receiving concurrently with a non-Mobile (e.g. Web or C++) Peer is not supported. Filename is the actual filename sent to remote user, may differ from local filename. If filename is null, the actual filename in the filePath will be used.

The file transfer can only be processed if config has fileTransfer

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. This can be only processed if config has hasP2PMessaging

Sends a user defined message to a specific remote peer or to all remote peers via a server. To send an encrypted message, ensure that a valid secret and secretId has been provided and selected via setEncryptSecretsMap(Map) and setSelectedSecretId(String). To be able to decrypt this message, the receiver must have the same secret and secretId set via their setEncryptSecretsMap(Map) or the corresponding API from other Skylink SDKs.

Sets the specified data transfer listener object.

Sets if logging should be enabled for SDK. By default, logging is disabled for released SDK. Enabling logs might be useful for debugging as the SDK will be logged in detail

Set a key value map of secretId and encryption secret for generating key for SDK encryption. Each secretId must be a unique and non-empty string. A secret with a secretId that is null or an empty string will not be used.

Sets the specified file transfer listener object.

Change the current captured video track of a specific SkylinkMedia to the specified resolution, and the specified resolution will be set into SkylinkConfig. Non-camera supported resolution can be accepted, but a camera supported resolution will be used when opening camera. There is no guarantee that a specific camera resolution will be maintained as WebRTC may adjust the resolution dynamically to match its bandwidth criteria.

Sets the specified life cycle listener object.

Sets the specified media listener object that will receive callbacks related to Media Stream.

Callbacks include those for the local user and remote peers.

Sets whether the next public server message sent should be persisted on Temasys server. For the message to be persisted (i.e. stored), all of the following are also required: - Persistent Message is active on Temasys console. - A valid secretId has been selected via setSelectedSecretId(String). - The message content was successfully encrypted.

Sets the specified messages listener object.

Sets the specified OS listener object.

Sets the specified remote peer listener object.

Set the secretId of the secret to use when SDK needs to perform encryption. Set to null to not perform encryption. No change in the SDK will occur if an empty string is provided, as that is not a valid secretId.

Start recording if conditions allows: - We must be using Skylink Media Relay. - Recording should not be already started. - We should not have just tried to start recording.

Actual start of recording will be notified via onStartRecording(String)

Stop recording if conditions allows: - We must be already be recording. - We should not have just tried to stop recording.

Actual stop of recording will be notified via onStopRecording(String)

Call this method to switch between available cameras. On successful operation, camera switched to will be delivered via callback at onReceiveInfo(SkylinkInfo, HashMap) with possible SkylinkInfo: -- CAM_OPEN_FRONT. -- CAM_OPEN_NON_FRONT.

Unlocks the room if it is already locked