Package io.agora.rtc2

Class ScreenCaptureParameters

java.lang.Object

io.agora.rtc2.ScreenCaptureParameters

public class ScreenCaptureParameters
extends Object

Since:

v3.7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScreenCaptureParameters.AudioCaptureParameters
static class	ScreenCaptureParameters.VideoCaptureParameters

Field Summary

Fields

Modifier and Type	Field	Description
ScreenCaptureParameters.AudioCaptureParameters	audioCaptureParameters	The audio configuration for the shared screen stream.
boolean	captureAudio	Determines whether to capture system audio during screen sharing: - `true`: Capture system audio.
boolean	captureVideo	Whether to capture the screen when screen sharing: - `true`: (Default) Capture the screen.
ScreenCaptureParameters.VideoCaptureParameters	videoCaptureParameters	The video configuration for the shared screen stream.

Constructor Summary

Constructors

Constructor	Description
ScreenCaptureParameters()

Method Summary

Modifier and Type	Method	Description
ScreenCaptureParameters.AudioCaptureParameters	getAudioCaptureParameters()
ScreenCaptureParameters.VideoCaptureParameters	getVideoCaptureParameters()
boolean	isCaptureAudio()
boolean	isCaptureVideo()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

captureAudio

public boolean captureAudio

Determines whether to capture system audio during screen sharing: - `true`: Capture system audio. - `false`: (Default) Do not capture system audio.

videoCaptureParameters

public ScreenCaptureParameters.VideoCaptureParameters videoCaptureParameters

The video configuration for the shared screen stream. See VideoCaptureParameters.

captureVideo

public boolean captureVideo

Whether to capture the screen when screen sharing: - `true`: (Default) Capture the screen. - `false`: Do not capture the screen.

audioCaptureParameters

public ScreenCaptureParameters.AudioCaptureParameters audioCaptureParameters

The audio configuration for the shared screen stream. See AudioCaptureParameters.

Constructor Details

ScreenCaptureParameters

public ScreenCaptureParameters()

Method Details

isCaptureAudio

public boolean isCaptureAudio()

getVideoCaptureParameters

public ScreenCaptureParameters.VideoCaptureParameters getVideoCaptureParameters()

isCaptureVideo

public boolean isCaptureVideo()

getAudioCaptureParameters

public ScreenCaptureParameters.AudioCaptureParameters getAudioCaptureParameters()

toString

public String toString()

Overrides:

toString in class Object