tracktion::engine::TrackMuteState Class Reference

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.
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.

Definition at line 17 of file tracktion_TrackMutingNode.h.

Constructor & Destructor Documentation

TrackMuteState() [1/2]

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

Creates a TrackMuteState for a Track.

Definition at line 14 of file tracktion_TrackMutingNode.cpp.

TrackMuteState() [2/2]

tracktion::engine::TrackMuteState::TrackMuteState

(

Edit &

e

)

Creates a TrackMuteState for an Edit.

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

Definition at line 30 of file tracktion_TrackMutingNode.cpp.

Member Function Documentation

getItemID()

size_t tracktion::engine::TrackMuteState::getItemID

(

)

const

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

Definition at line 74 of file tracktion_TrackMutingNode.cpp.

shouldTrackBeAudible()

bool tracktion::engine::TrackMuteState::shouldTrackBeAudible

(

)

const

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

Definition at line 44 of file tracktion_TrackMutingNode.cpp.

shouldTrackContentsBeProcessed()

bool tracktion::engine::TrackMuteState::shouldTrackContentsBeProcessed

(

)

const

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

clips and plugins.

Definition at line 49 of file tracktion_TrackMutingNode.cpp.

shouldTrackMidiBeProcessed()

bool tracktion::engine::TrackMuteState::shouldTrackMidiBeProcessed

(

)

const

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

Definition at line 54 of file tracktion_TrackMutingNode.cpp.

update()

void tracktion::engine::TrackMuteState::update

(

)

Call once per block to update the mute status.

Definition at line 36 of file tracktion_TrackMutingNode.cpp.

wasJustMuted()

bool tracktion::engine::TrackMuteState::wasJustMuted

(

)

const

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

Definition at line 43 of file tracktion_TrackMutingNode.h.

wasJustUnMuted()

bool tracktion::engine::TrackMuteState::wasJustUnMuted

(

)

const

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

Definition at line 46 of file tracktion_TrackMutingNode.h.

---

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

• tracktion_engine/playback/graph/tracktion_TrackMutingNode.h
• tracktion_engine/playback/graph/tracktion_TrackMutingNode.cpp