\hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config}{}\doxysection{io.\+agora.\+rte.\+Canvas\+Config Class Reference}
\label{classio_1_1agora_1_1rte_1_1_canvas_config}\index{io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}}


This class provides methods for configuring video rendering of the player.  


\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config_af20eb56c4f6a67d7c21a603f8d74dc59}\label{classio_1_1agora_1_1rte_1_1_canvas_config_af20eb56c4f6a67d7c21a603f8d74dc59}} 
long {\bfseries get\+Native\+Handle} ()
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config_a82ccc92dabbfcdf57e897e86eee14d6b}{set\+Video\+Render\+Mode}} (Constants.\+Video\+Render\+Mode mode)  throws Rte\+Exception 
\item 
Constants.\+Video\+Render\+Mode \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config_acd468d21fcc8948afa869af1afcb4204}{get\+Video\+Render\+Mode}} ()  throws Rte\+Exception 
\begin{DoxyCompactList}\small\item\em Gets the currently set mirror mode. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config_a5bc2963b3bc2af9bf815c9b43ff5d049}{set\+Video\+Mirror\+Mode}} (Constants.\+Video\+Mirror\+Mode mode)  throws Rte\+Exception 
\begin{DoxyCompactList}\small\item\em Sets the video mirror mode. \end{DoxyCompactList}\item 
Constants.\+Video\+Mirror\+Mode \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config_a742685895042d5d1d797b19bf9e1650c}{get\+Video\+Mirror\+Mode}} ()  throws Rte\+Exception 
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config_a4450d8617e00cac5f001ce202eaec86d}\label{classio_1_1agora_1_1rte_1_1_canvas_config_a4450d8617e00cac5f001ce202eaec86d}} 
void {\bfseries set\+Crop\+Area} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rect}{Rect}} rect)  throws Rte\+Exception 
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config_a27bbc128818da3fc02787c8af3ce714d}\label{classio_1_1agora_1_1rte_1_1_canvas_config_a27bbc128818da3fc02787c8af3ce714d}} 
\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rect}{Rect}} {\bfseries get\+Crop\+Area} ()  throws Rte\+Exception 
\end{DoxyCompactItemize}
\doxysubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config_a30c34edc02a0e97e30f97b71a4fb61a2}\label{classio_1_1agora_1_1rte_1_1_canvas_config_a30c34edc02a0e97e30f97b71a4fb61a2}} 
void {\bfseries finalize} ()
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This class provides methods for configuring video rendering of the player. 

\begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config_a82ccc92dabbfcdf57e897e86eee14d6b}\label{classio_1_1agora_1_1rte_1_1_canvas_config_a82ccc92dabbfcdf57e897e86eee14d6b}} 
\index{io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}!setVideoRenderMode@{setVideoRenderMode}}
\index{setVideoRenderMode@{setVideoRenderMode}!io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}}
\doxysubsubsection{\texorpdfstring{setVideoRenderMode()}{setVideoRenderMode()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Canvas\+Config.\+set\+Video\+Render\+Mode (\begin{DoxyParamCaption}\item[{Constants.\+Video\+Render\+Mode}]{mode }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Set the video render mode. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em mode} & The render mode to set. Refer to \mbox{\hyperlink{enumio_1_1agora_1_1rte_1_1_constants_1_1_video_render_mode}{Constants.\+Video\+Render\+Mode}} type, default is \mbox{\hyperlink{enumio_1_1agora_1_1rte_1_1_constants_1_1_video_render_mode_ab1e29fb773d252e3b89f3ddb2619f197}{Constants.\+Video\+Render\+Mode.\+H\+I\+D\+D\+EN}}. \\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em Rte\+Exception} & \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception_a2867a6ee1090dc015bbbae3dd380feb3}{Rte\+Exception.\+error\+Code()}} may return the following Error\+Code\+:
\begin{DoxyItemize}
\item Error\+Code.\+I\+N\+V\+A\+L\+I\+D\+\_\+\+A\+R\+G\+U\+M\+E\+NT\+: The mode parameter is set to an illegal value. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config_acd468d21fcc8948afa869af1afcb4204}\label{classio_1_1agora_1_1rte_1_1_canvas_config_acd468d21fcc8948afa869af1afcb4204}} 
\index{io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}!getVideoRenderMode@{getVideoRenderMode}}
\index{getVideoRenderMode@{getVideoRenderMode}!io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}}
\doxysubsubsection{\texorpdfstring{getVideoRenderMode()}{getVideoRenderMode()}}
{\footnotesize\ttfamily Constants.\+Video\+Render\+Mode io.\+agora.\+rte.\+Canvas\+Config.\+get\+Video\+Render\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}



Gets the currently set mirror mode. 

\begin{DoxySince}{Since}
v4.\+4.\+0
\end{DoxySince}
Call timing\+: You need to call this method after {\ttfamily get\+Configs(\+Canvas\+Config config)}.

\begin{DoxyReturn}{Returns}
The currently set mirror mode. See {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_video_mirror_mode}{Video\+Mirror\+Mode}}} for details. 
\end{DoxyReturn}

\begin{DoxyExceptions}{Exceptions}
{\em Rte\+Exception} & If the method call fails, the S\+DK throws an {\ttfamily Rte\+Exception} with the corresponding error information. You need to catch and handle the exception. \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config_a5bc2963b3bc2af9bf815c9b43ff5d049}\label{classio_1_1agora_1_1rte_1_1_canvas_config_a5bc2963b3bc2af9bf815c9b43ff5d049}} 
\index{io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}!setVideoMirrorMode@{setVideoMirrorMode}}
\index{setVideoMirrorMode@{setVideoMirrorMode}!io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}}
\doxysubsubsection{\texorpdfstring{setVideoMirrorMode()}{setVideoMirrorMode()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Canvas\+Config.\+set\+Video\+Mirror\+Mode (\begin{DoxyParamCaption}\item[{Constants.\+Video\+Mirror\+Mode}]{mode }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}



Sets the video mirror mode. 

\begin{DoxySince}{Since}
v4.\+4.\+0
\end{DoxySince}
Call timing\+: You must call this method before {\ttfamily set\+Configs(\+Canvas\+Config config)}.


\begin{DoxyParams}{Parameters}
{\em mode} & The mirror mode. See {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_video_mirror_mode}{Video\+Mirror\+Mode}}} for details. The default value is {\ttfamily A\+U\+TO}, which lets the S\+DK determine the mirror mode. By default, the mirror mode for remote users is disabled.\\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em Rte\+Exception} & If the method call fails, the S\+DK throws an {\ttfamily Rte\+Exception} with the corresponding error information. You need to catch and handle the exception. \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_config_a742685895042d5d1d797b19bf9e1650c}\label{classio_1_1agora_1_1rte_1_1_canvas_config_a742685895042d5d1d797b19bf9e1650c}} 
\index{io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}!getVideoMirrorMode@{getVideoMirrorMode}}
\index{getVideoMirrorMode@{getVideoMirrorMode}!io.agora.rte.CanvasConfig@{io.agora.rte.CanvasConfig}}
\doxysubsubsection{\texorpdfstring{getVideoMirrorMode()}{getVideoMirrorMode()}}
{\footnotesize\ttfamily Constants.\+Video\+Mirror\+Mode io.\+agora.\+rte.\+Canvas\+Config.\+get\+Video\+Mirror\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Get the video mirror mode. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_video_mirror_mode}{Video\+Mirror\+Mode}} 
\end{DoxyReturn}
