snapshotTaken property

SnapshotTakenCallback? snapshotTaken
getter/setter pair

Reports the result of taking a video snapshot.

Since v4.2.0

After a successful RtcEngine.takeSnapshot method call, the SDK triggers this callback to report whether the snapshot is successfully taken as well as the details for the snapshot taken.

The SnapshotTakenCallback typedef includes the following parameters:

Parameter channel The channel name.

Parameter uid The user ID of the user. A uid of 0 indicates the local user.

Parameter filePath The local path of the snapshot.

Parameter width The width (px) of the snapshot.

Parameter height The height (px) of the snapshot.

Parameter errCode The message that confirms success or the reason why the snapshot is not successfully taken:

  • 0: Success.
  • < 0: Failure.
    • -1: The SDK fails to write data to a file or encode a JPEG image.
    • -2: The SDK does not find the video stream of the specified user within one second after the RtcEngine.takeSnapshot method call succeeds.

Implementation

SnapshotTakenCallback? snapshotTaken;