sponsor-block

Crates.iosponsor-block
lib.rssponsor-block
version0.6.1
sourcesrc
created_at2021-11-05 01:31:15.590104
updated_at2021-11-20 22:26:35.611585
descriptionA Rust wrapper for the SponsorBlock API.
homepagehttps://github.com/zedseven/sponsor-block-rs
repositoryhttps://github.com/zedseven/sponsor-block-rs
max_upload_size
id477135
size69,311
Zacchary Dempsey-Plante (zedseven)

documentation

README

sponsor-block

License: MIT/Apache-2.0 # Issues Crates.io Crate Downloads

A Rust wrapper for the SponsorBlock API, which you can find complete documentation for here.

Uses SponsorBlock data licensed under CC BY-NC-SA 4.0 from https://sponsor.ajay.app/. Please see the SponsorBlock Database and API License for more information.

This library is still missing many features of the full API, but it contains many segment-retrieval functions necessary for use of the service.

For library documentation, visit docs.rs.

Example

The following is a short example of how you might fetch the segments for a video:

use sponsor_block::{AcceptedCategories, Client};

// This should be random, treated like a password, and stored across sessions
const USER_ID: &str = "your local user id";

let client = Client::new(USER_ID);
let video_segments = client
    .fetch_segments("7U-RbOKanYs", AcceptedCategories::all())
    .await
    .ok();

// Then do something with your video segments...

Project License

This project is licensed under either of

at your option.

Contribution

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

Commit count: 55

cargo fmt