Holds the state of a Track and if its contents/plugins should be played or not. More...

#include <tracktion_TrackMutingNode.h>

Public Member Functions
	TrackMuteState (Track &, bool muteForInputsWhenRecording, bool processMidiWhenMuted)
	Creates a TrackMuteState for a Track.

	TrackMuteState (Edit &)
	Creates a TrackMuteState for an Edit.

void	update ()
	Call once per block to update the mute status.

void	setKeepProcessingWhileMuted ()
	Forces the track's contents to keep processing while the track is muted, so it can still feed sidechains, aux buses and racks; the track's own output stays muted.

bool	shouldTrackBeAudible () const
	Returns true if the track's mix bus should be audible.

bool	shouldTrackContentsBeProcessed () const
	Returns true if the track's contents should be processed e.g.

bool	shouldTrackMidiBeProcessed () const
	Returns true if the track's MIDI should be processed to avoid breaks in long notes.

bool	wasJustMuted () const
	Returns true if the last block was audible but this one isn't.

bool	wasJustUnMuted () const
	Returns true if the last block wasn't audible but this one is.

size_t	getItemID () const
	Returns the ID for the relevant item, either the Track or Edit.

Detailed Description

Holds the state of a Track and if its contents/plugins should be played or not.

Constructor & Destructor Documentation

◆ TrackMuteState() [1/2]

engine::TrackMuteState::TrackMuteState	(	Track &	,
		bool	muteForInputsWhenRecording,
		bool	processMidiWhenMuted
	)

Creates a TrackMuteState for a Track.

◆ TrackMuteState() [2/2]

engine::TrackMuteState::TrackMuteState ( Edit & )

Creates a TrackMuteState for an Edit.

This is used for freeze tracks and will be muted if any other track is soloed.

Member Function Documentation

◆ update()

void engine::TrackMuteState::update ( )

Call once per block to update the mute status.

◆ setKeepProcessingWhileMuted()

void engine::TrackMuteState::setKeepProcessingWhileMuted ( )

Forces the track's contents to keep processing while the track is muted, so it can still feed sidechains, aux buses and racks; the track's own output stays muted.

Render graphs call this for stem source tracks.

See also: CreateNodeParams::tracksToProcessWhileMuted

◆ shouldTrackBeAudible()

bool engine::TrackMuteState::shouldTrackBeAudible ( ) const

Returns true if the track's mix bus should be audible.

◆ shouldTrackContentsBeProcessed()

bool engine::TrackMuteState::shouldTrackContentsBeProcessed ( ) const

Returns true if the track's contents should be processed e.g.

clips and plugins.

◆ shouldTrackMidiBeProcessed()

bool engine::TrackMuteState::shouldTrackMidiBeProcessed ( ) const

Returns true if the track's MIDI should be processed to avoid breaks in long notes.

◆ wasJustMuted()

bool engine::TrackMuteState::wasJustMuted ( ) const

Returns true if the last block was audible but this one isn't.

◆ wasJustUnMuted()

bool engine::TrackMuteState::wasJustUnMuted ( ) const

Returns true if the last block wasn't audible but this one is.

◆ getItemID()

size_t engine::TrackMuteState::getItemID ( ) const

Returns the ID for the relevant item, either the Track or Edit.

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

tracktion_TrackMutingNode.h

Public Member Functions