Struct sonos::Speaker

pub struct Speaker {
    pub ip: IpAddr,
    pub model: String,
    pub model_number: String,
    pub software_version: String,
    pub hardware_version: String,
    pub serial_number: String,
    pub name: String,
    pub uuid: String,
}

Fields

ip: IpAddr

model: String

model_number: String

software_version: String

hardware_version: String

serial_number: String

name: String

uuid: String

Methods

impl Speaker

pub fn from_ip(ip: IpAddr) -> Result<Speaker>

Create a new instance of this struct from an IP address

pub fn coordinator(&self) -> Result<IpAddr>

Get the coordinator for this speaker.

pub fn soap(
    &self,
    endpoint: &str,
    service: &str,
    action: &str,
    payload: &str,
    coordinator: bool
) -> Result<Element>

Call the Sonos SOAP endpoint

Arguments

• endpoint - The SOAP endpoint to call (eg. MediaRenderer/AVTransport/Control)
• service - The SOAP service to call (eg. urn:schemas-upnp-org:service:AVTransport:1)
• action - The action to call on the soap service (eg. Play)
• payload - XML doc to pass inside the action call body
• coordinator - Whether this SOAP call should be performed on the group coordinator or the speaker it was called on

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

Play the current track

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

Pause the current track

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

Stop the current queue

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

Skip the current track

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

Go to the previous track

pub fn seek(&self, time: &Duration) -> Result<()>

Seek to a time on the current track

pub fn play_queue_item(&self, track: &u64) -> Result<()>

Change the track, beginning at 1

pub fn remove_track(&self, track: &u64) -> Result<()>

Remove track at index from queue, beginning at 1

pub fn queue_track(&self, uri: &str) -> Result<()>

Add a new track to the end of the queue

pub fn queue_next(&self, uri: &str) -> Result<()>

Add a track to the queue to play next

pub fn play_track(&self, uri: &str) -> Result<()>

Replace the current track with a new one

pub fn clear_queue(&self) -> Result<()>

Remove every track from the queue

pub fn volume(&self) -> Result<u8>

Get the current volume

pub fn set_volume(&self, volume: u8) -> Result<()>

Set a new volume from 0-100.

pub fn muted(&self) -> Result<bool>

Check if this player is currently muted

pub fn mute(&self) -> Result<()>

Mute the current player

pub fn unmute(&self) -> Result<()>

Unmute the current player

pub fn transport_state(&self) -> Result<TransportState>

Get the transport state of the current player

pub fn track(&self) -> Result<Track>

Get information about the current track

Trait Implementations

impl Debug for Speaker

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.