\hypertarget{classio_1_1agora_1_1rte_1_1_canvas}{}\doxysection{io.\+agora.\+rte.\+Canvas Class Reference}
\label{classio_1_1agora_1_1rte_1_1_canvas}\index{io.agora.rte.Canvas@{io.agora.rte.Canvas}}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_ad5c278ee0947328ca8fd37e0bd10aab9}{Canvas}} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} rte, \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_initial_config}{Canvas\+Initial\+Config}} config)
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_a7b01340c0fe57a5cb7753d2de320274a}\label{classio_1_1agora_1_1rte_1_1_canvas_a7b01340c0fe57a5cb7753d2de320274a}} 
long {\bfseries get\+Native\+Handle} ()
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_a2e1cad856d8264b8594d9e4b26dd133e}{add\+View}} (View view, \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_view_config}{View\+Config}} view\+Config)  throws Rte\+Exception 
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_ab6c2f3079f2c4a89407825e713f8b8a8}{remove\+View}} (View view, \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_view_config}{View\+Config}} view\+Config)  throws Rte\+Exception 
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_a9b691257a56d25bd21c292fcafe805ae}{get\+Configs}} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config}{Canvas\+Config}} config)  throws Rte\+Exception 
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_a2a5b6a3fb71f107f1b0f3a1cdebe8084}{set\+Configs}} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config}{Canvas\+Config}} config)  throws Rte\+Exception 
\end{DoxyCompactItemize}
\doxysubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_ac8a62e2eb1cc821faabdf4229f9381f8}\label{classio_1_1agora_1_1rte_1_1_canvas_ac8a62e2eb1cc821faabdf4229f9381f8}} 
void {\bfseries finalize} ()
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas}{Canvas}} interface, used to set the video rendering view. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}


\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_ad5c278ee0947328ca8fd37e0bd10aab9}\label{classio_1_1agora_1_1rte_1_1_canvas_ad5c278ee0947328ca8fd37e0bd10aab9}} 
\index{io.agora.rte.Canvas@{io.agora.rte.Canvas}!Canvas@{Canvas}}
\index{Canvas@{Canvas}!io.agora.rte.Canvas@{io.agora.rte.Canvas}}
\doxysubsubsection{\texorpdfstring{Canvas()}{Canvas()}}
{\footnotesize\ttfamily io.\+agora.\+rte.\+Canvas.\+Canvas (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}}}]{rte,  }\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_initial_config}{Canvas\+Initial\+Config}}}]{config }\end{DoxyParamCaption})}

Construct a \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas}{Canvas}} object. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em rte} & \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} object. \\
\hline
{\em config} & \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_initial_config}{Canvas\+Initial\+Config}} initialization configuration object. Currently, a null pointer can be passed. \\
\hline
\end{DoxyParams}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_a2e1cad856d8264b8594d9e4b26dd133e}\label{classio_1_1agora_1_1rte_1_1_canvas_a2e1cad856d8264b8594d9e4b26dd133e}} 
\index{io.agora.rte.Canvas@{io.agora.rte.Canvas}!addView@{addView}}
\index{addView@{addView}!io.agora.rte.Canvas@{io.agora.rte.Canvas}}
\doxysubsubsection{\texorpdfstring{addView()}{addView()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Canvas.\+add\+View (\begin{DoxyParamCaption}\item[{View}]{view,  }\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_view_config}{View\+Config}}}]{view\+Config }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Add a rendering view. Currently, only one view is supported. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em view} & Pointer to the View object. On the Android platform, you can assign an Surface\+View object to a View type variable and pass it to the interface. \\
\hline
{\em config} & View-\/related configuration. Currently, nullptr can be passed. \\
\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\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON\+: The corresponding internal \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas}{Canvas}} object has been destroyed or is invalid.
\item Error\+Code.\+I\+N\+V\+A\+L\+I\+D\+\_\+\+A\+R\+G\+U\+M\+E\+NT\+: The passed view is null. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_ab6c2f3079f2c4a89407825e713f8b8a8}\label{classio_1_1agora_1_1rte_1_1_canvas_ab6c2f3079f2c4a89407825e713f8b8a8}} 
\index{io.agora.rte.Canvas@{io.agora.rte.Canvas}!removeView@{removeView}}
\index{removeView@{removeView}!io.agora.rte.Canvas@{io.agora.rte.Canvas}}
\doxysubsubsection{\texorpdfstring{removeView()}{removeView()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Canvas.\+remove\+View (\begin{DoxyParamCaption}\item[{View}]{view,  }\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_view_config}{View\+Config}}}]{view\+Config }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Remove a rendering view. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em view} & Pointer to the View object. \\
\hline
{\em config} & View-\/related configuration. Currently, nullptr can be passed. \\
\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\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON\+: The corresponding internal \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas}{Canvas}} object has been destroyed or is invalid.
\item Error\+Code.\+I\+N\+V\+A\+L\+I\+D\+\_\+\+A\+R\+G\+U\+M\+E\+NT\+: The passed view is null. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_a9b691257a56d25bd21c292fcafe805ae}\label{classio_1_1agora_1_1rte_1_1_canvas_a9b691257a56d25bd21c292fcafe805ae}} 
\index{io.agora.rte.Canvas@{io.agora.rte.Canvas}!getConfigs@{getConfigs}}
\index{getConfigs@{getConfigs}!io.agora.rte.Canvas@{io.agora.rte.Canvas}}
\doxysubsubsection{\texorpdfstring{getConfigs()}{getConfigs()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Canvas.\+get\+Configs (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config}{Canvas\+Config}}}]{config }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Get the configuration of \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas}{Canvas}} object. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em config} & \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config}{Canvas\+Config}} object \\
\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\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON\+: The corresponding internal \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas}{Canvas}} object has been destroyed or is invalid.
\item Error\+Code.\+I\+N\+V\+A\+L\+I\+D\+\_\+\+A\+R\+G\+U\+M\+E\+NT\+: The passed config object is null. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_canvas_a2a5b6a3fb71f107f1b0f3a1cdebe8084}\label{classio_1_1agora_1_1rte_1_1_canvas_a2a5b6a3fb71f107f1b0f3a1cdebe8084}} 
\index{io.agora.rte.Canvas@{io.agora.rte.Canvas}!setConfigs@{setConfigs}}
\index{setConfigs@{setConfigs}!io.agora.rte.Canvas@{io.agora.rte.Canvas}}
\doxysubsubsection{\texorpdfstring{setConfigs()}{setConfigs()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Canvas.\+set\+Configs (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config}{Canvas\+Config}}}]{config }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Configure the \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas}{Canvas}} object. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em config} & \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas_config}{Canvas\+Config}} object \\
\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\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON\+: The corresponding internal \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_canvas}{Canvas}} object has been destroyed or is invalid.
\item Error\+Code.\+I\+N\+V\+A\+L\+I\+D\+\_\+\+A\+R\+G\+U\+M\+E\+NT\+: The passed config object is null. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
