Struct Controller 

pub struct Controller { /* private fields */ }

One socket owner serializes all protocol requests and acknowledged transport changes.

Implementations

impl Controller

pub fn connect(&self, host: &str, port: u16) -> Result<Value, String>

Explicit non-mutating connection probe. Never opens during ordinary navigation.

pub fn validate_mapping(value: &Value) -> Result<(), String>

Validate mappings before attempting a connection or saving an active profile.

pub fn connected(&self) -> bool

Expose verified availability without making a discovery network request.

pub fn active(&self) -> bool

Route audio controls only after an explicit selection has been accepted.

pub fn halt(&self) -> Result<(), String>

Stop only this controller’s queue; unrelated HQPlayer playback is untouched.

pub fn clear(&self) -> Result<(), String>

Stop an owned selection and drop its retained metadata without disconnecting the output.

pub fn disconnect(&self) -> Result<(), String>

Remove the optional endpoint after stopping an owned queue.

pub fn prepare( client: &Client, tracks: Vec<String>, index: usize, mappings: &Value, current: impl Fn() -> bool, ) -> Result<Selection, String>

Prepare source-confined files without touching the external playlist; cancelled sessions stop retrieval.

pub fn start( &self, selection: Selection, current: impl Fn() -> bool, ) -> Result<(), String>

Publish only an authenticated selection, checking admission between protocol commands. An in-flight command may finish; cancellation prevents subsequent queue/Play commands.

pub fn snapshot(&self) -> Result<Value, String>

Read the engine’s actual track clock. Meter data and confirmed Aède history are unavailable.

pub fn control(&self, action: &str, value: Value) -> Result<Value, String>

Typed controls cannot transmit arbitrary XML or open an arbitrary media URL.

Trait Implementations

impl Default for Controller

fn default() -> Controller

Returns the “default value” for a type.