aboutsummaryrefslogtreecommitdiffstats
path: root/mumd/src/audio
diff options
context:
space:
mode:
authorGustav Sörnäs <gustav@sornas.net>2021-06-15 13:21:37 +0200
committerGustav Sörnäs <gustav@sornas.net>2021-06-15 13:21:37 +0200
commitbc270b506270a17fe830cc1a41426708fedcbdb6 (patch)
treee31f2642698f7873784a2c741d87646bf84e6c79 /mumd/src/audio
parent988ac16195e24c71ba17c4103448addb299c58bf (diff)
downloadmum-bc270b506270a17fe830cc1a41426708fedcbdb6.tar.gz
doc trait audioinputdevice
Diffstat (limited to 'mumd/src/audio')
-rw-r--r--mumd/src/audio/input.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/mumd/src/audio/input.rs b/mumd/src/audio/input.rs
index 10aea91..5721996 100644
--- a/mumd/src/audio/input.rs
+++ b/mumd/src/audio/input.rs
@@ -45,6 +45,9 @@ pub fn callback<T: Sample>(
}
}
+/// Something that can listen to audio and send it somewhere.
+///
+/// One sample is assumed to be an encoded opus frame. See [opus::Encoder].
pub trait AudioInputDevice {
/// Starts the device.
fn play(&self) -> Result<(), AudioError>;