sdk/com.cygnusreach/IRemoteSupportClientJava

IRemoteSupportClientJava

interface IRemoteSupportClientJava : Closeable

Java interop methods for com.cygnusreach.IRemoteSupportClient

Functions

addScreenSharingAsync

abstract fun addScreenSharingAsync(configuration: ScreenFormat): Future<Boolean>

Share the app screen with the remote peer. Only one screen sharing session may be active

addVideoStreamAsync

abstract fun addVideoStreamAsync(videoStreamConfiguration: CameraFormat): Future<Boolean>

Add a video stream to the remote support session. The stream must be added before the session is started.

abstract override fun close()

connectToSupportSessionAsync

abstract fun connectToSupportSessionAsync(pin: String): Future<Unit>

Wrapper functions for use in the Java Implementation. Connects to an existing remote support session with the given pin

initiateSupportSessionAsync

abstract fun initiateSupportSessionAsync(): Future<String?>

Wrapper functions for use in the Java Implementation. Initiates a new remote support session and returns the pin

sendCommandAsync

abstract fun sendCommandAsync(cmd: Command): Future<JavaCommandReceipt>

Wrapper functions for use in the Java Implementation. Adds the given Command to the outgoing message queue.

sendNotificationAsync

abstract fun sendNotificationAsync(notif: Notification): Future<Unit>

Wrapper functions for use in the Java Implementation. Adds the given Notification to the outgoing message queue.

sendQueryAsync

abstract fun sendQueryAsync(query: Query): Future<JavaQueryReceipt>

Wrapper functions for use in the Java Implementation. Adds the given Query to the outgoing message queue.

setOnCommandHandler

abstract fun setOnCommandHandler(handler: ICommandReceivedEventHandler)

Handle incoming command events

setOnConnectFromHandler

abstract fun setOnConnectFromHandler(handler: IConnectEventHandler)

Handle connect events

setOnDisconnectFromHandler

abstract fun setOnDisconnectFromHandler(handler: IDisconnectEventHandler)

Handle disconnect events

setOnLocalMediaStream

abstract fun setOnLocalMediaStream(handler: ILocalMediaStreamEventHandler<JavaCameraStreamController>)

Handle media stream creation events

setOnNotificationHandler

abstract fun setOnNotificationHandler(handler: INotificationReceivedEventHandler)

Handle incoming notification events

setOnQueryHandler

abstract fun setOnQueryHandler(handler: IQueryReceivedEventHandler)

Handle incoming query events

setOnScreenCapture

abstract fun setOnScreenCapture(handler: ILocalMediaStreamEventHandler<JavaScreenCaptureController>)

Handle screen capture events

Properties

clientConnectionState

abstract val clientConnectionState: RemoteSupportClientConnectionState

Client connection state