Agora Web SDK API Reference

Overview AgoraRTC AgoraRTCClient LocalTrack RemoteTrack Error codes

Configurations for the audio track from an audio file or AudioBuffer object. Set these configurations when calling AgoraRTC.createBufferSourceAudioTrack.

Hierarchy

BufferSourceAudioTrackInitConfig

Index

Properties

Optional cacheOnlineFile

cacheOnlineFile: undefined | false | true

Whether to cache the online file:

true: Cache the online file.
false: (default) Do not cache the online file.

Optional encoderConfig

encoderConfig: AudioEncoderConfiguration | AudioEncoderConfigurationPreset

The audio encoder configurations.

You can set the audio encoder configurations in either of the following ways:

Pass the preset audio encoder configurations by using AudioEncoderConfigurationPreset.
Pass your customized audio encoder configurations by using AudioEncoderConfiguration.

Firefox does not support setting the audio encoding rate.

source

source: File | string | AudioBuffer

The type of the audio source:

File: An File object, representing a local audio file.
string: The online audio file retrieved from an HTTPS address. Ensure the address supports HTTPS and CORS.
AudioBuffer: An AudioBuffer object, representing the raw data in PCM format.