SnapshotConfig

The snapshot configuration.

struct SnapshotConfig {
  const char* filePath;

  media::base::VIDEO_MODULE_POSITION position;
  SnapshotConfig() :filePath(NULL), position(media::base::POSITION_PRE_ENCODER) {}
};

Attributes

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/<package name>/files/example.jpg
Attention: Ensure that the path you specify exists and is writable.
position
The position of the snapshot video frame in the video pipeline. See VIDEO_MODULE_POSITION.