Enum knyst::modal_interface::UnifiedKnystCommands

pub enum UnifiedKnystCommands {
    Real(Rc<RefCell<MultiThreadedKnystCommands>>),
    Dummy(DummyKnystCommands),
}

Represents and possible implementor of KnystCommands

Variants

Real(Rc<RefCell<MultiThreadedKnystCommands>>)

Dummy(DummyKnystCommands)

Trait Implementations

impl KnystCommands for UnifiedKnystCommands

fn push_without_inputs(&mut self, gen_or_graph: impl GenOrGraph) -> NodeId

Push a Gen or Graph to the top level Graph without specifying any inputs.

fn push( &mut self, gen_or_graph: impl GenOrGraph, inputs: impl Into<InputBundle> ) -> NodeId

Push a Gen or Graph to the default Graph.

fn push_to_graph_without_inputs( &mut self, gen_or_graph: impl GenOrGraph, graph_id: GraphId ) -> NodeId

Push a Gen or Graph to the Graph with the specified id without specifying inputs.

fn push_to_graph( &mut self, gen_or_graph: impl GenOrGraph, graph_id: GraphId, inputs: impl Into<InputBundle> ) -> NodeId

Push a Gen or Graph to the Graph with the specified id.

fn connect(&mut self, connection: Connection)

Create a new connections

fn connect_bundle(&mut self, bundle: impl Into<ConnectionBundle>)

Make several connections at once using any of the ConnectionBundle notations

fn schedule_beat_callback( &mut self, callback: impl FnMut(Beats, &mut MultiThreadedKnystCommands) -> Option<Beats> + Send + 'static, start_time: StartBeat ) -> CallbackHandle

Add a new beat callback. See BeatCallback for documentation.

fn disconnect(&mut self, connection: Connection)

Disconnect (undo) a Connection

fn free_disconnected_nodes(&mut self)

Free any nodes that are not currently connected to the graph’s outputs via any chain of connections.

fn free_node_mend_connections(&mut self, node: NodeId)

Free a node and try to mend connections between the inputs and the outputs of the node.

fn free_node(&mut self, node: NodeId)

Free a node.

fn schedule_change(&mut self, change: ParameterChange)

Schedule a change to be made.

fn schedule_changes(&mut self, changes: SimultaneousChanges)

Schedule multiple changes to be made.

fn insert_buffer(&mut self, buffer: Buffer) -> BufferId

Inserts a new buffer in the Resources and returns an id which can be converted to a key on the audio thread with access to a Resources.

fn remove_buffer(&mut self, buffer_id: BufferId)

Remove a buffer from the Resources

fn replace_buffer(&mut self, buffer_id: BufferId, buffer: Buffer)

Replace a buffer in the Resources

fn insert_wavetable(&mut self, wavetable: Wavetable) -> WavetableId

Inserts a new wavetable in the Resources and returns an id which can be converted to a key on the audio thread with access to a Resources.

fn remove_wavetable(&mut self, wavetable_id: WavetableId)

Remove a wavetable from the Resources

fn replace_wavetable(&mut self, id: WavetableId, wavetable: Wavetable)

Replace a wavetable in the Resources

fn change_musical_time_map( &mut self, change_fn: impl FnOnce(&mut MusicalTimeMap) + Send + 'static )

Make a change to the shared MusicalTimeMap

fn default_graph_settings(&self) -> GraphSettings

Return the GraphSettings of the top level graph. This means you don’t have to manually keep track of matching sample rate and block size for example.

fn init_local_graph(&mut self, settings: GraphSettings) -> GraphId

Creates a new local graph and sets it as the default graph

fn upload_local_graph(&mut self) -> Option<Handle<GraphHandle>>

Upload the local graph to the previously default graph and restore the default graph to that previous default graph.

fn request_inspection(&mut self) -> Receiver<GraphInspection>

Request a GraphInspection of the top level graph which will be sent back in the returned channel

fn to_graph(&mut self, graph_id: GraphId)

Set knyst commands on the current thread to use the selected GraphId by default

fn to_top_level_graph(&mut self)

Set knyst commands on the current thread to use the top level GraphId by default

fn start_scheduling_bundle(&mut self, time: Time)

Start a scheduling bundle, meaning any change scheduled will not be applied until KnystCommands::upload_scheduling_bundle is called. Prefer using schedule_bundle as it is more difficult to misuse.

fn upload_scheduling_bundle(&mut self)

Uploads scheduled changes to the graph and schedules them for the time specified in KnystCommands::start_scheduling_bundle. Prefer schedule_bundle to help reinforce scoping and potential thread switches.

fn current_graph(&self) -> GraphId

Get the id of the currently active graph

fn set_mortality(&mut self, node: NodeId, is_mortal: bool)

Sets the mortality of a node to mortal (true) or immortal (false). An immortal node cannot be freed.