Skip to main content
Version: 6.2

Video pause event

LINE Planet generates events when one or more peers pause or resume their video streams.

Supported call typeMinimum SDK version
1-to-1 call, group call (conference)PlanetKit 3.0

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 callbackDescription
onPeerVideoPausedInvoked when a peer's video is paused
onPeerVideoResumedInvoked when a peer's video is resumed

Group call

In group calls, the following event callback is invoked when one or more peers' video is paused or resumed.

Event callbackDescription
onPeersVideoUpdatedInvoked when one or more peers' video is paused or resumed.
- When a peer's video is paused, the VideoState of the peer is PAUSED.
- When a peer's video is resumed, the VideoState 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.

For both 1-to-1 calls and group calls, the reason for video pause is delivered in the event callbacks when video is paused. The PlanetKitVideoPauseReason enum defines the following reasons for video pause.

Enum constantDescription
BY_USERWhen a peer calls pauseMyVideo()
BY_INTERRUPTWhen the app enters background status
ENABLE_VIDEO_RESPONSE(Only for 1-to-1 calls) The user's video is paused after the peer enabled a video call. For more information, refer to Enable video call from audio call.
CAMERA_INACTIVEWhen the camera device is being disabled
HOLDWhen a peer calls hold(). For more information, refer to Hold.