Agora C++ API Reference for All Platforms

Public Member Functions | Public Attributes | List of all members
agora::media::SnapshotConfig Struct Reference

## Public Member Functions
| SnapshotConfig ()

## Public Attributes
const char * | filePath
media::base::VIDEO_MODULE_POSITION | position

## Detailed Description

Definition of SnapshotConfig.

## Constructor & Destructor Documentation

## ◆ SnapshotConfig()

agora::media::SnapshotConfig::SnapshotConfig | ( |  | ) |
| inline

## Member Data Documentation

## ◆ filePath

const char* agora::media::SnapshotConfig::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`

## ◆ position

media::base::VIDEO_MODULE_POSITION agora::media::SnapshotConfig::position

The position of the video observation. See VIDEO_MODULE_POSITION.

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.