Skip to content

Commit b4a89e4

Browse files
committed
Clarify docs for Block::time()
1 parent f04d8be commit b4a89e4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/frame.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,11 @@ impl Block {
421421
}
422422
}
423423

424-
/// Returns the sample number of the first sample in the block.
424+
/// Returns the inter-channel sample number of the first sample in the block.
425+
///
426+
/// The time is independent of the number of channels. To get the start time
427+
/// of the block in seconds, divide this number by the sample rate in the
428+
/// streaminfo.
425429
pub fn time(&self) -> u64 {
426430
self.first_sample_number
427431
}

0 commit comments

Comments
 (0)