Presentation - Screen share
Presentation means sharing a screen of a user (presenter) to show a material such as slides to the other call peers. This page describes how to use the presentation function based on the call type.
| Supported call type | Minimum SDK version |
|---|---|
| 1-to-1 call, group call (conference) | WebPlanetKit 3.1 |
PlanetKit supports HD video for presentations, so clients must have good network conditions. For more information, see the recommended bandwidth.
1-to-1 call presentation
To start or end a presentation in a 1-to-1 call, use startMyScreenShare() or stopMyScreenShare() of Call.
Related APIs
The following table shows APIs related to screen share in a 1-to-1 call, where a counterpart means a peer to whom to show the presentation.
| Presenter-side API | Description | Counterpart-side API | Description |
|---|---|---|---|
startMyScreenShare() | Starts screen share by a presenter | evtPeerScreenShareStarted of MakeCallDelegateevtPeerScreenShareStarted of VerifyCallDelegate | Screen share by a presenter has been started |
| - | - | addPeerScreenShareView() | Sets a view instance created by an application |
stopMyScreenShare() | Ends screen share by the presenter | evtPeerScreenShareStopped of MakeCallDelegateevtPeerScreenShareStopped of VerifyCallDelegate | Screen share by the presenter has been stopped |
| - | - | removePeerScreenShareView() | Removes the view instance before release |
After being notified by evtPeerScreenShareStarted that a presentation has started, the counterpart side must create a view instance and call addPeerScreenShareView() to let PlanetKit render the shared screen.
The presentation video data is automatically streamed to the peer.
1-to-1 call presentation flow
The following diagram shows the flow for starting a presentation in 1-to-1 calls.
The following diagram shows the flow for stopping a presentation in 1-to-1 calls.
Unlike native PlanetKit, WebPlanetKit does not support a function to deliver the reason for stopping screen share.
Group call presentation
To start or end a presentation in a group call, use startMyScreenShare() or stopMyScreenShare() of Conference.
Related APIs
The following table shows APIs related to screen share in a group call, where counterparts mean participants in a group call to whom to show the presentation.
| Presenter-side API | Description | Counterpart-side API | Description |
|---|---|---|---|
startMyScreenShare() | Starts screen share by a presenter | evtPeerScreenShareStarted | Screen share by a presenter has been started |
| - | - | addPeerScreenShareView() | Sets a view instance created by an application |
stopMyScreenShare() | Ends screen share by the presenter | evtPeerScreenShareStopped | Screen share by the presenter has been stopped |
| - | - | removePeerScreenShareView() | Removes the view instance before release |
After being notified by evtPeerScreenShareStarted that a presentation has started, the counterpart must create a view instance and call addPeerScreenShareView() to let PlanetKit render the shared screen.
Group call presentation flow
The following diagram shows the flow for starting a presentation in group calls.
The following diagram shows the flow for stopping a presentation in group calls.
The following diagram shows the flow for a user who joined after a presentation started in a group call.
