Enum LanPlacementMode 

pub enum LanPlacementMode {
    JitterBuffered {
        jitter_packets: u32,
        latency_comp_frames: u64,
    },
    BarDelay {
        bars: u32,
        beats_per_bar: u32,
        tempo_bpm: u32,
        jitter_packets: u32,
        latency_comp_frames: u64,
    },
}

Placement mode for a stream fragment hosted on a LAN peer.

Selects how packets crossing the LAN are buffered and time-aligned: a plain jitter buffer for buffered preview, or a musically aligned bar delay for collaborative play.

Variants

JitterBuffered

Jitter-buffered preview placement.

Fields

jitter_packets: u32

Packets retained in the jitter buffer.

latency_comp_frames: u64

Latency-compensation delay applied, in frames.

BarDelay

Musically aligned collaborative placement delayed by whole bars.

Fields

bars: u32

Number of bars of alignment delay.

beats_per_bar: u32

Beats per bar used to size the bar delay.

tempo_bpm: u32

Tempo in beats per minute used to size the bar delay.

jitter_packets: u32

Packets retained in the jitter buffer.

latency_comp_frames: u64

Latency-compensation delay applied, in frames.

Implementations

impl LanPlacementMode

pub fn jitter_buffered( jitter_packets: u32, latency_comp_frames: u64, ) -> Result<Self>

Builds a jitter-buffered mode retaining jitter_packets packets.

Returns an evaluation error when jitter_packets is zero.

Examples

use sim_lib_stream_host::LanPlacementMode;

let mode = LanPlacementMode::jitter_buffered(4, 128).unwrap();
assert_eq!(mode.jitter_packets(), 4);
assert_eq!(mode.latency_comp_frames(), 128);
assert!(mode.bar_delay_millis().is_none());

pub fn bar_delay( bars: u32, tempo_bpm: u32, jitter_packets: u32, latency_comp_frames: u64, ) -> Result<Self>

Builds a bar-delay mode delaying bars bars at tempo_bpm.

Uses a default of four beats per bar. Returns an evaluation error when bars, tempo_bpm, or jitter_packets is zero.

pub fn symbol(self) -> Symbol

Returns the stable mode symbol.

pub fn latency_class(self) -> LatencyClass

Returns the latency class this mode places the fragment into.

pub fn jitter_packets(self) -> u32

Returns the number of packets retained in the jitter buffer.

pub fn latency_comp_frames(self) -> u64

Returns the latency-compensation delay in frames.

pub fn bar_delay_millis(self) -> Option<u64>

Returns the bar-delay length in milliseconds, or None for jitter-buffered placement.

pub fn transport_profile(self) -> Result<TransportProfile>

Returns the transport profile advertised for this mode.

Trait Implementations

impl Clone for LanPlacementMode

fn clone(&self) -> LanPlacementMode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LanPlacementMode

impl Debug for LanPlacementMode

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

Formats the value using the given formatter.

impl Eq for LanPlacementMode

impl PartialEq for LanPlacementMode

fn eq(&self, other: &LanPlacementMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LanPlacementMode