Agora RTC Objective-C API Reference Refactor

Properties
AgoraScreenCaptureParameters2 Class Reference

Inherits <NSObject>.

## Properties
BOOL | captureAudio
AgoraScreenAudioParameters *_Nonnull | audioParams
BOOL | captureVideo
AgoraScreenVideoParameters *_Nonnull | videoParams

## Property Documentation

## ◆ captureAudio

- (BOOL) captureAudio
| read write nonatomic assign

Determines whether to capture system audio during screen sharing:

- `YES`: Capture system audio.
- `NO`: (Default) Do not capture system audio.
  Note
    - 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 `AgoraAudioScenarioGameStreaming`.

## ◆ audioParams

- (AgoraScreenAudioParameters* _Nonnull) audioParams
| read write nonatomic strong

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

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

## ◆ captureVideo

- (BOOL) captureVideo
| read write nonatomic assign

Whether to capture the screen when screen sharing:

- `YES`: (Default) Capture the screen.
- `NO`: Do not capture the screen.

## ◆ videoParams

- (AgoraScreenVideoParameters* _Nonnull) videoParams
| read write nonatomic strong

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

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