IScreenCaptureSourceList

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

GetCount

Gets the number of shareable windows and screens.

UFUNCTION(BlueprintCallable, Category = "Agora|ScreenCaptureSourceList")
int GetCount();

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.

UFUNCTION(BlueprintCallable, Category = "Agora|ScreenCaptureSourceList")
	FScreenCaptureSourceInfo GetSourceInfo(int index);

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 FScreenCaptureSourceInfo.

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

FScreenCaptureSourceInfo

Release

Releases IScreenCaptureSourceList.

UFUNCTION(BlueprintCallable, Category = "Agora|ScreenCaptureSourceList")
void Release();

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.