\hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler}{}\doxysection{agora\+::rtc\+::I\+Rtc\+Engine\+Event\+Handler Class Reference}
\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler}\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}


{\ttfamily \#include $<$I\+Agora\+Rtc\+Engine.\+h$>$}

Inheritance diagram for agora\+::rtc\+::I\+Rtc\+Engine\+Event\+Handler\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classagora_1_1rtc_1_1_i_rtc_engine_event_handler}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a9c9dd9062eb94ff1659f4e62d801281b}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a9c9dd9062eb94ff1659f4e62d801281b}} 
virtual const char $\ast$ {\bfseries event\+Handler\+Type} () const
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aafceb1f91ae9bd82317bf25981e6851b}{on\+Join\+Channel\+Success}} (const char $\ast$channel, uid\+\_\+t uid, int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when a user joins a channel. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a89b17edd14a8bbf0bb67d0478a92fbc5}{on\+Rejoin\+Channel\+Success}} (const char $\ast$channel, uid\+\_\+t uid, int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when a user rejoins the channel. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a6c0ae1f75c9b1711e7ab32c8949e1605}{on\+Proxy\+Connected}} (const char $\ast$channel, uid\+\_\+t uid, P\+R\+O\+X\+Y\+\_\+\+T\+Y\+PE proxy\+Type, const char $\ast$local\+Proxy\+Ip, int elapsed)
\begin{DoxyCompactList}\small\item\em Reports the proxy connection state. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1775762d8ac3b7357ea130bfd600883c}{on\+Error}} (int err, const char $\ast$msg)
\begin{DoxyCompactList}\small\item\em Reports an error during S\+DK runtime. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab612312f6b4f72e1a036ef7683b8d324}{on\+Audio\+Quality}} (uid\+\_\+t uid, int quality, unsigned short delay, unsigned short lost) \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Reports the statistics of the audio stream sent by each remote user. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a44134dfda5d412831fa8e44fa533fca5}{on\+Lastmile\+Probe\+Result}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_lastmile_probe_result}{Lastmile\+Probe\+Result}} \&result)
\begin{DoxyCompactList}\small\item\em Reports the last mile network probe result. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aab1184a2b276f509870c055a9ff8fac4}{on\+Audio\+Volume\+Indication}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_audio_volume_info}{Audio\+Volume\+Info}} $\ast$speakers, unsigned int speaker\+Number, int total\+Volume)
\begin{DoxyCompactList}\small\item\em Reports the volume information of users. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a98f832d175dfc044b31f0ec5874460fb}{on\+Leave\+Channel}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_stats}{Rtc\+Stats}} \&stats)
\begin{DoxyCompactList}\small\item\em Occurs when a user leaves a channel. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ada38743982296a75879018c5773f08a1}{on\+Rtc\+Stats}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_stats}{Rtc\+Stats}} \&stats)
\begin{DoxyCompactList}\small\item\em Reports the statistics about the current call. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad2c6869aad679efab62b1cbeb276f964}{on\+Audio\+Device\+State\+Changed}} (const char $\ast$device\+Id, int device\+Type, int device\+State)
\begin{DoxyCompactList}\small\item\em Occurs when the audio device state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2423a5f76054fdbf35985f3357b0fda2}{on\+Audio\+Mixing\+Position\+Changed}} (int64\+\_\+t position)
\begin{DoxyCompactList}\small\item\em Reports the playback progress of a music file. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a844b1585ecc0c86471d7dd5a462eaaf3}{on\+Audio\+Mixing\+Finished}} () \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when the playback of the local music file finishes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab329b207f42408b3f673837a5de3b9e5}{on\+Audio\+Effect\+Finished}} (int sound\+Id)
\begin{DoxyCompactList}\small\item\em Occurs when the playback of the local music file finishes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a9a7c5dbb1b7452eed2dc32dbbe8e2ce9}{on\+Video\+Device\+State\+Changed}} (const char $\ast$device\+Id, int device\+Type, int device\+State)
\begin{DoxyCompactList}\small\item\em Occurs when the video device state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a80003ae8cce02039f3aa0e8ffad7deed}{on\+Network\+Quality}} (uid\+\_\+t uid, int tx\+Quality, int rx\+Quality)
\begin{DoxyCompactList}\small\item\em Reports the last mile network quality of each user in the channel. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2747779b0e8f7eb644069d134affd433}{on\+Intra\+Request\+Received}} ()
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa229c7b7832a13901683705e5371c40a}{on\+Uplink\+Network\+Info\+Updated}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_uplink_network_info}{Uplink\+Network\+Info}} \&info)
\begin{DoxyCompactList}\small\item\em Occurs when the uplink network information changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac7e14d1a26eb35ef236a0662d28d2b33}{on\+Lastmile\+Quality}} (int quality)
\begin{DoxyCompactList}\small\item\em Reports the last-\/mile network quality of the local user. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a15cb3afe45c869c129451c54b4383619}{on\+First\+Local\+Video\+Frame}} (V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source, int width, int height, int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when the first local video frame is displayed on the local video view. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a734c39289a40a97bc3dcd7df9413034a}{on\+First\+Local\+Video\+Frame\+Published}} (V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source, int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when the first video frame is published. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad8083c52d15135762a31c48192ad64f2}{on\+First\+Remote\+Video\+Decoded}} (uid\+\_\+t uid, int width, int height, int elapsed) \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when the first remote video frame is received and decoded. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3ef9bc5dd7c16c92ed1707cca4594bfb}{on\+Video\+Size\+Changed}} (V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source\+Type, uid\+\_\+t uid, int width, int height, int rotation)
\begin{DoxyCompactList}\small\item\em Occurs when the video size or rotation of a specified user changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a86730fd0927e730bf9f375a5edb33cd8}{on\+Local\+Video\+Event}} (V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source, L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+E\+V\+E\+N\+T\+\_\+\+T\+Y\+PE event)
\begin{DoxyCompactList}\small\item\em Occurs when the local video event occurs. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a48101bcc663c35b2b86562a20ea2eb96}{on\+Local\+Video\+State\+Changed}} (V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source, L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+TE state, L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+ON reason)
\begin{DoxyCompactList}\small\item\em Occurs when the local video stream state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae69799238c6a6cd9f017274dd630b74e}{on\+Remote\+Video\+State\+Changed}} (uid\+\_\+t uid, R\+E\+M\+O\+T\+E\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+A\+TE state, R\+E\+M\+O\+T\+E\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+A\+T\+E\+\_\+\+R\+E\+A\+S\+ON reason, int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when the remote video stream state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1caf7870fa39a8b938d8d485c3ee7dce}{on\+First\+Remote\+Video\+Frame}} (uid\+\_\+t uid, int width, int height, int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when the renderer receives the first frame of the remote video. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a985a675469baf9d54feb8781732e0ca8}{on\+User\+Joined}} (uid\+\_\+t uid, int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins the channel. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a9602593c05a16eafa7c094aa330c0719}{on\+User\+Offline}} (uid\+\_\+t uid, U\+S\+E\+R\+\_\+\+O\+F\+F\+L\+I\+N\+E\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE reason)
\begin{DoxyCompactList}\small\item\em Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves the channel. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a00433467903bd28b77631179a89a5bc6}{on\+User\+Mute\+Audio}} (uid\+\_\+t uid, bool muted)
\begin{DoxyCompactList}\small\item\em Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) stops/resumes sending the audio stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a8279591a761a5c2c1c4c1c4e677cbe0e}{on\+User\+Mute\+Video}} (uid\+\_\+t uid, bool muted)
\begin{DoxyCompactList}\small\item\em Occurs when a remote user stops or resumes publishing the video stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a91bef59a3659b6e6bcbe43eb203d0732}{on\+User\+Enable\+Video}} (uid\+\_\+t uid, bool enabled)
\begin{DoxyCompactList}\small\item\em Occurs when a remote user enables or disables the video module. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2744650deb07a19c91f342363d606451}{on\+User\+State\+Changed}} (uid\+\_\+t uid, R\+E\+M\+O\+T\+E\+\_\+\+U\+S\+E\+R\+\_\+\+S\+T\+A\+TE state)
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a199de5107bfc84c056998e2e45bba772}{on\+User\+Enable\+Local\+Video}} (uid\+\_\+t uid, bool enabled) \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when a specific remote user enables/disables the local video capturing function. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af8a59626a9265264fb4638e048091d3a}{on\+Remote\+Audio\+Stats}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_remote_audio_stats}{Remote\+Audio\+Stats}} \&stats)
\begin{DoxyCompactList}\small\item\em Reports the transport-\/layer statistics of each remote audio stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0cb47df6a8ef7acee229eb307d6f32c3}{on\+Local\+Audio\+Stats}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_local_audio_stats}{Local\+Audio\+Stats}} \&stats)
\begin{DoxyCompactList}\small\item\em Reports the statistics of the local audio stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3476915aca1141cb7821dba9da41af2b}{on\+Local\+Video\+Stats}} (V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source, const \mbox{\hyperlink{structagora_1_1rtc_1_1_local_video_stats}{Local\+Video\+Stats}} \&stats)
\begin{DoxyCompactList}\small\item\em Reports the statistics of the local video stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7163ffb650852be270ba0215b596d968}{on\+Remote\+Video\+Stats}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_remote_video_stats}{Remote\+Video\+Stats}} \&stats)
\begin{DoxyCompactList}\small\item\em Reports the statistics of the video stream sent by each remote users. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a630b63e8df71ab9f19a96b425fce7c94}{on\+Camera\+Ready}} () \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when the camera turns on and is ready to capture the video. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0e048d57ff13f946be1a1334d11f0ac6}{on\+Camera\+Focus\+Area\+Changed}} (int x, int y, int width, int height)
\begin{DoxyCompactList}\small\item\em Occurs when the camera focus area changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2fd62dcf7c816477ef559a9d2b3c43f3}{on\+Camera\+Exposure\+Area\+Changed}} (int x, int y, int width, int height)
\begin{DoxyCompactList}\small\item\em Occurs when the camera exposure area changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a595a28e6f0d3390aa4340ed13a80c234}{on\+Video\+Stopped}} () \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when the video stops playing. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae2e257d7bbf120b970b600b9b3731a07}{on\+Audio\+Mixing\+State\+Changed}} (A\+U\+D\+I\+O\+\_\+\+M\+I\+X\+I\+N\+G\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE state, A\+U\+D\+I\+O\+\_\+\+M\+I\+X\+I\+N\+G\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE reason)
\begin{DoxyCompactList}\small\item\em Occurs when the playback state of the music file changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a97dd875cfa6e9eb83657797bc2e406a8}{on\+Rhythm\+Player\+State\+Changed}} (R\+H\+Y\+T\+H\+M\+\_\+\+P\+L\+A\+Y\+E\+R\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE state, R\+H\+Y\+T\+H\+M\+\_\+\+P\+L\+A\+Y\+E\+R\+\_\+\+R\+E\+A\+S\+ON reason)
\begin{DoxyCompactList}\small\item\em Occurs when the state of virtual metronome changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab5c110382a2ef7eb92cd069c22884727}{on\+Connection\+Lost}} ()
\begin{DoxyCompactList}\small\item\em Occurs when the S\+DK cannot reconnect to Agora\textquotesingle{}s edge server 10 seconds after its connection to the server is interrupted. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac5d532fe92a0d6c424e87e694225b6e9}{on\+Connection\+Interrupted}} () \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when the connection between the S\+DK and the server is interrupted. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a96abb5e2fef0afc0a80e87388ebdaa5e}{on\+Connection\+Banned}} () \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when the connection is banned by the Agora server. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0add560882999732aec21098c29280e0}{on\+Stream\+Message}} (uid\+\_\+t uid, int stream\+Id, const char $\ast$data, size\+\_\+t length, uint64\+\_\+t sent\+Ts)
\begin{DoxyCompactList}\small\item\em Occurs when the local user receives the data stream from the remote user. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3af56e33ca95ccc6b9dce4b2a51c2b33}{on\+Stream\+Message\+Error}} (uid\+\_\+t uid, int stream\+Id, int code, int missed, int cached)
\begin{DoxyCompactList}\small\item\em Occurs when the local user does not receive the data stream from the remote user. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab9b8efc5d670fe14dd0cea7da23b57f2}{on\+Rdt\+Message}} (uid\+\_\+t user\+Id, Rdt\+Stream\+Type type, const char $\ast$data, size\+\_\+t length)
\begin{DoxyCompactList}\small\item\em Occurs when the local user receives data via Reliable Data Transmission (R\+DT) from a remote user. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a74076ace2c84fb29dc4586d4db33b1b4}{on\+Rdt\+State\+Changed}} (uid\+\_\+t user\+Id, Rdt\+State state)
\begin{DoxyCompactList}\small\item\em Occurs when the R\+DT tunnel state changed. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a82a1082fc12fcc26beacb0bdc055ac91}{on\+Media\+Control\+Message}} (uid\+\_\+t user\+Id, const char $\ast$data, size\+\_\+t length)
\begin{DoxyCompactList}\small\item\em Occurs when the local user receives media control message sent by a remote user. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa7b456b750f56ca8fdfee8611572310e}{on\+Request\+Token}} ()
\begin{DoxyCompactList}\small\item\em Occurs when the token expires. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac401db99e49d5f240f553087cb90571d}{on\+Token\+Privilege\+Will\+Expire}} (const char $\ast$token)
\begin{DoxyCompactList}\small\item\em Occurs when the token expires in 30 seconds. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a40b29ba97d3519619e22069718f27add}{on\+License\+Validation\+Failure}} (L\+I\+C\+E\+N\+S\+E\+\_\+\+E\+R\+R\+O\+R\+\_\+\+T\+Y\+PE error)
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a03058e62a0a4a41e80ecf0279975ab99}{on\+First\+Local\+Audio\+Frame\+Published}} (int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when the first audio frame is published. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a599399089441b7daa560e9c410e8a7ba}{on\+First\+Remote\+Audio\+Decoded}} (uid\+\_\+t uid, int elapsed) \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when the S\+DK decodes the first remote audio frame for playback. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a160165e2d77abe9b35d1a2e638e2ced7}{on\+First\+Remote\+Audio\+Frame}} (uid\+\_\+t uid, int elapsed) \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Occurs when the S\+DK receives the first audio frame from a specific remote user. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a32079919217571134d36b01252de60d3}{on\+Local\+Audio\+State\+Changed}} (L\+O\+C\+A\+L\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+TE state, L\+O\+C\+A\+L\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+ON reason)
\begin{DoxyCompactList}\small\item\em Occurs when the local audio stream state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa168380f86f1dc2df1c269a785c56612}{on\+Remote\+Audio\+State\+Changed}} (uid\+\_\+t uid, R\+E\+M\+O\+T\+E\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+A\+TE state, R\+E\+M\+O\+T\+E\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+A\+T\+E\+\_\+\+R\+E\+A\+S\+ON reason, int elapsed)
\begin{DoxyCompactList}\small\item\em Occurs when the remote audio state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae643c9dbf94360a23a8b3a56c93f90bc}{on\+Active\+Speaker}} (uid\+\_\+t uid)
\begin{DoxyCompactList}\small\item\em Occurs when the most active remote speaker is detected. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2479344eff97d9eecc19637008fa5092}{on\+Content\+Inspect\+Result}} (media\+::\+C\+O\+N\+T\+E\+N\+T\+\_\+\+I\+N\+S\+P\+E\+C\+T\+\_\+\+R\+E\+S\+U\+LT result)
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a6b8144c5a1591e06d6d854f703e97648}{on\+Snapshot\+Taken}} (uid\+\_\+t uid, const char $\ast$file\+Path, int width, int height, int err\+Code)
\begin{DoxyCompactList}\small\item\em Reports the result of taking a video snapshot. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a62ebb50a33d02175cddb4c655465cf20}{on\+Client\+Role\+Changed}} (C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE old\+Role, C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE new\+Role, const \mbox{\hyperlink{structagora_1_1rtc_1_1_client_role_options}{Client\+Role\+Options}} \&new\+Role\+Options)
\begin{DoxyCompactList}\small\item\em Occurs when the user role or the audience latency level changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7f7424742197df2e199981b7e0e50f4f}{on\+Client\+Role\+Change\+Failed}} (C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+C\+H\+A\+N\+G\+E\+\_\+\+F\+A\+I\+L\+E\+D\+\_\+\+R\+E\+A\+S\+ON reason, C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE current\+Role)
\begin{DoxyCompactList}\small\item\em Occurs when switching a user role fails. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0f99efc9aebf1242c2e8a49966ae21ae}{on\+Audio\+Device\+Volume\+Changed}} (M\+E\+D\+I\+A\+\_\+\+D\+E\+V\+I\+C\+E\+\_\+\+T\+Y\+PE device\+Type, int volume, bool muted)
\begin{DoxyCompactList}\small\item\em Reports the volume change of the audio device or app. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a01f3ce153df3a96703a0c9af934058f6}{on\+Rtmp\+Streaming\+State\+Changed}} (const char $\ast$url, R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE state, R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+R\+E\+A\+S\+ON reason)
\begin{DoxyCompactList}\small\item\em Occurs when the state of Media Push changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa2beb17562a3be9b5ddbe9366245cb0e}{on\+Rtmp\+Streaming\+Event}} (const char $\ast$url, R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+I\+N\+G\+\_\+\+E\+V\+E\+NT event\+Code)
\begin{DoxyCompactList}\small\item\em Reports events during the Media Push. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0583fb2aecbd4c51bba1af97ce1aa318}{on\+Transcoding\+Updated}} ()
\begin{DoxyCompactList}\small\item\em Occurs when the publisher\textquotesingle{}s transcoding is updated. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a5ad747e71cd7f57052a5240513af1949}{on\+Audio\+Routing\+Changed}} (int routing)
\begin{DoxyCompactList}\small\item\em Occurs when the local audio route changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1891ed124db5f74747e74ca3b3eb23e9}{on\+Channel\+Media\+Relay\+State\+Changed}} (int state, int code)
\begin{DoxyCompactList}\small\item\em Occurs when the state of the media stream relay changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7ee343146ad6e3f120bd04a7a6fdda74}{on\+Remote\+Subscribe\+Fallback\+To\+Audio\+Only}} (uid\+\_\+t uid, bool is\+Fallback\+Or\+Recover)
\begin{DoxyCompactList}\small\item\em Occurs when the remote media stream falls back to the audio-\/only stream due to poor network conditions or switches back to the video stream after the network conditions improve. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2aee5d99c0de8fa2f5cd71f5aa5f7128}{on\+Remote\+Audio\+Transport\+Stats}} (uid\+\_\+t uid, unsigned short delay, unsigned short lost, unsigned short rx\+K\+Bit\+Rate) \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Reports the transport-\/layer statistics of each remote audio stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aae6eb5cba66f6314ee806bc9be253ff6}{on\+Remote\+Video\+Transport\+Stats}} (uid\+\_\+t uid, unsigned short delay, unsigned short lost, unsigned short rx\+K\+Bit\+Rate) \+\_\+\+\_\+deprecated
\begin{DoxyCompactList}\small\item\em Reports the transport-\/layer statistics of each remote video stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af409b2e721d345a65a2c600cea2f5eb4}{on\+Connection\+State\+Changed}} (C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE state, C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+C\+H\+A\+N\+G\+E\+D\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE reason)
\begin{DoxyCompactList}\small\item\em Occurs when the network connection state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af71617b59ba8564963dfdd642f4e36a4}{on\+Network\+Type\+Changed}} (N\+E\+T\+W\+O\+R\+K\+\_\+\+T\+Y\+PE type)
\begin{DoxyCompactList}\small\item\em Occurs when the local network type changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad64b65c8bbb78624316770b01f2ee9bd}{on\+Encryption\+Error}} (E\+N\+C\+R\+Y\+P\+T\+I\+O\+N\+\_\+\+E\+R\+R\+O\+R\+\_\+\+T\+Y\+PE error\+Type)
\begin{DoxyCompactList}\small\item\em Reports the built-\/in encryption errors. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac3f1dae447118e5cb261bd10ea9edfa2}{on\+Permission\+Error}} (P\+E\+R\+M\+I\+S\+S\+I\+O\+N\+\_\+\+T\+Y\+PE permission\+Type)
\begin{DoxyCompactList}\small\item\em Occurs when the S\+DK cannot get the device permission. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a919404869f86412e1945c730e5219b20}{on\+Local\+User\+Registered}} (uid\+\_\+t uid, const char $\ast$user\+Account)
\begin{DoxyCompactList}\small\item\em Occurs when the local user registers a user account. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad086cc4d8e5555cc75a0ab264c16d5ff}{on\+User\+Info\+Updated}} (uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_user_info}{User\+Info}} \&info)
\begin{DoxyCompactList}\small\item\em Occurs when the S\+DK gets the user ID and user account of the remote user. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_acbd8141eb8257ec5e1c24c2fd978c229}{on\+User\+Account\+Updated}} (uid\+\_\+t uid, const char $\ast$user\+Account)
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af157b707afd93a5b0ab39569e46a6cd4}{on\+Video\+Rendering\+Tracing\+Result}} (uid\+\_\+t uid, M\+E\+D\+I\+A\+\_\+\+T\+R\+A\+C\+E\+\_\+\+E\+V\+E\+NT current\+Event, \mbox{\hyperlink{structagora_1_1rtc_1_1_video_rendering_tracing_info}{Video\+Rendering\+Tracing\+Info}} tracing\+Info)
\begin{DoxyCompactList}\small\item\em Video frame rendering event callback. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a10991aabb988c83f7515e9ea7eb693ad}{on\+Local\+Video\+Transcoder\+Error}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_video_stream}{Transcoding\+Video\+Stream}} \&stream, V\+I\+D\+E\+O\+\_\+\+T\+R\+A\+N\+S\+C\+O\+D\+E\+R\+\_\+\+E\+R\+R\+OR error)
\begin{DoxyCompactList}\small\item\em Occurs when there\textquotesingle{}s an error during the local video mixing. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a5f97ca5105b02f4381af3603d5a87ccf}{on\+Upload\+Log\+Result}} (const char $\ast$request\+Id, bool success, U\+P\+L\+O\+A\+D\+\_\+\+E\+R\+R\+O\+R\+\_\+\+R\+E\+A\+S\+ON reason)
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae3f517bd166a9e34aa77f9fbf137a7b9}{on\+Audio\+Subscribe\+State\+Changed}} (const char $\ast$channel, uid\+\_\+t uid, S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE old\+State, S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE new\+State, int elapse\+Since\+Last\+State)
\begin{DoxyCompactList}\small\item\em Occurs when the audio subscribing state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aebedc2b484b4e6b9f5d9a28aea997d65}{on\+Video\+Subscribe\+State\+Changed}} (const char $\ast$channel, uid\+\_\+t uid, S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE old\+State, S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE new\+State, int elapse\+Since\+Last\+State)
\begin{DoxyCompactList}\small\item\em Occurs when the video subscribing state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af5188bdc817fa62aac51b3dc627dfb64}{on\+Audio\+Publish\+State\+Changed}} (const char $\ast$channel, S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE old\+State, S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE new\+State, int elapse\+Since\+Last\+State)
\begin{DoxyCompactList}\small\item\em Occurs when the audio publishing state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae7b1f0d07f6c601717e38b101eda9d6c}{on\+Video\+Publish\+State\+Changed}} (V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source, const char $\ast$channel, S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE old\+State, S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE new\+State, int elapse\+Since\+Last\+State)
\begin{DoxyCompactList}\small\item\em Occurs when the video publishing state changes. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a4de055f77b40ca2aeab0d9132cbffc2a}{on\+Transcoded\+Stream\+Layout\+Info}} (uid\+\_\+t uid, int width, int height, int layout\+Count, const \mbox{\hyperlink{structagora_1_1_video_layout}{Video\+Layout}} $\ast$layoutlist)
\begin{DoxyCompactList}\small\item\em Occurs when the local user receives a mixed video stream carrying layout information. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a4a9e9a3c7d3a058191aeac328620aab9}{on\+Audio\+Metadata\+Received}} (uid\+\_\+t uid, const char $\ast$metadata, size\+\_\+t length)
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae9ab8501c677f6b25f9b61992578f50d}{on\+Extension\+Event\+With\+Context}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}} \&context, const char $\ast$key, const char $\ast$value)
\begin{DoxyCompactList}\small\item\em The event callback of the extension. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aec85c75025a10a0b03dc605f6b3652ae}{on\+Extension\+Started\+With\+Context}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}} \&context)
\begin{DoxyCompactList}\small\item\em Occurrs when the extension is enabled. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1776784b1d8870ef02c1d152a39ce5f3}{on\+Extension\+Stopped\+With\+Context}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}} \&context)
\begin{DoxyCompactList}\small\item\em Occurs when the extension is disabled. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a8a03f4eeead3215146302b2ed4458d06}{on\+Extension\+Error\+With\+Context}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}} \&context, int error, const char $\ast$message)
\begin{DoxyCompactList}\small\item\em Occurs when the extension runs incorrectly. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aee8751fc4c7ec335cc94b9d6b3df071a}{on\+Set\+Rtm\+Flag\+Result}} (int code)
\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3393ed4d85a160b57abd4ca7bc13002f}{on\+Multipath\+Stats}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_multipath_stats}{Multipath\+Stats}} \&stats)
\begin{DoxyCompactList}\small\item\em Report the multipath transmission statistics. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab02a474e317eb85459d79e5cf2296038}{on\+Renew\+Token\+Result}} (const char $\ast$token, R\+E\+N\+E\+W\+\_\+\+T\+O\+K\+E\+N\+\_\+\+E\+R\+R\+O\+R\+\_\+\+C\+O\+DE code)
\begin{DoxyCompactList}\small\item\em Callback for {\ttfamily renew\+Token} call result. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler}{I\+Rtc\+Engine\+Event\+Handler}} class.

The S\+DK uses this class to send callback event notifications to the app, and the app inherits the methods in this class to retrieve these event notifications.

All methods in this class have their default (empty) implementations, and the app can inherit only some of the required events instead of all. In the callback methods, the app should avoid time-\/consuming tasks or calling blocking A\+P\+Is, otherwise the S\+DK may not work properly. 

\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aafceb1f91ae9bd82317bf25981e6851b}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aafceb1f91ae9bd82317bf25981e6851b}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onJoinChannelSuccess@{onJoinChannelSuccess}}
\index{onJoinChannelSuccess@{onJoinChannelSuccess}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onJoinChannelSuccess()}{onJoinChannelSuccess()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Join\+Channel\+Success (\begin{DoxyParamCaption}\item[{const char $\ast$}]{channel,  }\item[{uid\+\_\+t}]{uid,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a user joins a channel. 

This callback notifies the application that a user joins a specified channel. Call timing\+: The S\+DK triggers this callback when you call {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ info, uid\+\_\+t uid)}, {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} , {\ttfamily join\+Channel\+With\+User\+Account(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ user\+Account)}, {\ttfamily join\+Channel\+With\+User\+Account(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ user\+Account, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} , {\ttfamily join\+Channel\+Ex} or {\ttfamily join\+Channel\+With\+User\+Account\+Ex} to join a channel.


\begin{DoxyParams}{Parameters}
{\em channel} & The channel name. \\
\hline
{\em uid} & The ID of the user who joins the channel. \\
\hline
{\em elapsed} & The time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a89b17edd14a8bbf0bb67d0478a92fbc5}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a89b17edd14a8bbf0bb67d0478a92fbc5}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRejoinChannelSuccess@{onRejoinChannelSuccess}}
\index{onRejoinChannelSuccess@{onRejoinChannelSuccess}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRejoinChannelSuccess()}{onRejoinChannelSuccess()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Rejoin\+Channel\+Success (\begin{DoxyParamCaption}\item[{const char $\ast$}]{channel,  }\item[{uid\+\_\+t}]{uid,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a user rejoins the channel. 

Call timing\+: When a user loses connection with the server because of network problems, the S\+DK automatically tries to reconnect and triggers this callback upon reconnection.


\begin{DoxyParams}{Parameters}
{\em channel} & The channel name. \\
\hline
{\em uid} & The ID of the user who rejoins the channel. \\
\hline
{\em elapsed} & Time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a6c0ae1f75c9b1711e7ab32c8949e1605}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a6c0ae1f75c9b1711e7ab32c8949e1605}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onProxyConnected@{onProxyConnected}}
\index{onProxyConnected@{onProxyConnected}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onProxyConnected()}{onProxyConnected()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Proxy\+Connected (\begin{DoxyParamCaption}\item[{const char $\ast$}]{channel,  }\item[{uid\+\_\+t}]{uid,  }\item[{P\+R\+O\+X\+Y\+\_\+\+T\+Y\+PE}]{proxy\+Type,  }\item[{const char $\ast$}]{local\+Proxy\+Ip,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the proxy connection state. 

You can use this callback to listen for the state of the S\+DK connecting to a proxy. For example, when a user calls {\ttfamily set\+Cloud\+Proxy} and joins a channel successfully, the S\+DK triggers this callback to report the user ID, the proxy type connected, and the time elapsed fromthe user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until this callback is triggered.


\begin{DoxyParams}{Parameters}
{\em channel} & The channel name. \\
\hline
{\em uid} & The user ID. \\
\hline
{\em proxy\+Type} & The proxy type connected. See {\ttfamily P\+R\+O\+X\+Y\+\_\+\+T\+Y\+PE}. \\
\hline
{\em local\+Proxy\+Ip} & Reserved for future use. \\
\hline
{\em elapsed} & The time elapsed (ms) from the user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until this callback is triggered. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1775762d8ac3b7357ea130bfd600883c}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1775762d8ac3b7357ea130bfd600883c}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onError@{onError}}
\index{onError@{onError}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onError()}{onError()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Error (\begin{DoxyParamCaption}\item[{int}]{err,  }\item[{const char $\ast$}]{msg }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports an error during S\+DK runtime. 

This callback indicates that an error (concerning network or media) occurs during S\+DK runtime. In most cases, the S\+DK cannot fix the issue and resume running. The S\+DK requires the app to take action or informs the user about the issue.


\begin{DoxyParams}{Parameters}
{\em err} & Error code. See {\ttfamily E\+R\+R\+O\+R\+\_\+\+C\+O\+D\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em msg} & The error message. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab612312f6b4f72e1a036ef7683b8d324}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab612312f6b4f72e1a036ef7683b8d324}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioQuality@{onAudioQuality}}
\index{onAudioQuality@{onAudioQuality}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioQuality()}{onAudioQuality()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Quality (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{quality,  }\item[{unsigned short}]{delay,  }\item[{unsigned short}]{lost }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the statistics of the audio stream sent by each remote user. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000035}{Deprecated}}]This callback is deprecated. Use on\+Remote\+Audio\+Stats instead.\end{DoxyRefDesc}


The S\+DK triggers this callback once every two seconds to report the audio quality of each remote user who is sending an audio stream. If a channel has multiple users sending audio streams, the S\+DK triggers this callback as many times.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user sending the audio stream. \\
\hline
{\em quality} & Audio quality of the user. See {\ttfamily Q\+U\+A\+L\+I\+T\+Y\+\_\+\+T\+Y\+PE}. \\
\hline
{\em delay} & The network delay (ms) from the sender to the receiver, including the delay caused by audio sampling pre-\/processing, network transmission, and network jitter buffering. \\
\hline
{\em lost} & The packet loss rate (\%) of the audio packet sent from the remote user to the receiver. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a44134dfda5d412831fa8e44fa533fca5}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a44134dfda5d412831fa8e44fa533fca5}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLastmileProbeResult@{onLastmileProbeResult}}
\index{onLastmileProbeResult@{onLastmileProbeResult}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLastmileProbeResult()}{onLastmileProbeResult()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Lastmile\+Probe\+Result (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_lastmile_probe_result}{Lastmile\+Probe\+Result}} \&}]{result }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the last mile network probe result. 

The S\+DK triggers this callback within 30 seconds after the app calls {\ttfamily start\+Lastmile\+Probe\+Test}.


\begin{DoxyParams}{Parameters}
{\em result} & The uplink and downlink last-\/mile network probe test result. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_lastmile_probe_result}{Lastmile\+Probe\+Result}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aab1184a2b276f509870c055a9ff8fac4}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aab1184a2b276f509870c055a9ff8fac4}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioVolumeIndication@{onAudioVolumeIndication}}
\index{onAudioVolumeIndication@{onAudioVolumeIndication}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioVolumeIndication()}{onAudioVolumeIndication()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Volume\+Indication (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_audio_volume_info}{Audio\+Volume\+Info}} $\ast$}]{speakers,  }\item[{unsigned int}]{speaker\+Number,  }\item[{int}]{total\+Volume }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the volume information of users. 

By default, this callback is disabled. You can enable it by calling {\ttfamily enable\+Audio\+Volume\+Indication}. Once this callback is enabled and users send streams in the channel, the S\+DK triggers the {\ttfamily on\+Audio\+Volume\+Indication} callback according to the time interval set in {\ttfamily enable\+Audio\+Volume\+Indication}. The S\+DK triggers two independent {\ttfamily on\+Audio\+Volume\+Indication} callbacks simultaneously, which separately report the volume information of the local user who sends a stream and the remote users (up to three) whose instantaneous volume is the highest.

\begin{DoxyNote}{Note}
Once this callback is enabled, if the local user calls the {\ttfamily mute\+Local\+Audio\+Stream} method to mute, the S\+DK continues to report the volume indication of the local user. If a remote user whose volume is one of the three highest in the channel stops publishing the audio stream for 20 seconds, the callback excludes this user\textquotesingle{}s information; if all remote users stop publishing audio streams for 20 seconds, the S\+DK stops triggering the callback for remote users.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em speakers} & The volume information of the users. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_audio_volume_info}{Audio\+Volume\+Info}}}. An empty {\ttfamily speakers} array in the callback indicates that no remote user is in the channel or is sending a stream. \\
\hline
{\em speaker\+Number} & The total number of users.
\begin{DoxyItemize}
\item In the callback for the local user, if the local user is sending streams, the value of {\ttfamily speaker\+Number} is 1.
\item In the callback for remote users, the value range of {\ttfamily speaker\+Number} is \mbox{[}0,3\mbox{]}. If the number of remote users who send streams is greater than or equal to three, the value of {\ttfamily speaker\+Number} is 3. 
\end{DoxyItemize}\\
\hline
{\em total\+Volume} & The volume of the speaker. The value range is \mbox{[}0,255\mbox{]}.
\begin{DoxyItemize}
\item In the callback for the local user, {\ttfamily total\+Volume} is the volume of the local user who sends a stream.
\item In the callback for remote users, {\ttfamily total\+Volume} is the sum of the volume of all remote users (up to three) whose instantaneous volume is the highest. If the user calls {\ttfamily start\+Audio\+Mixing(const char$\ast$ file\+Path, bool loopback, int cycle, int start\+Pos)} , then {\ttfamily total\+Volume} is the volume after audio mixing. 
\end{DoxyItemize}\\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a98f832d175dfc044b31f0ec5874460fb}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a98f832d175dfc044b31f0ec5874460fb}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLeaveChannel@{onLeaveChannel}}
\index{onLeaveChannel@{onLeaveChannel}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLeaveChannel()}{onLeaveChannel()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Leave\+Channel (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_stats}{Rtc\+Stats}} \&}]{stats }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a user leaves a channel. 

You can obtain information such as the total duration of a call, and the data traffic that the S\+DK transmits and receives. Call timing\+: The S\+DK triggers this callback after you call {\ttfamily leave\+Channel()}, {\ttfamily leave\+Channel(const \mbox{\hyperlink{structagora_1_1rtc_1_1_leave_channel_options}{Leave\+Channel\+Options}}\& options)} , {\ttfamily leave\+Channel\+Ex(const Rtc\+Connection\& connection)}, or {\ttfamily leave\+Channel\+Ex(const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}\& connection, const \mbox{\hyperlink{structagora_1_1rtc_1_1_leave_channel_options}{Leave\+Channel\+Options}}\& options)} to leave a channel.


\begin{DoxyParams}{Parameters}
{\em stats} & Call statistics. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_stats}{Rtc\+Stats}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ada38743982296a75879018c5773f08a1}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ada38743982296a75879018c5773f08a1}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRtcStats@{onRtcStats}}
\index{onRtcStats@{onRtcStats}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRtcStats()}{onRtcStats()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Rtc\+Stats (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_stats}{Rtc\+Stats}} \&}]{stats }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the statistics about the current call. 

Call timing\+: The S\+DK triggers this callback once every two seconds after the user joins the channel.


\begin{DoxyParams}{Parameters}
{\em stats} & Statistics of the R\+TC engine. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_stats}{Rtc\+Stats}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad2c6869aad679efab62b1cbeb276f964}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad2c6869aad679efab62b1cbeb276f964}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioDeviceStateChanged@{onAudioDeviceStateChanged}}
\index{onAudioDeviceStateChanged@{onAudioDeviceStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioDeviceStateChanged()}{onAudioDeviceStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Device\+State\+Changed (\begin{DoxyParamCaption}\item[{const char $\ast$}]{device\+Id,  }\item[{int}]{device\+Type,  }\item[{int}]{device\+State }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the audio device state changes. 

This callback notifies the application that the system\textquotesingle{}s audio device state is changed. For example, a headset is unplugged from the device.

\begin{DoxyNote}{Note}
This method is for Windows and mac\+OS only.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em device\+Id} & The device ID. \\
\hline
{\em device\+Type} & The device type. See {\ttfamily M\+E\+D\+I\+A\+\_\+\+D\+E\+V\+I\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em device\+State} & The device state. See {\ttfamily M\+E\+D\+I\+A\+\_\+\+D\+E\+V\+I\+C\+E\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2423a5f76054fdbf35985f3357b0fda2}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2423a5f76054fdbf35985f3357b0fda2}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioMixingPositionChanged@{onAudioMixingPositionChanged}}
\index{onAudioMixingPositionChanged@{onAudioMixingPositionChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioMixingPositionChanged()}{onAudioMixingPositionChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Mixing\+Position\+Changed (\begin{DoxyParamCaption}\item[{int64\+\_\+t}]{position }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the playback progress of a music file. 

After you called the {\ttfamily start\+Audio\+Mixing(const char$\ast$ file\+Path, bool loopback, int cycle, int start\+Pos)} method to play a music file, the S\+DK triggers this callback every two seconds to report the playback progress.


\begin{DoxyParams}{Parameters}
{\em position} & The playback progress (ms).\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a844b1585ecc0c86471d7dd5a462eaaf3}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a844b1585ecc0c86471d7dd5a462eaaf3}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioMixingFinished@{onAudioMixingFinished}}
\index{onAudioMixingFinished@{onAudioMixingFinished}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioMixingFinished()}{onAudioMixingFinished()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Mixing\+Finished (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the playback of the local music file finishes. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000036}{Deprecated}}]This method is deprecated, use on\+Audio\+Mixing\+State\+Changed instead.\end{DoxyRefDesc}


After you call {\ttfamily start\+Audio\+Mixing(const char$\ast$ file\+Path, bool loopback, int cycle, int start\+Pos)} to play a local music file, this callback occurs when the playback finishes. If the call of {\ttfamily start\+Audio\+Mixing(const char$\ast$ file\+Path, bool loopback, int cycle, int start\+Pos)} fails, the error code {\ttfamily W\+A\+R\+N\+\_\+\+A\+U\+D\+I\+O\+\_\+\+M\+I\+X\+I\+N\+G\+\_\+\+O\+P\+E\+N\+\_\+\+E\+R\+R\+OR} is returned. \mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab329b207f42408b3f673837a5de3b9e5}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab329b207f42408b3f673837a5de3b9e5}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioEffectFinished@{onAudioEffectFinished}}
\index{onAudioEffectFinished@{onAudioEffectFinished}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioEffectFinished()}{onAudioEffectFinished()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Effect\+Finished (\begin{DoxyParamCaption}\item[{int}]{sound\+Id }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the playback of the local music file finishes. 

This callback occurs when the local audio effect file finishes playing.


\begin{DoxyParams}{Parameters}
{\em sound\+Id} & The ID of the audio effect. The unique ID of each audio effect file. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a9a7c5dbb1b7452eed2dc32dbbe8e2ce9}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a9a7c5dbb1b7452eed2dc32dbbe8e2ce9}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onVideoDeviceStateChanged@{onVideoDeviceStateChanged}}
\index{onVideoDeviceStateChanged@{onVideoDeviceStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onVideoDeviceStateChanged()}{onVideoDeviceStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Video\+Device\+State\+Changed (\begin{DoxyParamCaption}\item[{const char $\ast$}]{device\+Id,  }\item[{int}]{device\+Type,  }\item[{int}]{device\+State }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the video device state changes. 

This callback reports the change of system video devices, such as being unplugged or removed. On a Windows device with an external camera for video capturing, the video disables once the external camera is unplugged.

\begin{DoxyNote}{Note}
This callback is for Windows and mac\+OS only.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em device\+Id} & The device ID. \\
\hline
{\em device\+Type} & Media device types. See {\ttfamily M\+E\+D\+I\+A\+\_\+\+D\+E\+V\+I\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em device\+State} & Media device states. See {\ttfamily M\+E\+D\+I\+A\+\_\+\+D\+E\+V\+I\+C\+E\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a80003ae8cce02039f3aa0e8ffad7deed}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a80003ae8cce02039f3aa0e8ffad7deed}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onNetworkQuality@{onNetworkQuality}}
\index{onNetworkQuality@{onNetworkQuality}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onNetworkQuality()}{onNetworkQuality()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Network\+Quality (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{tx\+Quality,  }\item[{int}]{rx\+Quality }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the last mile network quality of each user in the channel. 

This callback reports the last mile network conditions of each user in the channel. Last mile refers to the connection between the local device and Agora\textquotesingle{}s edge server. The S\+DK triggers this callback once every two seconds. If a channel includes multiple users, the S\+DK triggers this callback as many times. This callback provides feedback on network quality through sending and receiving broadcast packets within the channel. Excessive broadcast packets can lead to broadcast storms. To prevent broadcast storms from causing a large amount of data transmission within the channel, this callback supports feedback on the network quality of up to 4 remote hosts simultaneously by default.

\begin{DoxyNote}{Note}
{\ttfamily tx\+Quality} is {\ttfamily U\+N\+K\+N\+O\+WN} when the user is not sending a stream; {\ttfamily rx\+Quality} is {\ttfamily U\+N\+K\+N\+O\+WN} when the user is not receiving a stream.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The user ID. The network quality of the user with this user ID is reported. If the uid is 0, the local network quality is reported. \\
\hline
{\em tx\+Quality} & Uplink network quality rating of the user in terms of the transmission bit rate, packet loss rate, average R\+TT (Round-\/\+Trip Time) and jitter of the uplink network. This parameter is a quality rating helping you understand how well the current uplink network conditions can support the selected video encoder configuration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 × 480 and a frame rate of 15 fps in the L\+I\+V\+E\+\_\+\+B\+R\+O\+A\+D\+C\+A\+S\+T\+I\+NG profile, but might be inadequate for resolutions higher than 1280 × 720. See {\ttfamily Q\+U\+A\+L\+I\+T\+Y\+\_\+\+T\+Y\+PE}. \\
\hline
{\em rx\+Quality} & Downlink network quality rating of the user in terms of packet loss rate, average R\+TT, and jitter of the downlink network. See {\ttfamily Q\+U\+A\+L\+I\+T\+Y\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2747779b0e8f7eb644069d134affd433}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2747779b0e8f7eb644069d134affd433}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onIntraRequestReceived@{onIntraRequestReceived}}
\index{onIntraRequestReceived@{onIntraRequestReceived}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onIntraRequestReceived()}{onIntraRequestReceived()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Intra\+Request\+Received (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Occurs when intra request from remote user is received.

This callback is triggered once remote user needs one Key frame. \mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa229c7b7832a13901683705e5371c40a}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa229c7b7832a13901683705e5371c40a}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUplinkNetworkInfoUpdated@{onUplinkNetworkInfoUpdated}}
\index{onUplinkNetworkInfoUpdated@{onUplinkNetworkInfoUpdated}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUplinkNetworkInfoUpdated()}{onUplinkNetworkInfoUpdated()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Uplink\+Network\+Info\+Updated (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_uplink_network_info}{Uplink\+Network\+Info}} \&}]{info }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the uplink network information changes. 

The S\+DK triggers this callback when the uplink network information changes.

\begin{DoxyNote}{Note}
This callback only applies to scenarios where you push externally encoded video data in H.\+264 format to the S\+DK.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em info} & The uplink network information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_uplink_network_info}{Uplink\+Network\+Info}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac7e14d1a26eb35ef236a0662d28d2b33}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac7e14d1a26eb35ef236a0662d28d2b33}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLastmileQuality@{onLastmileQuality}}
\index{onLastmileQuality@{onLastmileQuality}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLastmileQuality()}{onLastmileQuality()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Lastmile\+Quality (\begin{DoxyParamCaption}\item[{int}]{quality }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the last-\/mile network quality of the local user. 

This callback reports the last-\/mile network conditions of the local user before the user joins the channel. Last mile refers to the connection between the local device and Agora\textquotesingle{}s edge server. Before the user joins the channel, this callback is triggered by the S\+DK once {\ttfamily start\+Lastmile\+Probe\+Test} is called and reports the last-\/mile network conditions of the local user.


\begin{DoxyParams}{Parameters}
{\em quality} & The last-\/mile network quality. See {\ttfamily Q\+U\+A\+L\+I\+T\+Y\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a15cb3afe45c869c129451c54b4383619}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a15cb3afe45c869c129451c54b4383619}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onFirstLocalVideoFrame@{onFirstLocalVideoFrame}}
\index{onFirstLocalVideoFrame@{onFirstLocalVideoFrame}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onFirstLocalVideoFrame()}{onFirstLocalVideoFrame()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+First\+Local\+Video\+Frame (\begin{DoxyParamCaption}\item[{V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}]{source,  }\item[{int}]{width,  }\item[{int}]{height,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the first local video frame is displayed on the local video view. 

The S\+DK triggers this callback when the first local video frame is displayed on the local video view.


\begin{DoxyParams}{Parameters}
{\em source} & The type of the video source. See {\ttfamily V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em width} & The width (px) of the first local video frame. \\
\hline
{\em height} & The height (px) of the first local video frame. \\
\hline
{\em elapsed} & The time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ info, uid\+\_\+t uid)} or {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} to join the channel to when the S\+DK triggers this callback. If {\ttfamily start\+Preview()} / {\ttfamily start\+Preview(\+V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+P\+E source\+Type)} is called before joining the channel, this parameter indicates the time elapsed from calling {\ttfamily start\+Preview()} or {\ttfamily start\+Preview(\+V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+P\+E source\+Type)} to when this event occurred. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a734c39289a40a97bc3dcd7df9413034a}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a734c39289a40a97bc3dcd7df9413034a}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onFirstLocalVideoFramePublished@{onFirstLocalVideoFramePublished}}
\index{onFirstLocalVideoFramePublished@{onFirstLocalVideoFramePublished}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onFirstLocalVideoFramePublished()}{onFirstLocalVideoFramePublished()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+First\+Local\+Video\+Frame\+Published (\begin{DoxyParamCaption}\item[{V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}]{source,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the first video frame is published. 

The S\+DK triggers this callback under one of the following circumstances\+:
\begin{DoxyItemize}
\item The local client enables the video module and calls {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ info, uid\+\_\+t uid)} or {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} to join the channel successfully.
\item The local client calls {\ttfamily mute\+Local\+Video\+Stream} ({\ttfamily true}) and {\ttfamily mute\+Local\+Video\+Stream} ({\ttfamily false}) in sequence.
\item The local client calls {\ttfamily disable\+Video} and {\ttfamily enable\+Video} in sequence.
\item The local client calls {\ttfamily push\+Video\+Frame} to successfully push the video frame to the S\+DK.
\end{DoxyItemize}


\begin{DoxyParams}{Parameters}
{\em source} & The type of the video source. See {\ttfamily V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em elapsed} & Time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ info, uid\+\_\+t uid)} or {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until this callback is triggered. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad8083c52d15135762a31c48192ad64f2}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad8083c52d15135762a31c48192ad64f2}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onFirstRemoteVideoDecoded@{onFirstRemoteVideoDecoded}}
\index{onFirstRemoteVideoDecoded@{onFirstRemoteVideoDecoded}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onFirstRemoteVideoDecoded()}{onFirstRemoteVideoDecoded()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+First\+Remote\+Video\+Decoded (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{width,  }\item[{int}]{height,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the first remote video frame is received and decoded. 

The S\+DK triggers this callback under one of the following circumstances\+:
\begin{DoxyItemize}
\item The remote user joins the channel and sends the video stream.
\item The remote user stops sending the video stream and re-\/sends it after 15 seconds. Reasons for such an interruption include\+:
\begin{DoxyItemize}
\item The remote user leaves the channel.
\item The remote user drops offline.
\item The remote user calls {\ttfamily disable\+Video} to disable video.
\end{DoxyItemize}
\end{DoxyItemize}


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user sending the video stream. \\
\hline
{\em width} & The width (px) of the video stream. \\
\hline
{\em height} & The height (px) of the video stream. \\
\hline
{\em elapsed} & The time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ info, uid\+\_\+t uid)} or {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3ef9bc5dd7c16c92ed1707cca4594bfb}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3ef9bc5dd7c16c92ed1707cca4594bfb}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onVideoSizeChanged@{onVideoSizeChanged}}
\index{onVideoSizeChanged@{onVideoSizeChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onVideoSizeChanged()}{onVideoSizeChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Video\+Size\+Changed (\begin{DoxyParamCaption}\item[{V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}]{source\+Type,  }\item[{uid\+\_\+t}]{uid,  }\item[{int}]{width,  }\item[{int}]{height,  }\item[{int}]{rotation }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the video size or rotation of a specified user changes. 


\begin{DoxyParams}{Parameters}
{\em source\+Type} & The type of the video source. See {\ttfamily V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em uid} & The ID of the user whose video size or rotation changes. (The {\ttfamily uid} for the local user is 0. The video is the local user\textquotesingle{}s video preview). \\
\hline
{\em width} & The width (pixels) of the video stream. \\
\hline
{\em height} & The height (pixels) of the video stream. \\
\hline
{\em rotation} & The rotation information. The value range is \mbox{[}0,360).Note\+: On the i\+OS platform, the parameter value is always 0. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a86730fd0927e730bf9f375a5edb33cd8}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a86730fd0927e730bf9f375a5edb33cd8}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLocalVideoEvent@{onLocalVideoEvent}}
\index{onLocalVideoEvent@{onLocalVideoEvent}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLocalVideoEvent()}{onLocalVideoEvent()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Local\+Video\+Event (\begin{DoxyParamCaption}\item[{V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}]{source,  }\item[{L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+E\+V\+E\+N\+T\+\_\+\+T\+Y\+PE}]{event }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local video event occurs. 

\begin{DoxySince}{Since}
v4.\+6.\+1
\end{DoxySince}
This callback is triggered when a video event occurs. You can use this callback to get the reason for such an event.


\begin{DoxyParams}{Parameters}
{\em source} & The video source type\+: \#\+V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE. \\
\hline
{\em event} & The local video event type\+: \#\+L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+E\+V\+E\+N\+T\+\_\+\+T\+Y\+PE. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a48101bcc663c35b2b86562a20ea2eb96}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a48101bcc663c35b2b86562a20ea2eb96}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLocalVideoStateChanged@{onLocalVideoStateChanged}}
\index{onLocalVideoStateChanged@{onLocalVideoStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLocalVideoStateChanged()}{onLocalVideoStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Local\+Video\+State\+Changed (\begin{DoxyParamCaption}\item[{V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}]{source,  }\item[{L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+TE}]{state,  }\item[{L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+ON}]{reason }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local video stream state changes. 

When the status of the local video changes, the S\+DK triggers this callback to report the current local video state and the reason for the state change. Applicable scenarios\+: You can use this callback to stay updated on the state changes of the local video stream, and take corresponding measures based on the reasons for the state changes, to better manage and debug issues related to the video stream. Call timing\+: -\/ The S\+DK triggeres this callback under the following circumstances, with the {\ttfamily state} as L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+F\+A\+I\+L\+ED, and the {\ttfamily reason} as {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+C\+A\+P\+T\+U\+R\+E\+\_\+\+F\+A\+I\+L\+U\+RE}\+:
\begin{DoxyItemize}
\item The app switches to the background, and the system revokes the camera resource.
\item For Android 9 and later versions, after an app is in the background for a period, the system automatically revokes camera permissions.
\item For Android 6 and later versions, if the camera is held by a third-\/party app for a certain duration and then released, the S\+DK triggers this callback and reports the {\ttfamily on\+Local\+Video\+State\+Changed} ({\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+C\+A\+P\+T\+U\+R\+I\+NG,L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+OK}) callback.
\item The camera starts normally, but does not output video frames for four consecutive seconds.
\end{DoxyItemize}

When the camera outputs captured video frames, if the S\+DK detects 15 consecutive duplicate video frames, it triggers this callback, with the {\ttfamily state} as {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+C\+A\+P\+T\+U\+R\+I\+NG} and the {\ttfamily reason} as {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+C\+A\+P\+T\+U\+R\+E\+\_\+\+F\+A\+I\+L\+U\+RE}.Note\+:
\begin{DoxyItemize}
\item Note that the video frame duplication detection is only available for video frames with a resolution greater than 200 × 200, a frame rate greater than or equal to 10 fps, and a bitrate less than 20 Kbps.
\item Normally, if there is an error in video capturing, the issue can be troubleshooted through the {\ttfamily reason} parameter in this callback. However, on some devices, when there is an issue with capturing (such as freezing), the Android system will not throw any error callbacks, so the S\+DK cannot report the reason for the change in local video status. In this case, you can determine if there is no video frame being captured by checking the following\+: this callback reports the {\ttfamily state} as {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+C\+A\+P\+T\+U\+R\+I\+NG} or {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+E\+N\+C\+O\+D\+I\+NG}, and the {\ttfamily capture\+Frame\+Rate} in the {\ttfamily on\+Local\+Video\+Stats} callback is 0.
\end{DoxyItemize}

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Note that the video frame duplication detection is only available for video frames with a resolution greater than 200 × 200, a frame rate greater than or equal to 10 fps, and a bitrate less than 20 Kbps.
\item Normally, if there is an error in video capturing, the issue can be troubleshooted through the {\ttfamily reason} parameter in this callback. However, on some devices, when there is an issue with capturing (such as freezing), the Android system will not throw any error callbacks, so the S\+DK cannot report the reason for the change in local video status. In this case, you can determine if there is no video frame being captured by checking the following\+: this callback reports the {\ttfamily state} as {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+C\+A\+P\+T\+U\+R\+I\+NG} or {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+E\+N\+C\+O\+D\+I\+NG}, and the {\ttfamily capture\+Frame\+Rate} in the {\ttfamily on\+Local\+Video\+Stats} callback is 0.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em source} & The type of the video source. See {\ttfamily V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em state} & The state of the local video, see {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em reason} & The reasons for changes in local video state. See {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+ON}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae69799238c6a6cd9f017274dd630b74e}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae69799238c6a6cd9f017274dd630b74e}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRemoteVideoStateChanged@{onRemoteVideoStateChanged}}
\index{onRemoteVideoStateChanged@{onRemoteVideoStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRemoteVideoStateChanged()}{onRemoteVideoStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Remote\+Video\+State\+Changed (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{R\+E\+M\+O\+T\+E\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+A\+TE}]{state,  }\item[{R\+E\+M\+O\+T\+E\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+A\+T\+E\+\_\+\+R\+E\+A\+S\+ON}]{reason,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the remote video stream state changes. 

\begin{DoxyNote}{Note}
This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 32.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the remote user whose video state changes. \\
\hline
{\em state} & The state of the remote video. See {\ttfamily R\+E\+M\+O\+T\+E\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em reason} & The reason for the remote video state change. See {\ttfamily R\+E\+M\+O\+T\+E\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+A\+T\+E\+\_\+\+R\+E\+A\+S\+ON}. \\
\hline
{\em elapsed} & Time elapsed (ms) from the local user calling the {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} method until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1caf7870fa39a8b938d8d485c3ee7dce}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1caf7870fa39a8b938d8d485c3ee7dce}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onFirstRemoteVideoFrame@{onFirstRemoteVideoFrame}}
\index{onFirstRemoteVideoFrame@{onFirstRemoteVideoFrame}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onFirstRemoteVideoFrame()}{onFirstRemoteVideoFrame()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+First\+Remote\+Video\+Frame (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{width,  }\item[{int}]{height,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the renderer receives the first frame of the remote video. 

\begin{DoxyNote}{Note}
This callback is only triggered when the video frame is rendered by the S\+DK; it will not be triggered if the user employs custom video rendering.\+You need to implement this independently using methods outside the S\+DK.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user sending the video stream. \\
\hline
{\em width} & The width (px) of the video stream. \\
\hline
{\em height} & The height (px) of the video stream. \\
\hline
{\em elapsed} & The time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ info, uid\+\_\+t uid)} or {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a985a675469baf9d54feb8781732e0ca8}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a985a675469baf9d54feb8781732e0ca8}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserJoined@{onUserJoined}}
\index{onUserJoined@{onUserJoined}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserJoined()}{onUserJoined()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+Joined (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins the channel. 


\begin{DoxyItemize}
\item In a communication channel, this callback indicates that a remote user joins the channel. The S\+DK also triggers this callback to report the existing users in the channel when a user joins the channel.
\item In a live-\/broadcast channel, this callback indicates that a host joins the channel. The S\+DK also triggers this callback to report the existing hosts in the channel when a host joins the channel. Agora recommends limiting the number of co-\/hosts to 32, with a maximum of 17 video hosts. Call timing\+: The S\+DK triggers this callback under one of the following circumstances\+:
\item A remote user/host joins the channel.
\item A remote user switches the user role to the host after joining the channel.
\item A remote user/host rejoins the channel after a network interruption.
\end{DoxyItemize}


\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the user or host who joins the channel. \\
\hline
{\em elapsed} & Time delay (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ info, uid\+\_\+t uid)} or {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until this callback is triggered. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a9602593c05a16eafa7c094aa330c0719}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a9602593c05a16eafa7c094aa330c0719}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserOffline@{onUserOffline}}
\index{onUserOffline@{onUserOffline}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserOffline()}{onUserOffline()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+Offline (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{U\+S\+E\+R\+\_\+\+O\+F\+F\+L\+I\+N\+E\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE}]{reason }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves the channel. 

There are generally two reasons for users to become offline\+:
\begin{DoxyItemize}
\item Leave the channel\+: When a user/host leaves the channel, the user/host sends a goodbye message.
\item Drop offline\+: When no data packet of the user or host is received for a certain period of time (20 seconds for the communication profile, and more for the live broadcast profile), the S\+DK assumes that the user/host drops offline. A poor network connection may lead to false detections. It is recommended to use the Agora R\+TM S\+DK for reliable offline detection. Call timing\+: This callback is triggered when a remote user (in the communication profile) or host (in the live streaming profile) leaves a channel.
\end{DoxyItemize}


\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the user who leaves the channel or goes offline. \\
\hline
{\em reason} & Reasons why a remote user (in the communication profile) or host (in the live streaming profile) goes offline. See {\ttfamily U\+S\+E\+R\+\_\+\+O\+F\+F\+L\+I\+N\+E\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a00433467903bd28b77631179a89a5bc6}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a00433467903bd28b77631179a89a5bc6}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserMuteAudio@{onUserMuteAudio}}
\index{onUserMuteAudio@{onUserMuteAudio}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserMuteAudio()}{onUserMuteAudio()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+Mute\+Audio (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{bool}]{muted }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) stops/resumes sending the audio stream. 

The S\+DK triggers this callback when the remote user stops or resumes sending the audio stream by calling the {\ttfamily mute\+Local\+Audio\+Stream} method.

\begin{DoxyNote}{Note}
This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 32.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The user ID. \\
\hline
{\em muted} & Whether the remote user\textquotesingle{}s audio stream is muted\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: User\textquotesingle{}s audio stream is muted.
\item {\ttfamily false}\+: User\textquotesingle{}s audio stream is unmuted. 
\end{DoxyItemize}\\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a8279591a761a5c2c1c4c1c4e677cbe0e}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a8279591a761a5c2c1c4c1c4e677cbe0e}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserMuteVideo@{onUserMuteVideo}}
\index{onUserMuteVideo@{onUserMuteVideo}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserMuteVideo()}{onUserMuteVideo()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+Mute\+Video (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{bool}]{muted }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a remote user stops or resumes publishing the video stream. 

When a remote user calls {\ttfamily mute\+Local\+Video\+Stream} to stop or resume publishing the video stream, the S\+DK triggers this callback to report to the local user the state of the streams published by the remote user.

\begin{DoxyNote}{Note}
This callback can be inaccurate when the number of users (in the communication profile) or hosts (in the live streaming profile) in a channel exceeds 32.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em muted} & Whether the remote user stops publishing the video stream\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: The remote user stops publishing the video stream.
\item {\ttfamily false}\+: The remote user resumes publishing the video stream. 
\end{DoxyItemize}\\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a91bef59a3659b6e6bcbe43eb203d0732}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a91bef59a3659b6e6bcbe43eb203d0732}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserEnableVideo@{onUserEnableVideo}}
\index{onUserEnableVideo@{onUserEnableVideo}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserEnableVideo()}{onUserEnableVideo()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+Enable\+Video (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{bool}]{enabled }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a remote user enables or disables the video module. 

Once the video module is disabled, the user can only use a voice call. The user cannot send or receive any video. The S\+DK triggers this callback when a remote user enables or disables the video module by calling the {\ttfamily enable\+Video} or {\ttfamily disable\+Video} method.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em enabled} & 
\begin{DoxyItemize}
\item {\ttfamily true}\+: The video module is enabled.
\end{DoxyItemize}\\
\hline
\end{DoxyParams}

\begin{DoxyItemize}
\item {\ttfamily false}\+: The video module is disabled. 
\end{DoxyItemize}\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2744650deb07a19c91f342363d606451}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2744650deb07a19c91f342363d606451}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserStateChanged@{onUserStateChanged}}
\index{onUserStateChanged@{onUserStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserStateChanged()}{onUserStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+State\+Changed (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{R\+E\+M\+O\+T\+E\+\_\+\+U\+S\+E\+R\+\_\+\+S\+T\+A\+TE}]{state }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Occurs when the remote user audio or video state is updated. 
\begin{DoxyParams}{Parameters}
{\em uid} & The uid of the remote user. \\
\hline
{\em state} & The remote user\textquotesingle{}s audio or video state\+: \#\+R\+E\+M\+O\+T\+E\+\_\+\+U\+S\+E\+R\+\_\+\+S\+T\+A\+TE. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a199de5107bfc84c056998e2e45bba772}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a199de5107bfc84c056998e2e45bba772}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserEnableLocalVideo@{onUserEnableLocalVideo}}
\index{onUserEnableLocalVideo@{onUserEnableLocalVideo}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserEnableLocalVideo()}{onUserEnableLocalVideo()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+Enable\+Local\+Video (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{bool}]{enabled }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when a specific remote user enables/disables the local video capturing function. 

The S\+DK triggers this callback when the remote user resumes or stops capturing the video stream by calling the {\ttfamily enable\+Local\+Video} method.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em enabled} & Whether the specified remote user enables/disables local video capturing\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: The video module is enabled. Other users in the channel can see the video of this remote user.
\item {\ttfamily false}\+: The video module is disabled. Other users in the channel can no longer receive the video stream from this remote user, while this remote user can still receive the video streams from other users. 
\end{DoxyItemize}\\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af8a59626a9265264fb4638e048091d3a}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af8a59626a9265264fb4638e048091d3a}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRemoteAudioStats@{onRemoteAudioStats}}
\index{onRemoteAudioStats@{onRemoteAudioStats}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRemoteAudioStats()}{onRemoteAudioStats()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Remote\+Audio\+Stats (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_remote_audio_stats}{Remote\+Audio\+Stats}} \&}]{stats }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the transport-\/layer statistics of each remote audio stream. 

The S\+DK triggers this callback once every two seconds for each remote user who is sending audio streams. If a channel includes multiple remote users, the S\+DK triggers this callback as many times.


\begin{DoxyParams}{Parameters}
{\em stats} & The statistics of the received remote audio streams. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_remote_audio_stats}{Remote\+Audio\+Stats}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0cb47df6a8ef7acee229eb307d6f32c3}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0cb47df6a8ef7acee229eb307d6f32c3}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLocalAudioStats@{onLocalAudioStats}}
\index{onLocalAudioStats@{onLocalAudioStats}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLocalAudioStats()}{onLocalAudioStats()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Local\+Audio\+Stats (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_local_audio_stats}{Local\+Audio\+Stats}} \&}]{stats }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the statistics of the local audio stream. 

The S\+DK triggers this callback once every two seconds.


\begin{DoxyParams}{Parameters}
{\em stats} & Local audio statistics. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_local_audio_stats}{Local\+Audio\+Stats}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3476915aca1141cb7821dba9da41af2b}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3476915aca1141cb7821dba9da41af2b}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLocalVideoStats@{onLocalVideoStats}}
\index{onLocalVideoStats@{onLocalVideoStats}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLocalVideoStats()}{onLocalVideoStats()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Local\+Video\+Stats (\begin{DoxyParamCaption}\item[{V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}]{source,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_local_video_stats}{Local\+Video\+Stats}} \&}]{stats }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the statistics of the local video stream. 

The S\+DK triggers this callback once every two seconds to report the statistics of the local video stream.


\begin{DoxyParams}{Parameters}
{\em source} & The type of the video source. See {\ttfamily V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em stats} & The statistics of the local video stream. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_local_video_stats}{Local\+Video\+Stats}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7163ffb650852be270ba0215b596d968}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7163ffb650852be270ba0215b596d968}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRemoteVideoStats@{onRemoteVideoStats}}
\index{onRemoteVideoStats@{onRemoteVideoStats}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRemoteVideoStats()}{onRemoteVideoStats()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Remote\+Video\+Stats (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_remote_video_stats}{Remote\+Video\+Stats}} \&}]{stats }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the statistics of the video stream sent by each remote users. 

Reports the statistics of the video stream from the remote users. The S\+DK triggers this callback once every two seconds for each remote user. If a channel has multiple users/hosts sending video streams, the S\+DK triggers this callback as many times.


\begin{DoxyParams}{Parameters}
{\em stats} & Statistics of the remote video stream. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_remote_video_stats}{Remote\+Video\+Stats}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a630b63e8df71ab9f19a96b425fce7c94}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a630b63e8df71ab9f19a96b425fce7c94}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onCameraReady@{onCameraReady}}
\index{onCameraReady@{onCameraReady}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onCameraReady()}{onCameraReady()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Camera\+Ready (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the camera turns on and is ready to capture the video. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000037}{Deprecated}}]Use {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+C\+A\+P\+T\+U\+R\+I\+N\+G(1)} in on\+Local\+Video\+State\+Changed instead.\end{DoxyRefDesc}


This callback indicates that the camera has been successfully turned on and you can start to capture video. \mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0e048d57ff13f946be1a1334d11f0ac6}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0e048d57ff13f946be1a1334d11f0ac6}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onCameraFocusAreaChanged@{onCameraFocusAreaChanged}}
\index{onCameraFocusAreaChanged@{onCameraFocusAreaChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onCameraFocusAreaChanged()}{onCameraFocusAreaChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Camera\+Focus\+Area\+Changed (\begin{DoxyParamCaption}\item[{int}]{x,  }\item[{int}]{y,  }\item[{int}]{width,  }\item[{int}]{height }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the camera focus area changes. 

\begin{DoxyNote}{Note}
This callback is for Android and i\+OS only.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em x} & The x-\/coordinate of the changed camera focus area. \\
\hline
{\em y} & The y-\/coordinate of the changed camera focus area. \\
\hline
{\em width} & The width of the changed camera focus area. \\
\hline
{\em height} & The height of the changed camera focus area. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2fd62dcf7c816477ef559a9d2b3c43f3}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2fd62dcf7c816477ef559a9d2b3c43f3}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onCameraExposureAreaChanged@{onCameraExposureAreaChanged}}
\index{onCameraExposureAreaChanged@{onCameraExposureAreaChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onCameraExposureAreaChanged()}{onCameraExposureAreaChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Camera\+Exposure\+Area\+Changed (\begin{DoxyParamCaption}\item[{int}]{x,  }\item[{int}]{y,  }\item[{int}]{width,  }\item[{int}]{height }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the camera exposure area changes. 

The S\+DK triggers this callback when the local user changes the camera exposure position by calling {\ttfamily set\+Camera\+Exposure\+Position}.

\begin{DoxyNote}{Note}
This callback is for Android and i\+OS only.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em x} & The x coordinate of the changed camera exposure area. \\
\hline
{\em y} & The y coordinate of the changed camera exposure area. \\
\hline
{\em width} & The width of the changed camera exposure area. \\
\hline
{\em height} & The height of the changed exposure area. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a595a28e6f0d3390aa4340ed13a80c234}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a595a28e6f0d3390aa4340ed13a80c234}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onVideoStopped@{onVideoStopped}}
\index{onVideoStopped@{onVideoStopped}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onVideoStopped()}{onVideoStopped()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Video\+Stopped (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the video stops playing. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000038}{Deprecated}}]Use {\ttfamily L\+O\+C\+A\+L\+\_\+\+V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+S\+T\+O\+P\+P\+E\+D(0)} in the on\+Local\+Video\+State\+Changed callback instead.\end{DoxyRefDesc}


The application can use this callback to change the configuration of the {\ttfamily view} (for example, displaying other pictures in the view) after the video stops playing. \mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae2e257d7bbf120b970b600b9b3731a07}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae2e257d7bbf120b970b600b9b3731a07}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioMixingStateChanged@{onAudioMixingStateChanged}}
\index{onAudioMixingStateChanged@{onAudioMixingStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioMixingStateChanged()}{onAudioMixingStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Mixing\+State\+Changed (\begin{DoxyParamCaption}\item[{A\+U\+D\+I\+O\+\_\+\+M\+I\+X\+I\+N\+G\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}]{state,  }\item[{A\+U\+D\+I\+O\+\_\+\+M\+I\+X\+I\+N\+G\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE}]{reason }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the playback state of the music file changes. 

This callback occurs when the playback state of the music file changes, and reports the current state and error code.


\begin{DoxyParams}{Parameters}
{\em state} & The playback state of the music file. See {\ttfamily A\+U\+D\+I\+O\+\_\+\+M\+I\+X\+I\+N\+G\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em reason} & Error code. See {\ttfamily A\+U\+D\+I\+O\+\_\+\+M\+I\+X\+I\+N\+G\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a97dd875cfa6e9eb83657797bc2e406a8}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a97dd875cfa6e9eb83657797bc2e406a8}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRhythmPlayerStateChanged@{onRhythmPlayerStateChanged}}
\index{onRhythmPlayerStateChanged@{onRhythmPlayerStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRhythmPlayerStateChanged()}{onRhythmPlayerStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Rhythm\+Player\+State\+Changed (\begin{DoxyParamCaption}\item[{R\+H\+Y\+T\+H\+M\+\_\+\+P\+L\+A\+Y\+E\+R\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}]{state,  }\item[{R\+H\+Y\+T\+H\+M\+\_\+\+P\+L\+A\+Y\+E\+R\+\_\+\+R\+E\+A\+S\+ON}]{reason }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the state of virtual metronome changes. 

When the state of the virtual metronome changes, the S\+DK triggers this callback to report the current state of the virtual metronome. This callback indicates the state of the local audio stream and enables you to troubleshoot issues when audio exceptions occur.

\begin{DoxyNote}{Note}
This callback is for Android and i\+OS only.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em state} & For the current virtual metronome status, see {\ttfamily R\+H\+Y\+T\+H\+M\+\_\+\+P\+L\+A\+Y\+E\+R\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em reason} & For the error codes and error messages related to virtual metronome errors, see {\ttfamily R\+H\+Y\+T\+H\+M\+\_\+\+P\+L\+A\+Y\+E\+R\+\_\+\+R\+E\+A\+S\+ON}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab5c110382a2ef7eb92cd069c22884727}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab5c110382a2ef7eb92cd069c22884727}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onConnectionLost@{onConnectionLost}}
\index{onConnectionLost@{onConnectionLost}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onConnectionLost()}{onConnectionLost()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Connection\+Lost (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the S\+DK cannot reconnect to Agora\textquotesingle{}s edge server 10 seconds after its connection to the server is interrupted. 

The S\+DK triggers this callback when it cannot connect to the server 10 seconds after calling the {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} method, regardless of whether it is in the channel. If the S\+DK fails to rejoin the channel 20 minutes after being disconnected from Agora\textquotesingle{}s edge server, the S\+DK stops rejoining the channel. \mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac5d532fe92a0d6c424e87e694225b6e9}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac5d532fe92a0d6c424e87e694225b6e9}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onConnectionInterrupted@{onConnectionInterrupted}}
\index{onConnectionInterrupted@{onConnectionInterrupted}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onConnectionInterrupted()}{onConnectionInterrupted()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Connection\+Interrupted (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the connection between the S\+DK and the server is interrupted. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000039}{Deprecated}}]Use {\ttfamily on\+Connection\+State\+Changed} instead.\end{DoxyRefDesc}


The S\+DK triggers this callback when it loses connection with the server for more than four seconds after the connection is established. After triggering this callback, the S\+DK tries to reconnect to the server. You can use this callback to implement pop-\/up reminders. The differences between this callback and {\ttfamily on\+Connection\+Lost} are as follow\+:
\begin{DoxyItemize}
\item The S\+DK triggers the {\ttfamily on\+Connection\+Interrupted} callback when it loses connection with the server for more than four seconds after it successfully joins the channel.
\item The S\+DK triggers the {\ttfamily on\+Connection\+Lost} callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel. If the S\+DK fails to rejoin the channel 20 minutes after being disconnected from Agora\textquotesingle{}s edge server, the S\+DK stops rejoining the channel. 
\end{DoxyItemize}\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a96abb5e2fef0afc0a80e87388ebdaa5e}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a96abb5e2fef0afc0a80e87388ebdaa5e}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onConnectionBanned@{onConnectionBanned}}
\index{onConnectionBanned@{onConnectionBanned}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onConnectionBanned()}{onConnectionBanned()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Connection\+Banned (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the connection is banned by the Agora server. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000040}{Deprecated}}]Use {\ttfamily on\+Connection\+State\+Changed} instead. \end{DoxyRefDesc}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0add560882999732aec21098c29280e0}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0add560882999732aec21098c29280e0}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onStreamMessage@{onStreamMessage}}
\index{onStreamMessage@{onStreamMessage}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onStreamMessage()}{onStreamMessage()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Stream\+Message (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{stream\+Id,  }\item[{const char $\ast$}]{data,  }\item[{size\+\_\+t}]{length,  }\item[{uint64\+\_\+t}]{sent\+Ts }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local user receives the data stream from the remote user. 

The S\+DK triggers this callback when the local user receives the stream message that the remote user sends by calling the {\ttfamily send\+Stream\+Message} method.

\begin{DoxyNote}{Note}
If you need a more comprehensive solution for low-\/latency, high-\/concurrency, and scalable real-\/time messaging and status synchronization, it is recommended to use {\ttfamily Signaling}.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the remote user sending the message. \\
\hline
{\em stream\+Id} & The stream ID of the received message. \\
\hline
{\em data} & The data received. \\
\hline
{\em length} & The data length (byte). \\
\hline
{\em sent\+Ts} & The time when the data stream is sent. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3af56e33ca95ccc6b9dce4b2a51c2b33}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3af56e33ca95ccc6b9dce4b2a51c2b33}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onStreamMessageError@{onStreamMessageError}}
\index{onStreamMessageError@{onStreamMessageError}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onStreamMessageError()}{onStreamMessageError()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Stream\+Message\+Error (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{stream\+Id,  }\item[{int}]{code,  }\item[{int}]{missed,  }\item[{int}]{cached }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local user does not receive the data stream from the remote user. 

The S\+DK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the {\ttfamily send\+Stream\+Message} method.

\begin{DoxyNote}{Note}
If you need a more comprehensive solution for low-\/latency, high-\/concurrency, and scalable real-\/time messaging and status synchronization, it is recommended to use {\ttfamily Signaling}.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the remote user sending the message. \\
\hline
{\em stream\+Id} & The stream ID of the received message. \\
\hline
{\em code} & Error code. \\
\hline
{\em missed} & The number of lost messages. \\
\hline
{\em cached} & Number of incoming cached messages when the data stream is interrupted. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab9b8efc5d670fe14dd0cea7da23b57f2}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab9b8efc5d670fe14dd0cea7da23b57f2}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRdtMessage@{onRdtMessage}}
\index{onRdtMessage@{onRdtMessage}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRdtMessage()}{onRdtMessage()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Rdt\+Message (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{user\+Id,  }\item[{Rdt\+Stream\+Type}]{type,  }\item[{const char $\ast$}]{data,  }\item[{size\+\_\+t}]{length }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local user receives data via Reliable Data Transmission (R\+DT) from a remote user. 

@technical preview

The S\+DK triggers this callback when the user receives the data stream that another user sends by calling the \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_abec7a493c27c4c0474dac59a23808879}{send\+Rdt\+Message}} method.


\begin{DoxyParams}{Parameters}
{\em user\+Id} & ID of the user who sends the data. \\
\hline
{\em type} & The R\+DT stream type. See Rdt\+Stream\+Type. \\
\hline
{\em data} & The data received. \\
\hline
{\em length} & The length (byte) of the data. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a74076ace2c84fb29dc4586d4db33b1b4}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a74076ace2c84fb29dc4586d4db33b1b4}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRdtStateChanged@{onRdtStateChanged}}
\index{onRdtStateChanged@{onRdtStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRdtStateChanged()}{onRdtStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Rdt\+State\+Changed (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{user\+Id,  }\item[{Rdt\+State}]{state }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the R\+DT tunnel state changed. 

@technical preview


\begin{DoxyParams}{Parameters}
{\em user\+Id} & ID of the user who sends the data. \\
\hline
{\em state} & The R\+DT tunnel state. See Rdt\+State. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a82a1082fc12fcc26beacb0bdc055ac91}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a82a1082fc12fcc26beacb0bdc055ac91}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onMediaControlMessage@{onMediaControlMessage}}
\index{onMediaControlMessage@{onMediaControlMessage}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onMediaControlMessage()}{onMediaControlMessage()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Media\+Control\+Message (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{user\+Id,  }\item[{const char $\ast$}]{data,  }\item[{size\+\_\+t}]{length }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local user receives media control message sent by a remote user. 

@technical preview

The S\+DK triggers this callback when the user receives data sent by a remote user using the send\+Media\+Control\+Message method.


\begin{DoxyParams}{Parameters}
{\em user\+Id} & ID of the user who sends the data. \\
\hline
{\em data} & The data received. \\
\hline
{\em length} & The length (byte) of the data. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa7b456b750f56ca8fdfee8611572310e}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa7b456b750f56ca8fdfee8611572310e}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRequestToken@{onRequestToken}}
\index{onRequestToken@{onRequestToken}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRequestToken()}{onRequestToken()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Request\+Token (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the token expires. 

The S\+DK triggers this callback if the token expires. When receiving this callback, you need to generate a new token on your token server and you can renew your token through one of the following ways\+:
\begin{DoxyItemize}
\item In scenarios involving one channel\+:
\begin{DoxyItemize}
\item Call {\ttfamily renew\+Token} to pass in the new token.
\item Call {\ttfamily leave\+Channel(const Leave\+Channel\+Options\& options)} to leave the current channel and then pass in the new token when you call {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} to join a channel.
\end{DoxyItemize}
\item In scenarios involving mutiple channels\+: Call {\ttfamily update\+Channel\+Media\+Options\+Ex} to pass in the new token. 
\end{DoxyItemize}\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac401db99e49d5f240f553087cb90571d}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac401db99e49d5f240f553087cb90571d}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onTokenPrivilegeWillExpire@{onTokenPrivilegeWillExpire}}
\index{onTokenPrivilegeWillExpire@{onTokenPrivilegeWillExpire}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onTokenPrivilegeWillExpire()}{onTokenPrivilegeWillExpire()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Token\+Privilege\+Will\+Expire (\begin{DoxyParamCaption}\item[{const char $\ast$}]{token }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the token expires in 30 seconds. 

When receiving this callback, you need to generate a new token on your token server and you can renew your token through one of the following ways\+:
\begin{DoxyItemize}
\item In scenarios involving one channel\+:
\begin{DoxyItemize}
\item Call {\ttfamily renew\+Token} to pass in the new token.
\item Call {\ttfamily leave\+Channel(const Leave\+Channel\+Options\& options)} to leave the current channel and then pass in the new token when you call {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} to join a channel.
\end{DoxyItemize}
\item In scenarios involving mutiple channels\+: Call {\ttfamily update\+Channel\+Media\+Options\+Ex} to pass in the new token. Call timing\+: The S\+DK triggers this callback 30 seconds before the token expires, reminding the app to update the token.
\end{DoxyItemize}


\begin{DoxyParams}{Parameters}
{\em token} & The token that is about to expire. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a40b29ba97d3519619e22069718f27add}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a40b29ba97d3519619e22069718f27add}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLicenseValidationFailure@{onLicenseValidationFailure}}
\index{onLicenseValidationFailure@{onLicenseValidationFailure}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLicenseValidationFailure()}{onLicenseValidationFailure()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+License\+Validation\+Failure (\begin{DoxyParamCaption}\item[{L\+I\+C\+E\+N\+S\+E\+\_\+\+E\+R\+R\+O\+R\+\_\+\+T\+Y\+PE}]{error }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Occurs when connection license verification fails.

You can know the reason accordding to error code \mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a03058e62a0a4a41e80ecf0279975ab99}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a03058e62a0a4a41e80ecf0279975ab99}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onFirstLocalAudioFramePublished@{onFirstLocalAudioFramePublished}}
\index{onFirstLocalAudioFramePublished@{onFirstLocalAudioFramePublished}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onFirstLocalAudioFramePublished()}{onFirstLocalAudioFramePublished()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+First\+Local\+Audio\+Frame\+Published (\begin{DoxyParamCaption}\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the first audio frame is published. 

The S\+DK triggers this callback under one of the following circumstances\+:
\begin{DoxyItemize}
\item The local client enables the audio module and calls {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} successfully.
\item The local client calls {\ttfamily mute\+Local\+Audio\+Stream} ({\ttfamily true}) and {\ttfamily mute\+Local\+Audio\+Stream} ({\ttfamily false}) in sequence.
\item The local client calls {\ttfamily disable\+Audio} and {\ttfamily enable\+Audio} in sequence.
\item The local client calls {\ttfamily push\+Audio\+Frame} to successfully push the audio frame to the S\+DK.
\end{DoxyItemize}


\begin{DoxyParams}{Parameters}
{\em elapsed} & Time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a599399089441b7daa560e9c410e8a7ba}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a599399089441b7daa560e9c410e8a7ba}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onFirstRemoteAudioDecoded@{onFirstRemoteAudioDecoded}}
\index{onFirstRemoteAudioDecoded@{onFirstRemoteAudioDecoded}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onFirstRemoteAudioDecoded()}{onFirstRemoteAudioDecoded()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+First\+Remote\+Audio\+Decoded (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the S\+DK decodes the first remote audio frame for playback. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000041}{Deprecated}}]Use {\ttfamily on\+Remote\+Audio\+State\+Changed} instead.\end{DoxyRefDesc}


The S\+DK triggers this callback under one of the following circumstances\+:
\begin{DoxyItemize}
\item The remote user joins the channel and sends the audio stream for the first time.
\item The remote user\textquotesingle{}s audio is offline and then goes online to re-\/send audio. It means the local user cannot receive audio in 15 seconds. Reasons for such an interruption include\+:
\begin{DoxyItemize}
\item The remote user leaves channel.
\item The remote user drops offline.
\item The remote user calls {\ttfamily mute\+Local\+Audio\+Stream} to stop sending the audio stream.
\item The remote user calls {\ttfamily disable\+Audio} to disable audio.
\end{DoxyItemize}
\end{DoxyItemize}


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em elapsed} & The time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a160165e2d77abe9b35d1a2e638e2ced7}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a160165e2d77abe9b35d1a2e638e2ced7}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onFirstRemoteAudioFrame@{onFirstRemoteAudioFrame}}
\index{onFirstRemoteAudioFrame@{onFirstRemoteAudioFrame}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onFirstRemoteAudioFrame()}{onFirstRemoteAudioFrame()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+First\+Remote\+Audio\+Frame (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the S\+DK receives the first audio frame from a specific remote user. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000042}{Deprecated}}]Use {\ttfamily on\+Remote\+Audio\+State\+Changed} instead.\end{DoxyRefDesc}



\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em elapsed} & The time elapsed (ms) from the local user calling {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a32079919217571134d36b01252de60d3}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a32079919217571134d36b01252de60d3}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLocalAudioStateChanged@{onLocalAudioStateChanged}}
\index{onLocalAudioStateChanged@{onLocalAudioStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLocalAudioStateChanged()}{onLocalAudioStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Local\+Audio\+State\+Changed (\begin{DoxyParamCaption}\item[{L\+O\+C\+A\+L\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+TE}]{state,  }\item[{L\+O\+C\+A\+L\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+ON}]{reason }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local audio stream state changes. 

When the state of the local audio stream changes (including the state of the audio capture and encoding), the S\+DK triggers this callback to report the current state. This callback indicates the state of the local audio stream, and allows you to troubleshoot issues when audio exceptions occur.

\begin{DoxyNote}{Note}
When the state is {\ttfamily L\+O\+C\+A\+L\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+T\+E\+\_\+\+F\+A\+I\+L\+ED} (3), you can view the error information in the {\ttfamily error} parameter.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em state} & The state of the local audio. See {\ttfamily L\+O\+C\+A\+L\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em reason} & Reasons for local audio state changes. See {\ttfamily L\+O\+C\+A\+L\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+R\+E\+A\+S\+ON}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa168380f86f1dc2df1c269a785c56612}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa168380f86f1dc2df1c269a785c56612}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRemoteAudioStateChanged@{onRemoteAudioStateChanged}}
\index{onRemoteAudioStateChanged@{onRemoteAudioStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRemoteAudioStateChanged()}{onRemoteAudioStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Remote\+Audio\+State\+Changed (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{R\+E\+M\+O\+T\+E\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+A\+TE}]{state,  }\item[{R\+E\+M\+O\+T\+E\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+A\+T\+E\+\_\+\+R\+E\+A\+S\+ON}]{reason,  }\item[{int}]{elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the remote audio state changes. 

When the audio state of a remote user (in a voice/video call channel) or host (in a live streaming channel) changes, the S\+DK triggers this callback to report the current state of the remote audio stream.

\begin{DoxyNote}{Note}
This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 32.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the remote user whose audio state changes. \\
\hline
{\em state} & The state of the remote audio. See {\ttfamily R\+E\+M\+O\+T\+E\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em reason} & The reason of the remote audio state change. See {\ttfamily R\+E\+M\+O\+T\+E\+\_\+\+A\+U\+D\+I\+O\+\_\+\+S\+T\+A\+T\+E\+\_\+\+R\+E\+A\+S\+ON}. \\
\hline
{\em elapsed} & Time elapsed (ms) from the local user calling the {\ttfamily join\+Channel(const char$\ast$ token, const char$\ast$ channel\+Id, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} method until the S\+DK triggers this callback. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae643c9dbf94360a23a8b3a56c93f90bc}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae643c9dbf94360a23a8b3a56c93f90bc}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onActiveSpeaker@{onActiveSpeaker}}
\index{onActiveSpeaker@{onActiveSpeaker}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onActiveSpeaker()}{onActiveSpeaker()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Active\+Speaker (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the most active remote speaker is detected. 

After a successful call of {\ttfamily enable\+Audio\+Volume\+Indication}, the S\+DK continuously detects which remote user has the loudest volume. During the current period, the remote user whose volume is detected as the loudest for the most times, is the most active user. When the number of users is no less than two and an active remote speaker exists, the S\+DK triggers this callback and reports the {\ttfamily uid} of the most active remote speaker.
\begin{DoxyItemize}
\item If the most active remote speaker is always the same user, the S\+DK triggers the {\ttfamily on\+Active\+Speaker} callback only once.
\item If the most active remote speaker changes to another user, the S\+DK triggers this callback again and reports the {\ttfamily uid} of the new active remote speaker.
\end{DoxyItemize}


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the most active speaker. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2479344eff97d9eecc19637008fa5092}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2479344eff97d9eecc19637008fa5092}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onContentInspectResult@{onContentInspectResult}}
\index{onContentInspectResult@{onContentInspectResult}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onContentInspectResult()}{onContentInspectResult()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Content\+Inspect\+Result (\begin{DoxyParamCaption}\item[{media\+::\+C\+O\+N\+T\+E\+N\+T\+\_\+\+I\+N\+S\+P\+E\+C\+T\+\_\+\+R\+E\+S\+U\+LT}]{result }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Reports result of content inspection.


\begin{DoxyParams}{Parameters}
{\em result} & The result of content inspection\+: \#\+C\+O\+N\+T\+E\+N\+T\+\_\+\+I\+N\+S\+P\+E\+C\+T\+\_\+\+R\+E\+S\+U\+LT. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a6b8144c5a1591e06d6d854f703e97648}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a6b8144c5a1591e06d6d854f703e97648}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onSnapshotTaken@{onSnapshotTaken}}
\index{onSnapshotTaken@{onSnapshotTaken}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onSnapshotTaken()}{onSnapshotTaken()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Snapshot\+Taken (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{const char $\ast$}]{file\+Path,  }\item[{int}]{width,  }\item[{int}]{height,  }\item[{int}]{err\+Code }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the result of taking a video snapshot. 

After a successful {\ttfamily take\+Snapshot(uid\+\_\+t uid, const char$\ast$ file\+Path)} method call, the S\+DK triggers this callback to report whether the snapshot is successfully taken as well as the details for the snapshot taken.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID. One {\ttfamily uid} of 0 indicates the local user. \\
\hline
{\em file\+Path} & The local path of the snapshot. \\
\hline
{\em width} & The width (px) of the snapshot. \\
\hline
{\em height} & The height (px) of the snapshot. \\
\hline
{\em err\+Code} & The message that confirms success or gives the reason why the snapshot is not successfully taken\+:
\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure\+:
\begin{DoxyItemize}
\item -\/1\+: The S\+DK fails to write data to a file or encode a J\+P\+EG image.
\item -\/2\+: The S\+DK does not find the video stream of the specified user within one second after the {\ttfamily take\+Snapshot(uid\+\_\+t uid, const char$\ast$ file\+Path)} method call succeeds. The possible reasons are\+: local capture stops, remote end stops publishing, or video data processing is blocked.
\item -\/3\+: Calling the {\ttfamily take\+Snapshot(uid\+\_\+t uid, const char$\ast$ file\+Path)} method too frequently. 
\end{DoxyItemize}
\end{DoxyItemize}\\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a62ebb50a33d02175cddb4c655465cf20}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a62ebb50a33d02175cddb4c655465cf20}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onClientRoleChanged@{onClientRoleChanged}}
\index{onClientRoleChanged@{onClientRoleChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onClientRoleChanged()}{onClientRoleChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Client\+Role\+Changed (\begin{DoxyParamCaption}\item[{C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE}]{old\+Role,  }\item[{C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE}]{new\+Role,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_client_role_options}{Client\+Role\+Options}} \&}]{new\+Role\+Options }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the user role or the audience latency level changes. 

Call timing\+: This callback will be triggered in any of the following situations\+:
\begin{DoxyItemize}
\item Calling {\ttfamily set\+Client\+Role(\+C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+P\+E role)} or {\ttfamily set\+Client\+Role(C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE role, const \mbox{\hyperlink{structagora_1_1rtc_1_1_client_role_options}{Client\+Role\+Options}}\& options)} to set the user role or audience latency level {\bfseries{after joining a channel}}
\item Calling {\ttfamily set\+Client\+Role(\+C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+P\+E role)} or {\ttfamily set\+Client\+Role(C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE role, const \mbox{\hyperlink{structagora_1_1rtc_1_1_client_role_options}{Client\+Role\+Options}}\& options)} and set the user role to {\ttfamily A\+U\+D\+I\+E\+N\+CE} {\bfseries{before joining a channel}}.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
This callback will not be triggered when you call {\ttfamily set\+Client\+Role(\+C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+P\+E role)} or {\ttfamily set\+Client\+Role(\+C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+P\+E role, const Client\+Role\+Options\& options)} and set the user role to {\ttfamily B\+R\+O\+A\+D\+C\+A\+S\+T\+ER} {\bfseries{before joining a channel}}.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em old\+Role} & Role that the user switches from\+: {\ttfamily C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em new\+Role} & Role that the user switches to\+: {\ttfamily C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em new\+Role\+Options} & Since v4.\+1.\+0 Properties of the role that the user switches to. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_client_role_options}{Client\+Role\+Options}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7f7424742197df2e199981b7e0e50f4f}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7f7424742197df2e199981b7e0e50f4f}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onClientRoleChangeFailed@{onClientRoleChangeFailed}}
\index{onClientRoleChangeFailed@{onClientRoleChangeFailed}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onClientRoleChangeFailed()}{onClientRoleChangeFailed()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Client\+Role\+Change\+Failed (\begin{DoxyParamCaption}\item[{C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+C\+H\+A\+N\+G\+E\+\_\+\+F\+A\+I\+L\+E\+D\+\_\+\+R\+E\+A\+S\+ON}]{reason,  }\item[{C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE}]{current\+Role }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when switching a user role fails. 

This callback informs you about the reason for failing to switching and your current user role. Call timing\+: The S\+DK triggers this callback when the local user calls {\ttfamily set\+Client\+Role(\+C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+P\+E role)} or {\ttfamily set\+Client\+Role(\+C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+P\+E role, const Client\+Role\+Options\& options)} after joining a channel to switch the user role but the switching fails.


\begin{DoxyParams}{Parameters}
{\em reason} & The reason for a user role switch failure. See {\ttfamily C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+C\+H\+A\+N\+G\+E\+\_\+\+F\+A\+I\+L\+E\+D\+\_\+\+R\+E\+A\+S\+ON}. \\
\hline
{\em current\+Role} & Current user role. See {\ttfamily C\+L\+I\+E\+N\+T\+\_\+\+R\+O\+L\+E\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0f99efc9aebf1242c2e8a49966ae21ae}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0f99efc9aebf1242c2e8a49966ae21ae}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioDeviceVolumeChanged@{onAudioDeviceVolumeChanged}}
\index{onAudioDeviceVolumeChanged@{onAudioDeviceVolumeChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioDeviceVolumeChanged()}{onAudioDeviceVolumeChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Device\+Volume\+Changed (\begin{DoxyParamCaption}\item[{M\+E\+D\+I\+A\+\_\+\+D\+E\+V\+I\+C\+E\+\_\+\+T\+Y\+PE}]{device\+Type,  }\item[{int}]{volume,  }\item[{bool}]{muted }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the volume change of the audio device or app. 

Occurs when the volume on the playback device, audio capture device, or the volume of the app changes.

\begin{DoxyNote}{Note}
This callback is for Windows and mac\+OS only.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em device\+Type} & The device type. See {\ttfamily M\+E\+D\+I\+A\+\_\+\+D\+E\+V\+I\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em volume} & The volume value. The range is \mbox{[}0, 255\mbox{]}. \\
\hline
{\em muted} & Whether the audio device is muted\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: The audio device is muted.
\item {\ttfamily false}\+: The audio device is not muted. 
\end{DoxyItemize}\\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a01f3ce153df3a96703a0c9af934058f6}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a01f3ce153df3a96703a0c9af934058f6}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRtmpStreamingStateChanged@{onRtmpStreamingStateChanged}}
\index{onRtmpStreamingStateChanged@{onRtmpStreamingStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRtmpStreamingStateChanged()}{onRtmpStreamingStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Rtmp\+Streaming\+State\+Changed (\begin{DoxyParamCaption}\item[{const char $\ast$}]{url,  }\item[{R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}]{state,  }\item[{R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+R\+E\+A\+S\+ON}]{reason }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the state of Media Push changes. 

When the state of Media Push changes, the S\+DK triggers this callback and reports the U\+RL address and the current state of the Media Push. This callback indicates the state of the Media Push. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the error code parameter.


\begin{DoxyParams}{Parameters}
{\em url} & The U\+RL address where the state of the Media Push changes. \\
\hline
{\em state} & The current state of the Media Push. See {\ttfamily R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em reason} & Reasons for the changes in the Media Push status. See {\ttfamily R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+R\+E\+A\+S\+ON}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa2beb17562a3be9b5ddbe9366245cb0e}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aa2beb17562a3be9b5ddbe9366245cb0e}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRtmpStreamingEvent@{onRtmpStreamingEvent}}
\index{onRtmpStreamingEvent@{onRtmpStreamingEvent}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRtmpStreamingEvent()}{onRtmpStreamingEvent()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Rtmp\+Streaming\+Event (\begin{DoxyParamCaption}\item[{const char $\ast$}]{url,  }\item[{R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+I\+N\+G\+\_\+\+E\+V\+E\+NT}]{event\+Code }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports events during the Media Push. 


\begin{DoxyParams}{Parameters}
{\em url} & The U\+RL for Media Push. \\
\hline
{\em event\+Code} & The event code of Media Push. See {\ttfamily R\+T\+M\+P\+\_\+\+S\+T\+R\+E\+A\+M\+I\+N\+G\+\_\+\+E\+V\+E\+NT}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0583fb2aecbd4c51bba1af97ce1aa318}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a0583fb2aecbd4c51bba1af97ce1aa318}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onTranscodingUpdated@{onTranscodingUpdated}}
\index{onTranscodingUpdated@{onTranscodingUpdated}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onTranscodingUpdated()}{onTranscodingUpdated()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Transcoding\+Updated (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the publisher\textquotesingle{}s transcoding is updated. 

When the {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}}} class in the {\ttfamily start\+Rtmp\+Stream\+With\+Transcoding} method updates, the S\+DK triggers the {\ttfamily on\+Transcoding\+Updated} callback to report the update information.

\begin{DoxyNote}{Note}
If you call the {\ttfamily start\+Rtmp\+Stream\+With\+Transcoding} method to set the {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}}} class for the first time, the S\+DK does not trigger this callback. 
\end{DoxyNote}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a5ad747e71cd7f57052a5240513af1949}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a5ad747e71cd7f57052a5240513af1949}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioRoutingChanged@{onAudioRoutingChanged}}
\index{onAudioRoutingChanged@{onAudioRoutingChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioRoutingChanged()}{onAudioRoutingChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Routing\+Changed (\begin{DoxyParamCaption}\item[{int}]{routing }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local audio route changes. 

\begin{DoxyNote}{Note}
This method is for Android, i\+OS and mac\+OS only.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em routing} & The current audio routing. See {\ttfamily Audio\+Route}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1891ed124db5f74747e74ca3b3eb23e9}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1891ed124db5f74747e74ca3b3eb23e9}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onChannelMediaRelayStateChanged@{onChannelMediaRelayStateChanged}}
\index{onChannelMediaRelayStateChanged@{onChannelMediaRelayStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onChannelMediaRelayStateChanged()}{onChannelMediaRelayStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Channel\+Media\+Relay\+State\+Changed (\begin{DoxyParamCaption}\item[{int}]{state,  }\item[{int}]{code }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the state of the media stream relay changes. 

The S\+DK returns the state of the current media relay with any error message.


\begin{DoxyParams}{Parameters}
{\em state} & The state code. See {\ttfamily C\+H\+A\+N\+N\+E\+L\+\_\+\+M\+E\+D\+I\+A\+\_\+\+R\+E\+L\+A\+Y\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em code} & The error code of the channel media relay. See {\ttfamily C\+H\+A\+N\+N\+E\+L\+\_\+\+M\+E\+D\+I\+A\+\_\+\+R\+E\+L\+A\+Y\+\_\+\+E\+R\+R\+OR}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7ee343146ad6e3f120bd04a7a6fdda74}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a7ee343146ad6e3f120bd04a7a6fdda74}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRemoteSubscribeFallbackToAudioOnly@{onRemoteSubscribeFallbackToAudioOnly}}
\index{onRemoteSubscribeFallbackToAudioOnly@{onRemoteSubscribeFallbackToAudioOnly}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRemoteSubscribeFallbackToAudioOnly()}{onRemoteSubscribeFallbackToAudioOnly()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Remote\+Subscribe\+Fallback\+To\+Audio\+Only (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{bool}]{is\+Fallback\+Or\+Recover }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the remote media stream falls back to the audio-\/only stream due to poor network conditions or switches back to the video stream after the network conditions improve. 

If you call {\ttfamily set\+Remote\+Subscribe\+Fallback\+Option} and set {\ttfamily option} to {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+F\+A\+L\+L\+B\+A\+C\+K\+\_\+\+O\+P\+T\+I\+O\+N\+\_\+\+A\+U\+D\+I\+O\+\_\+\+O\+N\+LY}, the S\+DK triggers this callback in the following situations\+:
\begin{DoxyItemize}
\item The downstream network condition is poor, and the subscribed video stream is downgraded to audio-\/only stream.
\item The downstream network condition has improved, and the subscribed stream has been restored to video stream.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
Once the remote media stream switches to the low-\/quality video stream due to weak network conditions, you can monitor the stream switch between a high-\/quality and low-\/quality stream in the {\ttfamily on\+Remote\+Video\+Stats} callback.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em is\+Fallback\+Or\+Recover} & -\/ {\ttfamily true}\+: The subscribed media stream falls back to audio-\/only due to poor network conditions.
\begin{DoxyItemize}
\item {\ttfamily false}\+: The subscribed media stream switches back to the video stream after the network conditions improve. 
\end{DoxyItemize}\\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2aee5d99c0de8fa2f5cd71f5aa5f7128}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a2aee5d99c0de8fa2f5cd71f5aa5f7128}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRemoteAudioTransportStats@{onRemoteAudioTransportStats}}
\index{onRemoteAudioTransportStats@{onRemoteAudioTransportStats}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRemoteAudioTransportStats()}{onRemoteAudioTransportStats()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Remote\+Audio\+Transport\+Stats (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{unsigned short}]{delay,  }\item[{unsigned short}]{lost,  }\item[{unsigned short}]{rx\+K\+Bit\+Rate }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the transport-\/layer statistics of each remote audio stream. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000043}{Deprecated}}]Use {\ttfamily on\+Remote\+Audio\+Stats} instead.\end{DoxyRefDesc}


This callback reports the transport-\/layer statistics, such as the packet loss rate and network time delay after the local user receives an audio packet from a remote user. During a call, when the user receives the audio packet sent by the remote user, the callback is triggered every 2 seconds.


\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the remote user sending the audio streams. \\
\hline
{\em delay} & The network delay (ms) from the remote user to the receiver. \\
\hline
{\em lost} & The packet loss rate (\%) of the audio packet sent from the remote user to the receiver. \\
\hline
{\em rx\+K\+Bitrate} & The bitrate of the received audio (Kbps). \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aae6eb5cba66f6314ee806bc9be253ff6}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aae6eb5cba66f6314ee806bc9be253ff6}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRemoteVideoTransportStats@{onRemoteVideoTransportStats}}
\index{onRemoteVideoTransportStats@{onRemoteVideoTransportStats}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRemoteVideoTransportStats()}{onRemoteVideoTransportStats()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Remote\+Video\+Transport\+Stats (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{unsigned short}]{delay,  }\item[{unsigned short}]{lost,  }\item[{unsigned short}]{rx\+K\+Bit\+Rate }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the transport-\/layer statistics of each remote video stream. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000044}{Deprecated}}]Use {\ttfamily on\+Remote\+Video\+Stats} instead.\end{DoxyRefDesc}


This callback reports the transport-\/layer statistics, such as the packet loss rate and network time delay after the local user receives a video packet from a remote user. During a call, when the user receives the video packet sent by the remote user/host, the callback is triggered every 2 seconds.


\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the remote user sending the video packets. \\
\hline
{\em delay} & The network delay (ms) from the sender to the receiver. \\
\hline
{\em lost} & The packet loss rate (\%) of the video packet sent from the remote user. \\
\hline
{\em rx\+K\+Bit\+Rate} & The bitrate of the received video (Kbps). \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af409b2e721d345a65a2c600cea2f5eb4}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af409b2e721d345a65a2c600cea2f5eb4}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onConnectionStateChanged@{onConnectionStateChanged}}
\index{onConnectionStateChanged@{onConnectionStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onConnectionStateChanged()}{onConnectionStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Connection\+State\+Changed (\begin{DoxyParamCaption}\item[{C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}]{state,  }\item[{C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+C\+H\+A\+N\+G\+E\+D\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE}]{reason }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the network connection state changes. 

When the network connection state changes, the S\+DK triggers this callback and reports the current connection state and the reason for the change.


\begin{DoxyParams}{Parameters}
{\em state} & The current connection state. See {\ttfamily C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em reason} & The reason for a connection state change. See {\ttfamily C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+C\+H\+A\+N\+G\+E\+D\+\_\+\+R\+E\+A\+S\+O\+N\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af71617b59ba8564963dfdd642f4e36a4}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af71617b59ba8564963dfdd642f4e36a4}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onNetworkTypeChanged@{onNetworkTypeChanged}}
\index{onNetworkTypeChanged@{onNetworkTypeChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onNetworkTypeChanged()}{onNetworkTypeChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Network\+Type\+Changed (\begin{DoxyParamCaption}\item[{N\+E\+T\+W\+O\+R\+K\+\_\+\+T\+Y\+PE}]{type }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local network type changes. 

This callback occurs when the connection state of the local user changes. You can get the connection state and reason for the state change in this callback. When the network connection is interrupted, this callback indicates whether the interruption is caused by a network type change or poor network conditions.


\begin{DoxyParams}{Parameters}
{\em type} & The type of the local network connection. See {\ttfamily N\+E\+T\+W\+O\+R\+K\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad64b65c8bbb78624316770b01f2ee9bd}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad64b65c8bbb78624316770b01f2ee9bd}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onEncryptionError@{onEncryptionError}}
\index{onEncryptionError@{onEncryptionError}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onEncryptionError()}{onEncryptionError()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Encryption\+Error (\begin{DoxyParamCaption}\item[{E\+N\+C\+R\+Y\+P\+T\+I\+O\+N\+\_\+\+E\+R\+R\+O\+R\+\_\+\+T\+Y\+PE}]{error\+Type }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Reports the built-\/in encryption errors. 

When encryption is enabled by calling {\ttfamily enable\+Encryption}, the S\+DK triggers this callback if an error occurs in encryption or decryption on the sender or the receiver side.


\begin{DoxyParams}{Parameters}
{\em error\+Type} & Details about the error type. See {\ttfamily E\+N\+C\+R\+Y\+P\+T\+I\+O\+N\+\_\+\+E\+R\+R\+O\+R\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac3f1dae447118e5cb261bd10ea9edfa2}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ac3f1dae447118e5cb261bd10ea9edfa2}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onPermissionError@{onPermissionError}}
\index{onPermissionError@{onPermissionError}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onPermissionError()}{onPermissionError()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Permission\+Error (\begin{DoxyParamCaption}\item[{P\+E\+R\+M\+I\+S\+S\+I\+O\+N\+\_\+\+T\+Y\+PE}]{permission\+Type }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the S\+DK cannot get the device permission. 

When the S\+DK fails to get the device permission, the S\+DK triggers this callback to report which device permission cannot be got.


\begin{DoxyParams}{Parameters}
{\em permission\+Type} & The type of the device permission. See {\ttfamily P\+E\+R\+M\+I\+S\+S\+I\+O\+N\+\_\+\+T\+Y\+PE}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a919404869f86412e1945c730e5219b20}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a919404869f86412e1945c730e5219b20}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLocalUserRegistered@{onLocalUserRegistered}}
\index{onLocalUserRegistered@{onLocalUserRegistered}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLocalUserRegistered()}{onLocalUserRegistered()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Local\+User\+Registered (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{const char $\ast$}]{user\+Account }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local user registers a user account. 

After the local user successfully calls {\ttfamily register\+Local\+User\+Account} to register the user account or calls {\ttfamily join\+Channel\+With\+User\+Account(const char$\ast$ token, const char$\ast$ channel\+Id, const char$\ast$ user\+Account, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}\& options)} to join a channel, the S\+DK triggers the callback and informs the local user\textquotesingle{}s U\+ID and User Account.


\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the local user. \\
\hline
{\em user\+Account} & The user account of the local user. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad086cc4d8e5555cc75a0ab264c16d5ff}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ad086cc4d8e5555cc75a0ab264c16d5ff}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserInfoUpdated@{onUserInfoUpdated}}
\index{onUserInfoUpdated@{onUserInfoUpdated}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserInfoUpdated()}{onUserInfoUpdated()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+Info\+Updated (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_user_info}{User\+Info}} \&}]{info }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the S\+DK gets the user ID and user account of the remote user. 

After a remote user joins the channel, the S\+DK gets the U\+ID and user account of the remote user, caches them in a mapping table object, and triggers this callback on the local client.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em info} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_user_info}{User\+Info}} object that contains the user ID and user account of the remote user. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_user_info}{User\+Info}}} for details. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_acbd8141eb8257ec5e1c24c2fd978c229}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_acbd8141eb8257ec5e1c24c2fd978c229}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUserAccountUpdated@{onUserAccountUpdated}}
\index{onUserAccountUpdated@{onUserAccountUpdated}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUserAccountUpdated()}{onUserAccountUpdated()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+User\+Account\+Updated (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{const char $\ast$}]{user\+Account }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Occurs when the user account is updated.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID. \\
\hline
{\em user\+Account} & The user account. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af157b707afd93a5b0ab39569e46a6cd4}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af157b707afd93a5b0ab39569e46a6cd4}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onVideoRenderingTracingResult@{onVideoRenderingTracingResult}}
\index{onVideoRenderingTracingResult@{onVideoRenderingTracingResult}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onVideoRenderingTracingResult()}{onVideoRenderingTracingResult()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Video\+Rendering\+Tracing\+Result (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{M\+E\+D\+I\+A\+\_\+\+T\+R\+A\+C\+E\+\_\+\+E\+V\+E\+NT}]{current\+Event,  }\item[{\mbox{\hyperlink{structagora_1_1rtc_1_1_video_rendering_tracing_info}{Video\+Rendering\+Tracing\+Info}}}]{tracing\+Info }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Video frame rendering event callback. 

After calling the {\ttfamily start\+Media\+Rendering\+Tracing} method or joining a channel, the S\+DK triggers this callback to report the events of video frame rendering and the indicators during the rendering process. Developers can optimize the indicators to improve the efficiency of the first video frame rendering.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID. \\
\hline
{\em current\+Event} & The current video frame rendering event. See {\ttfamily M\+E\+D\+I\+A\+\_\+\+T\+R\+A\+C\+E\+\_\+\+E\+V\+E\+NT}. \\
\hline
{\em tracing\+Info} & The indicators during the video frame rendering process. Developers need to reduce the value of indicators as much as possible in order to improve the efficiency of the first video frame rendering. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_video_rendering_tracing_info}{Video\+Rendering\+Tracing\+Info}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a10991aabb988c83f7515e9ea7eb693ad}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a10991aabb988c83f7515e9ea7eb693ad}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onLocalVideoTranscoderError@{onLocalVideoTranscoderError}}
\index{onLocalVideoTranscoderError@{onLocalVideoTranscoderError}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onLocalVideoTranscoderError()}{onLocalVideoTranscoderError()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Local\+Video\+Transcoder\+Error (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_video_stream}{Transcoding\+Video\+Stream}} \&}]{stream,  }\item[{V\+I\+D\+E\+O\+\_\+\+T\+R\+A\+N\+S\+C\+O\+D\+E\+R\+\_\+\+E\+R\+R\+OR}]{error }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when there\textquotesingle{}s an error during the local video mixing. 

When you fail to call {\ttfamily start\+Local\+Video\+Transcoder} or {\ttfamily update\+Local\+Transcoder\+Configuration}, the S\+DK triggers this callback to report the reason.


\begin{DoxyParams}{Parameters}
{\em stream} & The video streams that cannot be mixed during video mixing. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_video_stream}{Transcoding\+Video\+Stream}}}. \\
\hline
{\em error} & The reason for local video mixing error. See {\ttfamily V\+I\+D\+E\+O\+\_\+\+T\+R\+A\+N\+S\+C\+O\+D\+E\+R\+\_\+\+E\+R\+R\+OR}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a5f97ca5105b02f4381af3603d5a87ccf}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a5f97ca5105b02f4381af3603d5a87ccf}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onUploadLogResult@{onUploadLogResult}}
\index{onUploadLogResult@{onUploadLogResult}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onUploadLogResult()}{onUploadLogResult()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Upload\+Log\+Result (\begin{DoxyParamCaption}\item[{const char $\ast$}]{request\+Id,  }\item[{bool}]{success,  }\item[{U\+P\+L\+O\+A\+D\+\_\+\+E\+R\+R\+O\+R\+\_\+\+R\+E\+A\+S\+ON}]{reason }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Reports the user log upload result 
\begin{DoxyParams}{Parameters}
{\em request\+Id} & Request\+Id of the upload \\
\hline
{\em success} & Is upload success \\
\hline
{\em reason} & Reason of the upload, 0\+: OK, 1 Network Error, 2 Server Error. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae3f517bd166a9e34aa77f9fbf137a7b9}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae3f517bd166a9e34aa77f9fbf137a7b9}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioSubscribeStateChanged@{onAudioSubscribeStateChanged}}
\index{onAudioSubscribeStateChanged@{onAudioSubscribeStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioSubscribeStateChanged()}{onAudioSubscribeStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Subscribe\+State\+Changed (\begin{DoxyParamCaption}\item[{const char $\ast$}]{channel,  }\item[{uid\+\_\+t}]{uid,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE}]{old\+State,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE}]{new\+State,  }\item[{int}]{elapse\+Since\+Last\+State }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the audio subscribing state changes. 


\begin{DoxyParams}{Parameters}
{\em channel} & The channel name. \\
\hline
{\em uid} & The user ID of the remote user. \\
\hline
{\em old\+State} & The previous subscribing status. See {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em new\+State} & The current subscribing status. See {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em elapse\+Since\+Last\+State} & The time elapsed (ms) from the previous state to the current state. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aebedc2b484b4e6b9f5d9a28aea997d65}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aebedc2b484b4e6b9f5d9a28aea997d65}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onVideoSubscribeStateChanged@{onVideoSubscribeStateChanged}}
\index{onVideoSubscribeStateChanged@{onVideoSubscribeStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onVideoSubscribeStateChanged()}{onVideoSubscribeStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Video\+Subscribe\+State\+Changed (\begin{DoxyParamCaption}\item[{const char $\ast$}]{channel,  }\item[{uid\+\_\+t}]{uid,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE}]{old\+State,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE}]{new\+State,  }\item[{int}]{elapse\+Since\+Last\+State }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the video subscribing state changes. 


\begin{DoxyParams}{Parameters}
{\em channel} & The channel name. \\
\hline
{\em uid} & The user ID of the remote user. \\
\hline
{\em old\+State} & The previous subscribing status. See {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em new\+State} & The current subscribing status. See {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+S\+U\+B\+S\+C\+R\+I\+B\+E\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em elapse\+Since\+Last\+State} & The time elapsed (ms) from the previous state to the current state. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af5188bdc817fa62aac51b3dc627dfb64}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_af5188bdc817fa62aac51b3dc627dfb64}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioPublishStateChanged@{onAudioPublishStateChanged}}
\index{onAudioPublishStateChanged@{onAudioPublishStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioPublishStateChanged()}{onAudioPublishStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Publish\+State\+Changed (\begin{DoxyParamCaption}\item[{const char $\ast$}]{channel,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}]{old\+State,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}]{new\+State,  }\item[{int}]{elapse\+Since\+Last\+State }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the audio publishing state changes. 


\begin{DoxyParams}{Parameters}
{\em channel} & The channel name. \\
\hline
{\em old\+State} & The previous publishing state. See {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em new\+State} & The current publishing stat. See {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em elapse\+Since\+Last\+State} & The time elapsed (ms) from the previous state to the current state. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae7b1f0d07f6c601717e38b101eda9d6c}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae7b1f0d07f6c601717e38b101eda9d6c}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onVideoPublishStateChanged@{onVideoPublishStateChanged}}
\index{onVideoPublishStateChanged@{onVideoPublishStateChanged}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onVideoPublishStateChanged()}{onVideoPublishStateChanged()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Video\+Publish\+State\+Changed (\begin{DoxyParamCaption}\item[{V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}]{source,  }\item[{const char $\ast$}]{channel,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}]{old\+State,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}]{new\+State,  }\item[{int}]{elapse\+Since\+Last\+State }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the video publishing state changes. 


\begin{DoxyParams}{Parameters}
{\em channel} & The channel name. \\
\hline
{\em source} & The type of the video source. See {\ttfamily V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em old\+State} & The previous publishing state. See {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em new\+State} & The current publishing stat. See {\ttfamily S\+T\+R\+E\+A\+M\+\_\+\+P\+U\+B\+L\+I\+S\+H\+\_\+\+S\+T\+A\+TE}. \\
\hline
{\em elapse\+Since\+Last\+State} & The time elapsed (ms) from the previous state to the current state. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a4de055f77b40ca2aeab0d9132cbffc2a}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a4de055f77b40ca2aeab0d9132cbffc2a}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onTranscodedStreamLayoutInfo@{onTranscodedStreamLayoutInfo}}
\index{onTranscodedStreamLayoutInfo@{onTranscodedStreamLayoutInfo}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onTranscodedStreamLayoutInfo()}{onTranscodedStreamLayoutInfo()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Transcoded\+Stream\+Layout\+Info (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{width,  }\item[{int}]{height,  }\item[{int}]{layout\+Count,  }\item[{const \mbox{\hyperlink{structagora_1_1_video_layout}{Video\+Layout}} $\ast$}]{layoutlist }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the local user receives a mixed video stream carrying layout information. 

When the local user receives a mixed video stream sent by the video mixing server for the first time, or when there is a change in the layout information of the mixed stream, the S\+DK triggers this callback, reporting the layout information of each sub-\/video stream within the mixed video stream.

\begin{DoxyNote}{Note}
This callback is for Android and i\+OS only.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & User ID who published this mixed video stream. \\
\hline
{\em width} & Width (px) of the mixed video stream. \\
\hline
{\em height} & Heitht (px) of the mixed video stream. \\
\hline
{\em layout\+Count} & The number of layout information in the mixed video stream. \\
\hline
{\em layoutlist} & Layout information of a specific sub-\/video stream within the mixed stream. See {\ttfamily \mbox{\hyperlink{structagora_1_1_video_layout}{Video\+Layout}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a4a9e9a3c7d3a058191aeac328620aab9}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a4a9e9a3c7d3a058191aeac328620aab9}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onAudioMetadataReceived@{onAudioMetadataReceived}}
\index{onAudioMetadataReceived@{onAudioMetadataReceived}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onAudioMetadataReceived()}{onAudioMetadataReceived()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Audio\+Metadata\+Received (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{const char $\ast$}]{metadata,  }\item[{size\+\_\+t}]{length }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Occurs when the S\+DK receives audio metadata. \begin{DoxySince}{Since}
v4.\+3.\+1 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em uid} & ID of the remote user. \\
\hline
{\em metadata} & The pointer of metadata \\
\hline
{\em length} & Size of metadata @technical preview \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae9ab8501c677f6b25f9b61992578f50d}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ae9ab8501c677f6b25f9b61992578f50d}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onExtensionEventWithContext@{onExtensionEventWithContext}}
\index{onExtensionEventWithContext@{onExtensionEventWithContext}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onExtensionEventWithContext()}{onExtensionEventWithContext()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Extension\+Event\+With\+Context (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}} \&}]{context,  }\item[{const char $\ast$}]{key,  }\item[{const char $\ast$}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



The event callback of the extension. 

To listen for events while the extension is running, you need to register this callback.


\begin{DoxyParams}{Parameters}
{\em context} & The context information of the extension, see {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}}}. \\
\hline
{\em key} & The key of the extension. \\
\hline
{\em value} & The value of the extension key. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aec85c75025a10a0b03dc605f6b3652ae}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aec85c75025a10a0b03dc605f6b3652ae}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onExtensionStartedWithContext@{onExtensionStartedWithContext}}
\index{onExtensionStartedWithContext@{onExtensionStartedWithContext}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onExtensionStartedWithContext()}{onExtensionStartedWithContext()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Extension\+Started\+With\+Context (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}} \&}]{context }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurrs when the extension is enabled. 

The callback is triggered after the extension is successfully enabled.


\begin{DoxyParams}{Parameters}
{\em context} & The context information of the extension, see {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1776784b1d8870ef02c1d152a39ce5f3}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a1776784b1d8870ef02c1d152a39ce5f3}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onExtensionStoppedWithContext@{onExtensionStoppedWithContext}}
\index{onExtensionStoppedWithContext@{onExtensionStoppedWithContext}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onExtensionStoppedWithContext()}{onExtensionStoppedWithContext()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Extension\+Stopped\+With\+Context (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}} \&}]{context }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the extension is disabled. 

The callback is triggered after the extension is successfully disabled.


\begin{DoxyParams}{Parameters}
{\em context} & The context information of the extension, see {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a8a03f4eeead3215146302b2ed4458d06}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a8a03f4eeead3215146302b2ed4458d06}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onExtensionErrorWithContext@{onExtensionErrorWithContext}}
\index{onExtensionErrorWithContext@{onExtensionErrorWithContext}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onExtensionErrorWithContext()}{onExtensionErrorWithContext()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Extension\+Error\+With\+Context (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}} \&}]{context,  }\item[{int}]{error,  }\item[{const char $\ast$}]{message }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Occurs when the extension runs incorrectly. 

In case of extension enabling failure or runtime errors, the extension triggers this callback and reports the error code along with the reasons.


\begin{DoxyParams}{Parameters}
{\em context} & The context information of the extension, see {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_extension_context}{Extension\+Context}}}. \\
\hline
{\em error} & Error code. For details, see the extension documentation provided by the extension provider. \\
\hline
{\em message} & Reason. For details, see the extension documentation provided by the extension provider. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aee8751fc4c7ec335cc94b9d6b3df071a}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_aee8751fc4c7ec335cc94b9d6b3df071a}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onSetRtmFlagResult@{onSetRtmFlagResult}}
\index{onSetRtmFlagResult@{onSetRtmFlagResult}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onSetRtmFlagResult()}{onSetRtmFlagResult()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Set\+Rtm\+Flag\+Result (\begin{DoxyParamCaption}\item[{int}]{code }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Occurs when the S\+DK receives R\+TM setting change response.

@technical preview 
\begin{DoxyParams}{Parameters}
{\em code} & The error code. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3393ed4d85a160b57abd4ca7bc13002f}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a3393ed4d85a160b57abd4ca7bc13002f}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onMultipathStats@{onMultipathStats}}
\index{onMultipathStats@{onMultipathStats}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onMultipathStats()}{onMultipathStats()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Multipath\+Stats (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_multipath_stats}{Multipath\+Stats}} \&}]{stats }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Report the multipath transmission statistics. 

\begin{DoxyPostcond}{Postcondition}
This callback is triggered after you set {\ttfamily enable\+Multipath} to {\ttfamily true} to enable multipath transmission.
\end{DoxyPostcond}
\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em stats} & The multipath statistics. See the \mbox{\hyperlink{structagora_1_1rtc_1_1_multipath_stats}{Multipath\+Stats}} structure for details. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab02a474e317eb85459d79e5cf2296038}\label{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_ab02a474e317eb85459d79e5cf2296038}} 
\index{agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}!onRenewTokenResult@{onRenewTokenResult}}
\index{onRenewTokenResult@{onRenewTokenResult}!agora::rtc::IRtcEngineEventHandler@{agora::rtc::IRtcEngineEventHandler}}
\doxysubsubsection{\texorpdfstring{onRenewTokenResult()}{onRenewTokenResult()}}
{\footnotesize\ttfamily virtual void agora\+::rtc\+::\+I\+Rtc\+Engine\+Event\+Handler\+::on\+Renew\+Token\+Result (\begin{DoxyParamCaption}\item[{const char $\ast$}]{token,  }\item[{R\+E\+N\+E\+W\+\_\+\+T\+O\+K\+E\+N\+\_\+\+E\+R\+R\+O\+R\+\_\+\+C\+O\+DE}]{code }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Callback for {\ttfamily renew\+Token} call result. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
This callback is triggered after the user calls the {\ttfamily renew\+Token} method to update the token, and is used to notify the app of the result.


\begin{DoxyParams}{Parameters}
{\em token} & Token. \\
\hline
{\em code} & Error code. See {\ttfamily R\+E\+N\+E\+W\+\_\+\+T\+O\+K\+E\+N\+\_\+\+E\+R\+R\+O\+R\+\_\+\+C\+O\+DE}. \\
\hline
\end{DoxyParams}
