Agora Java API Reference for Android
Classes | Public Member Functions | Public Attributes | List of all members
io.agora.rtc2.ScreenCaptureParameters Class Reference

Classes

class  AudioCaptureParameters
 
class  VideoCaptureParameters
 

Public Member Functions

boolean isCaptureAudio ()
 
VideoCaptureParameters getVideoCaptureParameters ()
 
boolean isCaptureVideo ()
 
AudioCaptureParameters getAudioCaptureParameters ()
 
String toString ()
 

Public Attributes

boolean captureAudio = false
 
VideoCaptureParameters videoCaptureParameters = new VideoCaptureParameters()
 
boolean captureVideo = true
 
AudioCaptureParameters audioCaptureParameters = new AudioCaptureParameters()
 

Detailed Description

The configuration of the screen sharing

Since
v3.7.0

Member Data Documentation

◆ captureAudio

boolean io.agora.rtc2.ScreenCaptureParameters.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).

◆ videoCaptureParameters

VideoCaptureParameters io.agora.rtc2.ScreenCaptureParameters.videoCaptureParameters = new VideoCaptureParameters()

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

◆ captureVideo

boolean io.agora.rtc2.ScreenCaptureParameters.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).

◆ audioCaptureParameters

AudioCaptureParameters io.agora.rtc2.ScreenCaptureParameters.audioCaptureParameters = new AudioCaptureParameters()

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