From bc270b506270a17fe830cc1a41426708fedcbdb6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= <gustav@sornas.net>
Date: Tue, 15 Jun 2021 13:21:37 +0200
Subject: doc trait audioinputdevice

---
 mumd/src/audio/input.rs | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'mumd/src/audio/input.rs')

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>;
-- 
cgit v1.2.1