Skip to main content

SnapServer

Struct SnapServer 

Source
pub struct SnapServer { /* private fields */ }
Expand description

The embeddable Snapcast server.

Implementations§

Source§

impl SnapServer

Convert f32 samples to PCM bytes at the given bit depth.

Source

pub fn new(config: ServerConfig) -> (Self, Receiver<ServerEvent>)

Create a new server. Returns the server and event receiver.

Source

pub fn add_stream(&mut self, name: &str) -> Sender<AudioFrame>

Add a named audio stream. Returns a sender for pushing audio frames.

Uses the server’s default codec and sample format.

Source

pub fn add_f32_stream(&mut self, name: &str) -> Result<F32AudioSender, String>

Add a named F32 audio stream with automatic chunking and timestamping.

Returns an F32AudioSender that accepts variable-size F32 sample buffers and handles 20ms chunking, monotonic timestamps, and gap detection internally.

§Errors

Returns an error if the server’s sample_format cannot be parsed.

Source

pub fn add_stream_with_config( &mut self, name: &str, config: StreamConfig, ) -> Sender<AudioFrame>

Add a named audio stream with per-stream codec/format overrides.

Source

pub fn command_sender(&self) -> Sender<ServerCommand>

Get a cloneable command sender.

Source

pub fn config(&self) -> &ServerConfig

Access the server configuration.

Source

pub async fn run(&mut self) -> Result<()>

Run the server. Blocks until stopped or a fatal error occurs.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more