Voice SDK v3.7.1 API Reference for Unity
Public Member Functions | List of all members
agora_gaming_rtc.ScreenCaptureManager Class Reference

Inherits agora_gaming_rtc.IScreenCaptureManager.

Public Member Functions
override void  CreateScreenCaptureManager (int thumbHeight, int thumbWidth, int iconHeight, int iconWidth, bool includeScreen)
 
override int  GetScreenCaptureSourcesCount ()
 
override ScreenCaptureSourceType  GetScreenCaptureSourceType (uint index)
 
override string  GetScreenCaptureSourceName (uint index)
 
override string  GetScreenCaptureSourceProcessPath (uint index)
 
override string  GetScreenCaptureSourceTitle (uint index)
 
override IntPtr  GetScreenCaptureSourceId (uint index)
 
override bool  GetScreenCaptureIsPrimaryMonitor (uint index)
 
override ThumbImageBuffer  GetScreenCaptureThumbImage (uint index)
 
override ThumbImageBuffer  GetScreenCaptureIconImage (uint index)
 

Detailed Description

The definition of ScreenCaptureManager.

Member Function Documentation

◆ CreateScreenCaptureManager()

override void agora_gaming_rtc.ScreenCaptureManager.CreateScreenCaptureManager ( int  thumbHeight,
int  thumbWidth,
int  iconHeight,
int  iconWidth,
bool  includeScreen 
)
virtual

Creates a ScreenCaptureManager class, which includes a list of shareable screens and windows.

You can call this method before sharing a screen or window to get a list of shareable screens and windows, which enables a user to use thumbnails in the list to easily choose a particular screen or window to share.

This list also contains important information such as window ID and screen ID, with which you can call StartScreenCaptureByWindowId or StartScreenCaptureByDisplayId to start the sharing.

Note
This method applies to macOS and Windows only.
Parameters
thumbHeight The target height of the screen or window thumbnail in pixels.
thumbWidth The target width of the screen or window thumbnail in pixels.
iconHeight The target height of the app icon in pixels.
iconWidth The target width of the app icon in pixels.
includeScreen Whether the SDK returns screen information in addition to window information:
  • true: Yes. The SDK returns both the screen and window information.
  • false: No. The SDK returns the window information only.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureIconImage()

override ThumbImageBuffer agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureIconImage ( uint  index )
virtual

Gets the image content of the icon.

Parameters
index The index number of the shared window or screen.
Returns
The image buffer of the icon: ThumbImageBuffer.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureIsPrimaryMonitor()

override bool agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureIsPrimaryMonitor ( uint  index )
virtual

Checks whether the screen is the primary display.

Parameters
index The index number of the shared screen.
Returns
Whether the screen or window is the primary display:
  • true: Yes.
  • false: No.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureSourceId()

override IntPtr agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureSourceId ( uint  index )
virtual

Gets the source ID of the window or screen.

Parameters
index The index number of the shared window or screen.
Returns
The source ID of the window or screen.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureSourceName()

override string agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureSourceName ( uint  index )
virtual

Gets the name of the window or screen.

Parameters
index The index number of the shared window or screen.
Returns
The name of the shared window or screen.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureSourceProcessPath()

override string agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureSourceProcessPath ( uint  index )
virtual

Gets the process to which the window or screen belongs.

Parameters
index The index number of the shared window or screen.
Returns
The process to which the window or screen belongs.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureSourcesCount()

override int agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureSourcesCount ( )
virtual

Gets the number of the shareable screens or windows.

Returns
The number of shareable screens or windows.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureSourceTitle()

override string agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureSourceTitle ( uint  index )
virtual

Gets the title of the window or screen.

Parameters
index The index number of the shared window or screen.
Returns
The title of the window or screen.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureSourceType()

override ScreenCaptureSourceType agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureSourceType ( uint  index )
virtual

Gets the type of the shared target.

Parameters
index The index number of the shared target.
Returns
The screen capture source type: ScreenCaptureSourceType.

Implements agora_gaming_rtc.IScreenCaptureManager.

◆ GetScreenCaptureThumbImage()

override ThumbImageBuffer agora_gaming_rtc.ScreenCaptureManager.GetScreenCaptureThumbImage ( uint  index )
virtual

Gets the image content of the thumbnail.

Parameters
index The index number of the shared window or screen.
Returns
The image buffer of the thumbnail: ThumbImageBuffer.

Implements agora_gaming_rtc.IScreenCaptureManager.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1