Skip to main content

AudioRecorderConfiguration

Recording configuration.

Properties

  • android_configuration - Android specific configuration.
  • auto_gain - The recorder will try to auto adjust recording volume in a limited range (if available on the device).
  • bit_rate - The audio encoding bit rate in bits per second if applicable.
  • cancel_echo - The recorder will try to reduce echo (if available on the device).
  • channels - The numbers of channels for the recording.
  • device - The device to be used for recording.
  • encoder - The requested output format through this given encoder.
  • ios_configuration - iOS specific configuration.
  • sample_rate - The sample rate for audio in samples per second if applicable.
  • suppress_noise - The recorder will try to negate the input noise (if available on the device).

Properties​

android_configurationclass-attributeinstance-attribute​

android_configuration: AndroidRecorderConfiguration = field(
    default_factory=lambda: AndroidRecorderConfiguration()
)

Android specific configuration.

auto_gainclass-attributeinstance-attribute​

auto_gain: bool = False

The recorder will try to auto adjust recording volume in a limited range (if available on the device).

Recording volume may be lowered by using this.

bit_rateclass-attributeinstance-attribute​

bit_rate: Number = 128000

The audio encoding bit rate in bits per second if applicable.

cancel_echoclass-attributeinstance-attribute​

cancel_echo: bool = False

The recorder will try to reduce echo (if available on the device).

Recording volume may be lowered by using this.

channelsclass-attributeinstance-attribute​

channels: int = 2

The numbers of channels for the recording.

  • 1 for mono
  • 2 for stereo

Most platforms only accept at most 2 channels.

deviceclass-attributeinstance-attribute​

device: InputDevice | None = None

The device to be used for recording.

If None, default device will be selected.

encoderclass-attributeinstance-attribute​

encoder: AudioEncoder = AudioEncoder.WAV

The requested output format through this given encoder.

ios_configurationclass-attributeinstance-attribute​

ios_configuration: IosRecorderConfiguration = field(
    default_factory=lambda: IosRecorderConfiguration()
)

iOS specific configuration.

sample_rateclass-attributeinstance-attribute​

sample_rate: int = 44100

The sample rate for audio in samples per second if applicable.

suppress_noiseclass-attributeinstance-attribute​

suppress_noise: bool = False

The recorder will try to negate the input noise (if available on the device).

Recording volume may be lowered by using this.