Struct Playerctl 

pub struct Playerctl;

Playerctl

Playerctl wrapper struct allowing to send commands and control the player.

Examples

Stop the current player

Playerctl::stop().unwrap();

Advance and rewind 10 seconds

Playerctl::position(10.).unwrap();
Playerctl::position(-10.).unwrap();

Get metadata

let metadata = Playerctl::metadata().unwrap();

println!("Track title: {}", metadata.title);

Implementations

impl Playerctl

pub fn play() -> Result<()>

Command the player to play.

Playerctl::play().unwrap();

Examples found in repository

examples/basic.rs (line 5)

fn main() {
    // Command the player to play
    Playerctl::play().unwrap_or_default();

    // Command the player to pause
    Playerctl::pause().unwrap_or_default();

    // Command the player to toggle between play/pause
    Playerctl::play_pause().unwrap_or_default();

    // Command the player to seek forward/backward OFFSET in seconds
    Playerctl::position(10.).unwrap_or_default();

    // Get metadata information for the current track
    let metadata = Playerctl::metadata().unwrap_or_default();

    println!(
        "Title: {}\nAlbum: {}\nArtist: {}\nURL: {}\nLength: {}",
        metadata.title, metadata.album, metadata.artist, metadata.url, metadata.length
    )
}

pub fn pause() -> Result<()>

Command the player to pause.

Playerctl::pause().unwrap();

Examples found in repository

examples/basic.rs (line 8)

fn main() {
    // Command the player to play
    Playerctl::play().unwrap_or_default();

    // Command the player to pause
    Playerctl::pause().unwrap_or_default();

    // Command the player to toggle between play/pause
    Playerctl::play_pause().unwrap_or_default();

    // Command the player to seek forward/backward OFFSET in seconds
    Playerctl::position(10.).unwrap_or_default();

    // Get metadata information for the current track
    let metadata = Playerctl::metadata().unwrap_or_default();

    println!(
        "Title: {}\nAlbum: {}\nArtist: {}\nURL: {}\nLength: {}",
        metadata.title, metadata.album, metadata.artist, metadata.url, metadata.length
    )
}

pub fn play_pause() -> Result<()>

Command the player to toggle between play/pause.

Playerctl::play_pause().unwrap();

Examples found in repository

examples/basic.rs (line 11)

fn main() {
    // Command the player to play
    Playerctl::play().unwrap_or_default();

    // Command the player to pause
    Playerctl::pause().unwrap_or_default();

    // Command the player to toggle between play/pause
    Playerctl::play_pause().unwrap_or_default();

    // Command the player to seek forward/backward OFFSET in seconds
    Playerctl::position(10.).unwrap_or_default();

    // Get metadata information for the current track
    let metadata = Playerctl::metadata().unwrap_or_default();

    println!(
        "Title: {}\nAlbum: {}\nArtist: {}\nURL: {}\nLength: {}",
        metadata.title, metadata.album, metadata.artist, metadata.url, metadata.length
    )
}

pub fn stop() -> Result<()>

Command the player to stop.

Playerctl::stop().unwrap();

pub fn next() -> Result<()>

Command the player to skip to the next track.

Playerctl::next().unwrap();

pub fn previous() -> Result<()>

Command the player to skip to the previous track.

Playerctl::previous().unwrap();

pub fn position(secs: f32) -> Result<()>

Command the player to seek forward/backward OFFSET in seconds.

Playerctl::position(10.).unwrap();

Examples found in repository

examples/basic.rs (line 14)

fn main() {
    // Command the player to play
    Playerctl::play().unwrap_or_default();

    // Command the player to pause
    Playerctl::pause().unwrap_or_default();

    // Command the player to toggle between play/pause
    Playerctl::play_pause().unwrap_or_default();

    // Command the player to seek forward/backward OFFSET in seconds
    Playerctl::position(10.).unwrap_or_default();

    // Get metadata information for the current track
    let metadata = Playerctl::metadata().unwrap_or_default();

    println!(
        "Title: {}\nAlbum: {}\nArtist: {}\nURL: {}\nLength: {}",
        metadata.title, metadata.album, metadata.artist, metadata.url, metadata.length
    )
}

pub fn volume(percent: f32) -> Result<()>

Set the volume to LEVEL from 0.0 to 1.0.

Playerctl::volume(10.).unwrap();

pub fn status() -> Result<TrackStatus>

Get the play status of the player.

Playerctl::status(10.).unwrap();

pub fn metadata() -> Result<TrackMetadata>

Get metadata information for the current track.

let metadata = Playerctl::metadata().unwrap();

println!("Title: {}", metadata.title);

Examples found in repository

examples/basic.rs (line 17)

fn main() {
    // Command the player to play
    Playerctl::play().unwrap_or_default();

    // Command the player to pause
    Playerctl::pause().unwrap_or_default();

    // Command the player to toggle between play/pause
    Playerctl::play_pause().unwrap_or_default();

    // Command the player to seek forward/backward OFFSET in seconds
    Playerctl::position(10.).unwrap_or_default();

    // Get metadata information for the current track
    let metadata = Playerctl::metadata().unwrap_or_default();

    println!(
        "Title: {}\nAlbum: {}\nArtist: {}\nURL: {}\nLength: {}",
        metadata.title, metadata.album, metadata.artist, metadata.url, metadata.length
    )
}