Add some documentation.

kyutai-labs · Aug 19, 2024 · 039ee9f · 039ee9f
1 parent 0797422
commit 039ee9f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/py_src/sphn/__init__.pyi b/py_src/sphn/__init__.pyi
@@ -22,6 +22,15 @@ def read(filename, start_sec=None, duration_sec=None, sample_rate=None):
     """
     pass
 
+@staticmethod
+def read_opus(filename):
+    """
+    Reads the whole content of an ogg/opus encoded file.
+
+    This returns a two dimensional array as well as the sample rate.
+    """
+    pass
+
 @staticmethod
 def write_wav(filename, data, sample_rate):
     """

diff --git a/src/lib.rs b/src/lib.rs
@@ -186,6 +186,9 @@ fn write_wav(
     Ok(())
 }
 
+/// Reads the whole content of an ogg/opus encoded file.
+///
+/// This returns a two dimensional array as well as the sample rate.
 #[pyfunction]
 #[pyo3(signature = (filename))]
 fn read_opus(filename: std::path::PathBuf, py: Python) -> PyResult<(PyObject, u32)> {