Struct PlayerChain 

pub struct PlayerChain {
    pub source_id: Symbol,
    pub source: Music,
    pub devices: Vec<ChainDevice>,
    pub target: PlayerTargetDescriptor,
}

A source music object plus an ordered chain of devices and an output target.

Fields

source_id: Symbol

Symbol identifying the source.

source: Music

Source music rendered at the head of the chain.

devices: Vec<ChainDevice>

Devices applied in order to the source events.

target: PlayerTargetDescriptor

Descriptor of the chain’s output target.

Implementations

impl PlayerChain

pub fn new( source_id: Symbol, source: Music, devices: Vec<ChainDevice>, target: PlayerTargetDescriptor, ) -> Self

Creates a chain from a source and its devices and target.

pub fn stable_devices(&self) -> Vec<&ChainDevice>

Returns the devices in stable order by order then id.

pub fn placement_plan(&self) -> ChainPlacementPlan

Builds the placement plan for the chain’s devices.

pub fn render_chain(&self, cx: &PlayContext) -> Result<ChainRender>

Renders the source through every active device into events and traces.

pub fn record_source(&self, cx: &PlayContext) -> SourceRecording

Records source metadata (hashes, seed, placement) without rendering output.

pub fn record_direct(&self, cx: &PlayContext) -> Result<DirectRecording>

Freezes the chain and captures it as a direct recording.

pub fn freeze_chain(&self, cx: &PlayContext) -> Result<FrozenPlayerChain>

Renders the chain and freezes it with metadata into a FrozenPlayerChain.

pub fn freeze_meta( &self, cx: &PlayContext, events: &[PlayEvent], traces: &[ChainTraceRecord], ) -> FreezeMeta

Builds freeze metadata for already-rendered events and traces.

pub fn chain_hash(&self) -> String

Returns a stable hash over the source id, devices, and target.

Trait Implementations

impl Clone for PlayerChain

fn clone(&self) -> PlayerChain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlayerChain

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

Formats the value using the given formatter.

impl Playable for PlayerChain

fn describe(&self) -> Result<PlayableDescriptor>

Returns the static descriptor for this playable.

fn render_range(&self, cx: &PlayContext) -> Result<PlayStream>

Renders the playable over the context’s time range into a stream.

fn freeze(&self, cx: &PlayContext) -> Result<FrozenPlayable>

Renders and captures the playable into a FrozenPlayable.

fn prepare(&mut self, _cx: &PlayContext) -> Result<()>

Prepares the playable for rendering under cx; defaults to a no-op.

fn render_preview(&self, cx: &PlayContext) -> Result<PlayStream>

Renders a preview stream; defaults to Playable::render_range.

fn as_shape(&self) -> PlayableShape

Returns the object shape; defaults to PlayableShape::music_object.