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

## Member Data Documentation

## ◆ captureAudio

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

Determines whether to capture system audio during screen sharing:

- `true`: Capture system audio.
- `false`: (Default) Do not capture system audio.
  Note
- Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
- To improve the success rate of capturing system audio during screen sharing, ensure that you have called the `setAudioScenario` method and set the audio scenario to `AUDIO_SCENARIO_GAME_STREAMING`.

## ◆ audioParams

ScreenAudioParameters agora::rtc::ScreenCaptureParameters2::audioParams

The audio configuration for the shared screen stream. See `ScreenAudioParameters`.

Note
  This parameter only takes effect when `captureAudio` is `true`.

## ◆ captureVideo

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

Whether to capture the screen when screen sharing:

- `true`: (Default) Capture the screen.
- `false`: Do not capture the screen.
  Note
    Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.

## ◆ videoParams

ScreenVideoParameters agora::rtc::ScreenCaptureParameters2::videoParams

The video configuration for the shared screen stream. See `ScreenVideoParameters`.

Note
  This parameter only takes effect when `captureVideo` is `true`.