\hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex}{}\doxysection{agora\+::rtc\+::I\+Rtc\+Engine\+Ex Class Reference}
\label{classagora_1_1rtc_1_1_i_rtc_engine_ex}\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
Inheritance diagram for agora\+::rtc\+::I\+Rtc\+Engine\+Ex\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{classagora_1_1rtc_1_1_i_rtc_engine_ex}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aea0d3d4fd0c5e50a684b8e08af56bfee}{join\+Channel\+Ex}} (const char $\ast$token, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}} \&options, \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler}{I\+Rtc\+Engine\+Event\+Handler}} $\ast$event\+Handler)=0
\begin{DoxyCompactList}\small\item\em Joins a channel. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a32a7b59b5a79b8c7fcf2523fef500f77}{leave\+Channel\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Leaves a channel. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a8a6964eba31ae04024f2aec067954a93}{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)=0
\begin{DoxyCompactList}\small\item\em Sets channel options and leaves the channel. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab4c1cf6ac6964bdce98a35519e8ae518}{leave\+Channel\+With\+User\+Account\+Ex}} (const char $\ast$channel\+Id, const char $\ast$user\+Account)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aebb64a45c6ba10b7cf554444359114a7}{leave\+Channel\+With\+User\+Account\+Ex}} (const char $\ast$channel\+Id, const char $\ast$user\+Account, const \mbox{\hyperlink{structagora_1_1rtc_1_1_leave_channel_options}{Leave\+Channel\+Options}} \&options)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a8334b0d0f5f2c3632eaa9358de14900d}{update\+Channel\+Media\+Options\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}} \&options, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Updates the channel media options after joining the channel. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_af075e5e718c6c66e94076daf20dcc818}{set\+Video\+Encoder\+Configuration\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_video_encoder_configuration}{Video\+Encoder\+Configuration}} \&config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the video encoder configuration. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a9b440849431c01df80df39c2b18ff54e}{setup\+Remote\+Video\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_video_canvas}{Video\+Canvas}} \&canvas, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Initializes the video view of a remote user. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ae964daa0d8f236dea59c75545a7e861a}{mute\+Remote\+Audio\+Stream\+Ex}} (uid\+\_\+t uid, bool mute, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Stops or resumes receiving the audio stream of a specified user. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_abd81f06feeaf8d8ec2744adf74af3655}{mute\+Remote\+Video\+Stream\+Ex}} (uid\+\_\+t uid, bool mute, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Stops or resumes receiving the video stream of a specified user. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a245d6219f67386235fd24598374b4c55}{set\+Remote\+Video\+Stream\+Type\+Ex}} (uid\+\_\+t uid, V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+T\+Y\+PE stream\+Type, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the video stream type to subscribe to. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_af7e054754c73efcf8685217cae50c54d}{mute\+Local\+Audio\+Stream\+Ex}} (bool mute, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Stops or resumes publishing the local audio stream. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_acf944fe1a250465d25408c506ab7cc29}{mute\+Local\+Video\+Stream\+Ex}} (bool mute, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Stops or resumes publishing the local video stream. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a0c3a729430610485683ac4481435ce5d}{mute\+All\+Remote\+Audio\+Streams\+Ex}} (bool mute, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Stops or resumes subscribing to the audio streams of all remote users. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a5240ee4174bcfc34d7d32a79e7c9e493}{mute\+All\+Remote\+Video\+Streams\+Ex}} (bool mute, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Stops or resumes subscribing to the video streams of all remote users. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_adcfaaaaa0afea21fc99627413dfaa531}{set\+Subscribe\+Audio\+Blocklist\+Ex}} (uid\+\_\+t $\ast$uid\+List, int uid\+Number, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the blocklist of subscriptions for audio streams. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a4d2d8d6a39b43fa9276bb449ed691f37}{set\+Subscribe\+Audio\+Allowlist\+Ex}} (uid\+\_\+t $\ast$uid\+List, int uid\+Number, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the allowlist of subscriptions for audio streams. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a0a6208443d2c80759eb1475c471bbb59}{set\+Subscribe\+Video\+Blocklist\+Ex}} (uid\+\_\+t $\ast$uid\+List, int uid\+Number, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the blocklist of subscriptions for video streams. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7740e07bffa4b9983e7b2a7826d907a7}{set\+Subscribe\+Video\+Allowlist\+Ex}} (uid\+\_\+t $\ast$uid\+List, int uid\+Number, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the allowlist of subscriptions for video streams. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a198048296a6f9b3e702c895eff3ecc91}{set\+Remote\+Video\+Subscription\+Options\+Ex}} (uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1rtc_1_1_video_subscription_options}{Video\+Subscription\+Options}} \&options, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets options for subscribing to remote video streams. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a83936bd67ca063ac968d0e89f60af5d5}{set\+Remote\+Voice\+Position\+Ex}} (uid\+\_\+t uid, double pan, double gain, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the 2D position (the position on the horizontal plane) of the remote user\textquotesingle{}s voice. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7c1a8b5a0816340f7c05534e51859630}{set\+Remote\+User\+Spatial\+Audio\+Params\+Ex}} (uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1_spatial_audio_params}{agora\+::\+Spatial\+Audio\+Params}} \&params, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a6af2cfc66d271e37f784313822b7cb9a}{set\+Remote\+Render\+Mode\+Ex}} (uid\+\_\+t uid, media\+::base\+::\+R\+E\+N\+D\+E\+R\+\_\+\+M\+O\+D\+E\+\_\+\+T\+Y\+PE render\+Mode, V\+I\+D\+E\+O\+\_\+\+M\+I\+R\+R\+O\+R\+\_\+\+M\+O\+D\+E\+\_\+\+T\+Y\+PE mirror\+Mode, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the video display mode of a specified remote user. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ad056b11c74ee1fa06f06774ef81dbfc5}{enable\+Loopback\+Recording\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, bool enabled, const char $\ast$device\+Name=N\+U\+LL)=0
\begin{DoxyCompactList}\small\item\em Enables loopback audio capturing. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a9f19918def79779f83ba319b1e820275}{adjust\+Recording\+Signal\+Volume\+Ex}} (int volume, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab9aa357deb8169da2f32f94aba0c75ea}{mute\+Recording\+Signal\+Ex}} (bool mute, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ad25a20b6c896736f453ec22b77bab617}{adjust\+User\+Playback\+Signal\+Volume\+Ex}} (uid\+\_\+t uid, int volume, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Adjusts the playback signal volume of a specified remote user. \end{DoxyCompactList}\item 
virtual C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ac24f03787cfe422852a5dcf5ada82a9e}{get\+Connection\+State\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Gets the current connection state of the S\+DK. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa5a67d72404e0e9320e58a39bff0f160}{enable\+Encryption\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, bool enabled, const \mbox{\hyperlink{structagora_1_1rtc_1_1_encryption_config}{Encryption\+Config}} \&config)=0
\begin{DoxyCompactList}\small\item\em Enables or disables the built-\/in encryption. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a3411b5f2f6e70cc4ed8607f8597cfea0}{create\+Data\+Stream\+Ex}} (int $\ast$stream\+Id, bool reliable, bool ordered, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Creates a data stream. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a54171a25927e05ee178a9b4c84449491}{create\+Data\+Stream\+Ex}} (int $\ast$stream\+Id, const \mbox{\hyperlink{structagora_1_1rtc_1_1_data_stream_config}{Data\+Stream\+Config}} \&config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Creates a data stream. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_acb5aa2c150630a2949b803bbe2fcb219}{send\+Stream\+Message\+Ex}} (int stream\+Id, const char $\ast$data, size\+\_\+t length, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sends data stream messages. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7ca3f9b34be15eb005389142695e15d2}{send\+Rdt\+Message\+Ex}} (uid\+\_\+t uid, Rdt\+Stream\+Type type, const char $\ast$data, size\+\_\+t length, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Send Reliable message to remote uid in channel. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aca77c53cca7d44ac30b1243f9de878e2}{send\+Media\+Control\+Message\+Ex}} (uid\+\_\+t uid, const char $\ast$data, size\+\_\+t length, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Send media control message. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a3236771daf7b826f41718e0e477b37e7}{add\+Video\+Watermark\+Ex}} (const char $\ast$watermark\+Url, const \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options}{Watermark\+Options}} \&options, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Adds a watermark image to the local video. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a8c0e435d8bb4f26bc5caf5eb3d314827}{add\+Video\+Watermark\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_config}{Watermark\+Config}} \&config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Adds a watermark image to the local video. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_adc8bcef2d95af79367326c7624ac79c7}{remove\+Video\+Watermark\+Ex}} (const char $\ast$id, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Removes the specified watermark image from the local or remote video stream. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aabeeb90f0eab9224614994b4aefd85fa}{clear\+Video\+Watermark\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Removes the watermark image from the video stream. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ad2b162bf448070754386f52a4ccadce1}{send\+Custom\+Report\+Message\+Ex}} (const char $\ast$id, const char $\ast$category, const char $\ast$event, const char $\ast$label, int value, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Agora supports reporting and analyzing customized messages. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ae17f2728556a209f394d31b3f00b97bf}{enable\+Audio\+Volume\+Indication\+Ex}} (int interval, int smooth, bool report\+Vad, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Enables the reporting of users\textquotesingle{} volume indication. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa378933c89523540c60d68acb62f5d31}{start\+Rtmp\+Stream\+Without\+Transcoding\+Ex}} (const char $\ast$url, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Starts pushing media streams to a C\+DN without transcoding. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa4d1ef7eeceecd8baf53622dc20d271e}{start\+Rtmp\+Stream\+With\+Transcoding\+Ex}} (const char $\ast$url, const \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}} \&transcoding, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Starts Media Push and sets the transcoding configuration. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7166a565c1aeb53d8a3dbe28c008237b}{update\+Rtmp\+Transcoding\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}} \&transcoding, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Updates the transcoding configuration. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7c82d9a5e2e679d798718c35c921126a}{stop\+Rtmp\+Stream\+Ex}} (const char $\ast$url, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Stops pushing media streams to a C\+DN. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab30b266694ae9d2ad08e551c8519523d}{start\+Or\+Update\+Channel\+Media\+Relay\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_relay_configuration}{Channel\+Media\+Relay\+Configuration}} \&configuration, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Starts relaying media streams across channels or updates channels for media relay. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aba056aa7a09644615f07e8e8a95e3638}{stop\+Channel\+Media\+Relay\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Stops the media stream relay. Once the relay stops, the host quits all the target channels. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab1b6ce25f01fd933d128391b3f7a2444}{pause\+All\+Channel\+Media\+Relay\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Pauses the media stream relay to all target channels. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_afafa5382d22353b4bde60b1d9e63230a}{resume\+All\+Channel\+Media\+Relay\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Resumes the media stream relay to all target channels. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a9cbb0b4985356bf89ccfe4bec6ae53e9}{get\+User\+Info\+By\+User\+Account\+Ex}} (const char $\ast$user\+Account, \mbox{\hyperlink{structagora_1_1rtc_1_1_user_info}{rtc\+::\+User\+Info}} $\ast$user\+Info, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a1b05424979241a61cd3ede056c808812}{get\+User\+Info\+By\+Uid\+Ex}} (uid\+\_\+t uid, \mbox{\hyperlink{structagora_1_1rtc_1_1_user_info}{rtc\+::\+User\+Info}} $\ast$user\+Info, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a4d7a88053b9874b7fbd2ab6d8ecc034b}{enable\+Dual\+Stream\+Mode\+Ex}} (bool enabled, const \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_stream_config}{Simulcast\+Stream\+Config}} \&stream\+Config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Enables or disables dual-\/stream mode on the sender side. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7264a77658ad9ad5563d15fba63991a2}{set\+Dual\+Stream\+Mode\+Ex}} (S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+M\+O\+DE mode, const \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_stream_config}{Simulcast\+Stream\+Config}} \&stream\+Config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the dual-\/stream mode on the sender side. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa3ec7031aba854a5ff1eaf9c55666205}{set\+Simulcast\+Config\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_config}{Simulcast\+Config}} \&simulcast\+Config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Sets the simulcast video stream configuration. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ae242e9b161910dc66d8340031a75d25d}{set\+High\+Priority\+User\+List\+Ex}} (uid\+\_\+t $\ast$uid\+List, int uid\+Num, S\+T\+R\+E\+A\+M\+\_\+\+F\+A\+L\+L\+B\+A\+C\+K\+\_\+\+O\+P\+T\+I\+O\+NS option, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab44ff5921d69865c76a830eeba1b03a7}{take\+Snapshot\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, uid\+\_\+t uid, const char $\ast$file\+Path)=0
\begin{DoxyCompactList}\small\item\em Takes a snapshot of a video stream using connection ID. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a4c51b1ae3b9f14683e22fc7080919600}{take\+Snapshot\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, uid\+\_\+t uid, const \mbox{\hyperlink{structagora_1_1media_1_1_snapshot_config}{media\+::\+Snapshot\+Config}} \&config)=0
\begin{DoxyCompactList}\small\item\em Gets a video screenshot of the specified observation point using the connection ID. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a46488c427ce67b133718509ca429bbe6}{enable\+Content\+Inspect\+Ex}} (bool enabled, const \mbox{\hyperlink{structagora_1_1media_1_1_content_inspect_config}{media\+::\+Content\+Inspect\+Config}} \&config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Enables or disables video screenshot and upload. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_aca766ae6dc1c7fea4758bae36fd1705b}{start\+Media\+Rendering\+Tracing\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Enables tracing the video frame rendering process. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a29aca501a8d88ae1ee99b53c8cb8adc8}{set\+Parameters\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, const char $\ast$parameters)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a61f53e6874cda9a1559dd120d0f376fd}{get\+Call\+Id\+Ex}} (\mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&call\+Id, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection)=0
\begin{DoxyCompactList}\small\item\em Gets the call ID with the connection ID. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab6f8dd51f1310bf94cd7ca9727840198}{send\+Audio\+Metadata\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, const char $\ast$metadata, size\+\_\+t length)=0
\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a17f72653191438ecf902d1db25b72eda}{preload\+Effect\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, int sound\+Id, const char $\ast$file\+Path, int start\+Pos=0)=0
\begin{DoxyCompactList}\small\item\em Preloads a specified sound effect to a channel. \end{DoxyCompactList}\item 
virtual int \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_af5dcf23e932a064e8a395522118c8d21}{play\+Effect\+Ex}} (const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&connection, int sound\+Id, const char $\ast$file\+Path, int loop\+Count, double pitch, double pan, int gain, bool publish=false, int start\+Pos=0)=0
\begin{DoxyCompactList}\small\item\em Plays a specified sound effect in a channel. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_aea0d3d4fd0c5e50a684b8e08af56bfee}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aea0d3d4fd0c5e50a684b8e08af56bfee}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!joinChannelEx@{joinChannelEx}}
\index{joinChannelEx@{joinChannelEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{joinChannelEx()}{joinChannelEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::join\+Channel\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{token,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}} \&}]{options,  }\item[{\mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler}{I\+Rtc\+Engine\+Event\+Handler}} $\ast$}]{event\+Handler }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Joins a channel. 

You can call this method multiple times to join more than one channel. If you want to join the same channel from different devices, ensure that the user I\+Ds are different for all devices. Applicable scenarios\+: This method can be called in scenarios involving multiple channels. Call timing\+: Call this method after {\ttfamily initialize}. In a multi-\/camera capture scenario, you need to call the {\ttfamily start\+Preview(V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source\+Type)} method after calling this method to set the {\ttfamily source\+Type} to {\ttfamily V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+C\+A\+M\+E\+R\+A\+\_\+\+S\+E\+C\+O\+N\+D\+A\+RY}, to ensure that the second camera captures normally. Related callbacks\+: A successful call of this method triggers the following callbacks\+:
\begin{DoxyItemize}
\item The local client\+: The {\ttfamily on\+Join\+Channel\+Success} and {\ttfamily on\+Connection\+State\+Changed} callbacks.
\item The remote client\+: The {\ttfamily on\+User\+Joined} callback, if a user joining the channel in the C\+O\+M\+M\+U\+N\+I\+C\+A\+T\+I\+ON profile, or a host joining a channel in the L\+I\+V\+E\+\_\+\+B\+R\+O\+A\+D\+C\+A\+S\+T\+I\+NG profile. When the connection between the local client and Agora\textquotesingle{}s server is interrupted due to poor network conditions, the S\+DK tries reconnecting to the server. When the local client successfully rejoins the channel, the S\+DK triggers the {\ttfamily on\+Rejoin\+Channel\+Success} callback on the local client.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
If you are already in a channel, you cannot rejoin the channel with the same user ID. Before joining a channel, ensure that the App ID you use to generate a token is the same as that you pass in the {\ttfamily initialize} method; otherwise, you may fail to join the channel with the token.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em token} & The token generated on your server for authentication. See .Note\+:
\begin{DoxyItemize}
\item (Recommended) If your project has enabled the security mode (using A\+PP ID and Token for authentication), this parameter is required.
\item If you have only enabled the testing mode (using A\+PP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
\item If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don\textquotesingle{}t need to apply for a new token every time joining a channel. See {\ttfamily Secure authentication with tokens}. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}. \\
\hline
{\em options} & The channel media options. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}}. \\
\hline
{\em event\+Handler} & The callback class of {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex}{I\+Rtc\+Engine\+Ex}}}. See {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler}{I\+Rtc\+Engine\+Event\+Handler}}}. You can get the callback events of multiple channels through the {\ttfamily event\+Handler} object passed in this parameter.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure.
\begin{DoxyItemize}
\item -\/2\+: The parameter is invalid. For example, the token is invalid, the {\ttfamily uid} parameter is not set to an integer, or the value of a member in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}} is invalid. You need to pass in a valid parameter and join the channel again.
\item -\/3\+: Fails to initialize the {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}} object. You need to reinitialize the {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}} object.
\item -\/7\+: The {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}} object has not been initialized. You need to initialize the {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}} object before calling this method.
\item -\/8\+: The internal state of the {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}} object is wrong. The typical cause is that after calling {\ttfamily start\+Echo\+Test} to start a call loop test, you call this method to join the channel without calling {\ttfamily stop\+Echo\+Test} to stop the test. You need to call {\ttfamily stop\+Echo\+Test} before calling this method.
\item -\/17\+: The request to join the channel is rejected. The typical cause is that the user is already in the channel. Agora recommends that you use the {\ttfamily on\+Connection\+State\+Changed} callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the {\ttfamily C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+D\+I\+S\+C\+O\+N\+N\+E\+C\+T\+ED} (1) state.
\item -\/102\+: The channel name is invalid. You need to pass in a valid channel name in {\ttfamily channel\+Id} to rejoin the channel.
\item -\/121\+: The user ID is invalid. You need to pass in a valid user ID in {\ttfamily uid} to rejoin the channel. 
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_a32a7b59b5a79b8c7fcf2523fef500f77}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a32a7b59b5a79b8c7fcf2523fef500f77}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!leaveChannelEx@{leaveChannelEx}}
\index{leaveChannelEx@{leaveChannelEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{leaveChannelEx()}{leaveChannelEx()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::leave\+Channel\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Leaves a channel. 

After calling this method, the S\+DK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session. After calling {\ttfamily join\+Channel\+Ex} to join a channel, you must call this method or {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a8a6964eba31ae04024f2aec067954a93}{leave\+Channel\+Ex(const Rtc\+Connection\& connection, const Leave\+Channel\+Options\& options)}}} to end the call, otherwise, the next call cannot be started. Applicable scenarios\+: This method can be called in scenarios involving multiple channels. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}. Related callbacks\+: A successful call of this method triggers the following callbacks\+:
\begin{DoxyItemize}
\item The local client\+: The {\ttfamily on\+Leave\+Channel} callback will be triggered.
\item The remote client\+: The {\ttfamily on\+User\+Offline} callback will be triggered after the remote host leaves the channel.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
If you call {\ttfamily release} immediately after calling this method, the S\+DK does not trigger the {\ttfamily on\+Leave\+Channel} callback.
\begin{DoxyItemize}
\item This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
\item If you call {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_a51c12d209373650638bfd82e28777081}{leave\+Channel()}}} or {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ad5c2ef631e3e4076f6aec96ed1152262}{leave\+Channel(const Leave\+Channel\+Options\& options)}}}, you will leave all the channels you have joined by calling {\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)}, or {\ttfamily join\+Channel\+Ex}.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a8a6964eba31ae04024f2aec067954a93}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a8a6964eba31ae04024f2aec067954a93}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!leaveChannelEx@{leaveChannelEx}}
\index{leaveChannelEx@{leaveChannelEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{leaveChannelEx()}{leaveChannelEx()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::leave\+Channel\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_leave_channel_options}{Leave\+Channel\+Options}} \&}]{options }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets channel options and leaves the channel. 

After calling this method, the S\+DK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session. After calling {\ttfamily join\+Channel\+Ex} to join a channel, you must call this method or {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ex_a32a7b59b5a79b8c7fcf2523fef500f77}{leave\+Channel\+Ex(const Rtc\+Connection\& connection)}}} to end the call, otherwise, the next call cannot be started. Applicable scenarios\+: This method can be called in scenarios involving multiple channels. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}. Related callbacks\+: A successful call of this method triggers the following callbacks\+:
\begin{DoxyItemize}
\item The local client\+: The {\ttfamily on\+Leave\+Channel} callback will be triggered.
\item The remote client\+: The {\ttfamily on\+User\+Offline} callback will be triggered after the remote host leaves the channel.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
If you call {\ttfamily release} immediately after calling this method, the S\+DK does not trigger the {\ttfamily on\+Leave\+Channel} callback.
\begin{DoxyItemize}
\item This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
\item If you call {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_a51c12d209373650638bfd82e28777081}{leave\+Channel()}}} or {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ad5c2ef631e3e4076f6aec96ed1152262}{leave\+Channel(const Leave\+Channel\+Options\& options)}}}, you will leave all the channels you have joined by calling {\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)}, or {\ttfamily join\+Channel\+Ex}.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}. \\
\hline
{\em options} & Since v4.\+1.\+0 The options for leaving the channel. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_leave_channel_options}{Leave\+Channel\+Options}}}. Note\+: This parameter only supports the {\ttfamily stop\+Microphone\+Recording} member in the {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_leave_channel_options}{Leave\+Channel\+Options}}} settings; setting other members does not take effect.\\
\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_ex_ab4c1cf6ac6964bdce98a35519e8ae518}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab4c1cf6ac6964bdce98a35519e8ae518}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!leaveChannelWithUserAccountEx@{leaveChannelWithUserAccountEx}}
\index{leaveChannelWithUserAccountEx@{leaveChannelWithUserAccountEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{leaveChannelWithUserAccountEx()}{leaveChannelWithUserAccountEx()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::leave\+Channel\+With\+User\+Account\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{channel\+Id,  }\item[{const char $\ast$}]{user\+Account }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Leaves a channel with the channel ID and user account.

This method allows a user to leave the channel, for example, by hanging up or exiting a call.

This method is an asynchronous call, which means that the result of this method returns even before the user has not actually left the channel. Once the user successfully leaves the channel, the S\+DK triggers the \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_event_handler_a98f832d175dfc044b31f0ec5874460fb}{on\+Leave\+Channel}} callback.


\begin{DoxyParams}{Parameters}
{\em channel\+Id} & The channel name. The maximum length of this parameter is 64 bytes. Supported character scopes are\+:
\begin{DoxyItemize}
\item All lowercase English letters\+: a to z.
\item All uppercase English letters\+: A to Z.
\item All numeric characters\+: 0 to 9.
\item The space character.
\item Punctuation characters and other symbols, including\+: \char`\"{}!\char`\"{}, \char`\"{}\#\char`\"{}, \char`\"{}\$\char`\"{}, \char`\"{}\%\char`\"{}, \char`\"{}\&\char`\"{}, \char`\"{}(\char`\"{}, \char`\"{})\char`\"{}, \char`\"{}+\char`\"{}, \char`\"{}-\/\char`\"{}, \char`\"{}\+:\char`\"{}, \char`\"{};\char`\"{}, \char`\"{}$<$\char`\"{}, \char`\"{}=\char`\"{}, \char`\"{}.\char`\"{}, \char`\"{}$>$\char`\"{}, \char`\"{}?\char`\"{}, \char`\"{}@\char`\"{}, \char`\"{}\mbox{[}\char`\"{}, \char`\"{}\mbox{]}\char`\"{}, \char`\"{}$^\wedge$\char`\"{}, \char`\"{}\+\_\+\char`\"{}, \char`\"{} \{\char`\"{}, \char`\"{}\}\char`\"{}, \char`\"{}$\vert$\char`\"{}, \char`\"{}$\sim$\char`\"{}, \char`\"{},\char`\"{}. 
\end{DoxyItemize}\\
\hline
{\em user\+Account} & The user account. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported character scopes are\+:
\begin{DoxyItemize}
\item All lowercase English letters\+: a to z.
\item All uppercase English letters\+: A to Z.
\item All numeric characters\+: 0 to 9.
\item The space character.
\item Punctuation characters and other symbols, including\+: \char`\"{}!\char`\"{}, \char`\"{}\#\char`\"{}, \char`\"{}\$\char`\"{}, \char`\"{}\%\char`\"{}, \char`\"{}\&\char`\"{}, \char`\"{}(\char`\"{}, \char`\"{})\char`\"{}, \char`\"{}+\char`\"{}, \char`\"{}-\/\char`\"{}, \char`\"{}\+:\char`\"{}, \char`\"{};\char`\"{}, \char`\"{}$<$\char`\"{}, \char`\"{}=\char`\"{}, \char`\"{}.\char`\"{}, \char`\"{}$>$\char`\"{}, \char`\"{}?\char`\"{}, \char`\"{}@\char`\"{}, \char`\"{}\mbox{[}\char`\"{}, \char`\"{}\mbox{]}\char`\"{}, \char`\"{}$^\wedge$\char`\"{}, \char`\"{}\+\_\+\char`\"{}, \char`\"{} \{\char`\"{}, \char`\"{}\}\char`\"{}, \char`\"{}$\vert$\char`\"{}, \char`\"{}$\sim$\char`\"{}, \char`\"{},\char`\"{}. 
\end{DoxyItemize}\\
\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_ex_aebb64a45c6ba10b7cf554444359114a7}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aebb64a45c6ba10b7cf554444359114a7}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!leaveChannelWithUserAccountEx@{leaveChannelWithUserAccountEx}}
\index{leaveChannelWithUserAccountEx@{leaveChannelWithUserAccountEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{leaveChannelWithUserAccountEx()}{leaveChannelWithUserAccountEx()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::leave\+Channel\+With\+User\+Account\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{channel\+Id,  }\item[{const char $\ast$}]{user\+Account,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_leave_channel_options}{Leave\+Channel\+Options}} \&}]{options }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Leaves a channel with the channel ID and user account and sets the options for leaving.


\begin{DoxyParams}{Parameters}
{\em channel\+Id} & The channel name. The maximum length of this parameter is 64 bytes. Supported character scopes are\+:
\begin{DoxyItemize}
\item All lowercase English letters\+: a to z.
\item All uppercase English letters\+: A to Z.
\item All numeric characters\+: 0 to 9.
\item The space character.
\item Punctuation characters and other symbols, including\+: \char`\"{}!\char`\"{}, \char`\"{}\#\char`\"{}, \char`\"{}\$\char`\"{}, \char`\"{}\%\char`\"{}, \char`\"{}\&\char`\"{}, \char`\"{}(\char`\"{}, \char`\"{})\char`\"{}, \char`\"{}+\char`\"{}, \char`\"{}-\/\char`\"{}, \char`\"{}\+:\char`\"{}, \char`\"{};\char`\"{}, \char`\"{}$<$\char`\"{}, \char`\"{}=\char`\"{}, \char`\"{}.\char`\"{}, \char`\"{}$>$\char`\"{}, \char`\"{}?\char`\"{}, \char`\"{}@\char`\"{}, \char`\"{}\mbox{[}\char`\"{}, \char`\"{}\mbox{]}\char`\"{}, \char`\"{}$^\wedge$\char`\"{}, \char`\"{}\+\_\+\char`\"{}, \char`\"{} \{\char`\"{}, \char`\"{}\}\char`\"{}, \char`\"{}$\vert$\char`\"{}, \char`\"{}$\sim$\char`\"{}, \char`\"{},\char`\"{}. 
\end{DoxyItemize}\\
\hline
{\em user\+Account} & The user account. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported character scopes are\+:
\begin{DoxyItemize}
\item All lowercase English letters\+: a to z.
\item All uppercase English letters\+: A to Z.
\item All numeric characters\+: 0 to 9.
\item The space character.
\item Punctuation characters and other symbols, including\+: \char`\"{}!\char`\"{}, \char`\"{}\#\char`\"{}, \char`\"{}\$\char`\"{}, \char`\"{}\%\char`\"{}, \char`\"{}\&\char`\"{}, \char`\"{}(\char`\"{}, \char`\"{})\char`\"{}, \char`\"{}+\char`\"{}, \char`\"{}-\/\char`\"{}, \char`\"{}\+:\char`\"{}, \char`\"{};\char`\"{}, \char`\"{}$<$\char`\"{}, \char`\"{}=\char`\"{}, \char`\"{}.\char`\"{}, \char`\"{}$>$\char`\"{}, \char`\"{}?\char`\"{}, \char`\"{}@\char`\"{}, \char`\"{}\mbox{[}\char`\"{}, \char`\"{}\mbox{]}\char`\"{}, \char`\"{}$^\wedge$\char`\"{}, \char`\"{}\+\_\+\char`\"{}, \char`\"{} \{\char`\"{}, \char`\"{}\}\char`\"{}, \char`\"{}$\vert$\char`\"{}, \char`\"{}$\sim$\char`\"{}, \char`\"{},\char`\"{}. 
\end{DoxyItemize}\\
\hline
{\em options} & The options for leaving the channel. See \#\+Leave\+Channel\+Options. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
int
\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_a8334b0d0f5f2c3632eaa9358de14900d}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a8334b0d0f5f2c3632eaa9358de14900d}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!updateChannelMediaOptionsEx@{updateChannelMediaOptionsEx}}
\index{updateChannelMediaOptionsEx@{updateChannelMediaOptionsEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{updateChannelMediaOptionsEx()}{updateChannelMediaOptionsEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::update\+Channel\+Media\+Options\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}} \&}]{options,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Updates the channel media options after joining the channel. 


\begin{DoxyParams}{Parameters}
{\em options} & The channel media options. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure.
\begin{DoxyItemize}
\item -\/2\+: The value of a member in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}} is invalid. For example, the token or the user ID is invalid. You need to fill in a valid parameter.
\item -\/7\+: The {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}} object has not been initialized. You need to initialize the {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}} object before calling this method.
\item -\/8\+: The internal state of the {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}} object is wrong. The possible reason is that the user is not in the channel. Agora recommends that you use the {\ttfamily on\+Connection\+State\+Changed} callback to see whether the user is in the channel. If you receive the {\ttfamily C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+D\+I\+S\+C\+O\+N\+N\+E\+C\+T\+ED} (1) or {\ttfamily C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+F\+A\+I\+L\+ED} (5) state, the user is not in the channel. You need to 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 before calling this method. 
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_af075e5e718c6c66e94076daf20dcc818}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_af075e5e718c6c66e94076daf20dcc818}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setVideoEncoderConfigurationEx@{setVideoEncoderConfigurationEx}}
\index{setVideoEncoderConfigurationEx@{setVideoEncoderConfigurationEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setVideoEncoderConfigurationEx()}{setVideoEncoderConfigurationEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Video\+Encoder\+Configuration\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_video_encoder_configuration}{Video\+Encoder\+Configuration}} \&}]{config,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the video encoder configuration. 

Sets the encoder configuration for the local video. Each configuration profile corresponds to a set of video parameters, including the resolution, frame rate, and bitrate. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}.

\begin{DoxyNote}{Note}
The {\ttfamily config} specified in this method is the maximum value under ideal network conditions. If the video engine cannot render the video using the specified {\ttfamily config} due to unreliable network conditions, the parameters further down the list are considered until a successful configuration is found.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em config} & Video profile. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_video_encoder_configuration}{Video\+Encoder\+Configuration}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a9b440849431c01df80df39c2b18ff54e}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a9b440849431c01df80df39c2b18ff54e}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setupRemoteVideoEx@{setupRemoteVideoEx}}
\index{setupRemoteVideoEx@{setupRemoteVideoEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setupRemoteVideoEx()}{setupRemoteVideoEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::setup\+Remote\+Video\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_video_canvas}{Video\+Canvas}} \&}]{canvas,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Initializes the video view of a remote user. 

This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view. The application specifies the uid of the remote video in the {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_video_canvas}{Video\+Canvas}}} method before the remote user joins the channel. If the remote uid is unknown to the application, set it after the application receives the {\ttfamily on\+User\+Joined} callback. If the Video Recording function is enabled, the Video Recording Service joins the channel as a dummy client, causing other clients to also receive the {\ttfamily on\+User\+Joined} callback. Do not bind the dummy client to the application view because the dummy client does not send any video streams. To unbind the remote user from the view, set the {\ttfamily view} parameter to N\+U\+LL. Once the remote user leaves the channel, the S\+DK unbinds the remote user.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Call this method after {\ttfamily join\+Channel\+Ex}.
\item To update the rendering or mirror mode of the remote video view during a call, use the {\ttfamily set\+Remote\+Render\+Mode\+Ex} method.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em canvas} & The remote video view settings. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_video_canvas}{Video\+Canvas}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_ae964daa0d8f236dea59c75545a7e861a}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ae964daa0d8f236dea59c75545a7e861a}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!muteRemoteAudioStreamEx@{muteRemoteAudioStreamEx}}
\index{muteRemoteAudioStreamEx@{muteRemoteAudioStreamEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{muteRemoteAudioStreamEx()}{muteRemoteAudioStreamEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::mute\+Remote\+Audio\+Stream\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{bool}]{mute,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Stops or resumes receiving the audio stream of a specified user. 

This method is used to stops or resumes receiving the audio stream of a specified user. You can call this method before or after joining a channel. If a user leaves a channel, the settings in this method become invalid.


\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the specified user. \\
\hline
{\em mute} & Whether to stop receiving the audio stream of the specified user\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Stop receiving the audio stream of the specified user.
\item {\ttfamily false}\+: (Default) Resume receiving the audio stream of the specified user. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_abd81f06feeaf8d8ec2744adf74af3655}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_abd81f06feeaf8d8ec2744adf74af3655}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!muteRemoteVideoStreamEx@{muteRemoteVideoStreamEx}}
\index{muteRemoteVideoStreamEx@{muteRemoteVideoStreamEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{muteRemoteVideoStreamEx()}{muteRemoteVideoStreamEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::mute\+Remote\+Video\+Stream\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{bool}]{mute,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Stops or resumes receiving the video stream of a specified user. 

This method is used to stop or resume receiving the video stream of a specified user. You can call this method before or after joining a channel. If a user leaves a channel, the settings in this method become invalid.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em mute} & Whether to stop receiving the video stream of the specified user\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Stop receiving the video stream of the specified user.
\item {\ttfamily false}\+: (Default) Resume receiving the video stream of the specified user. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a245d6219f67386235fd24598374b4c55}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a245d6219f67386235fd24598374b4c55}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setRemoteVideoStreamTypeEx@{setRemoteVideoStreamTypeEx}}
\index{setRemoteVideoStreamTypeEx@{setRemoteVideoStreamTypeEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setRemoteVideoStreamTypeEx()}{setRemoteVideoStreamTypeEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Remote\+Video\+Stream\+Type\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+T\+Y\+PE}]{stream\+Type,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the video stream type to subscribe to. 

Depending on the default behavior of the sender and the specific settings when calling {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_a33c7eebc75e9a5bbde3904467657eb54}{set\+Dual\+Stream\+Mode(\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+M\+O\+D\+E mode, const Simulcast\+Stream\+Config\& stream\+Config)}}}, the scenarios for the receiver calling this method are as follows\+:
\begin{DoxyItemize}
\item The S\+DK enables low-\/quality video stream adaptive mode ( {\ttfamily A\+U\+T\+O\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM} ) on the sender side by default, meaning only the high-\/quality video stream is transmitted. Only the receiver with the role of the $\ast$$\ast$host$\ast$$\ast$can call this method to initiate a low-\/quality video stream request. Once the sender receives the request, it starts automatically sending the low-\/quality video stream. At this point, all users in the channel can call this method to switch to low-\/quality video stream subscription mode.
\item If the sender calls {\ttfamily set\+Dual\+Stream\+Mode(S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+M\+O\+DE mode, const \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_stream_config}{Simulcast\+Stream\+Config}}\& stream\+Config)} and sets {\ttfamily mode} to {\ttfamily D\+I\+S\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM} (never send low-\/quality video stream), then calling this method will have no effect.
\item If the sender calls {\ttfamily set\+Dual\+Stream\+Mode(S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+M\+O\+DE mode, const \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_stream_config}{Simulcast\+Stream\+Config}}\& stream\+Config)} and sets {\ttfamily mode} to {\ttfamily E\+N\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM} (always send low-\/quality video stream), both the host and audience receivers can call this method to switch to low-\/quality video stream subscription mode. The S\+DK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-\/quality video stream is the same as that of the high-\/quality video stream. According to the current aspect ratio of the high-\/quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-\/quality video stream.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
If the publisher has already called {\ttfamily set\+Dual\+Stream\+Mode\+Ex} and set {\ttfamily mode} to {\ttfamily D\+I\+S\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM} (never send low-\/quality video stream), calling this method will not take effect, you should call {\ttfamily set\+Dual\+Stream\+Mode\+Ex} again on the sending end and adjust the settings.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The user ID. \\
\hline
{\em stream\+Type} & The video stream type, see {\ttfamily V\+I\+D\+E\+O\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+T\+Y\+PE}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_af7e054754c73efcf8685217cae50c54d}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_af7e054754c73efcf8685217cae50c54d}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!muteLocalAudioStreamEx@{muteLocalAudioStreamEx}}
\index{muteLocalAudioStreamEx@{muteLocalAudioStreamEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{muteLocalAudioStreamEx()}{muteLocalAudioStreamEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::mute\+Local\+Audio\+Stream\+Ex (\begin{DoxyParamCaption}\item[{bool}]{mute,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Stops or resumes publishing the local audio stream. 

A successful call of this method triggers the {\ttfamily on\+User\+Mute\+Audio} and {\ttfamily on\+Remote\+Audio\+State\+Changed} callbacks on the remote client.

\begin{DoxyNote}{Note}
This method does not affect any ongoing audio recording, because it does not disable the audio capture device.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em mute} & Whether to stop publishing the local audio stream\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Stops publishing the local audio stream.
\item {\ttfamily false}\+: (Default) Resumes publishing the local audio stream. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_acf944fe1a250465d25408c506ab7cc29}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_acf944fe1a250465d25408c506ab7cc29}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!muteLocalVideoStreamEx@{muteLocalVideoStreamEx}}
\index{muteLocalVideoStreamEx@{muteLocalVideoStreamEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{muteLocalVideoStreamEx()}{muteLocalVideoStreamEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::mute\+Local\+Video\+Stream\+Ex (\begin{DoxyParamCaption}\item[{bool}]{mute,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Stops or resumes publishing the local video stream. 

A successful call of this method triggers the {\ttfamily on\+User\+Mute\+Video} callback on the remote client.

\begin{DoxyNote}{Note}
This method does not affect any ongoing video recording, because it does not disable the camera.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em mute} & Whether to stop publishing the local video stream.
\begin{DoxyItemize}
\item {\ttfamily true}\+: Stop publishing the local video stream.
\item {\ttfamily false}\+: (Default) Publish the local video stream. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a0c3a729430610485683ac4481435ce5d}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a0c3a729430610485683ac4481435ce5d}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!muteAllRemoteAudioStreamsEx@{muteAllRemoteAudioStreamsEx}}
\index{muteAllRemoteAudioStreamsEx@{muteAllRemoteAudioStreamsEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{muteAllRemoteAudioStreamsEx()}{muteAllRemoteAudioStreamsEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::mute\+All\+Remote\+Audio\+Streams\+Ex (\begin{DoxyParamCaption}\item[{bool}]{mute,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Stops or resumes subscribing to the audio streams of all remote users. 

After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including the ones join the channel subsequent to this call.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Call this method after joining a channel.
\item If you do not want to subscribe the audio streams of remote users before joining a channel, you can set {\ttfamily auto\+Subscribe\+Audio} as {\ttfamily false} when 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)}.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em mute} & Whether to stop subscribing to the audio streams of all remote users\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Stops subscribing to the audio streams of all remote users.
\item {\ttfamily false}\+: (Default) Subscribes to the audio streams of all remote users by default. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a5240ee4174bcfc34d7d32a79e7c9e493}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a5240ee4174bcfc34d7d32a79e7c9e493}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!muteAllRemoteVideoStreamsEx@{muteAllRemoteVideoStreamsEx}}
\index{muteAllRemoteVideoStreamsEx@{muteAllRemoteVideoStreamsEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{muteAllRemoteVideoStreamsEx()}{muteAllRemoteVideoStreamsEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::mute\+All\+Remote\+Video\+Streams\+Ex (\begin{DoxyParamCaption}\item[{bool}]{mute,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Stops or resumes subscribing to the video streams of all remote users. 

After successfully calling this method, the local user stops or resumes subscribing to the video streams of all remote users, including all subsequent users.


\begin{DoxyParams}{Parameters}
{\em mute} & Whether to stop subscribing to the video streams of all remote users.
\begin{DoxyItemize}
\item {\ttfamily true}\+: Stop subscribing to the video streams of all remote users.
\item {\ttfamily false}\+: (Default) Subscribe to the video streams of all remote users by default. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_adcfaaaaa0afea21fc99627413dfaa531}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_adcfaaaaa0afea21fc99627413dfaa531}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setSubscribeAudioBlocklistEx@{setSubscribeAudioBlocklistEx}}
\index{setSubscribeAudioBlocklistEx@{setSubscribeAudioBlocklistEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setSubscribeAudioBlocklistEx()}{setSubscribeAudioBlocklistEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Subscribe\+Audio\+Blocklist\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t $\ast$}]{uid\+List,  }\item[{int}]{uid\+Number,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the blocklist of subscriptions for audio streams. 

You can call this method to specify the audio streams of a user that you do not want to subscribe to.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item You can call this method either before or after joining a channel.
\item The blocklist is not affected by the setting in {\ttfamily mute\+Remote\+Audio\+Stream}, {\ttfamily mute\+All\+Remote\+Audio\+Streams}, and {\ttfamily auto\+Subscribe\+Audio} in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}}.
\item Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
\item If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid\+List} & The user ID list of users that you do not want to subscribe to. If you want to specify the audio streams of a user that you do not want to subscribe to, add the user ID in this list. If you want to remove a user from the blocklist, you need to call the {\ttfamily set\+Subscribe\+Audio\+Blocklist} method to update the user ID list; this means you only add the {\ttfamily uid} of users that you do not want to subscribe to in the new user ID list. \\
\hline
{\em uid\+Number} & The number of users in the user ID list. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a4d2d8d6a39b43fa9276bb449ed691f37}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a4d2d8d6a39b43fa9276bb449ed691f37}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setSubscribeAudioAllowlistEx@{setSubscribeAudioAllowlistEx}}
\index{setSubscribeAudioAllowlistEx@{setSubscribeAudioAllowlistEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setSubscribeAudioAllowlistEx()}{setSubscribeAudioAllowlistEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Subscribe\+Audio\+Allowlist\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t $\ast$}]{uid\+List,  }\item[{int}]{uid\+Number,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the allowlist of subscriptions for audio streams. 

You can call this method to specify the audio streams of a user that you want to subscribe to.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item You can call this method either before or after joining a channel.
\item The allowlist is not affected by the setting in {\ttfamily mute\+Remote\+Audio\+Stream}, {\ttfamily mute\+All\+Remote\+Audio\+Streams} and {\ttfamily auto\+Subscribe\+Audio} in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}}.
\item Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
\item If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid\+List} & The user ID list of users that you want to subscribe to. If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the {\ttfamily set\+Subscribe\+Audio\+Allowlist} method to update the user ID list; this means you only add the {\ttfamily uid} of users that you want to subscribe to in the new user ID list. \\
\hline
{\em uid\+Number} & The number of users in the user ID list. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a0a6208443d2c80759eb1475c471bbb59}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a0a6208443d2c80759eb1475c471bbb59}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setSubscribeVideoBlocklistEx@{setSubscribeVideoBlocklistEx}}
\index{setSubscribeVideoBlocklistEx@{setSubscribeVideoBlocklistEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setSubscribeVideoBlocklistEx()}{setSubscribeVideoBlocklistEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Subscribe\+Video\+Blocklist\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t $\ast$}]{uid\+List,  }\item[{int}]{uid\+Number,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the blocklist of subscriptions for video streams. 

You can call this method to specify the video streams of a user that you do not want to subscribe to.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item You can call this method either before or after joining a channel.
\item The blocklist is not affected by the setting in {\ttfamily mute\+Remote\+Video\+Stream}, {\ttfamily mute\+All\+Remote\+Video\+Streams} and {\ttfamily auto\+Subscribe\+Audio} in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}}.
\item Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
\item If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid\+List} & The user ID list of users that you do not want to subscribe to. If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the {\ttfamily set\+Subscribe\+Video\+Blocklist} method to update the user ID list; this means you only add the {\ttfamily uid} of users that you do not want to subscribe to in the new user ID list. \\
\hline
{\em uid\+Number} & The number of users in the user ID list. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a7740e07bffa4b9983e7b2a7826d907a7}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7740e07bffa4b9983e7b2a7826d907a7}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setSubscribeVideoAllowlistEx@{setSubscribeVideoAllowlistEx}}
\index{setSubscribeVideoAllowlistEx@{setSubscribeVideoAllowlistEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setSubscribeVideoAllowlistEx()}{setSubscribeVideoAllowlistEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Subscribe\+Video\+Allowlist\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t $\ast$}]{uid\+List,  }\item[{int}]{uid\+Number,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the allowlist of subscriptions for video streams. 

You can call this method to specify the video streams of a user that you want to subscribe to.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item You can call this method either before or after joining a channel.
\item The allowlist is not affected by the setting in {\ttfamily mute\+Remote\+Video\+Stream}, {\ttfamily mute\+All\+Remote\+Video\+Streams} and {\ttfamily auto\+Subscribe\+Audio} in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}}.
\item Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
\item If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid\+List} & The user ID list of users that you want to subscribe to. If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the {\ttfamily set\+Subscribe\+Video\+Allowlist} method to update the user ID list; this means you only add the {\ttfamily uid} of users that you want to subscribe to in the new user ID list. \\
\hline
{\em uid\+Number} & The number of users in the user ID list. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a198048296a6f9b3e702c895eff3ecc91}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a198048296a6f9b3e702c895eff3ecc91}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setRemoteVideoSubscriptionOptionsEx@{setRemoteVideoSubscriptionOptionsEx}}
\index{setRemoteVideoSubscriptionOptionsEx@{setRemoteVideoSubscriptionOptionsEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setRemoteVideoSubscriptionOptionsEx()}{setRemoteVideoSubscriptionOptionsEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Remote\+Video\+Subscription\+Options\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_video_subscription_options}{Video\+Subscription\+Options}} \&}]{options,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets options for subscribing to remote video streams. 

When a remote user has enabled dual-\/stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em options} & The video subscription options. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_video_subscription_options}{Video\+Subscription\+Options}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a83936bd67ca063ac968d0e89f60af5d5}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a83936bd67ca063ac968d0e89f60af5d5}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setRemoteVoicePositionEx@{setRemoteVoicePositionEx}}
\index{setRemoteVoicePositionEx@{setRemoteVoicePositionEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setRemoteVoicePositionEx()}{setRemoteVoicePositionEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Remote\+Voice\+Position\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{double}]{pan,  }\item[{double}]{gain,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the 2D position (the position on the horizontal plane) of the remote user\textquotesingle{}s voice. 

This method sets the voice position and volume of a remote user. When the local user calls this method to set the voice position of a remote user, the voice difference between the left and right channels allows the local user to track the real-\/time position of the remote user, creating a sense of space. This method applies to massive multiplayer online games, such as Battle Royale games.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item For the best voice positioning, Agora recommends using a wired headset.
\item Call this method after joining a channel.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em pan} & The voice position of the remote user. The value ranges from -\/1.\+0 to 1.\+0\+:
\begin{DoxyItemize}
\item -\/1.\+0\+: The remote voice comes from the left.
\item 0.\+0\+: (Default) The remote voice comes from the front.
\item 1.\+0\+: The remote voice comes from the right. 
\end{DoxyItemize}\\
\hline
{\em gain} & The volume of the remote user. The value ranges from 0.\+0 to 100.\+0. The default value is 100.\+0 (the original volume of the remote user). The smaller the value, the lower the volume. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a7c1a8b5a0816340f7c05534e51859630}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7c1a8b5a0816340f7c05534e51859630}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setRemoteUserSpatialAudioParamsEx@{setRemoteUserSpatialAudioParamsEx}}
\index{setRemoteUserSpatialAudioParamsEx@{setRemoteUserSpatialAudioParamsEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setRemoteUserSpatialAudioParamsEx()}{setRemoteUserSpatialAudioParamsEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Remote\+User\+Spatial\+Audio\+Params\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{const \mbox{\hyperlink{structagora_1_1_spatial_audio_params}{agora\+::\+Spatial\+Audio\+Params}} \&}]{params,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Sets remote user parameters for spatial audio


\begin{DoxyParams}{Parameters}
{\em uid} & The ID of the remote user. \\
\hline
{\em param} & Spatial audio parameters. See \mbox{\hyperlink{structagora_1_1_spatial_audio_params}{Spatial\+Audio\+Params}}. \\
\hline
{\em connection} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} object.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
int
\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_a6af2cfc66d271e37f784313822b7cb9a}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a6af2cfc66d271e37f784313822b7cb9a}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setRemoteRenderModeEx@{setRemoteRenderModeEx}}
\index{setRemoteRenderModeEx@{setRemoteRenderModeEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setRemoteRenderModeEx()}{setRemoteRenderModeEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Remote\+Render\+Mode\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{media\+::base\+::\+R\+E\+N\+D\+E\+R\+\_\+\+M\+O\+D\+E\+\_\+\+T\+Y\+PE}]{render\+Mode,  }\item[{V\+I\+D\+E\+O\+\_\+\+M\+I\+R\+R\+O\+R\+\_\+\+M\+O\+D\+E\+\_\+\+T\+Y\+PE}]{mirror\+Mode,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the video display mode of a specified remote user. 

After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Call this method after initializing the remote view by calling the {\ttfamily setup\+Remote\+Video} method.
\item During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em render\+Mode} & The video display mode of the remote user. See {\ttfamily R\+E\+N\+D\+E\+R\+\_\+\+M\+O\+D\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em mirror\+Mode} & The mirror mode of the remote user view. See {\ttfamily V\+I\+D\+E\+O\+\_\+\+M\+I\+R\+R\+O\+R\+\_\+\+M\+O\+D\+E\+\_\+\+T\+Y\+PE}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_ad056b11c74ee1fa06f06774ef81dbfc5}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ad056b11c74ee1fa06f06774ef81dbfc5}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!enableLoopbackRecordingEx@{enableLoopbackRecordingEx}}
\index{enableLoopbackRecordingEx@{enableLoopbackRecordingEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{enableLoopbackRecordingEx()}{enableLoopbackRecordingEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::enable\+Loopback\+Recording\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{bool}]{enabled,  }\item[{const char $\ast$}]{device\+Name = {\ttfamily NULL} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Enables loopback audio capturing. 

If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item This method applies to the mac\+OS and Windows only.
\item mac\+OS does not support loopback audio capture of the default sound card. If you need to use this function, use a virtual sound card and pass its name to the {\ttfamily device\+Name} parameter. Agora recommends using Agora\+A\+LD as the virtual sound card for audio capturing.
\item This method only supports using one sound card for audio capturing.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}. \\
\hline
{\em enabled} & Sets whether to enable loopback audio capture\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Enable loopback audio capturing.
\item {\ttfamily false}\+: (Default) Disable loopback audio capturing. 
\end{DoxyItemize}\\
\hline
{\em device\+Name} & -\/ mac\+OS\+: The device name of the virtual sound card. The default value is set to N\+U\+LL, which means using Agora\+A\+LD for loopback audio capturing.
\begin{DoxyItemize}
\item Windows\+: The device name of the sound card. The default is set to N\+U\+LL, which means the S\+DK uses the sound card of your device for loopback audio capturing.
\end{DoxyItemize}\\
\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_ex_a9f19918def79779f83ba319b1e820275}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a9f19918def79779f83ba319b1e820275}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!adjustRecordingSignalVolumeEx@{adjustRecordingSignalVolumeEx}}
\index{adjustRecordingSignalVolumeEx@{adjustRecordingSignalVolumeEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{adjustRecordingSignalVolumeEx()}{adjustRecordingSignalVolumeEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::adjust\+Recording\+Signal\+Volume\+Ex (\begin{DoxyParamCaption}\item[{int}]{volume,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Adjusts the recording volume.


\begin{DoxyParams}{Parameters}
{\em volume} & The recording volume, which ranges from 0 to 400\+:
\begin{DoxyItemize}
\item 0 \+: Mute the recording volume.
\item 100\+: The original volume.
\item 400\+: (Maximum) Four times the original volume with signal clipping protection.
\end{DoxyItemize}\\
\hline
{\em connection} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} object.\\
\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_ex_ab9aa357deb8169da2f32f94aba0c75ea}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab9aa357deb8169da2f32f94aba0c75ea}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!muteRecordingSignalEx@{muteRecordingSignalEx}}
\index{muteRecordingSignalEx@{muteRecordingSignalEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{muteRecordingSignalEx()}{muteRecordingSignalEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::mute\+Recording\+Signal\+Ex (\begin{DoxyParamCaption}\item[{bool}]{mute,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Mute or resume recording signal volume.


\begin{DoxyParams}{Parameters}
{\em mute} & Determines whether to mute or resume the recording signal volume.
\begin{DoxyItemize}
\item true\+: Mute the recording signal volume.
\item false\+: (Default) Resume the recording signal volume.
\end{DoxyItemize}\\
\hline
{\em connection} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} object.\\
\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_ex_ad25a20b6c896736f453ec22b77bab617}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ad25a20b6c896736f453ec22b77bab617}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!adjustUserPlaybackSignalVolumeEx@{adjustUserPlaybackSignalVolumeEx}}
\index{adjustUserPlaybackSignalVolumeEx@{adjustUserPlaybackSignalVolumeEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{adjustUserPlaybackSignalVolumeEx()}{adjustUserPlaybackSignalVolumeEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::adjust\+User\+Playback\+Signal\+Volume\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{int}]{volume,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adjusts the playback signal volume of a specified remote user. 

You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}.


\begin{DoxyParams}{Parameters}
{\em uid} & The user ID of the remote user. \\
\hline
{\em volume} & The volume of the user. The value range is \mbox{[}0,400\mbox{]}.
\begin{DoxyItemize}
\item 0\+: Mute.
\item 100\+: (Default) The original volume.
\item 400\+: Four times the original volume (amplifying the audio signals by four times). 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_ac24f03787cfe422852a5dcf5ada82a9e}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ac24f03787cfe422852a5dcf5ada82a9e}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!getConnectionStateEx@{getConnectionStateEx}}
\index{getConnectionStateEx@{getConnectionStateEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{getConnectionStateEx()}{getConnectionStateEx()}}
{\footnotesize\ttfamily virtual C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::get\+Connection\+State\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Gets the current connection state of the S\+DK. 

Call timing\+: This method can be called either before or after joining the channel.


\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The current connection state. See {\ttfamily C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+S\+T\+A\+T\+E\+\_\+\+T\+Y\+PE}. 
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa5a67d72404e0e9320e58a39bff0f160}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa5a67d72404e0e9320e58a39bff0f160}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!enableEncryptionEx@{enableEncryptionEx}}
\index{enableEncryptionEx@{enableEncryptionEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{enableEncryptionEx()}{enableEncryptionEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::enable\+Encryption\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{bool}]{enabled,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_encryption_config}{Encryption\+Config}} \&}]{config }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Enables or disables the built-\/in encryption. 

After the user leaves the channel, the S\+DK automatically disables the built-\/in encryption. To enable the built-\/in encryption, call this method before the user joins the channel again. Applicable scenarios\+: Scenarios with higher security requirements. Call timing\+: Call this method before joining a channel.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item All users within the same channel must set the same encryption configurations when calling this method.
\item If you enable the built-\/in encryption, you cannot use the Media Push function.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em enabled} & Whether to enable built-\/in encryption\+:
\begin{DoxyItemize}
\item true\+: Enable the built-\/in encryption.
\item false\+: (Default) Disable the built-\/in encryption. 
\end{DoxyItemize}\\
\hline
{\em config} & Built-\/in encryption configurations. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_encryption_config}{Encryption\+Config}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a3411b5f2f6e70cc4ed8607f8597cfea0}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a3411b5f2f6e70cc4ed8607f8597cfea0}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!createDataStreamEx@{createDataStreamEx}}
\index{createDataStreamEx@{createDataStreamEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{createDataStreamEx()}{createDataStreamEx()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::create\+Data\+Stream\+Ex (\begin{DoxyParamCaption}\item[{int $\ast$}]{stream\+Id,  }\item[{bool}]{reliable,  }\item[{bool}]{ordered,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Creates a data stream. 

You can call this method to create a data stream and improve the reliability and ordering of data transmission. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}. Related callbacks\+: After setting {\ttfamily reliable} to {\ttfamily true}, if the recipient does not receive the data within five seconds, the S\+DK triggers the {\ttfamily on\+Stream\+Message\+Error} callback and returns an error code.

\begin{DoxyNote}{Note}
Each user can create up to five data streams during the lifecycle of {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}}. The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em stream\+Id} & An output parameter; the ID of the data stream created. \\
\hline
{\em reliable} & Sets whether the recipients are guaranteed to receive the data stream within five seconds\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the S\+DK triggers the {\ttfamily on\+Stream\+Message\+Error} callback and returns an error code.
\item {\ttfamily false}\+: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream. Attention\+: Please ensure that {\ttfamily reliable} and {\ttfamily ordered} are either both set to{\ttfamily true} or both set to {\ttfamily false}. 
\end{DoxyItemize}\\
\hline
{\em ordered} & Sets whether the recipients receive the data stream in the sent order\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: The recipients receive the data in the sent order.
\item {\ttfamily false}\+: The recipients do not receive the data in the sent order. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: The data stream is successfully created.
\item $<$ 0\+: Failure. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_a54171a25927e05ee178a9b4c84449491}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a54171a25927e05ee178a9b4c84449491}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!createDataStreamEx@{createDataStreamEx}}
\index{createDataStreamEx@{createDataStreamEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{createDataStreamEx()}{createDataStreamEx()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::create\+Data\+Stream\+Ex (\begin{DoxyParamCaption}\item[{int $\ast$}]{stream\+Id,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_data_stream_config}{Data\+Stream\+Config}} \&}]{config,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Creates a data stream. 

Compared to {\ttfamily create\+Data\+Stream\+Ex(int$\ast$ stream\+Id, bool reliable, bool ordered, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}\& connection)}, this method does not guarantee the reliability of data transmission. If a data packet is not received five seconds after it was sent, the S\+DK directly discards the data. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}.

\begin{DoxyNote}{Note}
Each user can create up to five data streams during the lifecycle of {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine}{I\+Rtc\+Engine}}}. The data stream will be destroyed when leaving the channel, and the data stream needs to be recreated if needed. 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 stream\+Id} & An output parameter; the ID of the data stream created. \\
\hline
{\em config} & The configurations for the data stream. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_data_stream_config}{Data\+Stream\+Config}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: The data stream is successfully created.
\item $<$ 0\+: Failure. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_acb5aa2c150630a2949b803bbe2fcb219}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_acb5aa2c150630a2949b803bbe2fcb219}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!sendStreamMessageEx@{sendStreamMessageEx}}
\index{sendStreamMessageEx@{sendStreamMessageEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{sendStreamMessageEx()}{sendStreamMessageEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::send\+Stream\+Message\+Ex (\begin{DoxyParamCaption}\item[{int}]{stream\+Id,  }\item[{const char $\ast$}]{data,  }\item[{size\+\_\+t}]{length,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sends data stream messages. 

After calling {\ttfamily create\+Data\+Stream\+Ex(int$\ast$ stream\+Id, const \mbox{\hyperlink{structagora_1_1rtc_1_1_data_stream_config}{Data\+Stream\+Config}}\& config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}\& connection)}, you can call this method to send data stream messages to all users in the channel. The S\+DK has the following restrictions on this method\+:
\begin{DoxyItemize}
\item Each client within the channel can have up to 5 data channels simultaneously, with a total shared packet bitrate limit of 30 K\+B/s for all data channels.
\item Each data channel can send up to 60 packets per second, with each packet being a maximum of 1 KB. A successful method call triggers the {\ttfamily on\+Stream\+Message} callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the {\ttfamily on\+Stream\+Message\+Error} callback on the remote client.
\end{DoxyItemize}

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item 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}.
\item Call this method after {\ttfamily join\+Channel\+Ex}.
\item Ensure that you call {\ttfamily create\+Data\+Stream\+Ex(int$\ast$ stream\+Id, const \mbox{\hyperlink{structagora_1_1rtc_1_1_data_stream_config}{Data\+Stream\+Config}}\& config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}\& connection)} to create a data channel before calling this method.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em stream\+Id} & The data stream ID. You can get the data stream ID by calling {\ttfamily create\+Data\+Stream\+Ex(int$\ast$ stream\+Id, const \mbox{\hyperlink{structagora_1_1rtc_1_1_data_stream_config}{Data\+Stream\+Config}}\& config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}\& connection)}\\
\hline
{\em data} & The message to be sent. \\
\hline
{\em length} & The length of the data. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a7ca3f9b34be15eb005389142695e15d2}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7ca3f9b34be15eb005389142695e15d2}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!sendRdtMessageEx@{sendRdtMessageEx}}
\index{sendRdtMessageEx@{sendRdtMessageEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{sendRdtMessageEx()}{sendRdtMessageEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::send\+Rdt\+Message\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{Rdt\+Stream\+Type}]{type,  }\item[{const char $\ast$}]{data,  }\item[{size\+\_\+t}]{length,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Send Reliable message to remote uid in channel. 

@technical preview


\begin{DoxyParams}{Parameters}
{\em uid} & Remote user id. \\
\hline
{\em type} & Reliable Data Transmission tunnel message type. See Rdt\+Stream\+Type \\
\hline
{\em data} & The pointer to the sent data. \\
\hline
{\em length} & The length of the sent data. \\
\hline
{\em connection} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} object. \\
\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_ex_aca77c53cca7d44ac30b1243f9de878e2}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aca77c53cca7d44ac30b1243f9de878e2}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!sendMediaControlMessageEx@{sendMediaControlMessageEx}}
\index{sendMediaControlMessageEx@{sendMediaControlMessageEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{sendMediaControlMessageEx()}{sendMediaControlMessageEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::send\+Media\+Control\+Message\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{const char $\ast$}]{data,  }\item[{size\+\_\+t}]{length,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Send media control message. 

@technical preview


\begin{DoxyParams}{Parameters}
{\em uid} & Remote user id. In particular, if the uid is set to 0, it means broadcasting the message to the entire channel. \\
\hline
{\em data} & The pointer to the sent data. \\
\hline
{\em length} & The length of the sent data, max 1024. \\
\hline
{\em connection} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} object. \\
\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_ex_a3236771daf7b826f41718e0e477b37e7}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a3236771daf7b826f41718e0e477b37e7}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!addVideoWatermarkEx@{addVideoWatermarkEx}}
\index{addVideoWatermarkEx@{addVideoWatermarkEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{addVideoWatermarkEx()}{addVideoWatermarkEx()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::add\+Video\+Watermark\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{watermark\+Url,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options}{Watermark\+Options}} \&}]{options,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adds a watermark image to the local video. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000061}{Deprecated}}]v4.\+6.\+0. This method is deprecated. Use add\+Video\+Watermark\+Ex(const \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_config}{Watermark\+Config}}\& config, const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}\& connection) instead.\end{DoxyRefDesc}


This method adds a P\+NG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (C\+DN audience included), and the capturing device can see and capture it. The Agora S\+DK supports adding only one watermark image onto a live video stream. The newly added watermark image replaces the previous one. The watermark coordinates are dependent on the settings in the {\ttfamily set\+Video\+Encoder\+Configuration\+Ex} method\+:
\begin{DoxyItemize}
\item If the orientation mode of the encoding video ( {\ttfamily O\+R\+I\+E\+N\+T\+A\+T\+I\+O\+N\+\_\+\+M\+O\+DE} ) is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation.
\item If the orientation mode of the encoding video ( {\ttfamily O\+R\+I\+E\+N\+T\+A\+T\+I\+O\+N\+\_\+\+M\+O\+DE} ) is fixed portrait mode or the adaptive portrait mode, the watermark uses the portrait orientation.
\item When setting the watermark position, the region must be less than the dimensions set in the {\ttfamily set\+Video\+Encoder\+Configuration\+Ex} method; otherwise, the watermark image will be cropped.
\end{DoxyItemize}

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Ensure that you have called {\ttfamily enable\+Video} before calling this method.
\item This method supports adding a watermark image in the P\+NG file format only. Supported pixel formats of the P\+NG image are R\+G\+BA, R\+GB, Palette, Gray, and Alpha\+\_\+gray.
\item If the dimensions of the P\+NG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings.
\item If you have enabled the local video preview by calling the {\ttfamily start\+Preview(V\+I\+D\+E\+O\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE source\+Type)} method, you can use the {\ttfamily visible\+In\+Preview} member to set whether or not the watermark is visible in the preview.
\item If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em watermark\+Url} & The local file path of the watermark image to be added. This method supports adding a watermark image from the local absolute or relative file path. \\
\hline
{\em options} & The options of the watermark image to be added. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options}{Watermark\+Options}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a8c0e435d8bb4f26bc5caf5eb3d314827}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a8c0e435d8bb4f26bc5caf5eb3d314827}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!addVideoWatermarkEx@{addVideoWatermarkEx}}
\index{addVideoWatermarkEx@{addVideoWatermarkEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{addVideoWatermarkEx()}{addVideoWatermarkEx()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::add\+Video\+Watermark\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_config}{Watermark\+Config}} \&}]{config,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Adds a watermark image to the local video. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Applicable scenarios\+: This method applies to multi-\/channel scenarios.


\begin{DoxyParams}{Parameters}
{\em config} & Watermark configuration. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_config}{Watermark\+Config}}}. \\
\hline
{\em connection} & {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}} object. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_adc8bcef2d95af79367326c7624ac79c7}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_adc8bcef2d95af79367326c7624ac79c7}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!removeVideoWatermarkEx@{removeVideoWatermarkEx}}
\index{removeVideoWatermarkEx@{removeVideoWatermarkEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{removeVideoWatermarkEx()}{removeVideoWatermarkEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::remove\+Video\+Watermark\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{id,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Removes the specified watermark image from the local or remote video stream. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Applicable scenarios\+: This method applies to multi-\/channel scenarios.


\begin{DoxyParams}{Parameters}
{\em id} & Watermark ID. \\
\hline
{\em connection} & {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}} object. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_aabeeb90f0eab9224614994b4aefd85fa}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aabeeb90f0eab9224614994b4aefd85fa}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!clearVideoWatermarkEx@{clearVideoWatermarkEx}}
\index{clearVideoWatermarkEx@{clearVideoWatermarkEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{clearVideoWatermarkEx()}{clearVideoWatermarkEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::clear\+Video\+Watermark\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Removes the watermark image from the video stream. 


\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_ad2b162bf448070754386f52a4ccadce1}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ad2b162bf448070754386f52a4ccadce1}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!sendCustomReportMessageEx@{sendCustomReportMessageEx}}
\index{sendCustomReportMessageEx@{sendCustomReportMessageEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{sendCustomReportMessageEx()}{sendCustomReportMessageEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::send\+Custom\+Report\+Message\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{id,  }\item[{const char $\ast$}]{category,  }\item[{const char $\ast$}]{event,  }\item[{const char $\ast$}]{label,  }\item[{int}]{value,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Agora supports reporting and analyzing customized messages. 

Agora supports reporting and analyzing customized messages. This function is in the beta stage with a free trial. The ability provided in its beta test version is reporting a maximum of 10 message pieces within 6 seconds, with each message piece not exceeding 256 bytes and each string not exceeding 100 bytes. To try out this function, contact {\ttfamily support@agora.\+io} and discuss the format of customized messages with us. \mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_ae17f2728556a209f394d31b3f00b97bf}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ae17f2728556a209f394d31b3f00b97bf}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!enableAudioVolumeIndicationEx@{enableAudioVolumeIndicationEx}}
\index{enableAudioVolumeIndicationEx@{enableAudioVolumeIndicationEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{enableAudioVolumeIndicationEx()}{enableAudioVolumeIndicationEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::enable\+Audio\+Volume\+Indication\+Ex (\begin{DoxyParamCaption}\item[{int}]{interval,  }\item[{int}]{smooth,  }\item[{bool}]{report\+Vad,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Enables the reporting of users\textquotesingle{} volume indication. 

This method enables the S\+DK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}. Related callbacks\+: The S\+DK triggers the {\ttfamily on\+Audio\+Volume\+Indication} callback according to the interval you set if this method is successfully called and there are users publishing streams in the channel.


\begin{DoxyParams}{Parameters}
{\em interval} & Sets the time interval between two consecutive volume indications\+:
\begin{DoxyItemize}
\item ≤ 0\+: Disables the volume indication.
\item $>$ 0\+: Time interval (ms) between two consecutive volume indications. Ensure this parameter is set to a value greater than 10, otherwise you will not receive the {\ttfamily on\+Audio\+Volume\+Indication} callback. Agora recommends that this value is set as greater than 100. 
\end{DoxyItemize}\\
\hline
{\em smooth} & The smoothing factor that sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The recommended value is 3. The greater the value, the more sensitive the indicator. \\
\hline
{\em report\+Vad} & -\/ {\ttfamily true}\+: Enables the voice activity detection of the local user. Once it is enabled, the {\ttfamily vad} parameter of the {\ttfamily on\+Audio\+Volume\+Indication} callback reports the voice activity status of the local user.
\begin{DoxyItemize}
\item {\ttfamily false}\+: (Default) Disables the voice activity detection of the local user. Once it is disabled, the {\ttfamily vad} parameter of the {\ttfamily on\+Audio\+Volume\+Indication} callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user. 
\end{DoxyItemize}\\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_aa378933c89523540c60d68acb62f5d31}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa378933c89523540c60d68acb62f5d31}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!startRtmpStreamWithoutTranscodingEx@{startRtmpStreamWithoutTranscodingEx}}
\index{startRtmpStreamWithoutTranscodingEx@{startRtmpStreamWithoutTranscodingEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{startRtmpStreamWithoutTranscodingEx()}{startRtmpStreamWithoutTranscodingEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::start\+Rtmp\+Stream\+Without\+Transcoding\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{url,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Starts pushing media streams to a C\+DN without transcoding. 

Agora recommends that you use the server-\/side Media Push function. For details, see {\ttfamily Use R\+E\+S\+Tful A\+PI}. You can call this method to push an audio or video stream to the specified C\+DN address. This method can push media streams to only one C\+DN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the S\+DK triggers the {\ttfamily on\+Rtmp\+Streaming\+State\+Changed} callback on the local client to report the state of the streaming.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Call this method after joining a channel.
\item Only hosts in the L\+I\+V\+E\+\_\+\+B\+R\+O\+A\+D\+C\+A\+S\+T\+I\+NG profile can call this method.
\item If you want to retry pushing streams after a failed push, make sure to call {\ttfamily stop\+Rtmp\+Stream} first, then call this method to retry pushing streams; otherwise, the S\+DK returns the same error code as the last failed push.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em url} & The address of Media Push. The format is R\+T\+MP or R\+T\+M\+PS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure.
\begin{DoxyItemize}
\item -\/2\+: The U\+RL or configuration of transcoding is invalid; check your U\+RL and transcoding configurations.
\item -\/7\+: The S\+DK is not initialized before calling this method.
\item -\/19\+: The Media Push U\+RL is already in use; use another U\+RL instead. 
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa4d1ef7eeceecd8baf53622dc20d271e}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa4d1ef7eeceecd8baf53622dc20d271e}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!startRtmpStreamWithTranscodingEx@{startRtmpStreamWithTranscodingEx}}
\index{startRtmpStreamWithTranscodingEx@{startRtmpStreamWithTranscodingEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{startRtmpStreamWithTranscodingEx()}{startRtmpStreamWithTranscodingEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::start\+Rtmp\+Stream\+With\+Transcoding\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{url,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}} \&}]{transcoding,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Starts Media Push and sets the transcoding configuration. 

Agora recommends that you use the server-\/side Media Push function. For details, see {\ttfamily Use R\+E\+S\+Tful A\+PI}. You can call this method to push a live audio-\/and-\/video stream to the specified C\+DN address and set the transcoding configuration. This method can push media streams to only one C\+DN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the S\+DK triggers the {\ttfamily on\+Rtmp\+Streaming\+State\+Changed} callback on the local client to report the state of the streaming.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Ensure that you enable the Media Push service before using this function.
\item Call this method after joining a channel.
\item Only hosts in the L\+I\+V\+E\+\_\+\+B\+R\+O\+A\+D\+C\+A\+S\+T\+I\+NG profile can call this method.
\item If you want to retry pushing streams after a failed push, make sure to call {\ttfamily stop\+Rtmp\+Stream\+Ex} first, then call this method to retry pushing streams; otherwise, the S\+DK returns the same error code as the last failed push.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em url} & The address of Media Push. The format is R\+T\+MP or R\+T\+M\+PS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported. \\
\hline
{\em transcoding} & The transcoding configuration for Media Push. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure.
\begin{DoxyItemize}
\item -\/2\+: The U\+RL or configuration of transcoding is invalid; check your U\+RL and transcoding configurations.
\item -\/7\+: The S\+DK is not initialized before calling this method.
\item -\/19\+: The Media Push U\+RL is already in use; use another U\+RL instead. 
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7166a565c1aeb53d8a3dbe28c008237b}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7166a565c1aeb53d8a3dbe28c008237b}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!updateRtmpTranscodingEx@{updateRtmpTranscodingEx}}
\index{updateRtmpTranscodingEx@{updateRtmpTranscodingEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{updateRtmpTranscodingEx()}{updateRtmpTranscodingEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::update\+Rtmp\+Transcoding\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}} \&}]{transcoding,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Updates the transcoding configuration. 

Agora recommends that you use the server-\/side Media Push function. For details, see {\ttfamily Use R\+E\+S\+Tful A\+PI}. After you start pushing media streams to C\+DN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The S\+DK triggers the {\ttfamily on\+Transcoding\+Updated} callback after the transcoding configuration is updated.


\begin{DoxyParams}{Parameters}
{\em transcoding} & The transcoding configuration for Media Push. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a7c82d9a5e2e679d798718c35c921126a}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7c82d9a5e2e679d798718c35c921126a}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!stopRtmpStreamEx@{stopRtmpStreamEx}}
\index{stopRtmpStreamEx@{stopRtmpStreamEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{stopRtmpStreamEx()}{stopRtmpStreamEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::stop\+Rtmp\+Stream\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{url,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Stops pushing media streams to a C\+DN. 

Agora recommends that you use the server-\/side Media Push function. For details, see {\ttfamily Use R\+E\+S\+Tful A\+PI}. You can call this method to stop the live stream on the specified C\+DN address. This method can stop pushing media streams to only one C\+DN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times. After you call this method, the S\+DK triggers the {\ttfamily on\+Rtmp\+Streaming\+State\+Changed} callback on the local client to report the state of the streaming.


\begin{DoxyParams}{Parameters}
{\em url} & The address of Media Push. The format is R\+T\+MP or R\+T\+M\+PS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_ab30b266694ae9d2ad08e551c8519523d}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab30b266694ae9d2ad08e551c8519523d}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!startOrUpdateChannelMediaRelayEx@{startOrUpdateChannelMediaRelayEx}}
\index{startOrUpdateChannelMediaRelayEx@{startOrUpdateChannelMediaRelayEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{startOrUpdateChannelMediaRelayEx()}{startOrUpdateChannelMediaRelayEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::start\+Or\+Update\+Channel\+Media\+Relay\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_relay_configuration}{Channel\+Media\+Relay\+Configuration}} \&}]{configuration,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Starts relaying media streams across channels or updates channels for media relay. 

\begin{DoxySince}{Since}
v4.\+2.\+0
\end{DoxySince}
The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels. After a successful method call, the S\+DK triggers the {\ttfamily on\+Channel\+Media\+Relay\+State\+Changed} callback, and this callback returns the state of the media stream relay. Common states are as follows\+:
\begin{DoxyItemize}
\item If the {\ttfamily on\+Channel\+Media\+Relay\+State\+Changed} callback returns {\ttfamily R\+E\+L\+A\+Y\+\_\+\+S\+T\+A\+T\+E\+\_\+\+R\+U\+N\+N\+I\+NG} (2) and {\ttfamily R\+E\+L\+A\+Y\+\_\+\+OK} (0), it means that the S\+DK starts relaying media streams from the source channel to the destination channel.
\item If the {\ttfamily on\+Channel\+Media\+Relay\+State\+Changed} callback returns {\ttfamily R\+E\+L\+A\+Y\+\_\+\+S\+T\+A\+T\+E\+\_\+\+F\+A\+I\+L\+U\+RE} (3), an exception occurs during the media stream relay.
\end{DoxyItemize}

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Call this method after joining the channel.
\item This method takes effect only when you are a host in a live streaming channel.
\item The relaying media streams across channels function needs to be enabled by contacting {\ttfamily technical support}.
\item Agora does not support string user accounts in this A\+PI.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em configuration} & The configuration of the media stream relay. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_relay_configuration}{Channel\+Media\+Relay\+Configuration}}}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure.
\begin{DoxyItemize}
\item -\/1\+: A general error occurs (no specified reason).
\item -\/2\+: The parameter is invalid.
\item -\/8\+: Internal state error. Probably because the user is not a broadcaster. 
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_aba056aa7a09644615f07e8e8a95e3638}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aba056aa7a09644615f07e8e8a95e3638}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!stopChannelMediaRelayEx@{stopChannelMediaRelayEx}}
\index{stopChannelMediaRelayEx@{stopChannelMediaRelayEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{stopChannelMediaRelayEx()}{stopChannelMediaRelayEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::stop\+Channel\+Media\+Relay\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Stops the media stream relay. Once the relay stops, the host quits all the target channels. 

After a successful method call, the S\+DK triggers the {\ttfamily on\+Channel\+Media\+Relay\+State\+Changed} callback. If the callback reports {\ttfamily R\+E\+L\+A\+Y\+\_\+\+S\+T\+A\+T\+E\+\_\+\+I\+D\+LE} (0) and {\ttfamily R\+E\+L\+A\+Y\+\_\+\+OK} (0), the host successfully stops the relay.

\begin{DoxyNote}{Note}
If the method call fails, the S\+DK triggers the {\ttfamily on\+Channel\+Media\+Relay\+State\+Changed} callback with the {\ttfamily R\+E\+L\+A\+Y\+\_\+\+E\+R\+R\+O\+R\+\_\+\+S\+E\+R\+V\+E\+R\+\_\+\+N\+O\+\_\+\+R\+E\+S\+P\+O\+N\+SE} (2) or {\ttfamily R\+E\+L\+A\+Y\+\_\+\+E\+R\+R\+O\+R\+\_\+\+S\+E\+R\+V\+E\+R\+\_\+\+C\+O\+N\+N\+E\+C\+T\+I\+O\+N\+\_\+\+L\+O\+ST} (8) status code. You can call the {\ttfamily \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_ad5c2ef631e3e4076f6aec96ed1152262}{leave\+Channel(const Leave\+Channel\+Options\& options)}}} method to leave the channel, and the media stream relay automatically stops.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure.
\begin{DoxyItemize}
\item -\/5\+: The method call was rejected. There is no ongoing channel media relay. 
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab1b6ce25f01fd933d128391b3f7a2444}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab1b6ce25f01fd933d128391b3f7a2444}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!pauseAllChannelMediaRelayEx@{pauseAllChannelMediaRelayEx}}
\index{pauseAllChannelMediaRelayEx@{pauseAllChannelMediaRelayEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{pauseAllChannelMediaRelayEx()}{pauseAllChannelMediaRelayEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::pause\+All\+Channel\+Media\+Relay\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Pauses the media stream relay to all target channels. 

After the cross-\/channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call {\ttfamily resume\+All\+Channel\+Media\+Relay}.

\begin{DoxyNote}{Note}
Call this method after {\ttfamily start\+Or\+Update\+Channel\+Media\+Relay\+Ex}.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure.
\begin{DoxyItemize}
\item -\/5\+: The method call was rejected. There is no ongoing channel media relay. 
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_afafa5382d22353b4bde60b1d9e63230a}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_afafa5382d22353b4bde60b1d9e63230a}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!resumeAllChannelMediaRelayEx@{resumeAllChannelMediaRelayEx}}
\index{resumeAllChannelMediaRelayEx@{resumeAllChannelMediaRelayEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{resumeAllChannelMediaRelayEx()}{resumeAllChannelMediaRelayEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::resume\+All\+Channel\+Media\+Relay\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Resumes the media stream relay to all target channels. 

After calling the {\ttfamily pause\+All\+Channel\+Media\+Relay\+Ex} method, you can call this method to resume relaying media streams to all destination channels.

\begin{DoxyNote}{Note}
Call this method after {\ttfamily pause\+All\+Channel\+Media\+Relay\+Ex}.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure.
\begin{DoxyItemize}
\item -\/5\+: The method call was rejected. There is no paused channel media relay. 
\end{DoxyItemize}
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_a9cbb0b4985356bf89ccfe4bec6ae53e9}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a9cbb0b4985356bf89ccfe4bec6ae53e9}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!getUserInfoByUserAccountEx@{getUserInfoByUserAccountEx}}
\index{getUserInfoByUserAccountEx@{getUserInfoByUserAccountEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{getUserInfoByUserAccountEx()}{getUserInfoByUserAccountEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::get\+User\+Info\+By\+User\+Account\+Ex (\begin{DoxyParamCaption}\item[{const char $\ast$}]{user\+Account,  }\item[{\mbox{\hyperlink{structagora_1_1rtc_1_1_user_info}{rtc\+::\+User\+Info}} $\ast$}]{user\+Info,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Gets the user information by passing in the user account. It is same as \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_acba378be5f666f84c64713197587dc43}{agora\+::rtc\+::\+I\+Rtc\+Engine\+::get\+User\+Info\+By\+User\+Account}}.


\begin{DoxyParams}[1]{Parameters}
 & {\em user\+Account} & The user account of the user. Ensure that you set this parameter. \\
\hline
\mbox{\texttt{ in,out}}  & {\em user\+Info} & A user\+Info object that identifies the user\+:
\begin{DoxyItemize}
\item Input\+: A user\+Info object.
\item Output\+: A user\+Info object that contains the user account and user ID of the user. 
\end{DoxyItemize}\\
\hline
 & {\em connection} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} object.\\
\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_ex_a1b05424979241a61cd3ede056c808812}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a1b05424979241a61cd3ede056c808812}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!getUserInfoByUidEx@{getUserInfoByUidEx}}
\index{getUserInfoByUidEx@{getUserInfoByUidEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{getUserInfoByUidEx()}{getUserInfoByUidEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::get\+User\+Info\+By\+Uid\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t}]{uid,  }\item[{\mbox{\hyperlink{structagora_1_1rtc_1_1_user_info}{rtc\+::\+User\+Info}} $\ast$}]{user\+Info,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Gets the user information by passing in the user ID. It is same as \mbox{\hyperlink{classagora_1_1rtc_1_1_i_rtc_engine_a7a34efc30c42f0c200aacd6a6f1dc386}{agora\+::rtc\+::\+I\+Rtc\+Engine\+::get\+User\+Info\+By\+Uid}}.


\begin{DoxyParams}[1]{Parameters}
 & {\em uid} & The user ID of the remote user. Ensure that you set this parameter. \\
\hline
\mbox{\texttt{ in,out}}  & {\em user\+Info} & A user\+Info object that identifies the user\+:
\begin{DoxyItemize}
\item Input\+: A user\+Info object.
\item Output\+: A user\+Info object that contains the user account and user ID of the user. 
\end{DoxyItemize}\\
\hline
 & {\em connection} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} object.\\
\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_ex_a4d7a88053b9874b7fbd2ab6d8ecc034b}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a4d7a88053b9874b7fbd2ab6d8ecc034b}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!enableDualStreamModeEx@{enableDualStreamModeEx}}
\index{enableDualStreamModeEx@{enableDualStreamModeEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{enableDualStreamModeEx()}{enableDualStreamModeEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::enable\+Dual\+Stream\+Mode\+Ex (\begin{DoxyParamCaption}\item[{bool}]{enabled,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_stream_config}{Simulcast\+Stream\+Config}} \&}]{stream\+Config,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Enables or disables dual-\/stream mode on the sender side. 

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000062}{Deprecated}}]v4.\+2.\+0. This method is deprecated. Use set\+Dual\+Stream\+Mode\+Ex instead\end{DoxyRefDesc}


You can call this method to enable or disable the dual-\/stream mode on the publisher side. Dual streams are a pairing of a high-\/quality video stream and a low-\/quality video stream\+:
\begin{DoxyItemize}
\item High-\/quality video stream\+: High bitrate, high resolution.
\item Low-\/quality video stream\+: Low bitrate, low resolution. After you enable dual-\/stream mode, you can call {\ttfamily set\+Remote\+Video\+Stream\+Type} to choose to receive either the high-\/quality video stream or the low-\/quality video stream on the subscriber side.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-\/collected video streams.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em enabled} & Whether to enable dual-\/stream mode\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Enable dual-\/stream mode.
\item {\ttfamily false}\+: (Default) Disable dual-\/stream mode. 
\end{DoxyItemize}\\
\hline
{\em stream\+Config} & The configuration of the low-\/quality video stream. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_stream_config}{Simulcast\+Stream\+Config}}}.Note\+: When setting {\ttfamily mode} to {\ttfamily D\+I\+S\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM}, setting {\ttfamily stream\+Config} will not take effect. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a7264a77658ad9ad5563d15fba63991a2}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a7264a77658ad9ad5563d15fba63991a2}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setDualStreamModeEx@{setDualStreamModeEx}}
\index{setDualStreamModeEx@{setDualStreamModeEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setDualStreamModeEx()}{setDualStreamModeEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Dual\+Stream\+Mode\+Ex (\begin{DoxyParamCaption}\item[{S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+M\+O\+DE}]{mode,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_stream_config}{Simulcast\+Stream\+Config}} \&}]{stream\+Config,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the dual-\/stream mode on the sender side. 

The S\+DK defaults to enabling low-\/quality video stream adaptive mode ( {\ttfamily A\+U\+T\+O\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM} ) on the sender side, which means the sender does not actively send low-\/quality video stream. The receiving end with the role of the {\bfseries{host}} can initiate a low-\/quality video stream request by calling {\ttfamily set\+Remote\+Video\+Stream\+Type\+Ex}, and upon receiving the request, the sending end automatically starts sending low-\/quality stream.
\begin{DoxyItemize}
\item If you want to modify this behavior, you can call this method and set {\ttfamily mode} to {\ttfamily D\+I\+S\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM} (never send low-\/quality video streams) or {\ttfamily E\+N\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM} (always send low-\/quality video streams).
\item If you want to restore the default behavior after making changes, you can call this method again with {\ttfamily mode} set to {\ttfamily A\+U\+T\+O\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM}.
\end{DoxyItemize}

\begin{DoxyNote}{Note}
The difference and connection between this method and {\ttfamily enable\+Dual\+Stream\+Mode\+Ex} is as follows\+:
\begin{DoxyItemize}
\item When calling this method and setting {\ttfamily mode} to D\+I\+S\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM, it has the same effect as {\ttfamily enable\+Dual\+Stream\+Mode\+Ex} {\ttfamily (false)}.
\item When calling this method and setting {\ttfamily mode} to E\+N\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM, it has the same effect as {\ttfamily enable\+Dual\+Stream\+Mode\+Ex} {\ttfamily (true)}.
\item Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em mode} & The mode in which the video stream is sent. See {\ttfamily S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+A\+M\+\_\+\+M\+O\+DE}. \\
\hline
{\em stream\+Config} & The configuration of the low-\/quality video stream. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_stream_config}{Simulcast\+Stream\+Config}}}.Note\+: When setting {\ttfamily mode} to {\ttfamily D\+I\+S\+A\+B\+L\+E\+\_\+\+S\+I\+M\+U\+L\+C\+A\+S\+T\+\_\+\+S\+T\+R\+E\+AM}, setting {\ttfamily stream\+Config} will not take effect. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_aa3ec7031aba854a5ff1eaf9c55666205}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aa3ec7031aba854a5ff1eaf9c55666205}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setSimulcastConfigEx@{setSimulcastConfigEx}}
\index{setSimulcastConfigEx@{setSimulcastConfigEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setSimulcastConfigEx()}{setSimulcastConfigEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Simulcast\+Config\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_config}{Simulcast\+Config}} \&}]{simulcast\+Config,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Sets the simulcast video stream configuration. 

\begin{DoxySince}{Since}
v4.\+6.\+0
\end{DoxySince}
This method can be called in scenarios involving multiple channels. You can call the {\ttfamily set\+Simulcast\+Config} method to set video streams with different resolutions for the same video source. The subscribers can call to select which stream layer to receive. The broadcaster can publish up to four layers of video streams\+: one main stream (highest resolution) and three additional streams of different quality levels. {\ttfamily set\+Remote\+Video\+Stream\+Type} Applicable scenarios\+: This method can be called in scenarios involving multiple channels.


\begin{DoxyParams}{Parameters}
{\em simulcast\+Config} & This configuration includes seven layers, from S\+T\+R\+E\+A\+M\+\_\+\+L\+A\+Y\+E\+R\+\_\+1 to S\+T\+R\+E\+A\+M\+\_\+\+L\+OW, with a maximum of three layers enabled simultaneously. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_simulcast_config}{Simulcast\+Config}}}. \\
\hline
{\em connection} & Connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_ae242e9b161910dc66d8340031a75d25d}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ae242e9b161910dc66d8340031a75d25d}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setHighPriorityUserListEx@{setHighPriorityUserListEx}}
\index{setHighPriorityUserListEx@{setHighPriorityUserListEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setHighPriorityUserListEx()}{setHighPriorityUserListEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+High\+Priority\+User\+List\+Ex (\begin{DoxyParamCaption}\item[{uid\+\_\+t $\ast$}]{uid\+List,  }\item[{int}]{uid\+Num,  }\item[{S\+T\+R\+E\+A\+M\+\_\+\+F\+A\+L\+L\+B\+A\+C\+K\+\_\+\+O\+P\+T\+I\+O\+NS}]{option,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Set the high priority user list and their fallback level in weak network condition.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item This method can be called before and after joining a channel.
\item If a subscriber is set to high priority, this stream only fallback to lower stream after all normal priority users fallback to their fallback level on weak network condition if needed.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em uid\+List} & The high priority user list. \\
\hline
{\em uid\+Num} & The size of uid\+List. \\
\hline
{\em option} & The fallback level of high priority users. \\
\hline
{\em connection} & An output parameter which is used to control different connection instances.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
int
\begin{DoxyItemize}
\item 0 \+: Success.
\item $<$0 \+: Failure. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab44ff5921d69865c76a830eeba1b03a7}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab44ff5921d69865c76a830eeba1b03a7}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!takeSnapshotEx@{takeSnapshotEx}}
\index{takeSnapshotEx@{takeSnapshotEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{takeSnapshotEx()}{takeSnapshotEx()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::take\+Snapshot\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{uid\+\_\+t}]{uid,  }\item[{const char $\ast$}]{file\+Path }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Takes a snapshot of a video stream using connection ID. 

This method takes a snapshot of a video stream from the specified user, generates a J\+PG image, and saves it to the specified path. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}. Related callbacks\+: After a successful call of this method, the S\+DK triggers the {\ttfamily on\+Snapshot\+Taken} callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item The method is asynchronous, and the S\+DK has not taken the snapshot when the method call returns.
\item When used for local video snapshots, this method takes a snapshot for the video streams specified in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}}.
\item If the user\textquotesingle{}s video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-\/processing effect.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}. \\
\hline
{\em uid} & The user ID. Set uid as 0 if you want to take a snapshot of the local user\textquotesingle{}s video. \\
\hline
{\em file\+Path} & The local path (including filename extensions) of the snapshot. For example\+:
\begin{DoxyItemize}
\item Windows\+: {\ttfamily C\+:\textbackslash{}Users\textbackslash{}$<$user\+\_\+name$>$\textbackslash{}App\+Data\textbackslash{}Local\textbackslash{}Agora\textbackslash{}$<$process\+\_\+name$>$\textbackslash{}example.\+jpg}
\item i\+OS\+: {\ttfamily /\+App Sandbox/\+Library/\+Caches/example.\+jpg}
\item mac\+OS\+: {\ttfamily ～/\+Library/\+Logs/example.jpg}
\item Android\+: {\ttfamily /storage/emulated/0/\+Android/data/$<$package name$>$/files/example.jpg} Attention\+: Ensure that the path you specify exists and is writable.
\end{DoxyItemize}\\
\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_ex_a4c51b1ae3b9f14683e22fc7080919600}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a4c51b1ae3b9f14683e22fc7080919600}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!takeSnapshotEx@{takeSnapshotEx}}
\index{takeSnapshotEx@{takeSnapshotEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{takeSnapshotEx()}{takeSnapshotEx()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::take\+Snapshot\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{uid\+\_\+t}]{uid,  }\item[{const \mbox{\hyperlink{structagora_1_1media_1_1_snapshot_config}{media\+::\+Snapshot\+Config}} \&}]{config }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Gets a video screenshot of the specified observation point using the connection ID. 

This method takes a snapshot of a video stream from the specified user, generates a J\+PG image, and saves it to the specified path. Call timing\+: Call this method after {\ttfamily join\+Channel\+Ex}. Related callbacks\+: After a successful call of this method, the S\+DK triggers the {\ttfamily on\+Snapshot\+Taken} callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item The method is asynchronous, and the S\+DK has not taken the snapshot when the method call returns.
\item When used for local video snapshots, this method takes a snapshot for the video streams specified in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_channel_media_options}{Channel\+Media\+Options}}}.
\item If the user\textquotesingle{}s video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-\/processing effect.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}. \\
\hline
{\em uid} & The user ID. Set uid as 0 if you want to take a snapshot of the local user\textquotesingle{}s video. \\
\hline
{\em config} & The configuration of the snaptshot. See {\ttfamily Snapshot\+Config}.\\
\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_ex_a46488c427ce67b133718509ca429bbe6}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a46488c427ce67b133718509ca429bbe6}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!enableContentInspectEx@{enableContentInspectEx}}
\index{enableContentInspectEx@{enableContentInspectEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{enableContentInspectEx()}{enableContentInspectEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::enable\+Content\+Inspect\+Ex (\begin{DoxyParamCaption}\item[{bool}]{enabled,  }\item[{const \mbox{\hyperlink{structagora_1_1media_1_1_content_inspect_config}{media\+::\+Content\+Inspect\+Config}} \&}]{config,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Enables or disables video screenshot and upload. 

This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the S\+DK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in {\ttfamily Content\+Inspect\+Config}. After video screenshot and upload, the Agora server sends the callback notification to your app server in H\+T\+T\+PS requests and sends all screenshots to the third-\/party cloud storage service. Call timing\+: This method can be called either before or after joining the channel.

\begin{DoxyNote}{Note}
Before calling this method, ensure that you have contacted {\ttfamily technical support} to activate the video screenshot upload service.
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em enabled} & Whether to enalbe video screenshot and upload\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Enables video screenshot and upload.
\item {\ttfamily false}\+: Disables video screenshot and upload. 
\end{DoxyItemize}\\
\hline
{\em config} & Screenshot and upload configuration. See {\ttfamily Content\+Inspect\+Config}. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_aca766ae6dc1c7fea4758bae36fd1705b}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_aca766ae6dc1c7fea4758bae36fd1705b}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!startMediaRenderingTracingEx@{startMediaRenderingTracingEx}}
\index{startMediaRenderingTracingEx@{startMediaRenderingTracingEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{startMediaRenderingTracingEx()}{startMediaRenderingTracingEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::start\+Media\+Rendering\+Tracing\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Enables tracing the video frame rendering process. 

\begin{DoxySince}{Since}
v4.\+1.\+1
\end{DoxySince}
The S\+DK starts tracing the rendering status of the video frames in the channel from the moment this method is successfully called and reports information about the event through the {\ttfamily on\+Video\+Rendering\+Tracing\+Result} callback. Applicable scenarios\+: Agora recommends that you use this method in conjunction with the UI settings (such as buttons and sliders) in your app to improve the user experience. For example, call this method when the user clicks the Join Channel button, and then get the time spent during the video frame rendering process through the {\ttfamily on\+Video\+Rendering\+Tracing\+Result} callback, so as to optimize the indicators accordingly.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item If you have not called this method, the S\+DK tracks the rendering events of the video frames from the moment 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 the channel. You can call this method at an appropriate time according to the actual application scenario to set the starting position for tracking video rendering events.
\item After the local user leaves the current channel, the S\+DK automatically tracks the video rendering events from the moment you join a channel.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}.\\
\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_ex_a29aca501a8d88ae1ee99b53c8cb8adc8}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a29aca501a8d88ae1ee99b53c8cb8adc8}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!setParametersEx@{setParametersEx}}
\index{setParametersEx@{setParametersEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{setParametersEx()}{setParametersEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::set\+Parameters\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{const char $\ast$}]{parameters }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

Provides the technical preview functionalities or special customizations by configuring the S\+DK with J\+S\+ON options. \begin{DoxySince}{Since}
v4.\+3.\+0 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em connection} & The connection information. See \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}. \\
\hline
{\em parameters} & Pointer to the set parameters in a J\+S\+ON string. \\
\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_ex_a61f53e6874cda9a1559dd120d0f376fd}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a61f53e6874cda9a1559dd120d0f376fd}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!getCallIdEx@{getCallIdEx}}
\index{getCallIdEx@{getCallIdEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{getCallIdEx()}{getCallIdEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::get\+Call\+Id\+Ex (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classagora_1_1util_1_1_copyable_auto_ptr}{agora\+::util\+::\+A\+String}} \&}]{call\+Id,  }\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Gets the call ID with the connection ID. 

When a user joins a channel on a client, a {\ttfamily call\+Id} is generated to identify the call from the client. You can call this method to get {\ttfamily call\+Id}, and pass it in when calling methods such as {\ttfamily rate} and {\ttfamily complain}. Call timing\+: Call this method after joining a channel.


\begin{DoxyParams}{Parameters}
{\em call\+Id} & Output parameter, the current call ID. \\
\hline
{\em connection} & The connection information. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab6f8dd51f1310bf94cd7ca9727840198}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_ab6f8dd51f1310bf94cd7ca9727840198}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!sendAudioMetadataEx@{sendAudioMetadataEx}}
\index{sendAudioMetadataEx@{sendAudioMetadataEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{sendAudioMetadataEx()}{sendAudioMetadataEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::send\+Audio\+Metadata\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{const char $\ast$}]{metadata,  }\item[{size\+\_\+t}]{length }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}

send audio metadata \begin{DoxySince}{Since}
v4.\+3.\+1 
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em connection} & The \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} object. \\
\hline
{\em metadata} & The pointer of metadata \\
\hline
{\em length} & Size of metadata \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: success
\item $<$0\+: failure @technical preview 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classagora_1_1rtc_1_1_i_rtc_engine_ex_a17f72653191438ecf902d1db25b72eda}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_a17f72653191438ecf902d1db25b72eda}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!preloadEffectEx@{preloadEffectEx}}
\index{preloadEffectEx@{preloadEffectEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{preloadEffectEx()}{preloadEffectEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::preload\+Effect\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{int}]{sound\+Id,  }\item[{const char $\ast$}]{file\+Path,  }\item[{int}]{start\+Pos = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Preloads a specified sound effect to a channel. 

\begin{DoxySince}{Since}
v4.\+6.\+0
\end{DoxySince}
Each time you call this method, you can only preload one sound effect file into memory. If you need to preload multiple sound files, please call this method multiple times. After preloading is complete, you can call {\ttfamily play\+Effect} to play the preloaded sound effects, or call {\ttfamily play\+All\+Effects} to play all preloaded sound effects. Applicable scenarios\+: This method can be called in scenarios involving multiple channels.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item To ensure a smooth experience, the size of sound effect files should not exceed the limit.
\item Agora recommends that you call this method before joining a channel.
\item If preload\+Effect\+Ex is called before play\+Effect\+Ex is executed, the file resource will not be closed after play\+Effect\+Ex. The next time play\+Effect\+Ex is executed, it will directly seek to play at the beginning.
\item If preload\+Effect\+Ex is not called before play\+Effect\+Ex is executed, the resource will be destroyed after play\+Effect\+Ex. The next time play\+Effect\+Ex is executed, it will try to reopen the file and play it from the beginning.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & One {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}} object. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}. \\
\hline
{\em sound\+Id} & The audio effect ID. \\
\hline
{\em file\+Path} & The absolute path of the local file or the U\+RL of the online file. Supported audio formats include\+: mp3, mp4, m4a, aac, 3gp, mkv and wav. \\
\hline
{\em start\+Pos} & The playback position (ms) of the audio effect file.\\
\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_ex_af5dcf23e932a064e8a395522118c8d21}\label{classagora_1_1rtc_1_1_i_rtc_engine_ex_af5dcf23e932a064e8a395522118c8d21}} 
\index{agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}!playEffectEx@{playEffectEx}}
\index{playEffectEx@{playEffectEx}!agora::rtc::IRtcEngineEx@{agora::rtc::IRtcEngineEx}}
\doxysubsubsection{\texorpdfstring{playEffectEx()}{playEffectEx()}}
{\footnotesize\ttfamily virtual int agora\+::rtc\+::\+I\+Rtc\+Engine\+Ex\+::play\+Effect\+Ex (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}} \&}]{connection,  }\item[{int}]{sound\+Id,  }\item[{const char $\ast$}]{file\+Path,  }\item[{int}]{loop\+Count,  }\item[{double}]{pitch,  }\item[{double}]{pan,  }\item[{int}]{gain,  }\item[{bool}]{publish = {\ttfamily false},  }\item[{int}]{start\+Pos = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Plays a specified sound effect in a channel. 

\begin{DoxySince}{Since}
v4.\+6.\+0
\end{DoxySince}
You can call this method to play a specified sound effect to all users in the channel. Each call to this method can only play one sound effect. To play multiple sound effects simultaneously, please call this method multiple times. This method allows you to set whether to publish sound effects in a channel. In order to play multiple sound files simultaneously, simply call the method multiple times with different {\ttfamily sound\+Id} and {\ttfamily file\+Path} parameters. Applicable scenarios\+: This method can be called in scenarios involving multiple channels.

\begin{DoxyNote}{Note}

\begin{DoxyItemize}
\item Agora recommends not playing more than three sound effects at the same time.
\item The sound effect ID and file path in this method must be consistent with those in the {\ttfamily preload\+Effect\+Ex} method.
\item If preload\+Effect\+Ex is called before play\+Effect\+Ex is executed, the file resource will not be closed after play\+Effect\+Ex. The next time play\+Effect\+Ex is executed, it will directly seek to play at the beginning.
\item If preload\+Effect\+Ex is not called before play\+Effect\+Ex is executed, the resource will be destroyed after play\+Effect\+Ex. The next time play\+Effect\+Ex is executed, it will try to reopen the file and play it from the beginning.
\end{DoxyItemize}
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em connection} & One {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}} object. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_connection}{Rtc\+Connection}}}. \\
\hline
{\em sound\+Id} & The audio effect ID. \\
\hline
{\em file\+Path} & The absolute path of the local file or the U\+RL of the online file. Supported audio formats\+: mp3, mp4, m4a, aac, 3gp, mkv and wav. \\
\hline
{\em loop\+Count} & Number of times the sound effect to be looped\+:
\begin{DoxyItemize}
\item {\ttfamily -\/1}\+: Loop infinitely until calling {\ttfamily stop\+Effect} or {\ttfamily stop\+All\+Effects}.
\item {\ttfamily 0}\+: Play once.
\item {\ttfamily 1}\+: Play twice. 
\end{DoxyItemize}\\
\hline
{\em pitch} & The pitch of the audio effect. The range is from 0.\+5 to 2.\+0, with a default value of 1.\+0 (original pitch). The lower the value, the lower the pitch. \\
\hline
{\em pan} & The spatial position of the audio effect. The range of values is from -\/1.\+0 to 1.\+0\+:
\begin{DoxyItemize}
\item {\ttfamily -\/1.\+0}\+: The audio effect is heard on the left of the user.
\item {\ttfamily 0.\+0}\+: The audio effect is heard in front of the user.
\item {\ttfamily 1.\+0}\+: The audio effect is heard on the right of the user. 
\end{DoxyItemize}\\
\hline
{\em gain} & The volume of the audio effect. The value range is from 0 to 100, with a default value of 100 (original volume). The smaller the value, the lower the volume. \\
\hline
{\em publish} & Whether to publish the audio effect in the channel\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: Publish the audio effect in the channel.
\item {\ttfamily false}\+: (Default) Do not publish the audio effect in the channel. 
\end{DoxyItemize}\\
\hline
{\em start\+Pos} & The playback position (ms) of the audio effect file.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$ 0\+: Failure. 
\end{DoxyItemize}
\end{DoxyReturn}
