\hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters}{}\doxysection{io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Video\+Capture\+Parameters Class Reference}
\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters}\index{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a39b83737ee1aa85edda70407c73ea880}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a39b83737ee1aa85edda70407c73ea880}} 
int {\bfseries get\+Bitrate} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_aa867220ceb23acf48e486d3799fa0f3d}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_aa867220ceb23acf48e486d3799fa0f3d}} 
int {\bfseries get\+Framerate} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a3543d8c55d49b37ae5ef44d4300a1461}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a3543d8c55d49b37ae5ef44d4300a1461}} 
int {\bfseries get\+Width} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_aa82deecbd6c215b24fd20bb047319e9a}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_aa82deecbd6c215b24fd20bb047319e9a}} 
int {\bfseries get\+Height} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_ae1fa3aad416e388dcbdd453f1786e448}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_ae1fa3aad416e388dcbdd453f1786e448}} 
int {\bfseries get\+Content\+Hint} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a6999d648e0adcd7ec7a408b109adfa05}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a6999d648e0adcd7ec7a408b109adfa05}} 
String {\bfseries to\+String} ()
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_adaf9dce3e32a8bfe653a29b29195b341}{bitrate}} = 0
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a15b81f09d54a59f5fdc2bb48bedd9589}{framerate}} = 15
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_ac3919decf07a695ab41e23f5a1f500fa}{width}} = 1280
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a88d47e4f87bdb8dfa647923666d3788f}{height}} = 720
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a5b1d7e4ef46a9476c795ddd021b21d43}{content\+Hint}} = \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_constants_a80b514cae0cec9021e9fb6202194f70b}{Constants.\+S\+C\+R\+E\+E\+N\+\_\+\+C\+A\+P\+T\+U\+R\+E\+\_\+\+C\+O\+N\+T\+E\+N\+T\+\_\+\+H\+I\+N\+T\+\_\+\+M\+O\+T\+I\+ON}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The video configuration for the shared screen stream.

Only available for scenarios where {\ttfamily capture\+Video} is {\ttfamily true}.

\begin{DoxySince}{Since}
v3.\+7.\+0 
\end{DoxySince}


\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_adaf9dce3e32a8bfe653a29b29195b341}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_adaf9dce3e32a8bfe653a29b29195b341}} 
\index{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}!bitrate@{bitrate}}
\index{bitrate@{bitrate}!io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}}
\doxysubsubsection{\texorpdfstring{bitrate}{bitrate}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Video\+Capture\+Parameters.\+bitrate = 0}

The video encoding bitrate (Kbps). For recommended values, see \href{https://docs.agora.io/en/Interactive\%20Broadcast/game_streaming_video_profile?platform=Android\#recommended-video-profiles}{\texttt{ Recommended video profiles}}. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a15b81f09d54a59f5fdc2bb48bedd9589}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a15b81f09d54a59f5fdc2bb48bedd9589}} 
\index{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}!framerate@{framerate}}
\index{framerate@{framerate}!io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}}
\doxysubsubsection{\texorpdfstring{framerate}{framerate}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Video\+Capture\+Parameters.\+framerate = 15}

The video encoding frame rate (fps). The default value is {\ttfamily 15}. For recommended values, see \href{https://docs.agora.io/en/Interactive\%20Broadcast/game_streaming_video_profile?platform=Android\#recommended-video-profiles}{\texttt{ Recommended video profiles}}. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_ac3919decf07a695ab41e23f5a1f500fa}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_ac3919decf07a695ab41e23f5a1f500fa}} 
\index{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}!width@{width}}
\index{width@{width}!io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}}
\doxysubsubsection{\texorpdfstring{width}{width}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Video\+Capture\+Parameters.\+width = 1280}

The width of the video encoding resolution. The default value is {\ttfamily 1280}. For recommended values, see \href{https://docs.agora.io/en/Interactive\%20Broadcast/game_streaming_video_profile?platform=Android\#recommended-video-profiles}{\texttt{ Recommended video profiles}}. If the aspect ratio is different between width and height and the screen, the S\+DK adjusts the video encoding resolution according to the following rules (using an example where {\ttfamily width} × {\ttfamily height} is 1280 × 720)\+:
\begin{DoxyItemize}
\item When the width and height of the screen are both lower than {\ttfamily width} and {\ttfamily height}, the S\+DK uses the resolution of the screen for video encoding. For example, if the screen is 640 × 360, The S\+DK uses 640 × 360 for video encoding.
\item When either the width or height of the screen is higher than {\ttfamily width} or {\ttfamily height}, the S\+DK uses the maximum values that do not exceed those of {\ttfamily width} and {\ttfamily height} while maintaining the aspect ratio of the screen for video encoding. For example, if the screen is 2000 × 1500, the S\+DK uses 960 × 720 for video encoding.
\end{DoxyItemize}

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item The billing of the screen sharing stream is based on the values of width and height. When you do not pass in these values, Agora bills you at 1280 × 720; when you pass in these values, Agora bills you at those values. For details, see \href{https://docs.agora.io/en/Interactive\%20Broadcast/billing_rtc}{\texttt{ Pricing for Real-\/time Communication}}.
\item This value does not indicate the orientation mode of the output ratio. For how to set the video orientation, see {\ttfamily O\+R\+I\+E\+N\+T\+A\+T\+I\+O\+N\+\_\+\+M\+O\+DE}.
\item Whether the S\+DK can support a resolution at 720P depends on the performance of the device. If you set 720P but the device cannot support it, the video frame rate can be lower. 
\end{DoxyItemize}
\end{DoxyNote}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a88d47e4f87bdb8dfa647923666d3788f}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a88d47e4f87bdb8dfa647923666d3788f}} 
\index{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}!height@{height}}
\index{height@{height}!io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}}
\doxysubsubsection{\texorpdfstring{height}{height}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Video\+Capture\+Parameters.\+height = 720}

The height of the video encoding resolution. The default value is 720. For recommended values, see \href{https://docs.agora.io/en/Interactive\%20Broadcast/game_streaming_video_profile?platform=Android\#recommended-video-profiles}{\texttt{ Recommended video profiles}}. If the aspect ratio is different between {\ttfamily width} and {\ttfamily height} and the screen, the S\+DK adjusts the video encoding resolution according to the following rules (using an example where {\ttfamily width} × {\ttfamily height} is 1280 × 720)\+:
\begin{DoxyItemize}
\item When the width and height of the screen are both lower than {\ttfamily width} and {\ttfamily height}, the S\+DK uses the resolution of the screen for video encoding. For example, if the screen is 640 × 360, The S\+DK uses 640 × 360 for video encoding.
\item When either the width or height of the screen is higher than {\ttfamily width} or {\ttfamily height}, the S\+DK uses the maximum values that do not exceed those of {\ttfamily width} and {\ttfamily height} while maintaining the aspect ratio of the screen for video encoding. For example, if the screen is 2000 × 1500, the S\+DK uses 960 × 720 for video encoding.
\end{DoxyItemize}

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item The billing of the screen sharing stream is based on the values of width and height. When you do not pass in these values, Agora bills you at 1280 × 720; when you pass in these values, Agora bills you at those values. For details, see \href{https://docs.agora.io/en/Interactive\%20Broadcast/billing_rtc}{\texttt{ Pricing for Real-\/time Communication}}.
\item This value does not indicate the orientation mode of the output ratio. For how to set the video orientation, see {\ttfamily O\+R\+I\+E\+N\+T\+A\+T\+I\+O\+N\+\_\+\+M\+O\+DE}.
\item Whether the S\+DK can support a resolution at 720P depends on the performance of the device. If you set 720P but the device cannot support it, the video frame rate can be lower. 
\end{DoxyItemize}
\end{DoxyNote}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a5b1d7e4ef46a9476c795ddd021b21d43}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_video_capture_parameters_a5b1d7e4ef46a9476c795ddd021b21d43}} 
\index{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}!contentHint@{contentHint}}
\index{contentHint@{contentHint}!io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters}}
\doxysubsubsection{\texorpdfstring{contentHint}{contentHint}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Video\+Capture\+Parameters.\+content\+Hint = \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_constants_a80b514cae0cec9021e9fb6202194f70b}{Constants.\+S\+C\+R\+E\+E\+N\+\_\+\+C\+A\+P\+T\+U\+R\+E\+\_\+\+C\+O\+N\+T\+E\+N\+T\+\_\+\+H\+I\+N\+T\+\_\+\+M\+O\+T\+I\+ON}}}

The content hint of the screen sharing\+:
\begin{DoxyItemize}
\item \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_constants_a2c40b372369856aec41944d95108d5de}{S\+C\+R\+E\+E\+N\+\_\+\+C\+A\+P\+T\+U\+R\+E\+\_\+\+C\+O\+N\+T\+E\+N\+T\+\_\+\+H\+I\+N\+T\+\_\+\+N\+O\+N\+E(0)}}
\item (Default) \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_constants_a80b514cae0cec9021e9fb6202194f70b}{S\+C\+R\+E\+E\+N\+\_\+\+C\+A\+P\+T\+U\+R\+E\+\_\+\+C\+O\+N\+T\+E\+N\+T\+\_\+\+H\+I\+N\+T\+\_\+\+M\+O\+T\+I\+O\+N(1)}}
\item \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_constants_a0bad317038cb69625fd2d5cd304782b3}{S\+C\+R\+E\+E\+N\+\_\+\+C\+A\+P\+T\+U\+R\+E\+\_\+\+C\+O\+N\+T\+E\+N\+T\+\_\+\+H\+I\+N\+T\+\_\+\+D\+E\+T\+A\+I\+L\+S(2)}} 
\end{DoxyItemize}