as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support

AudioFormat

Name

provides setters to set different properties which can be used to query for a specific audio codec which satisfies all the properties set.

Constructors

new AudioFormat()

new AudioFormat(): AudioFormat

Returns

AudioFormat

Accessors

channelCount

Get Signature

get channelCount(): number

Returns

number

Channel count as

Set Signature

set channelCount(count): void

The number of channels in the audio signal.

Example: 1(mono), 2(stereo), 3(2.1), 5(4.1), 6(5.1), 8(7.1) etc.

Parameters
count

number

Returns

void


sampleFormat

Get Signature

get sampleFormat(): AudioSampleFormat

Returns

AudioSampleFormat

set by setter.

Set Signature

set sampleFormat(format): void

Sets the raw sample format, the supported values are defined in

See

AudioSampleFormat

Parameters
format

AudioSampleFormat

Returns

void


sampleRate

Get Signature

get sampleRate(): number

Returns

number

Sample rate in Hz as

Set Signature

set sampleRate(rate): void

The number of audio samples taken per second (in Hz).

Parameters
rate

number

Returns

void


Last updated: Sep 30, 2025