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 |
|---|---|
peerVideoDidPause iOS, macOS | Invoked when a peer's video is paused |
peerVideoDidResume iOS, macOS | 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 |
|---|---|
peersVideoDidUpdate iOS, macOS | Invoked when one or more peers' video is paused or resumed. - When a peer's video is paused, the PlanetKitVideoState iOS, macOS 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.
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 iOS, macOS 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. |
Interface changes
The following changes have been made to the APIs related to the video pause event.
| SDK version | 1-to-1 call | Group call |
|---|---|---|
| PlanetKit 4.4 or higher | peerVideoDidPausepeerVideoDidResume | peersVideoDidUpdate |
| PlanetKit 4.3 | evtPeerVideoPausedevtPeerVideoResumed | evtPeerVideoPausedevtPeerVideoResumed |
| PlanetKit 4.2 or lower | evtPeerUpdated | evtPeerUpdated |
Up to PlanetKit 4.3, in a group call, the shareVideoPause property (default value is true) in the conference parameter must be set to false to disable sharing the user's own video pause status with others. The shareVideoPause property has been removed since PlanetKit 4.4.