Documentation
Flexible Classroom
Agora.io Community
English
search-icon
Screenshare Context
Last updated 2021/06/15 12:45:03

ScreenShareContext

ScreenShareContext provides the methods that can be called by your app for screen sharing.

setScreenShareState

abstract fun setScreenShareState(sharing: Boolean)

Start or stop screen sharing.

Parameter Description
sharing Whether to start screen sharing.

renderScreenShare

abstract fun renderScreenShare(container: ViewGroup?, streamUuid: String)

Start or stop rendering the screen-sharing stream.

Parameter Description
container The video container. Setting viewGroup as null means stopping rendering the video stream.
streamUuid The stream ID.

IScreenShareHandler

IScreenShareHandler reports screen-sharing-related event callbacks to your app.

onScreenShareStateUpdated

fun onScreenShareStateUpdated(sharing: Boolean, streamUuid: String)

Occurs when the state of screen sharing is updated.

Parameter Description
sharing Whether the screen is being shared.
streamUuid The stream ID.

onScreenShareTip

fun onScreenShareTip(tips: String)

Displays tips related to screen sharing.

There are the following tips:

  • User A has started screen sharing.
  • User A has stopped screen sharing.
Parameter Description
tips The tip.