kenku_control

Crates.iokenku_control
lib.rskenku_control
version0.2.3
sourcesrc
created_at2023-09-26 11:38:30.186303
updated_at2024-05-18 16:09:39.189124
descriptionA library for manage Kenku FM using Kenku Remote
homepage
repositoryhttps://github.com/Lucas-BRT/kenku_control
max_upload_size
id983545
size56,648
(Lucas-BRT)

documentation

https://docs.rs/kenku_control/0.1.0/kenku_control/

README

Kenku Control

License

Kenku Control is a library for controlling Kenku FM. It provides a set of functions and utilities to interact with the Kenku Remote.

Features

  • Retrieve information about all tracks and sounds available on your Kenku FM device.
  • Control playback of tracks and sounds.
  • Manage playlist playback using straightforward commands.

Usage

To use Kenku Control in your Rust project, add the following to your Cargo.toml file:

[dependencies]
kenku_control = "0.2.3"

Alternatively, you can use cargo add to automatically manage dependencies:

cargo add kenku_control

Here's an example demonstrating how to interact with Kenku in your Rust code:

use kenku_control::Controller;

#[tokio::main]
async fn main() {
    let controller = Controler::new("127.0.0.1".to_string(), 3333);

    let soundboards = controller
        .get_soundboard()
        .await
        .expect("failed to get kenku soundboards");
    // play all sounds in your soundboards
    for sound in soundboards.sounds {
        sound.play(&controller).await.unwrap();
    };
}

Make sure you have a Kenku Remote Online in your computer before running the code.

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Commit count: 79

cargo fmt