\hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone}{}\doxysection{io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone Class Reference}
\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone}\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}


Sound insulation area settings.  


\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a7603b0f29065c2803258021f5550d699}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a7603b0f29065c2803258021f5550d699}} 
float\mbox{[}$\,$\mbox{]} {\bfseries get\+Position} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a63632bebf034198ee39ce22a042dff80}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a63632bebf034198ee39ce22a042dff80}} 
float\mbox{[}$\,$\mbox{]} {\bfseries get\+Forward} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a6b15f76e4d3951fcca86c2d3a21cc971}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a6b15f76e4d3951fcca86c2d3a21cc971}} 
float\mbox{[}$\,$\mbox{]} {\bfseries get\+Right} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_ab3886e26b335b9a82ae9e184503d3316}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_ab3886e26b335b9a82ae9e184503d3316}} 
float\mbox{[}$\,$\mbox{]} {\bfseries get\+Up} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a626547ecf277b719f95e3f90ab3b05b5}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a626547ecf277b719f95e3f90ab3b05b5}} 
int {\bfseries get\+Zone\+Set\+Id} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_aa0fce8f027522477ef2a2ffc1562bf6c}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_aa0fce8f027522477ef2a2ffc1562bf6c}} 
float {\bfseries get\+Forward\+Length} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a4451b4a2bf693d3abeb0fbe6e33212e9}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a4451b4a2bf693d3abeb0fbe6e33212e9}} 
float {\bfseries get\+Right\+Length} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_ad13a5ff5fdefa6c99953e637c742e343}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_ad13a5ff5fdefa6c99953e637c742e343}} 
float {\bfseries get\+Up\+Length} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a24236499ccdcf4f1d40d17f3c68301cd}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a24236499ccdcf4f1d40d17f3c68301cd}} 
float {\bfseries get\+Audio\+Attenuation} ()
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a095cea4153160255240f9d8cb9676ac2}{zone\+Set\+Id}}
\item 
float\mbox{[}$\,$\mbox{]} \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a53fe1918e8e0bf2f55556027113bf865}{position}}
\item 
float\mbox{[}$\,$\mbox{]} \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a6206816009b672deaf8bb64b6dded58a}{forward}}
\item 
float\mbox{[}$\,$\mbox{]} \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a3338bdd813862452fb027b06cabe1af1}{right}}
\item 
float\mbox{[}$\,$\mbox{]} \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a797d1ee610c8fbacc8bae77522851095}{up}}
\item 
float \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a8650a949a5a34e5151c30ab6af5d22ed}{forward\+Length}}
\item 
float \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_ac598bc6da94d624198ec11910bef0c9c}{right\+Length}}
\item 
float \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a24fe25d75a48685f8aa0561ef3d4af85}{up\+Length}}
\item 
float \mbox{\hyperlink{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_adde7c3dab2416bfa1d3921bf7d7511e2}{audio\+Attenuation}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Sound insulation area settings. 

\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a095cea4153160255240f9d8cb9676ac2}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a095cea4153160255240f9d8cb9676ac2}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!zoneSetId@{zoneSetId}}
\index{zoneSetId@{zoneSetId}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{zoneSetId}{zoneSetId}}
{\footnotesize\ttfamily int io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+zone\+Set\+Id}

The ID of the sound insulation area. \mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a53fe1918e8e0bf2f55556027113bf865}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a53fe1918e8e0bf2f55556027113bf865}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!position@{position}}
\index{position@{position}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{position}{position}}
{\footnotesize\ttfamily float \mbox{[}$\,$\mbox{]} io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+position}

The spatial center point of the sound insulation area. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn. \mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a6206816009b672deaf8bb64b6dded58a}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a6206816009b672deaf8bb64b6dded58a}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!forward@{forward}}
\index{forward@{forward}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{forward}{forward}}
{\footnotesize\ttfamily float \mbox{[}$\,$\mbox{]} io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+forward}

Starting at {\ttfamily position}, the forward unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn. \mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a3338bdd813862452fb027b06cabe1af1}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a3338bdd813862452fb027b06cabe1af1}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!right@{right}}
\index{right@{right}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{right}{right}}
{\footnotesize\ttfamily float \mbox{[}$\,$\mbox{]} io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+right}

Starting at {\ttfamily position}, the right unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn. \mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a797d1ee610c8fbacc8bae77522851095}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a797d1ee610c8fbacc8bae77522851095}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!up@{up}}
\index{up@{up}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{up}{up}}
{\footnotesize\ttfamily float \mbox{[}$\,$\mbox{]} io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+up}

Starting at {\ttfamily position}, the up unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn. \mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a8650a949a5a34e5151c30ab6af5d22ed}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a8650a949a5a34e5151c30ab6af5d22ed}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!forwardLength@{forwardLength}}
\index{forwardLength@{forwardLength}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{forwardLength}{forwardLength}}
{\footnotesize\ttfamily float io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+forward\+Length}

The entire sound insulation area is regarded as a cube; this represents the length of the forward side in the unit length of the game engine. \mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_ac598bc6da94d624198ec11910bef0c9c}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_ac598bc6da94d624198ec11910bef0c9c}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!rightLength@{rightLength}}
\index{rightLength@{rightLength}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{rightLength}{rightLength}}
{\footnotesize\ttfamily float io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+right\+Length}

The entire sound insulation area is regarded as a cube; this represents the length of the right side in the unit length of the game engine. \mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a24fe25d75a48685f8aa0561ef3d4af85}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_a24fe25d75a48685f8aa0561ef3d4af85}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!upLength@{upLength}}
\index{upLength@{upLength}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{upLength}{upLength}}
{\footnotesize\ttfamily float io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+up\+Length}

The entire sound insulation area is regarded as a cube; this represents the length of the up side in the unit length of the game engine. \mbox{\Hypertarget{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_adde7c3dab2416bfa1d3921bf7d7511e2}\label{classio_1_1agora_1_1spatialaudio_1_1_spatial_audio_zone_adde7c3dab2416bfa1d3921bf7d7511e2}} 
\index{io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}!audioAttenuation@{audioAttenuation}}
\index{audioAttenuation@{audioAttenuation}!io.agora.spatialaudio.SpatialAudioZone@{io.agora.spatialaudio.SpatialAudioZone}}
\doxysubsubsection{\texorpdfstring{audioAttenuation}{audioAttenuation}}
{\footnotesize\ttfamily float io.\+agora.\+spatialaudio.\+Spatial\+Audio\+Zone.\+audio\+Attenuation}

The sound attenuation coefficient when users within the sound insulation area communicate with external users. The value range is \mbox{[}0,1\mbox{]}. The values are as follows\+:
\begin{DoxyItemize}
\item 0\+: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.
\item (0,0.\+5)\+: Weak attenuation mode, that is, the volume and timbre are only weakly attenuated during the propagation process, and the sound can travel farther than the real environment.
\item 0.\+5\+: (Default) simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the {\ttfamily audio\+Attenuation} parameter.
\item (0.\+5,1\mbox{]}\+: Strong attenuation mode (default value is 1), that is, the volume and timbre attenuate rapidly during propagation. 
\end{DoxyItemize}