Agora C++ API Reference for All Platforms

Loading...
Searching...
No Matches
Public Attributes | List of all members
agora::rtc::ScreenCaptureParameters2 Struct Reference

`#include <AgoraBase.h>`

## Public Attributes
bool | captureAudio = false
ScreenAudioParameters | audioParams
bool | captureVideo = true
ScreenVideoParameters | videoParams

## Detailed Description

The configuration of the screen sharing

## Member Data Documentation

## ◆ captureAudio

bool agora::rtc::ScreenCaptureParameters2::captureAudio = false

Determines whether to capture system audio during screen sharing:

- `true`: Capture.
- `false`: (Default) Do not capture.

Note Due to system limitations, capturing system audio is only available for Android API level 29 and later (that is, Android 10 and later).

## ◆ audioParams

ScreenAudioParameters agora::rtc::ScreenCaptureParameters2::audioParams

The audio configuration for the shared screen stream.

## ◆ captureVideo

bool agora::rtc::ScreenCaptureParameters2::captureVideo = true

Determines whether to capture the screen during screen sharing:

- `true`: (Default) Capture.
- `false`: Do not capture.

Note Due to system limitations, screen capture is only available for Android API level 21 and later (that is, Android 5 and later).

## ◆ videoParams

ScreenVideoParameters agora::rtc::ScreenCaptureParameters2::videoParams

The video configuration for the shared screen stream.