Agora Java API Reference for Android
Public Attributes | List of all members
io.agora.rtc2.video.SnapshotConfig Class Reference

The snapshot configuration. More...

Public Attributes

String filePath = null
 
Constants.VideoModulePosition position
 

Detailed Description

The snapshot configuration.

Member Data Documentation

◆ filePath

String io.agora.rtc2.video.SnapshotConfig.filePath = null

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

  • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
    Note
    Ensure that the path you specify exists and is writable.

◆ position

Constants.VideoModulePosition io.agora.rtc2.video.SnapshotConfig.position
Initial value:
=
Constants.VideoModulePosition.VIDEO_MODULE_POSITION_PRE_ENCODER

The position of the video observation. See VideoModulePosition. Allowed values vary depending on the uid parameter passed in takeSnapshot or takeSnapshotEx:

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