\hypertarget{classio_1_1agora_1_1rte_1_1_rte}{}\doxysection{io.\+agora.\+rte.\+Rte Class Reference}
\label{classio_1_1agora_1_1rte_1_1_rte}\index{io.agora.rte.Rte@{io.agora.rte.Rte}}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_aa07026c8b88c0272269d5ae6e9ad5006}\label{classio_1_1agora_1_1rte_1_1_rte_aa07026c8b88c0272269d5ae6e9ad5006}} 
{\bfseries Rte} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_initial_config}{Initial\+Config}} initial\+Config)
\item 
synchronized void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte_a5f24d5e108d0acd968e45ced6d7041e0}{destroy}} ()  throws Rte\+Exception 
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_ad25e43d37971aa99e5648eb1dcb5ac41}\label{classio_1_1agora_1_1rte_1_1_rte_ad25e43d37971aa99e5648eb1dcb5ac41}} 
long {\bfseries get\+Native\+Handle} ()
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte_a24928ab95aa8204425181e70c69a5f71}{init\+Media\+Engine}} (\mbox{\hyperlink{interfaceio_1_1agora_1_1rte_1_1callback_1_1_async_callback}{Async\+Callback}} call\+Back)  throws Rte\+Exception 
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte_aa9a0d8e65aedf26551b261f0b9a1efaa}{get\+Configs}} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_config}{Config}} config)  throws Rte\+Exception 
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte_a873ebfcf0fbb35cb988506cb4d2ebb4f}{set\+Configs}} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_config}{Config}} config)  throws Rte\+Exception 
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte_a5be8d918886e8a375cbd366992353a15}{register\+Observer}} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_observer}{Observer}} observer)  throws Rte\+Exception 
\item 
void \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte_aa5760f6fee5312e3e533d1a0587728d6}{unregister\+Observer}} (\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_observer}{Observer}} observer)  throws Rte\+Exception 
\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static synchronized \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte_ac38316989232ba9ac35a946e832f00a2}{get\+From\+Bridge}} ()  throws Rte\+Exception 
\end{DoxyCompactItemize}
\doxysubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_af75888866dac183c3f8107da3db9c746}\label{classio_1_1agora_1_1rte_1_1_rte_af75888866dac183c3f8107da3db9c746}} 
static final String {\bfseries T\+AG} = \char`\"{}Rte\char`\"{}
\end{DoxyCompactItemize}
\doxysubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_a1c9521af815e57bb1025d2ab5fa736dd}\label{classio_1_1agora_1_1rte_1_1_rte_a1c9521af815e57bb1025d2ab5fa736dd}} 
void {\bfseries finalize} ()
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} class, which is the basic interface of the Agora Real Time Engagement S\+DK. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_ac38316989232ba9ac35a946e832f00a2}\label{classio_1_1agora_1_1rte_1_1_rte_ac38316989232ba9ac35a946e832f00a2}} 
\index{io.agora.rte.Rte@{io.agora.rte.Rte}!getFromBridge@{getFromBridge}}
\index{getFromBridge@{getFromBridge}!io.agora.rte.Rte@{io.agora.rte.Rte}}
\doxysubsubsection{\texorpdfstring{getFromBridge()}{getFromBridge()}}
{\footnotesize\ttfamily static synchronized \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} io.\+agora.\+rte.\+Rte.\+get\+From\+Bridge (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}\hspace{0.3cm}{\ttfamily [static]}}

Create an \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} object from the rtc bridge. Used in scenarios where the rtc engine has already been initialized, which can save the operation of initializing the rte engine. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\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\+: Indicates that the rtc engine instance has not been created or the rtc engine has not been initialized. Unable to bridge rte from rtc engine. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} object. If the \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} object is invalid, subsequent operations on \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} will return an error. 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_a5f24d5e108d0acd968e45ced6d7041e0}\label{classio_1_1agora_1_1rte_1_1_rte_a5f24d5e108d0acd968e45ced6d7041e0}} 
\index{io.agora.rte.Rte@{io.agora.rte.Rte}!destroy@{destroy}}
\index{destroy@{destroy}!io.agora.rte.Rte@{io.agora.rte.Rte}}
\doxysubsubsection{\texorpdfstring{destroy()}{destroy()}}
{\footnotesize\ttfamily synchronized void io.\+agora.\+rte.\+Rte.\+destroy (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Destroy the \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} object. The operation will release all resources used by the \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} object. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\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_rte}{Rte}} object has already been destroyed or is invalid. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_a24928ab95aa8204425181e70c69a5f71}\label{classio_1_1agora_1_1rte_1_1_rte_a24928ab95aa8204425181e70c69a5f71}} 
\index{io.agora.rte.Rte@{io.agora.rte.Rte}!initMediaEngine@{initMediaEngine}}
\index{initMediaEngine@{initMediaEngine}!io.agora.rte.Rte@{io.agora.rte.Rte}}
\doxysubsubsection{\texorpdfstring{initMediaEngine()}{initMediaEngine()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Rte.\+init\+Media\+Engine (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{interfaceio_1_1agora_1_1rte_1_1callback_1_1_async_callback}{Async\+Callback}}}]{call\+Back }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

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

\begin{DoxyParams}{Parameters}
{\em call\+Back} & Asynchronous callback function that returns the result of engine initialization.
\begin{DoxyItemize}
\item 
\end{DoxyItemize}\\
\hline
{\em error} & Possible Error\+Code returns\+:
\begin{DoxyItemize}
\item Error\+Code.\+OK\+: Success
\item Error\+Code.\+D\+E\+F\+A\+U\+LT\+: Engine initialization failed, specific error reason can be obtained through Error.\+Message().
\item Error\+Code.\+I\+N\+V\+A\+L\+I\+D\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON\+: \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_rte}{Rte}} object created through Get\+From\+Bridge, initialization is not allowed. 
\end{DoxyItemize}\\
\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.\+D\+E\+F\+A\+U\+LT\+: Engine initialization failed, specific error description can be obtained through Rte\+Exception.\+get\+Message().
\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_rte}{Rte}} object has been destroyed or is invalid. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_aa9a0d8e65aedf26551b261f0b9a1efaa}\label{classio_1_1agora_1_1rte_1_1_rte_aa9a0d8e65aedf26551b261f0b9a1efaa}} 
\index{io.agora.rte.Rte@{io.agora.rte.Rte}!getConfigs@{getConfigs}}
\index{getConfigs@{getConfigs}!io.agora.rte.Rte@{io.agora.rte.Rte}}
\doxysubsubsection{\texorpdfstring{getConfigs()}{getConfigs()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Rte.\+get\+Configs (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_config}{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_rte}{Rte}} object. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em config} & The object used to get the rte config configuration. \\
\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_rte}{Rte}} 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_rte_a873ebfcf0fbb35cb988506cb4d2ebb4f}\label{classio_1_1agora_1_1rte_1_1_rte_a873ebfcf0fbb35cb988506cb4d2ebb4f}} 
\index{io.agora.rte.Rte@{io.agora.rte.Rte}!setConfigs@{setConfigs}}
\index{setConfigs@{setConfigs}!io.agora.rte.Rte@{io.agora.rte.Rte}}
\doxysubsubsection{\texorpdfstring{setConfigs()}{setConfigs()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Rte.\+set\+Configs (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_config}{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_rte}{Rte}} object. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em config} & The object used to set the rte config configuration. \\
\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_rte}{Rte}} 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_rte_a5be8d918886e8a375cbd366992353a15}\label{classio_1_1agora_1_1rte_1_1_rte_a5be8d918886e8a375cbd366992353a15}} 
\index{io.agora.rte.Rte@{io.agora.rte.Rte}!registerObserver@{registerObserver}}
\index{registerObserver@{registerObserver}!io.agora.rte.Rte@{io.agora.rte.Rte}}
\doxysubsubsection{\texorpdfstring{registerObserver()}{registerObserver()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Rte.\+register\+Observer (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_observer}{Observer}}}]{observer }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Register an rte observer. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em observer} & The object that observes rte callback events. \\
\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_rte}{Rte}} 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 registered observer object is null. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rte_1_1_rte_aa5760f6fee5312e3e533d1a0587728d6}\label{classio_1_1agora_1_1rte_1_1_rte_aa5760f6fee5312e3e533d1a0587728d6}} 
\index{io.agora.rte.Rte@{io.agora.rte.Rte}!unregisterObserver@{unregisterObserver}}
\index{unregisterObserver@{unregisterObserver}!io.agora.rte.Rte@{io.agora.rte.Rte}}
\doxysubsubsection{\texorpdfstring{unregisterObserver()}{unregisterObserver()}}
{\footnotesize\ttfamily void io.\+agora.\+rte.\+Rte.\+unregister\+Observer (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classio_1_1agora_1_1rte_1_1_observer}{Observer}}}]{observer }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classio_1_1agora_1_1rte_1_1exception_1_1_rte_exception}{Rte\+Exception}}}

Unregister an rte observer. \begin{DoxySince}{Since}
v4.\+4.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em observer} & The object that observes rte callback events. \\
\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_rte}{Rte}} 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 observer object to be unregistered is null. 
\end{DoxyItemize}\\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
