SnapshotConfig

Struct used to configure video screenshots.

struct SnapshotConfig {
  const char* filePath;
  media::base::VIDEO_MODULE_POSITION position;
};

Properties

filePath
Note: Make sure the specified path exists and is writable.
Local path of the screenshot (including file extension). 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/<package name>/files/example.jpg.
position
Position of the video frame in the video processing pipeline where the screenshot is taken. See VIDEO_MODULE_POSITION.