Video pause event
LINE Planet generates events when one or more peers pause or resume their video streams.
| Supported call type | Minimum 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 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 one or more peers' video is paused or resumed.
| Event callback | Description |
|---|---|
OnPeersVideoUpdated | Invoked when one or more peers' video is paused or resumed. - When a peer's video is paused, the EVideoState of the peer is PLNK_VIDEO_STATE_PAUSED.- When a peer's video is resumed, the EVideoState of the peer is PLNK_VIDEO_STATE_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 EVideoPauseReason enum defines the following reasons for video pause.
| Enum constant | Description |
|---|---|
PLNK_VIDEO_PAUSE_REASON_BY_USER | When a peer calls PauseMyVideo() |
PLNK_VIDEO_PAUSE_REASON_BY_INTERRUPT | When the app enters background status |
PLNK_VIDEO_PAUSE_REASON_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. |
PLNK_VIDEO_PAUSE_REASON_CAMERA_INACTIVE | When the camera device is being disabled |
PLNK_VIDEO_PAUSE_REASON_HOLD | When a peer calls Hold(). For more information, refer to Hold. |