Agora RTC Objective-C API Reference  Refactor
Data Fields
SnapshotConfig Struct Reference

Data Fields

const char * filePath
 
media::base::VIDEO_MODULE_POSITION position
 

Constructor & Destructor Documentation

◆ SnapshotConfig()

SnapshotConfig ( )
inline

Field Documentation

◆ filePath

const char* 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
    Note
    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.