Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioRecordingConfiguration

Recording configuration, which is set in startAudioRecordingWithConfig.

Hierarchy

  • AudioRecordingConfiguration

Index

Constructors

Properties

Constructors

constructor

Properties

filePath

filePath: string

The absolute path (including the filename extensions) of the recording file. For example:

  • On Android: /sdcard/emulated/0/audio.aac.
  • On iOS: /var/mobile/Containers/Data/audio.aac.

Note Ensure that the path you specify exists and is writable.

Optional recordingChannel

recordingChannel: undefined | number

The recorded audio channel. The following values are supported:

  • 1: (Default) Mono channel.
  • 2: Dual channel.
since

v3.6.2

Optional recordingPosition

recordingPosition: AudioRecordingPosition

Recording content. See AudioRecordingPosition.

Optional recordingQuality

recordingQuality: AudioRecordingQuality

Audio recording quality. See AudioRecordingQuality.

Note This parameter applies to AAC files only.

Optional recordingSampleRate

recordingSampleRate: AudioSampleRateType

Recording sample rate (Hz). The following values are supported:

  • 16000
  • (Default) 32000
  • 44100
  • 48000

Note If this parameter is set to 44100 or 48000, for better recording effects, Agora recommends recording WAV files or AAC files whose recordingQuality is Medium or High.

Generated using TypeDoc