Video pause event
LINE Planet generates events when a peer's video is paused or resumed.
| Supported call type | Minimum SDK version |
|---|---|
| 1-to-1 call, group call (conference) | 1-to-1 call: 0.8 Group call: 0.9 |
1-to-1 call
In 1-to-1 calls, the following event callbacks are invoked when a peer's video is paused or resumed.
| Event callback | Description |
|---|---|
onPeerVideoPaused | Invoked when a peer's video is paused |
onPeerVideoResumed | Invoked when a peer's video is resumed |
Group call
In group calls, the following event callback is invoked when a peer's video is paused or resumed.
| Event callback | Description |
|---|---|
onVideoUpdate of PlanetKitPeerControlHandler | Invoked when a peer's video is paused or resumed. - When a peer's video is paused, the PlanetKitVideoState of the peer is paused.- When a peer's video is resumed, the PlanetKitVideoState of the peer is enabled. |
Video pause reason
A video stream can be paused for various reasons, such as a user choosing to pause the video or the camera being disabled.
The reason for video pause is delivered in the event callback when video is paused. The PlanetKitVideoPauseReason enum defines the following reasons for video pause.
| Enum constant | Description |
|---|---|
user | When a peer calls pauseMyVideo() |
interrupt | When the app enters background status |
enableVideoResponse | (Only for 1-to-1 calls) When the peer has set the response type to pause and the user makes a request for enabling a video call. For more information, refer to Enable video call from audio call. |
cameraInactive | When the camera device is being disabled |
hold | When a peer calls hold(). For more information, refer to Hold. |
Related API
APIs related to video pause events are as follows.
Enums
1-to-1 call
Methods
Events
Group call
Methods
-
pauseMyVideo()ofPlanetKitConference -
resumeMyVideo()ofPlanetKitConference -
hold()ofPlanetKitConference