Serializable mixer-bus hierarchy, including master bus. 更多...

#include <AudioTarget.h>

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

Public 成员函数
	AudioMixerTarget (std::string id)
	Audio mixer 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.

Result< AudioBusSnapshot >	bus (const ObjectId &id) const
	Read one bus snapshot.

std::vector< ObjectId >	children (const ObjectId &parent) const
	Enumerate direct child buses in stable order.

Result< DomainOperation >	makeCreate (AudioBusSnapshot bus) const
	Plan a reversible bus creation.

Result< DomainOperation >	makeDelete (const ObjectId &id) const
	Plan a reversible leaf-bus deletion; master cannot be deleted.

Result< DomainOperation >	makeReplace (AudioBusSnapshot bus) const
	Plan a reversible bus settings/reparent change.

EditorValue	snapshotValue () const
	Capture deterministic mixer hierarchy content.

Result< void >	loadSnapshot (const EditorValue &snapshot)
	Atomically load and validate a versioned mixer hierarchy.

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.

详细描述

Serializable mixer-bus hierarchy, including master bus.

在文件 AudioTarget.h 第 143 行定义.

构造及析构函数说明

◆ AudioMixerTarget()

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

explicit

Audio mixer target.

在文件 AudioMixerTarget.cpp 第 17 行定义.

成员函数说明

◆ applyDomainOperation()

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

overridevirtual

Applies domain operation.

实现了 eve::editing::IDomainOperationTarget.

在文件 AudioMixerTarget.cpp 第 29 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), children, operation , 以及 eve::editing::EditableTargetState::widenDirty().

◆ bus()

Result< AudioBusSnapshot > eve::audio_editing::AudioMixerTarget::bus ( const ObjectId & id ) const

Read one bus snapshot.

在文件 AudioMixerTarget.cpp 第 79 行定义.

引用了 found , 以及 value.

被这些函数引用 children(), loadSnapshot(), eve::audio_editing::AudioEffectChainTarget::makeAssignToBus(), makeCreate() , 以及 snapshotValue().

◆ children()

std::vector< ObjectId > eve::audio_editing::AudioMixerTarget::children ( const ObjectId & parent ) const

Enumerate direct child buses in stable order.

在文件 AudioMixerTarget.cpp 第 87 行定义.

引用了 bus() , 以及 parent.

◆ cloneDomainState()

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

overridevirtual

Clones domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 AudioMixerTarget.cpp 第 65 行定义.

◆ commitDomainState()

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

overridevirtual

Commits domain state.

实现了 eve::editing::IDomainOperationTargetStaging.

在文件 AudioMixerTarget.cpp 第 69 行定义.

◆ describe()

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

overridevirtual

Describe.

重载 eve::editing::IEditableTarget .

在文件 AudioMixerTarget.cpp 第 21 行定义.

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

◆ loadSnapshot()

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

Atomically load and validate a versioned mixer hierarchy.

在文件 AudioMixerTarget.cpp 第 197 行定义.

引用了 eve::editing::EditableTargetState::bumpRevision(), bus(), eve::editing::IEditableTarget::clearDirtyRegion(), found, eve::editing::Value::getIf() , 以及 value.

◆ makeCreate()

Result< DomainOperation > eve::audio_editing::AudioMixerTarget::makeCreate ( AudioBusSnapshot bus ) const

Plan a reversible bus creation.

在文件 AudioMixerTarget.cpp 第 94 行定义.

引用了 bus(), eve::UuidIdAdapter< Tag >::empty(), operation, eve::editing::DomainOperation::type , 以及 eve::UuidIdAdapter< Tag >::value().

◆ makeDelete()

Result< DomainOperation > eve::audio_editing::AudioMixerTarget::makeDelete ( const ObjectId & id ) const

Plan a reversible leaf-bus deletion; master cannot be deleted.

在文件 AudioMixerTarget.cpp 第 110 行定义.

引用了 children, found, operation, eve::editing::DomainOperation::type , 以及 eve::UuidIdAdapter< Tag >::value().

◆ makeReplace()

Result< DomainOperation > eve::audio_editing::AudioMixerTarget::makeReplace ( AudioBusSnapshot bus ) const

Plan a reversible bus settings/reparent change.

在文件 AudioMixerTarget.cpp 第 126 行定义.

引用了 found, eve::audio_editing::AudioBusSnapshot::id, eve::audio_editing::AudioBusSnapshot::name, operation, eve::audio_editing::AudioBusSnapshot::parent, eve::editing::DomainOperation::type , 以及 eve::audio_editing::AudioBusSnapshot::volume.

被这些函数引用 eve::audio_editing::AudioEffectChainTarget::makeAssignToBus().

◆ queryCapability()

void * eve::audio_editing::AudioMixerTarget::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.

在文件 AudioMixerTarget.cpp 第 25 行定义.

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

◆ snapshotValue()

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

Capture deterministic mixer hierarchy content.

在文件 AudioMixerTarget.cpp 第 185 行定义.

引用了 bus() , 以及 root.

◆ targetId()

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

inlineoverridevirtual

Target id.

实现了 eve::editing::IEditableTarget.

在文件 AudioTarget.h 第 151 行定义.

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

src/modules/audio/editing/AudioTarget.h
src/modules/audio/editing/AudioMixerTarget.cpp

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ AudioMixerTarget()

成员函数说明

◆ applyDomainOperation()

◆ bus()

◆ children()

◆ cloneDomainState()

◆ commitDomainState()

◆ describe()

◆ loadSnapshot()

◆ makeCreate()

◆ makeDelete()

◆ makeReplace()

◆ queryCapability()

◆ snapshotValue()

◆ targetId()