\hypertarget{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info}{}\doxysection{io.\+agora.\+rtc2.\+I\+Rtc\+Engine\+Event\+Handler.\+Audio\+Volume\+Info Class Reference}
\label{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info}\index{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}}


The volume information of users.  


\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_a779bb6a02f5caba5ff1c29eb2f2f444d}{uid}}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_af868ce7e3da25afb138596db71515b19}{volume}}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_afae4ec18cf791a375b3e980762a3f2de}{vad}}
\item 
double \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_a77ac47c845208b82db145b01e91600b1}{voice\+Pitch}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The volume information of users. 

\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_a779bb6a02f5caba5ff1c29eb2f2f444d}\label{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_a779bb6a02f5caba5ff1c29eb2f2f444d}} 
\index{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}!uid@{uid}}
\index{uid@{uid}!io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}}
\doxysubsubsection{\texorpdfstring{uid}{uid}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+I\+Rtc\+Engine\+Event\+Handler.\+Audio\+Volume\+Info.\+uid}

The user ID.
\begin{DoxyItemize}
\item In the local user\textquotesingle{}s callback, {\ttfamily uid} is 0.
\item In the remote users\textquotesingle{} callback, {\ttfamily uid} is the user ID of a remote user whose instantaneous volume is the highest. 
\end{DoxyItemize}\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_af868ce7e3da25afb138596db71515b19}\label{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_af868ce7e3da25afb138596db71515b19}} 
\index{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}!volume@{volume}}
\index{volume@{volume}!io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}}
\doxysubsubsection{\texorpdfstring{volume}{volume}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+I\+Rtc\+Engine\+Event\+Handler.\+Audio\+Volume\+Info.\+volume}

The volume of the user. The value ranges between 0 (the lowest volume) and 255 (the highest volume). If the local user enables audio capturing and calls {\ttfamily mute\+Local\+Audio\+Stream} and set it as {\ttfamily true} to mute, the value of {\ttfamily volume} indicates the volume of locally captured audio signal. If the user calls {\ttfamily start\+Audio\+Mixing(String file\+Path, boolean loopback, int cycle, int start\+Pos)}, the value of {\ttfamily volume} indicates the volume after audio mixing. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_afae4ec18cf791a375b3e980762a3f2de}\label{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_afae4ec18cf791a375b3e980762a3f2de}} 
\index{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}!vad@{vad}}
\index{vad@{vad}!io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}}
\doxysubsubsection{\texorpdfstring{vad}{vad}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+I\+Rtc\+Engine\+Event\+Handler.\+Audio\+Volume\+Info.\+vad}

Voice activity status of the local user.
\begin{DoxyItemize}
\item 0\+: The local user is not speaking.
\item 1\+: The local user is speaking. \begin{DoxyNote}{Note}

\end{DoxyNote}

\item The {\ttfamily vad} parameter does not report the voice activity status of remote users. In a remote user\textquotesingle{}s callback, the value of {\ttfamily vad} is always 1.
\item To use this parameter, you must set {\ttfamily report\+Vad} to {\ttfamily true} when calling {\ttfamily enable\+Audio\+Volume\+Indication}. 
\end{DoxyItemize}\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_a77ac47c845208b82db145b01e91600b1}\label{classio_1_1agora_1_1rtc2_1_1_i_rtc_engine_event_handler_1_1_audio_volume_info_a77ac47c845208b82db145b01e91600b1}} 
\index{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}!voicePitch@{voicePitch}}
\index{voicePitch@{voicePitch}!io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo@{io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo}}
\doxysubsubsection{\texorpdfstring{voicePitch}{voicePitch}}
{\footnotesize\ttfamily double io.\+agora.\+rtc2.\+I\+Rtc\+Engine\+Event\+Handler.\+Audio\+Volume\+Info.\+voice\+Pitch}

The voice pitch of the local user. The value ranges between 0.\+0 and 4000.\+0. \begin{DoxyNote}{Note}
The {\ttfamily voice\+Pitch} parameter does not report the voice pitch of remote users. In the remote users\textquotesingle{} callback, the value of {\ttfamily voice\+Pitch} is always 0.\+0. 
\end{DoxyNote}
