takeSnapshotEx abstract method

Future<void> takeSnapshotEx({
  1. required RtcConnection connection,
  2. required int uid,
  3. required String filePath,
})

Takes a snapshot of a video stream using connection ID.

This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.

  • connection The connection information. See RtcConnection.
  • uid The user ID. Set uid as 0 if you want to take a snapshot of the local user's video.
  • filePath The local path (including filename extensions) of the snapshot. For example: Windows: C:\Users<user_name>\AppData\Local\Agora<process_name>\example.jpg iOS: /App Sandbox/Library/Caches/example.jpg macOS: ～/Library/Logs/example.jpg Android: /storage/emulated/0/Android/data/

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.

Implementation

Future<void> takeSnapshotEx(
    {required RtcConnection connection,
    required int uid,
    required String filePath});