Home
Video SDK for C++
IScreenCaptureSourceList
The IScreenCaptureSourceList class. This class is returned in the getScreenCaptureSources method.

Video SDK for C++
- API Overview
  Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through SD-RTN™.
- IRtcEngine
  The basic interface of the Agora SDK that implements the core functions of real-time communication.
- IRtcEngineEx
  This interface class contains multi-channel methods.
- IRtcEngineEventHandler
  The SDK uses the IRtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
- IMediaPlayer
  This class provides media player functions and supports multiple instances.
- IAudioEncodedFrameObserver
  The encoded audio observer.
- IAudioDeviceManager
  Audio device management methods.
- IAudioDeviceCollection
  The IAudioDeviceCollection interface. You can get the information of audio devices with this interface.
- IVideoDeviceManager
  Video device management methods.
- IVideoDeviceCollection
  You can get the information of video devices with this interface.
- IMediaEngine
  The IMediaEngine class.
- IMediaPlayerCacheManager
  This class provides methods to manage cached media files.
- IMediaPlayerCustomDataProvider
  The callback for custom media resource files.
- IMediaPlayerSourceObserver
  Provides callbacks for media players.
- IAudioPcmFrameSink
  This class is used to get raw PCM audio.
- IAudioFrameObserverBase
  The audio frame observer.
- IAudioSpectrumObserver
  The audio spectrum observer.
- IPacketObserver
  The definition of IPacketObserver.
- IMetadataObserver
  The metadata observer.
- IVideoEncodedFrameObserver
  Receives encoded video images.
- IVideoFrameObserver
  The IVideoFrameObserver class.
- IFaceInfoObserver
  Facial information observer.
- ILocalSpatialAudioEngine
  This class calculates user positions through the SDK to implement the spatial audio effect.
- IScreenCaptureSourceList
  The IScreenCaptureSourceList class. This class is returned in the getScreenCaptureSources method.
- Struct and Enum
  This page lists all the definitions of Struct and the enums for C++.
- API Sunset Notice
  This page introduces the deprecated and deleted APIs in the SDK.

IScreenCaptureSourceList

The IScreenCaptureSourceList class. This class is returned in the getScreenCaptureSources method.

getCount

Gets the number of shareable windows and screens.

virtual unsigned int getCount() = 0;

Details

Note: This method applies to macOS and Windows only.

Returns

The number of shareable windows and screens.

getSourceInfo

Gets information about the specified shareable window or screen.

virtual ScreenCaptureSourceInfo getSourceInfo(unsigned int index) = 0;

Details

After you get IScreenCaptureSourceList, you can pass in the index value of the specified shareable window or screen to get information about that window or screen from ScreenCaptureSourceInfo.

Note: This method applies to macOS and Windows only.

Parameters

index: The index of the specified shareable window or screen. The value range is [0, getCount()).

Returns

ScreenCaptureSourceInfo

release

Releases IScreenCaptureSourceList.

virtual void release() = 0;

Details

After you get the list of shareable windows and screens, to avoid memory leaks, call this method to release IScreenCaptureSourceList instead of deleting IScreenCaptureSourceList directly.

Note: This method applies to macOS and Windows only.