Skip to main content

PlayContext

Struct PlayContext 

Source
pub struct PlayContext {
    pub transport: Symbol,
    pub tempo: TempoMapRef,
    pub sample_rate: u32,
    pub ppq: u32,
    pub range: TimeRange,
    pub seed: u64,
    pub capabilities: Vec<String>,
    pub site: SiteHint,
    pub upstream: Vec<PlayEvent>,
}
Expand description

Rendering context handed to a Playable during prepare/render/freeze.

Carries the transport identity, tempo map, clock resolution, time window, and any upstream events that a render run depends on.

Fields§

§transport: Symbol

Symbol identifying the transport that drives this render.

§tempo: TempoMapRef

Reference to the tempo map used to relate musical and wall-clock time.

§sample_rate: u32

Audio sample rate in hertz.

§ppq: u32

Pulses (ticks) per quarter note for tick-domain conversion.

§range: TimeRange

Time window the render is clipped to.

§seed: u64

Deterministic seed for any randomized rendering.

§capabilities: Vec<String>

Capability tokens the render site advertises.

§site: SiteHint

Hint describing where the render is expected to execute.

§upstream: Vec<PlayEvent>

Events fed in from upstream stages of a chain.

Implementations§

Source§

impl PlayContext

Source

pub fn new(range: TimeRange) -> Self

Creates a context over range with offline transport defaults.

Source

pub fn stream_metadata( &self, id: Symbol, item_count: usize, ) -> Result<StreamMetadata>

Builds stream metadata for a source stream of item_count data items.

Trait Implementations§

Source§

impl Clone for PlayContext

Source§

fn clone(&self) -> PlayContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PlayContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PlayContext

Source§

impl PartialEq for PlayContext

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PlayContext

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.