From 883b6c73e83b781feaef523f41b17b1077690234 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Mon, 23 Nov 2020 22:56:46 -0800 Subject: [PATCH] Documentation --- src/fmt.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/fmt.rs b/src/fmt.rs index 8ffbd58..2c812c6 100644 --- a/src/fmt.rs +++ b/src/fmt.rs @@ -197,10 +197,15 @@ impl WaveFmt { } } + /// Format or codec of the file's audio data. + /// + /// The `CommonFormat` unifies the format tag and the format extension GUID. Use this + /// method to determine the codec. pub fn common_format(&self) -> CommonFormat { CommonFormat::make( self.tag, self.extended_format.map(|ext| ext.type_guid)) } + /// Channel descriptors for each channel. pub fn channels(&self) -> Vec { match self.channel_count { 1 => vec![