SDK/com.ciscowebex.androidsdk.phone.annotation/LiveAnnotations

LiveAnnotations

interface LiveAnnotations
Content copied to clipboard

Interface defining the methods related to live annotations during a screen sharing session in a specific call. The screen sharing session involves multiple participants in a meeting, and live annotations occur on the shared screen. For the presenter, the live annotation feature should be initialized when the screen share starts. A listener should be set to allow the client to listen to callbacks related to live annotation events. Any annotations made by the requester will be drawn on the presenter's annotation layer upon approval.

Since

API 3.11.0

Functions

Link copied to clipboard
abstract fun getLiveAnnotationsPolicy(): LiveAnnotationsPolicy?
Content copied to clipboard

Retrieves the current live annotations policy for the ongoing screen sharing session. The default policy is set to LiveAnnotationsPolicy.NobodyCanAnnotate.

Link copied to clipboard
abstract fun isLiveAnnotationStarted(): Boolean
Content copied to clipboard

Checks if live annotation has been started for the ongoing screen sharing session.

Link copied to clipboard
abstract fun respondToLiveAnnotationRequest(    personId: String,     didAccept: Boolean,     completionHandler: CompletionHandler<LiveAnnotationErrorCode>)
Content copied to clipboard

Allows responding to a live annotation request for the ongoing screen sharing session. This method is called when a requester asks to annotate. The annotation will start only after the presenter approves the request.

Link copied to clipboard
abstract fun setLiveAnnotationListener(listener: LiveAnnotationListener)
Content copied to clipboard

Sets a live annotation listener for the ongoing screen sharing session. This enables the presenter to listen for live annotation events and respond accordingly.

Link copied to clipboard
abstract fun setLiveAnnotationsPolicy(policy: LiveAnnotationsPolicy, completionHandler: CompletionHandler<LiveAnnotationErrorCode>)
Content copied to clipboard

Sets the live annotations policy for the ongoing screen sharing session. The default policy is set to LiveAnnotationsPolicy.NobodyCanAnnotate.

Link copied to clipboard
abstract fun stopLiveAnnotations()
Content copied to clipboard

Stops live annotations for the ongoing screen sharing session. This method also handles the cleaning process internally, which includes removing the annotation layer.