Struct UpdateContext 

pub struct UpdateContext<'a> {
    pub node_id: NodeID,
    pub stream_info: Option<&'a StreamInfo>,
    /* private fields */
}

A context for AudioNode::update.

Fields

node_id: NodeID

The ID of this audio node.

stream_info: Option<&'a StreamInfo>

Information about the running audio stream. If no audio stream is running, then this will be None.

Implementations

impl<'a> UpdateContext<'a>

pub fn new( node_id: NodeID, stream_info: Option<&'a StreamInfo>, custom_state: &'a mut Option<Box<dyn Any>>, event_queue: &'a mut Vec<NodeEvent>, ) -> Self

pub fn queue_event(&mut self, event: NodeEventType)

Queue an event to send to this node’s processor counterpart.

pub fn schedule_event(&mut self, event: NodeEventType, time: EventInstant)

Queue an event to send to this node’s processor counterpart, at a certain time.

Performance

Note that for most nodes that handle scheduled events, this will split the buffer into chunks and process those chunks. If two events are scheduled too close to one another in time then that chunk may be too small for the audio processing to be fully vectorized.

pub fn custom_state<T: 'static>(&self) -> Option<&T>

Get an immutable reference to the custom state that was created in AudioNodeInfo::custom_state.

pub fn custom_state_mut<T: 'static>(&mut self) -> Option<&mut T>

Get a mutable reference to the custom state that was created in AudioNodeInfo::custom_state.