SnapshotConfig

The snapshot configuration.

class SnapshotConfig {
  const SnapshotConfig({this.filePath, this.position});

  @JsonKey(name: 'filePath')
  final String? filePath;

  @JsonKey(name: 'position')
  final VideoModulePosition? position;

  factory SnapshotConfig.fromJson(Map<String, dynamic> json) =>
      _$SnapshotConfigFromJson(json);

  Map<String, dynamic> toJson() => _$SnapshotConfigToJson(this);
}

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 VideoModulePosition.