Revisioned reversible serial effect chain independent of an audio backend. 更多...

#include <AudioEffects.h>

类 eve::audio_editing::AudioEffectChainTarget 继承关系图:

Public 成员函数
	AudioEffectChainTarget (std::string id)
	Audio effect chain target.

TargetId	targetId () const override
	Target id.

TargetDescriptor	describe () const override
	Describe.

void *	queryCapability (const CapabilityId &capability) override
	Query an optional target capability.

Result< void >	applyDomainOperation (const DomainOperation &operation) override
	Applies domain operation.

std::unique_ptr< IDomainOperationTarget >	cloneDomainState () const override
	Clones domain state.

Result< void >	commitDomainState (std::unique_ptr< IDomainOperationTarget > candidate) override
	Commits domain state.

std::vector< AudioEffectRecord >	effects () const
	Enumerate effect records in processing order.

Result< DomainOperation >	makeSet (const AudioEffectRecord &effect) const
	Plan effect creation or replacement.

Result< DomainOperation >	makeDelete (const StableId &id) const
	Plan effect removal.

Result< DomainOperation >	makeReorder (const std::vector< StableId > &order) const
	Plan complete processing-order replacement.

std::vector< EditorDiagnostic >	validate () const
	Report invalid parameter ranges and unsafe chain budgets.

EditorValue	snapshotValue () const
	Capture deterministic schema-version-one effect chain.

Result< void >	loadSnapshot (const EditorValue &snapshot)
	Atomically load a validated effect chain.

Result< DomainOperation >	makeAssignToBus (const AudioMixerTarget &mixer, const ObjectId &bus) const
	Plan assigning this chain snapshot to an existing mixer bus.

Public 成员函数继承自 eve::editing::EditableTargetState
	EditableTargetState (Revision initial=1)
	Constructs the shared state with an explicit initial revision.

EditRegion	dirtyRegion () const override
	Return the accumulated dirty region.

void	clearDirtyRegion () override
	Discard the dirty region; the revision does not change.

std::uint64_t	revision () const override
	Return the current revision.

Revision	revisionValue () const noexcept
	Return the revision as the shared protocol revision type.

Public 成员函数继承自 eve::editing::IEditableTarget
virtual	~IEditableTarget ()=default
	Releases IEditableTarget resources.

virtual void *	queryCapability (const CapabilityId &capability)
	Query an optional stable capability.

template<class C >
eve::OptionalRef< C >	capability ()
	Query a capability through its interface-owned stable identity.

template<class C >
eve::OptionalRef< const C >	capability () const
	Capability.

template<class C >
C *	query ()
	Queries query.

template<class C >
const C *	query () const
	Queries query.

Public 成员函数继承自 eve::editing::IDomainOperationTarget
	~IDomainOperationTarget () override=default
	Releases IDomainOperationTarget resources.

Public 成员函数继承自 eve::editing::IDomainOperationTargetStaging
virtual	~IDomainOperationTargetStaging ()=default
	Releases IDomainOperationTargetStaging resources.

额外继承的成员函数
Protected 成员函数继承自 eve::editing::EditableTargetState
void	widenDirty (int x, int y)
	Widen the dirty region without advancing the revision.

void	widenDirty (const EditRegion &region)
	Widen the dirty region without advancing the revision.

void	widenDirty ()
	Mark an unknown area dirty without advancing the revision.

void	bumpRevision ()
	Advance the revision without touching the dirty region.

void	setRevision (Revision revision)
	Adopt a revision observed elsewhere, without advancing it.

void	setDirtyRegion (const EditRegion &region)
	Replace the dirty region wholesale, without advancing the revision.

void	markDirty (int x, int y)
	Include one cell in the dirty region and advance the revision.

void	markDirty (const EditRegion &region)
	Include a whole region and advance the revision.

void	markDirty ()
	Mark an unknown area dirty and advance the revision.

详细描述

Revisioned reversible serial effect chain independent of an audio backend.

在文件 AudioEffects.h 第 24 行定义.

构造及析构函数说明

◆ AudioEffectChainTarget()

eve::audio_editing::AudioEffectChainTarget::AudioEffectChainTarget ( std::string id )

explicit

Audio effect chain target.

在文件 AudioEffects.cpp 第 90 行定义.

成员函数说明

◆ applyDomainOperation()

Result< void > eve::audio_editing::AudioEffectChainTarget::applyDomainOperation ( const DomainOperation & operation )

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 AudioEffects.cpp 第 99 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), eve::Result< T >::failure(), eve::editing::Value::getIf(), order, eve::editing::DomainOperation::payload, eve::editing::DomainOperation::target, eve::editing::DomainOperation::type , 以及 eve::editing::EditableTargetState::widenDirty().

◆ cloneDomainState()

std::unique_ptr< IDomainOperationTarget > eve::audio_editing::AudioEffectChainTarget::cloneDomainState ( ) const

overridevirtual

Clones domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 AudioEffects.cpp 第 129 行定义.

◆ commitDomainState()

Result< void > eve::audio_editing::AudioEffectChainTarget::commitDomainState ( std::unique_ptr< IDomainOperationTarget > candidate )

overridevirtual

Commits domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 AudioEffects.cpp 第 132 行定义.

◆ describe()

TargetDescriptor eve::audio_editing::AudioEffectChainTarget::describe ( ) const

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

在文件 AudioEffects.cpp 第 91 行定义.

引用了 eve::editing::EditableTargetState::revisionValue().

◆ effects()

std::vector< AudioEffectRecord > eve::audio_editing::AudioEffectChainTarget::effects ( ) const

Enumerate effect records in processing order.

在文件 AudioEffects.cpp 第 141 行定义.

被这些函数引用 loadSnapshot(), makeAssignToBus(), eve::audio_editing::AudioEffectChainPublisher::publish() , 以及 snapshotValue().

◆ loadSnapshot()

Result< void > eve::audio_editing::AudioEffectChainTarget::loadSnapshot ( const EditorValue & snapshot )

Atomically load a validated effect chain.

在文件 AudioEffects.cpp 第 196 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), effects(), validate() , 以及 eve::editing::EditableTargetState::widenDirty().

◆ makeAssignToBus()

Result< DomainOperation > eve::audio_editing::AudioEffectChainTarget::makeAssignToBus	(	const AudioMixerTarget &	mixer,
		const ObjectId &	bus
	)		const

Plan assigning this chain snapshot to an existing mixer bus.

在文件 AudioEffects.cpp 第 224 行定义.

引用了 eve::audio_editing::AudioMixerTarget::bus(), effect, effects(), eve::Result< T >::failure(), eve::audio_editing::AudioMixerTarget::makeReplace() , 以及 validate().

◆ makeDelete()

Result< DomainOperation > eve::audio_editing::AudioEffectChainTarget::makeDelete ( const StableId & id ) const

Plan effect removal.

在文件 AudioEffects.cpp 第 155 行定义.

引用了 found, operation , 以及 value.

◆ makeReorder()

Result< DomainOperation > eve::audio_editing::AudioEffectChainTarget::makeReorder ( const std::vector< StableId > & order ) const

Plan complete processing-order replacement.

在文件 AudioEffects.cpp 第 163 行定义.

引用了 operation , 以及 order.

◆ makeSet()

Result< DomainOperation > eve::audio_editing::AudioEffectChainTarget::makeSet ( const AudioEffectRecord & effect ) const

Plan effect creation or replacement.

在文件 AudioEffects.cpp 第 146 行定义.

引用了 effect, eve::Result< T >::failure(), found , 以及 operation.

◆ queryCapability()

void * eve::audio_editing::AudioEffectChainTarget::queryCapability ( const CapabilityId & capability )

override

Query an optional target capability.

返回: Borrowed pointer owned by this target, or null. @lifetime Valid until this target is destroyed or mutated.

在文件 AudioEffects.cpp 第 95 行定义.

引用了 eve::editing::IEditableTarget::capability().

◆ snapshotValue()

EditorValue eve::audio_editing::AudioEffectChainTarget::snapshotValue ( ) const

Capture deterministic schema-version-one effect chain.

在文件 AudioEffects.cpp 第 191 行定义.

引用了 effect , 以及 effects().

◆ targetId()

TargetId eve::audio_editing::AudioEffectChainTarget::targetId ( ) const

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

在文件 AudioEffects.h 第 32 行定义.

被这些函数引用 eve::audio_editing::AudioEffectChainPublisher::publish().

◆ validate()

std::vector< EditorDiagnostic > eve::audio_editing::AudioEffectChainTarget::validate ( ) const

Report invalid parameter ranges and unsafe chain budgets.

在文件 AudioEffects.cpp 第 176 行定义.

引用了 eve::PreconditionViolation , 以及 eve::editing::ruleDiagnostic().

被这些函数引用 loadSnapshot(), makeAssignToBus() , 以及 eve::audio_editing::AudioEffectChainPublisher::publish().

该类的文档由以下文件生成:

src/modules/audio/editing/AudioEffects.h
src/modules/audio/editing/AudioEffects.cpp

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ AudioEffectChainTarget()

成员函数说明

◆ applyDomainOperation()

◆ cloneDomainState()

◆ commitDomainState()

◆ describe()

◆ effects()

◆ loadSnapshot()

◆ makeAssignToBus()

◆ makeDelete()

◆ makeReorder()

◆ makeSet()

◆ queryCapability()

◆ snapshotValue()

◆ targetId()

◆ validate()