\hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters}{}\doxysection{agora\+::rtc\+::Screen\+Capture\+Parameters Struct Reference}
\label{structagora_1_1rtc_1_1_screen_capture_parameters}\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}


{\ttfamily \#include $<$Agora\+Base.\+h$>$}

\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a6283b0f5e0225a02cd485f58b1767863}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a6283b0f5e0225a02cd485f58b1767863}} 
{\bfseries Screen\+Capture\+Parameters} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_video_dimensions}{Video\+Dimensions}} \&d, int f, int b)
\item 
\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a6ed66ba8ff7c51ff9352b19f2ff2ceae}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a6ed66ba8ff7c51ff9352b19f2ff2ceae}} 
{\bfseries Screen\+Capture\+Parameters} (int width, int height, int f, int b)
\item 
\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a4dc0f28c32851a90638b3f8e2111b9a2}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a4dc0f28c32851a90638b3f8e2111b9a2}} 
{\bfseries Screen\+Capture\+Parameters} (int width, int height, int f, int b, bool cur, bool fcs)
\item 
\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a9fb92ebdfafceaab323485530b7db3cb}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a9fb92ebdfafceaab323485530b7db3cb}} 
{\bfseries Screen\+Capture\+Parameters} (int width, int height, int f, int b, view\+\_\+t $\ast$ex, int cnt)
\item 
\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a0889517faaff02ee1aa51576c5c01a71}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a0889517faaff02ee1aa51576c5c01a71}} 
{\bfseries Screen\+Capture\+Parameters} (int width, int height, int f, int b, bool cur, bool fcs, view\+\_\+t $\ast$ex, int cnt)
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
bool \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a0cc678fbbe8f20618e0625ce55313e89}{capture\+Audio}}
\item 
\mbox{\hyperlink{structagora_1_1rtc_1_1_screen_audio_parameters}{Screen\+Audio\+Parameters}} \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a6923ade2a0259746039920f63cf1e32e}{audio\+Params}}
\item 
\mbox{\hyperlink{structagora_1_1rtc_1_1_video_dimensions}{Video\+Dimensions}} \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a9ee8c96bbfe031e8c614d7b2e49ddbb8}{dimensions}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a4872b7367bc6112429391474cd9c9cd4}{frame\+Rate}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a68b41628a90544e78d1f0ab45c9300a5}{bitrate}}
\item 
bool \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_aa68157203616423bad85f852f3816c1f}{capture\+Mouse\+Cursor}}
\item 
bool \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_ace45151f5601ff006708135de1323daf}{window\+Focus}}
\item 
view\+\_\+t $\ast$ \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a9d7422f28a60d3217996557c30079ca4}{exclude\+Window\+List}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a16dcc43342b5db0489e1a45edafcb23f}{exclude\+Window\+Count}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a93bbd85bc8120298095b1fb5bdc72b3b}{high\+Light\+Width}}
\item 
unsigned int \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_a1e8d5e822c7dfcaa45ea71a0f186f581}{high\+Light\+Color}}
\item 
bool \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_capture_parameters_ad05439540b82ad7768631f105a6dff65}{enable\+High\+Light}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Screen sharing configurations. 

\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a0cc678fbbe8f20618e0625ce55313e89}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a0cc678fbbe8f20618e0625ce55313e89}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!captureAudio@{captureAudio}}
\index{captureAudio@{captureAudio}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{captureAudio}{captureAudio}}
{\footnotesize\ttfamily bool agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::capture\+Audio}

Determines whether to capture system audio during screen sharing\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Capture.
\item {\ttfamily false}\+: (Default) Do not capture.
\end{DoxyItemize}

{\bfseries{Note}} Due to system limitations, capturing system audio is only available for Android A\+PI level 29 and later (that is, Android 10 and later). \mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a6923ade2a0259746039920f63cf1e32e}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a6923ade2a0259746039920f63cf1e32e}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!audioParams@{audioParams}}
\index{audioParams@{audioParams}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{audioParams}{audioParams}}
{\footnotesize\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_screen_audio_parameters}{Screen\+Audio\+Parameters}} agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::audio\+Params}

The audio configuration for the shared screen stream. \mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a9ee8c96bbfe031e8c614d7b2e49ddbb8}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a9ee8c96bbfe031e8c614d7b2e49ddbb8}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!dimensions@{dimensions}}
\index{dimensions@{dimensions}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{dimensions}{dimensions}}
{\footnotesize\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_video_dimensions}{Video\+Dimensions}} agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::dimensions}

On Windows and mac\+OS, it represents the video encoding resolution of the shared screen stream. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_video_dimensions}{Video\+Dimensions}}}. The default value is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

If the aspect ratio is different between the encoding dimensions and screen dimensions, Agora applies the following algorithms for encoding. Suppose dimensions are 1920 x 1080\+:
\begin{DoxyItemize}
\item If the value of the screen dimensions is lower than that of dimensions, for example, 1000 x 1000 pixels, the S\+DK uses 1000 x 1000 pixels for encoding.
\item If the value of the screen dimensions is higher than that of dimensions, for example, 2000 x 1500, the S\+DK uses the maximum value under dimensions with the aspect ratio of the screen dimension (4\+:3) for encoding, that is, 1440 x 1080. 
\end{DoxyItemize}\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a4872b7367bc6112429391474cd9c9cd4}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a4872b7367bc6112429391474cd9c9cd4}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!frameRate@{frameRate}}
\index{frameRate@{frameRate}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{frameRate}{frameRate}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::frame\+Rate}

On Windows and mac\+OS, it represents the video encoding frame rate (fps) of the shared screen stream. The frame rate (fps) of the shared region. The default value is 5. We do not recommend setting this to a value greater than 15. \mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a68b41628a90544e78d1f0ab45c9300a5}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a68b41628a90544e78d1f0ab45c9300a5}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!bitrate@{bitrate}}
\index{bitrate@{bitrate}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{bitrate}{bitrate}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::bitrate}

On Windows and mac\+OS, it represents the video encoding bitrate of the shared screen stream. The bitrate (Kbps) of the shared region. The default value is 0 (the S\+DK works out a bitrate according to the dimensions of the current screen). \mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_aa68157203616423bad85f852f3816c1f}\label{structagora_1_1rtc_1_1_screen_capture_parameters_aa68157203616423bad85f852f3816c1f}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!captureMouseCursor@{captureMouseCursor}}
\index{captureMouseCursor@{captureMouseCursor}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{captureMouseCursor}{captureMouseCursor}}
{\footnotesize\ttfamily bool agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::capture\+Mouse\+Cursor}

Whether to capture the mouse in screen sharing\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: (Default) Capture the mouse.
\item {\ttfamily false}\+: Do not capture the mouse. 
\end{DoxyItemize}\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_ace45151f5601ff006708135de1323daf}\label{structagora_1_1rtc_1_1_screen_capture_parameters_ace45151f5601ff006708135de1323daf}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!windowFocus@{windowFocus}}
\index{windowFocus@{windowFocus}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{windowFocus}{windowFocus}}
{\footnotesize\ttfamily bool agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::window\+Focus}

Whether to bring the window to the front when calling the {\ttfamily start\+Screen\+Capture\+By\+Window\+Id} method to share it\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Bring the window to the front.
\item {\ttfamily false}\+: (Default) Do not bring the window to the front. 
\end{DoxyItemize}\mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a9d7422f28a60d3217996557c30079ca4}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a9d7422f28a60d3217996557c30079ca4}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!excludeWindowList@{excludeWindowList}}
\index{excludeWindowList@{excludeWindowList}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{excludeWindowList}{excludeWindowList}}
{\footnotesize\ttfamily view\+\_\+t$\ast$ agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::exclude\+Window\+List}

A list of I\+Ds of windows to be blocked. When calling {\ttfamily start\+Screen\+Capture\+By\+Display\+Id} to start screen sharing, you can use this parameter to block a specified window. When calling {\ttfamily update\+Screen\+Capture\+Parameters} to update screen sharing configurations, you can use this parameter to dynamically block the specified windows during screen sharing. \mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a16dcc43342b5db0489e1a45edafcb23f}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a16dcc43342b5db0489e1a45edafcb23f}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!excludeWindowCount@{excludeWindowCount}}
\index{excludeWindowCount@{excludeWindowCount}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{excludeWindowCount}{excludeWindowCount}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::exclude\+Window\+Count}

The number of windows to be blocked. \mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a93bbd85bc8120298095b1fb5bdc72b3b}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a93bbd85bc8120298095b1fb5bdc72b3b}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!highLightWidth@{highLightWidth}}
\index{highLightWidth@{highLightWidth}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{highLightWidth}{highLightWidth}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::high\+Light\+Width}

The width (px) of the border. Defaults to 0, and the value range is \mbox{[}0,50\mbox{]}. \mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_a1e8d5e822c7dfcaa45ea71a0f186f581}\label{structagora_1_1rtc_1_1_screen_capture_parameters_a1e8d5e822c7dfcaa45ea71a0f186f581}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!highLightColor@{highLightColor}}
\index{highLightColor@{highLightColor}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{highLightColor}{highLightColor}}
{\footnotesize\ttfamily unsigned int agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::high\+Light\+Color}

The color of the border in R\+G\+BA format. The default value is 0x\+F\+F8\+C\+B\+F26. \mbox{\Hypertarget{structagora_1_1rtc_1_1_screen_capture_parameters_ad05439540b82ad7768631f105a6dff65}\label{structagora_1_1rtc_1_1_screen_capture_parameters_ad05439540b82ad7768631f105a6dff65}} 
\index{agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}!enableHighLight@{enableHighLight}}
\index{enableHighLight@{enableHighLight}!agora::rtc::ScreenCaptureParameters@{agora::rtc::ScreenCaptureParameters}}
\doxysubsubsection{\texorpdfstring{enableHighLight}{enableHighLight}}
{\footnotesize\ttfamily bool agora\+::rtc\+::\+Screen\+Capture\+Parameters\+::enable\+High\+Light}

Whether to place a border around the shared window or screen\+:
\begin{DoxyItemize}
\item true\+: Place a border.
\item false\+: (Default) Do not place a border.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
When you share a part of a window or screen, the S\+DK places a border around the entire window or screen if you set {\ttfamily enable\+High\+Light} as true. 
\end{DoxyNote}
