Agora Java API Reference for Android

Public Member Functions | Public Attributes | List of all members
io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters Class Reference

The audio configuration for the shared screen stream. More...

## Public Member Functions
int | getSampleRate ()
int | getChannels ()
int | getCaptureSignalVolume ()
String | toString ()

## Public Attributes
int | sampleRate = 16000
int | channels = 2
int | captureSignalVolume = 100
boolean | allowCaptureCurrentApp = true

## Detailed Description

The audio configuration for the shared screen stream.

Since
  v3.7.0

Only available where `captureAudio` is `true`.

## Member Data Documentation

## ◆ sampleRate

int io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters.sampleRate = 16000

Audio sample rate (Hz). The default value is 16000.

## ◆ channels

int io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters.channels = 2

The number of audio channels. The default value is 2, which means stereo.

## ◆ captureSignalVolume

int io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters.captureSignalVolume = 100

The volume of the captured system audio. The value range is [0, 100]. The default value is 100.

## ◆ allowCaptureCurrentApp

boolean io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters.allowCaptureCurrentApp = true

Whether to capture audio from the current app:

- `true`: (Default) Caputre audio from the current app.
- `false`Do not capture the audio from the current app:
  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 `options` parameter when calling `joinChannel(String token, String channelId, int uid, ChannelMediaOptions options)` or `updateChannelMediaOptions`.