Package io.agora.rtc2.audio
Class AudioParams
java.lang.Object
io.agora.rtc2.audio.AudioParams
The `AudioParams` class.
You can pass the `AudioParams` object in the return value of the following callbacks to
set the audio data format for the corresponding callbacks:
-
getRecordAudioParams: Sets the audio recording
format for the onRecordFrame callback.
- getPlaybackAudioParams: Sets the audio
playback format for the onPlaybackFrame callback.
- getMixedAudioParams: Sets the audio mixing
format for the onMixedFrame callback.-
Field Summary
FieldsModifier and TypeFieldDescriptionintThe number of audio channels, which can be set as either of the following values: - `1`: Mono (Default) - `2`: StereointThe use mode of the audio data: -RAW_AUDIO_FRAME_OP_MODE_READ_ONLY(0): (Default) Read-only mode, in which users can only read theAudioFramewithout modifying anything.intThe audio sample rate (Hz), which can be set as one of the following values: - `8000` - `16000` (Default) - `32000` - `44100` - `48000`intThe number of samples. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
sampleRate
public int sampleRateThe audio sample rate (Hz), which can be set as one of the following values: - `8000` - `16000` (Default) - `32000` - `44100` - `48000` -
channel
public int channelThe number of audio channels, which can be set as either of the following values: - `1`: Mono (Default) - `2`: Stereo -
mode
public int modeThe use mode of the audio data: -RAW_AUDIO_FRAME_OP_MODE_READ_ONLY(0): (Default) Read-only mode, in which users can only read theAudioFramewithout modifying anything. For example, this mode applies when users acquire data with the Agora SDK and then push the RTMP or RTMPS streams. -RAW_AUDIO_FRAME_OP_MODE_READ_WRITE(2): Read and write mode, in which users read theAudioFrame, modify it, and then play it. For example, this mode applies when users have their own sound-effect processing module to pre-process the audio (such as a voice changer). -
samplesPerCall
public int samplesPerCallThe number of samples. For example, set it as 1024 for RTMP or RTMPS streaming.
-
-
Constructor Details
-
AudioParams
public AudioParams(int sampleRate, int channelCnt, int mode, int samplesPerCall)
-
-
Method Details