Skip to content

Commit d3b0785

Browse files
committed
updated comments
1 parent 70e3b27 commit d3b0785

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

src/cam/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,4 +144,4 @@ impl Webcam {
144144
pub fn release(&mut self) -> anyhow::Result<()> {
145145
Ok(self.0.release()?)
146146
}
147-
}
147+
}

src/lib.rs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,20 @@
99
//! A crate to make voip services easier to create.
1010
//! Silence-core provides core functions, helpers and type definitions for a voip service to work.
1111
//! If you just want a quick and easy way to set up a voip service, you should use [silence](https://crates.io/crates/silence) instead as it provides a more complete (end-user friendly) approach.
12+
//!
1213
//! This crate provides 2 main functionalities:
13-
//!
1414
//! * Type definitions:
1515
//! This crate provides Type definitions and traits in order to make the handling of packets easier.
16-
//!
16+
//!
1717
//! * APIs for performing audio I/O:
1818
//! The crate provides multiple ways to handle audio I/O on multiple platforms efficiently.
19-
//!
19+
//!
20+
//! * APIs for receiving image input:
21+
//! The crate provides ways to utilize the user's webcam to send images.
22+
//!
23+
//! * APIs for encoding in certain codecs:
24+
//! The crate provides ways to encode the raw auudio samples with [opus](https://opus-codec.org/). It also provides ways to encode raw images with the [AV1](https://en.wikipedia.org/wiki/AV1) codec.
25+
//!
2026
//! A complete version of the documentation is available at [here](https://docs.rs/silence-core/latest).
2127
//!
2228

src/tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ mod tests {
88
use cpal::traits::{DeviceTrait, StreamTrait};
99
use opus::Channels;
1010
use ravif::Encoder;
11-
use tokio::sync::oneshot;
1211

12+
use tokio::sync::oneshot;
1313
use crate::{
1414
avif::encoding::encode_raw_image,
1515
cam,

0 commit comments

Comments
 (0)