AgoraSnapshotConfig Class Reference

Inherits <NSObject>.

Properties
NSString *_Nullable	filePath
AgoraVideoModulePosition	position

Property Documentation

filePath

- (NSString* _Nullable) filePath

readwritenonatomiccopy

The local path (including filename extensions) of the snapshot. For example:

• iOS: /App Sandbox/Library/Caches/example.jpg

  Note

  Ensure that the path you specify exists and is writable.

position

- (AgoraVideoModulePosition) position

readwritenonatomicassign

The position of the snapshot video frame in the video pipeline. See AgoraVideoModulePosition. Allowed values vary depending on the uid parameter passed in takeSnapshotWithConfig:config: or takeSnapshotExWithConfig:uid:config::

• uid = 0: Position 2, 4 and 8 are allowed.
• uid != 0: Only position 2 is allowed.