\hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters}{}\doxysection{io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Audio\+Capture\+Parameters Class Reference}
\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters}\index{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}}


The audio configuration for the shared screen stream.  


\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a63721a2c23b78dbcf60fceb1900f6950}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a63721a2c23b78dbcf60fceb1900f6950}} 
int {\bfseries get\+Sample\+Rate} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a56c12b1225dc3d744d499505df476e21}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a56c12b1225dc3d744d499505df476e21}} 
int {\bfseries get\+Channels} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a2840a19a60d9b8a91e86caac80db1c8c}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a2840a19a60d9b8a91e86caac80db1c8c}} 
int {\bfseries get\+Capture\+Signal\+Volume} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_aebf4e746e072ee3d463b001256d596ca}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_aebf4e746e072ee3d463b001256d596ca}} 
String {\bfseries to\+String} ()
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a11cb0d9c3b6725b65207c7cc49d59bf9}{sample\+Rate}} = 16000
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_aef5ac04ed26a431ee339a04710b82a4c}{channels}} = 2
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a6af25d17794e2a2d473d65479d34d501}{capture\+Signal\+Volume}} = 100
\item 
boolean \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_ae6b8d0829f8fd705322f6ab423a77d59}{allow\+Capture\+Current\+App}} = true
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The audio configuration for the shared screen stream. 

\begin{DoxySince}{Since}
v3.\+7.\+0
\end{DoxySince}
Only available where {\ttfamily capture\+Audio} is {\ttfamily true}. 

\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a11cb0d9c3b6725b65207c7cc49d59bf9}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a11cb0d9c3b6725b65207c7cc49d59bf9}} 
\index{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}!sampleRate@{sampleRate}}
\index{sampleRate@{sampleRate}!io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}}
\doxysubsubsection{\texorpdfstring{sampleRate}{sampleRate}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Audio\+Capture\+Parameters.\+sample\+Rate = 16000}

Audio sample rate (Hz). The default value is 16000. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_aef5ac04ed26a431ee339a04710b82a4c}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_aef5ac04ed26a431ee339a04710b82a4c}} 
\index{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}!channels@{channels}}
\index{channels@{channels}!io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}}
\doxysubsubsection{\texorpdfstring{channels}{channels}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Audio\+Capture\+Parameters.\+channels = 2}

The number of audio channels. The default value is 2, which means stereo. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a6af25d17794e2a2d473d65479d34d501}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_a6af25d17794e2a2d473d65479d34d501}} 
\index{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}!captureSignalVolume@{captureSignalVolume}}
\index{captureSignalVolume@{captureSignalVolume}!io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}}
\doxysubsubsection{\texorpdfstring{captureSignalVolume}{captureSignalVolume}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Audio\+Capture\+Parameters.\+capture\+Signal\+Volume = 100}

The volume of the captured system audio. The value range is \mbox{[}0, 100\mbox{]}. The default value is 100. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_ae6b8d0829f8fd705322f6ab423a77d59}\label{classio_1_1agora_1_1rtc2_1_1_screen_capture_parameters_1_1_audio_capture_parameters_ae6b8d0829f8fd705322f6ab423a77d59}} 
\index{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}!allowCaptureCurrentApp@{allowCaptureCurrentApp}}
\index{allowCaptureCurrentApp@{allowCaptureCurrentApp}!io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters@{io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters}}
\doxysubsubsection{\texorpdfstring{allowCaptureCurrentApp}{allowCaptureCurrentApp}}
{\footnotesize\ttfamily boolean io.\+agora.\+rtc2.\+Screen\+Capture\+Parameters.\+Audio\+Capture\+Parameters.\+allow\+Capture\+Current\+App = true}

Whether to capture audio from the current app\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: (Default) Caputre audio from the current app.
\item {\ttfamily false}Do not capture the audio from the current app\+: \begin{DoxyNote}{Note}
This parameter can only set whether to capture audio from the current app and cannot control whether the captured app audio is published to the channel. You need to set it through the {\ttfamily options} parameter when calling {\ttfamily join\+Channel(\+String token, String channel\+Id, int uid, Channel\+Media\+Options options)} or {\ttfamily update\+Channel\+Media\+Options}. 
\end{DoxyNote}

\end{DoxyItemize}