rodio/README.md
UnknownSuperficialNight d57e410ca7 Add Contributing guide and Integration Test guidelines
- Link to CONTRIBUTING.md in project root
- New Integration Tests section:
  - Avoid sound output in tests
  - Tips for testing audio sources
  - Suggest examples for audible features
  - Note challenges in automated audio testing
2024-10-05 15:06:27 +13:00

2.1 KiB

Audio playback library

Crates.io Version Crates.io Downloads Build Status

Rust playback library.

Playback is handled by cpal. Format decoding can be handled either by Symphonia, or by format-specific decoders:

See the docs for more details on backends.

Documentation

The documentation contains an introduction to the library.

Dependencies(Linux only)

Rodio uses cpal to send audio to the OS for playback. On Linux cpal needs the ALSA development files. These are provided as part of the libasound2-dev package on Debian and Ubuntu distributions and alsa-lib-devel on Fedora.

Contributing

For information on how to contribute to this project, please see our Contributing Guide.

License

Licensed under either of

at your option.

License of your contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.