Skip to content

zedseven/sponsor-block-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sponsor-block

License: MIT/Apache-2.0 Integrity Check # 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::{AcceptedActions, 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(), AcceptedActions::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.