Add documentation on fileType meaning

taglib · Dec 9, 2024 · 1f80099 · 1f80099
1 parent ef59074
commit 1f80099
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/taglib/shn/shnproperties.h b/taglib/shn/shnproperties.h
@@ -52,7 +52,13 @@ namespace TagLib {
 
       //! Returns the Shorten file version (1-3).
       int shortenVersion() const;
-      //! Returns the Shorten file type.
+      //! Returns the file type (0-9).
+      //! 0 = 8-bit µ-law,
+      //! 1 = signed 8-bit PCM, 2 = unsigned 8-bit PCM,
+      //! 3 = signed big-endian 16-bit PCM, 4 = unsigned big-endian 16-bit PCM,
+      //! 5 = signed little-endian 16-bit PCM, 6 = unsigned little-endian 16-bit PCM,
+      //! 7 = 8-bit ITU-T G.711 µ-law, 8 = 8-bit µ-law,
+      //! 9 = 8-bit A-law, 10 = 8-bit ITU-T G.711 A-law
       int fileType() const;
       int bitsPerSample() const;
       unsigned long sampleFrames() const;