SnapshotConfig

The snapshot configuration.

export class SnapshotConfig {
  filePath?: string;
  position?: VideoModulePosition;
}

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
  • macOS: ～/Library/Logs/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 VideoModulePosition.