Skip to content

Commit e1e7cfd

Browse files
author
Artyom Astafurov
authored
Update AudioMetaData docstring with encoding values (#1324)
1 parent 3e5c353 commit e1e7cfd

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

torchaudio/backend/common.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,21 @@ class AudioMetaData:
1313
:ivar int num_channels: The number of channels
1414
:ivar int bits_per_sample: The number of bits per sample. This is 0 for lossy formats,
1515
or when it cannot be accurately inferred.
16-
:ivar str encoding: Audio encoding.
16+
:ivar str encoding: Audio encoding
17+
The values encoding can take are one of the following:
18+
19+
* ``PCM_S``: Signed integer linear PCM
20+
* ``PCM_U``: Unsigned integer linear PCM
21+
* ``PCM_F``: Floating point linear PCM
22+
* ``FLAC``: Flac, Free Lossless Audio Codec
23+
* ``ULAW``: Mu-law
24+
* ``ALAW``: A-law
25+
* ``MP3`` : MP3, MPEG-1 Audio Layer III
26+
* ``VORBIS``: OGG Vorbis
27+
* ``AMR_WB``: Adaptive Multi-Rate
28+
* ``AMR_NB``: Adaptive Multi-Rate Wideband
29+
* ``OPUS``: Opus
30+
* ``UNKNOWN`` : None of above
1731
"""
1832
def __init__(
1933
self,

0 commit comments

Comments
 (0)