takeSnapshotWithConfigEx abstract method

Future<void> takeSnapshotWithConfigEx({
  1. required RtcConnection connection,
  2. required int uid,
  3. required SnapshotConfig config,
})

Takes a video snapshot at the specified observation point using the connection ID.

This method takes a snapshot of the specified user's video stream, generates a JPG image, and saves it to the specified path. This method is asynchronous. When the call returns, the SDK has not actually captured the snapshot. When used for local video snapshot, it captures the video stream specified in ChannelMediaOptions. If the user's video has undergone preprocessing, such as watermarking or beautification, the snapshot will include these effects.

  • connection Connection information. See RtcConnection.
  • uid User ID. Set to 0 to capture the local user's video.
  • config Snapshot configuration. See SnapshotConfig.

Returns When the method call succeeds, there is no return value; when fails, the AgoraRtcException exception is thrown. You need to catch the exception and handle it accordingly. See Error Codes for details and resolution suggestions.

Implementation

Future<void> takeSnapshotWithConfigEx(
    {required RtcConnection connection,
    required int uid,
    required SnapshotConfig config});