Documentation

This commit is contained in:
Jamie Hardt
2021-01-01 11:59:28 -08:00
parent dfaf55955d
commit 1f56e0f380

View File

@@ -303,11 +303,13 @@ impl<W> WaveWriter<W> where W: Write + Seek {
Ok( AudioFrameWriter::new(inner) ) Ok( AudioFrameWriter::new(inner) )
} }
/// Open a wave chunk writer here
fn chunk(mut self, ident: FourCC) -> Result<WaveChunkWriter<W>,Error> { fn chunk(mut self, ident: FourCC) -> Result<WaveChunkWriter<W>,Error> {
self.inner.seek(SeekFrom::End(0))?; self.inner.seek(SeekFrom::End(0))?;
WaveChunkWriter::begin(self, ident) WaveChunkWriter::begin(self, ident)
} }
/// Upgrade this file to RF64
fn promote_to_rf64(&mut self) -> Result<(), std::io::Error> { fn promote_to_rf64(&mut self) -> Result<(), std::io::Error> {
if !self.is_rf64 { if !self.is_rf64 {
self.inner.seek(SeekFrom::Start(0))?; self.inner.seek(SeekFrom::Start(0))?;
@@ -323,6 +325,7 @@ impl<W> WaveWriter<W> where W: Write + Seek {
Ok(()) Ok(())
} }
/// Add `amount` to the RIFF/RF64 form length
fn increment_form_length(&mut self, amount: u64) -> Result<(), std::io::Error> { fn increment_form_length(&mut self, amount: u64) -> Result<(), std::io::Error> {
self.form_length = self.form_length + amount; self.form_length = self.form_length + amount;
if self.is_rf64 { if self.is_rf64 {