SnapshotConfig

Video snapshot settings.

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

Properties

filePath
Note: Make sure the directory exists and is writable.
Local path to save the snapshot, including file name and format. For example:
  • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg
  • macOS: ～/Library/Logs/example.jpg
position
The position of the video frame in the video pipeline for the snapshot. See VideoModulePosition.