Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::format::ProcessorNodeInstance Class Referencefinal

Retained, self-contained lifetime for an authored in-process graph node. More...

#include <processor_node_adapter.hpp>

Public Member Functions

 ~ProcessorNodeInstance ()
 ProcessorNodeInstance (const ProcessorNodeInstance &)=delete
ProcessorNodeInstance & operator= (const ProcessorNodeInstance &)=delete
bool prepare (const PrepareContext &context) noexcept
bool release () noexcept
void set_audio_input_provider (AudioInputBusProvider provider) noexcept
GraphRuntimeNodeBinding binding (graph::NodeId node_id, bool required=true) noexcept
const PluginDescriptor & descriptor () const noexcept
int graph_type_version () const noexcept
void set_graph_type_version (int version) noexcept
std::string_view graph_type_id () const noexcept
void set_graph_type_id (std::string id)
int graph_state_schema_version () const noexcept
void set_graph_state_schema_version (int version) noexcept
std::span< const state::ParamInfo > parameter_catalog () const noexcept
const state::ParamInfo * parameter (state::ParamID id) const noexcept
state::StateStore & state_store () noexcept
const state::StateStore & state_store () const noexcept
Processor & processor () noexcept
const Processor & processor () const noexcept

Static Public Member Functions

static std::shared_ptr< ProcessorNodeInstance > create (std::unique_ptr< Processor > processor) noexcept

Detailed Description

Retained, self-contained lifetime for an authored in-process graph node.

Creation freezes the descriptor and parameter catalog off the audio thread; published graph snapshots retain the shared instance through quiescence.

Constructor & Destructor Documentation

◆ ~ProcessorNodeInstance()

pulp::format::ProcessorNodeInstance::~ProcessorNodeInstance ( )

◆ ProcessorNodeInstance()

pulp::format::ProcessorNodeInstance::ProcessorNodeInstance ( const ProcessorNodeInstance & )
delete

Member Function Documentation

◆ binding()

GraphRuntimeNodeBinding pulp::format::ProcessorNodeInstance::binding ( graph::NodeId node_id,
bool required = true )
inlinenoexcept

◆ create()

std::shared_ptr< ProcessorNodeInstance > pulp::format::ProcessorNodeInstance::create ( std::unique_ptr< Processor > processor)
staticnoexcept

◆ descriptor()

const PluginDescriptor & pulp::format::ProcessorNodeInstance::descriptor ( ) const
inlinenoexcept

◆ graph_state_schema_version()

int pulp::format::ProcessorNodeInstance::graph_state_schema_version ( ) const
inlinenoexcept

◆ graph_type_id()

std::string_view pulp::format::ProcessorNodeInstance::graph_type_id ( ) const
inlinenoexcept

◆ graph_type_version()

int pulp::format::ProcessorNodeInstance::graph_type_version ( ) const
inlinenoexcept

◆ operator=()

ProcessorNodeInstance & pulp::format::ProcessorNodeInstance::operator= ( const ProcessorNodeInstance & )
delete

◆ parameter()

const state::ParamInfo * pulp::format::ProcessorNodeInstance::parameter ( state::ParamID id) const
noexcept

◆ parameter_catalog()

std::span< const state::ParamInfo > pulp::format::ProcessorNodeInstance::parameter_catalog ( ) const
inlinenoexcept

◆ prepare()

bool pulp::format::ProcessorNodeInstance::prepare ( const PrepareContext & context)
noexcept

◆ processor() [1/2]

const Processor & pulp::format::ProcessorNodeInstance::processor ( ) const
inlinenoexcept

◆ processor() [2/2]

Processor & pulp::format::ProcessorNodeInstance::processor ( )
inlinenoexcept

◆ release()

bool pulp::format::ProcessorNodeInstance::release ( )
noexcept

◆ set_audio_input_provider()

void pulp::format::ProcessorNodeInstance::set_audio_input_provider ( AudioInputBusProvider provider)
inlinenoexcept

◆ set_graph_state_schema_version()

void pulp::format::ProcessorNodeInstance::set_graph_state_schema_version ( int version)
inlinenoexcept

◆ set_graph_type_id()

void pulp::format::ProcessorNodeInstance::set_graph_type_id ( std::string id)
inline

◆ set_graph_type_version()

void pulp::format::ProcessorNodeInstance::set_graph_type_version ( int version)
inlinenoexcept

◆ state_store() [1/2]

const state::StateStore & pulp::format::ProcessorNodeInstance::state_store ( ) const
inlinenoexcept

◆ state_store() [2/2]

state::StateStore & pulp::format::ProcessorNodeInstance::state_store ( )
inlinenoexcept

The documentation for this class was generated from the following file: