A clip in an edit. More...

#include <tracktion_Clip.h>

Inheritance diagram for tracktion::engine::Clip:

Classes
struct	Listener
	Listener interface to be notified of recorded MIDI being sent to the plugins. More...

Public Types
enum class	FollowActionDurationType { beats , loops }
	Defines the types of duration follow actions can use. More...

enum	SyncType { syncBarsBeats = 0 , syncAbsolute }
	Determines the clip sync type. More...

using	Ptr = juce::ReferenceCountedObjectPtr< Clip >

using	Array = juce::ReferenceCountedArray< Clip >

Public Types inherited from tracktion::engine::TrackItem
enum class	Type { unknown , wave , midi , edit , step , marker , pitch , timeSig , collection , video , recording , chord , arranger , container }
	Defines the types of item that can live on Track[s]. More...

Public Types inherited from tracktion::engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >

Public Member Functions
	Clip (const juce::ValueTree &, ClipOwner &, EditItemID, Type)
	Creates a clip of a given type from a ValueTree state.

	~Clip () override
	Destructor.

virtual void	initialise ()
	Initialises the Clip.

virtual void	flushStateToValueTree ()
	Can be overridden to ensure any state (e.g.

virtual void	sourceMediaChanged ()
	Called when the source media file reference (attribute "source") has changed - i.e.

virtual void	pitchTempoTrackChanged ()
	Called when there are pitch or tempo changes made which might require clips to adjust timing information.

virtual juce::String	getName () const override
	Returns the name of the clip.

void	setName (const juce::String &newName)
	Sets a new name for a clip.

virtual bool	isMidi () const =0
	Returns true if this is a MidiClip.

virtual bool	canBeAddedTo (ClipOwner &)=0
	Tests whether this clip can go on the given parent.

virtual bool	usesSourceFile () const
	True if it references a source file - i.e.

SourceFileReference &	getSourceFileReference ()
	Returns the SourceFileReference of the Clip.

juce::File	getCurrentSourceFile () const
	Returns the current source file, this is different to the SourceFileReference as it could be a temporary comp file, clipFX, reverse render etc.

juce::Array< ReferencedItem >	getReferencedItems () override
	Returns an array of any ReferencedItem[s] e.g.

void	reassignReferencedItem (const ReferencedItem &, ProjectItemID, double) override
	Should be implemented to change the underlying source to a new ProjectItemID.

virtual std::shared_ptr< LaunchHandle >	getLaunchHandle ()
	Some clip types can be launched, if that's possible, this returns a handle to trigger starting/stopping the clip.

virtual void	setUsesGlobalLaunchQuatisation (bool)
	Some clip types can be launched, if that's possible, this sets whether the clip's quantisation or the global quantisation should be used.

virtual bool	usesGlobalLaunchQuatisation ()
	Some clip types can be launched, if that's possible, this returns whether the clip's quantisation or the global quantisation should be used.

virtual LaunchQuantisation *	getLaunchQuantisation ()
	Some clip types can be launched, if that's possible, this returns a quantisation that can be used for this clip.

virtual FollowActions *	getFollowActions ()
	Some clip types can be launched, if that's possible, this can be used to determine the action to perform after a clip has played.

ClipPosition	getPosition () const override
	Returns the ClipPosition on the parent Track.

BeatPosition	getContentBeatAtTime (TimePosition) const
	Returns the beat number (with offset) at the given time.

TimePosition	getTimeOfContentBeat (BeatPosition) const
	Returns time of a beat number.

virtual TimeDuration	getMaximumLength ()
	Returns the maximum length this clip can have.

virtual juce::Array< TimePosition >	getInterestingTimes ()
	Returns times for snapping to, relative to the Edit.

TimePosition	getSpottingPoint () const
	Returns the first marked time in the source file which can be used for syncronising newly added clips.

virtual bool	canLoop () const
	Returns true if this clip is capable of looping.

virtual bool	isLooping () const
	Returns true if this clip is currently looping.

virtual bool	beatBasedLooping () const
	Returns true if this clip's looping is based on beats or false if absolute time.

virtual void	setNumberOfLoops (int)
	Sets the clip looping a number of times.

virtual void	disableLooping ()
	Disables all looping.

virtual BeatPosition	getLoopStartBeats () const
	Returns the beat position of the loop start point.

virtual TimePosition	getLoopStart () const
	Returns the start time of the loop start point.

virtual BeatDuration	getLoopLengthBeats () const
	Returns the length of loop in beats.

virtual TimeDuration	getLoopLength () const
	Returns the length of loop in seconds.

TimeRange	getLoopRange () const
	Returns the loop range in seconds.

BeatRange	getLoopRangeBeats () const
	Returns the loop range in beats.

virtual void	setLoopRange (TimeRange)
	Sets the loop range the clip should use in seconds.

virtual void	setLoopRangeBeats (BeatRange)
	Sets the loop range the clip should use in beats.

virtual bool	isMuted () const =0
	Returns true if the clip is muted.

virtual void	setMuted (bool)
	Mutes or unmutes the clip.

virtual void	setSyncType (SyncType sync)
	Sets the sync type for the clip.

SyncType	getSyncType () const
	Returns the sync type clip is using.

void	setPosition (ClipPosition newPosition)
	Sets the position of the clip.

void	setStart (TimePosition newStart, bool preserveSync, bool keepLength)
	Sets the start time of the clip.

void	setLength (TimeDuration newLength, bool preserveSync)
	Sets the length of the clip.

void	setEnd (TimePosition newEnd, bool preserveSync)
	Sets the end of the clip.

void	setOffset (TimeDuration newOffset)
	Sets the offset of the clip, i.e.

void	trimAwayOverlap (TimeRange editRangeToTrim)
	Trims away any part of the clip that overlaps this region.

void	removeFromParent ()
	Removes this clip from the parent track or container clip.

bool	moveTo (ClipOwner &)
	Moves the clip to a new parent (if possible).

double	getSpeedRatio () const noexcept
	Returns the speed ratio i.e.

virtual void	setSpeedRatio (double)
	Sets a speed ratio i.e.

virtual void	rescale (TimePosition pivotTimeInEdit, double factor)
	stretches and scales this clip relative to a fixed point in the edit.

bool	isGrouped () const override
	Returns true if the clip is part of a group.

TrackItem *	getGroupParent () const override
	Returns the parent TrackItem if part of a group.

void	setGroup (EditItemID newGroupID)
	Sets the clip to be part of a group.

EditItemID	getGroupID () const noexcept
	Returns the ID of the group.

CollectionClip *	getGroupClip () const
	Returns this as a CollectionClip if it is one.

bool	isLinked () const
	Returns true if this clip is linked with any others.

void	setLinkGroupID (juce::String newLinkID)
	Sets the link ID to link this clip with others.

juce::String	getLinkGroupID () const
	Returns the link ID of this clip.

ClipOwner *	getParent () const
	Returns the parent ClipOwner this clip is on.

ClipTrack *	getClipTrack () const
	Returns the parent ClipTrack this clip is on (if any).

Track *	getTrack () const override
	Returns the parent Track this clip is on (if any).

ClipSlot *	getClipSlot () const
	Returns the parent ClipSlot this clip is on (if any).

virtual juce::Colour	getColour () const
	Returns the colour property of this clip.

void	setColour (juce::Colour col)
	Sets the colour property of this clip.

virtual void	removePlugin (const Plugin::Ptr &)
	Removes the given plugin from the clip if the clip supports plugins.

virtual bool	addClipPlugin (const Plugin::Ptr &, SelectionManager &)
	Adds a plugin to the clip.

virtual Plugin::Array	getAllPlugins ()
	Returns all the plugins on the clip.

virtual void	sendMirrorUpdateToAllPlugins (Plugin &) const
	Sends an update to all plugins mirroing the one passed in.

virtual PluginList *	getPluginList ()
	Returns the PluginList for this clip if it has one.

virtual juce::Colour	getDefaultColour () const =0
	Returns the default colour for this clip.

virtual void	clearTakes ()
	Clears any takes this clip has.

virtual bool	hasAnyTakes () const
	Returns true if this clip has any takes.

virtual juce::StringArray	getTakeDescriptions () const
	Returns the descriptions of any takes.

virtual void	setCurrentTake (int)
	Sets a given take index to be the current take.

virtual int	getCurrentTake () const
	Returns the current take index.

virtual int	getNumTakes (bool)
	Returns the total number of takes.

virtual bool	isCurrentTakeComp ()
	Returns true if the current take is a comp.

virtual void	setShowingTakes (bool shouldShow)
	Sets whether the clip should be showing takes.

virtual bool	isShowingTakes () const
	Returns true if the clip is showing takes.

virtual Clip::Array	unpackTakes (bool)
	Attempts to unpack the takes to new clips.

virtual void	cloneFrom (Clip *)
	Clones the given clip to this clip.

void	updateLinkedClips ()
	Triggers a call to cloneFrom for all clips with the same linkID.

virtual PatternGenerator *	getPatternGenerator ()
	Returns the PatternGenerator for this clip if it has one.

void	addListener (Listener *)
	Adds a Listener.

void	removeListener (Listener *)
	Removes a Listener.

juce::ListenerList< Listener > &	getListeners ()
	Returns the listener list so Nodes can manually call them.

void	changed () override

juce::UndoManager *	getUndoManager () const
	Returns the UndoManager.

virtual void	setParent (ClipOwner *)

Public Member Functions inherited from tracktion::engine::TrackItem
	TrackItem (Edit &, EditItemID, Type)
	Creates a TrackItem with an ID and type.

	~TrackItem ()
	Destructor.

TimeRange	getEditTimeRange () const
	Returns the time range of this item.

BeatRange	getEditBeatRange () const
	Returns the beat range of this item.

BeatPosition	getStartBeat () const
	Returns the start beat in the Edit of this item.

BeatPosition	getContentStartBeat () const
	Returns the start beat of the content in the Edit of this item.

BeatPosition	getEndBeat () const
	Returns the end beat in the Edit of this item.

BeatDuration	getLengthInBeats () const
	Returns the duration in beats the of this item.

TimePosition	getTimeOfRelativeBeat (BeatDuration) const
	Returns an Edit time point for a given number of beats from the start of this item.

BeatPosition	getBeatOfRelativeTime (TimeDuration) const
	Returns an Edit beat point for a given number of seconds from the start of this item.

BeatDuration	getOffsetInBeats () const
	Returns an the offset of this item in beats.

EditItemID	getTrackID () const
	Returns the ID of the Track this item lives on.

Public Member Functions inherited from tracktion::engine::EditItem
	EditItem (EditItemID, Edit &)

	EditItem (Edit &, const juce::ValueTree &)

virtual	~EditItem ()=default

Public Member Functions inherited from tracktion::engine::Selectable
	Selectable ()

virtual	~Selectable ()

virtual juce::String	getSelectableDescription ()=0
	Subclasses must return a description of what they are.

virtual void	selectionStatusChanged (bool isNowSelected)
	Can be overridden to tell this object that it has just been selected or deselected.

virtual void	selectableAboutToBeDeleted ()
	Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.

void	addListener (SelectableListener *)

void	removeListener (SelectableListener *)

void	addSelectableListener (SelectableListener *)

void	removeSelectableListener (SelectableListener *)

void	cancelAnyPendingUpdates ()
	If changed() has been called, this will cancel any pending async change notificaions.

void	deselect ()

void	propertiesChanged ()

void	notifyListenersOfDeletion ()

WeakRef	getWeakRef ()

Public Member Functions inherited from tracktion::engine::Exportable
virtual	~Exportable ()=default

Static Public Member Functions
static bool	isClipState (const juce::ValueTree &)
	Checks whether a ValueTree is some kind of clip state.

static bool	isClipState (const juce::Identifier &)
	Checks whether a ValueTree type is some kind of clip state.

static Ptr	createClipForState (const juce::ValueTree &, ClipOwner &targetParent)
	Creates a clip for a given ValueTree representation.

Static Public Member Functions inherited from tracktion::engine::TrackItem
static const char *	typeToString (Type)
	Returns the string version of a TrackItem::Type.

static juce::Identifier	clipTypeToXMLType (Type)
	Returns an Identifier version of a TrackItem::Type.

static TrackItem::Type	xmlTagToType (juce::StringRef)
	Returns the TrackItem::Type of a type string.

static TrackItem::Type	stringToType (const juce::String &)
	Returns the TrackItem::Type of a type string.

static juce::String	getSuggestedNameForNewItem (Type)
	Returns a text string for a new clip of the given type.

template<typename ArrayType >
static void	sortByTime (ArrayType &items)
	Helper function to sort an array of TrackItem[s] by their start time.

template<typename ArrayType >
static void	stableSortByTime (ArrayType &items)
	Helper function to sort an array of TrackItem[s] by their start time without changing the order of items at the same time.

Static Public Member Functions inherited from tracktion::engine::Selectable
static void	initialise ()

static bool	isSelectableValid (const Selectable *) noexcept
	checks whether this object has been deleted.

Static Public Member Functions inherited from tracktion::engine::Exportable
static juce::Array< Exportable * >	addAllExportables (Edit &)
	Returns all the Exportables contained in an Edit.

Public Attributes
juce::CachedValue< FollowActionDurationType >	followActionDurationType
	The type of duration to use for when to trigger the follow action.

juce::CachedValue< BeatDuration >	followActionBeats
	Determines the time for which a launched clip will play before a follow action is taken.

juce::CachedValue< double >	followActionNumLoops
	Determines the number of loops for which a launched clip will play before a follow action is taken.

juce::ValueTree	state
	The ValueTree of the Clip state.

juce::CachedValue< juce::Colour >	colour
	The colour property.

juce::CachedValue< bool >	disabled
	Whether the Clip is disabled or not.

Public Attributes inherited from tracktion::engine::TrackItem
const Type	type
	The type of this item.

Public Attributes inherited from tracktion::engine::EditItem
Edit &	edit

const EditItemID	itemID
	Every EditItem has an ID which is unique within the edit.

Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference

Protected Member Functions
void	setCurrentSourceFile (const juce::File &)
	Sets a new source file for this clip.

virtual juce::Array< TimePosition >	getRescaledMarkPoints () const
	Returns the mark points relative to the start of the clip, rescaled to the current speed.

void	valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override

void	valueTreeParentChanged (juce::ValueTree &) override

Protected Attributes
bool	isInitialised = false

bool	cloneInProgress = false

juce::CachedValue< juce::String >	clipName

ClipOwner *	parent = nullptr

juce::CachedValue< TimePosition >	clipStart

juce::CachedValue< TimeDuration >	length

juce::CachedValue< TimeDuration >	offset

juce::CachedValue< double >	speedRatio

SourceFileReference	sourceFileReference

juce::CachedValue< EditItemID >	groupID

juce::CachedValue< juce::String >	linkID

juce::File	currentSourceFile

juce::CachedValue< SyncType >	syncType

juce::CachedValue< bool >	showingTakes

std::unique_ptr< PatternGenerator >	patternGenerator

AsyncCaller	updateLinkedClipsCaller

juce::ListenerList< Listener >	listeners

Detailed Description

A clip in an edit.

This is the base class for various clip types

Member Typedef Documentation

◆ Ptr

using tracktion::engine::Clip::Ptr = juce::ReferenceCountedObjectPtr<Clip>

◆ Array

using tracktion::engine::Clip::Array = juce::ReferenceCountedArray<Clip>

Member Enumeration Documentation

◆ FollowActionDurationType

enum class tracktion::engine::Clip::FollowActionDurationType

strong

Defines the types of duration follow actions can use.

Enumerator
beats	A number of beats.
loops	A number of loops.

◆ SyncType

enum tracktion::engine::Clip::SyncType

Determines the clip sync type.

Enumerator
syncBarsBeats	Sync to beats.
syncAbsolute	Sync to abslute time.

Constructor & Destructor Documentation

◆ Clip()

tracktion::engine::Clip::Clip	(	const juce::ValueTree &	,
		ClipOwner &	,
		EditItemID	,
		Type
	)

Creates a clip of a given type from a ValueTree state.

Clip's have to have a parent ClipOwner and unique EditItemID

See also: Edit::createNewItemID You would usually create a clip using ClipOwner::insertNewClip

◆ ~Clip()

tracktion::engine::Clip::~Clip ( )

override

Destructor.

Member Function Documentation

◆ initialise()

virtual void tracktion::engine::Clip::initialise ( )

virtual

Initialises the Clip.

Called once automatically after construction.

Reimplemented in tracktion::engine::ArrangerClip, tracktion::engine::AudioClipBase, tracktion::engine::ChordClip, tracktion::engine::ContainerClip, tracktion::engine::EditClip, tracktion::engine::MarkerClip, tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

◆ isClipState() [1/2]

static bool tracktion::engine::Clip::isClipState ( const juce::ValueTree & )

static

Checks whether a ValueTree is some kind of clip state.

◆ isClipState() [2/2]

static bool tracktion::engine::Clip::isClipState ( const juce::Identifier & )

static

Checks whether a ValueTree type is some kind of clip state.

◆ createClipForState()

static Ptr tracktion::engine::Clip::createClipForState	(	const juce::ValueTree &	,
		ClipOwner &	targetParent
	)

static

Creates a clip for a given ValueTree representation.

This may return a previously-existing clip with the same ID.

◆ flushStateToValueTree()

virtual void tracktion::engine::Clip::flushStateToValueTree ( )

virtual

Can be overridden to ensure any state (e.g.

clip plugins) is flushed to the ValueTree ready for saving.

Reimplemented in tracktion::engine::AudioClipBase, and tracktion::engine::ContainerClip.

◆ sourceMediaChanged()

virtual void tracktion::engine::Clip::sourceMediaChanged ( )

virtual

Called when the source media file reference (attribute "source") has changed - i.e.

when the clip has a new ProjectItemID assigned, not when the file itself changes.

Reimplemented in tracktion::engine::EditClip, and tracktion::engine::WaveAudioClip.

◆ pitchTempoTrackChanged()

virtual void tracktion::engine::Clip::pitchTempoTrackChanged ( )

virtual

Called when there are pitch or tempo changes made which might require clips to adjust timing information.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::ChordClip, tracktion::engine::ContainerClip, and tracktion::engine::MidiClip.

◆ getName()

virtual juce::String tracktion::engine::Clip::getName ( ) const

overridevirtual

Returns the name of the clip.

Implements tracktion::engine::EditItem.

References clipName.

◆ setName()

void tracktion::engine::Clip::setName ( const juce::String & newName )

Sets a new name for a clip.

◆ isMidi()

virtual bool tracktion::engine::Clip::isMidi ( ) const

pure virtual

Returns true if this is a MidiClip.

Implemented in tracktion::engine::ArrangerClip, tracktion::engine::ChordClip, tracktion::engine::ContainerClip, tracktion::engine::EditClip, tracktion::engine::MarkerClip, tracktion::engine::MidiClip, tracktion::engine::StepClip, and tracktion::engine::WaveAudioClip.

◆ canBeAddedTo()

virtual bool tracktion::engine::Clip::canBeAddedTo ( ClipOwner & )

pure virtual

Tests whether this clip can go on the given parent.

Implemented in tracktion::engine::ArrangerClip, tracktion::engine::AudioClipBase, tracktion::engine::ChordClip, tracktion::engine::MarkerClip, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ usesSourceFile()

virtual bool tracktion::engine::Clip::usesSourceFile ( ) const

virtual

True if it references a source file - i.e.

audio clips do, midi doesn't.

Reimplemented in tracktion::engine::EditClip, and tracktion::engine::WaveAudioClip.

◆ getSourceFileReference()

SourceFileReference & tracktion::engine::Clip::getSourceFileReference ( )

Returns the SourceFileReference of the Clip.

References sourceFileReference.

◆ getCurrentSourceFile()

juce::File tracktion::engine::Clip::getCurrentSourceFile ( ) const

Returns the current source file, this is different to the SourceFileReference as it could be a temporary comp file, clipFX, reverse render etc.

References currentSourceFile.

Referenced by tracktion::engine::AudioClipBase::getAudioFile().

◆ getReferencedItems()

juce::Array< ReferencedItem > tracktion::engine::Clip::getReferencedItems ( )

overridevirtual

Returns an array of any ReferencedItem[s] e.g.

audio files.

Implements tracktion::engine::Exportable.

◆ reassignReferencedItem()

void tracktion::engine::Clip::reassignReferencedItem	(	const ReferencedItem &	,
		ProjectItemID	,
		double
	)

overridevirtual

Should be implemented to change the underlying source to a new ProjectItemID.

Implements tracktion::engine::Exportable.

Reimplemented in tracktion::engine::WaveAudioClip.

◆ getLaunchHandle()

virtual std::shared_ptr< LaunchHandle > tracktion::engine::Clip::getLaunchHandle ( )

virtual

Some clip types can be launched, if that's possible, this returns a handle to trigger starting/stopping the clip.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ setUsesGlobalLaunchQuatisation()

virtual void tracktion::engine::Clip::setUsesGlobalLaunchQuatisation ( bool )

virtual

Some clip types can be launched, if that's possible, this sets whether the clip's quantisation or the global quantisation should be used.

See also: getLaunchQuantisation, Edit::getLaunchQuantisation

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ usesGlobalLaunchQuatisation()

virtual bool tracktion::engine::Clip::usesGlobalLaunchQuatisation ( )

virtual

Some clip types can be launched, if that's possible, this returns whether the clip's quantisation or the global quantisation should be used.

See also: getLaunchQuantisation, Edit::getLaunchQuantisation

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ getLaunchQuantisation()

virtual LaunchQuantisation * tracktion::engine::Clip::getLaunchQuantisation ( )

virtual

Some clip types can be launched, if that's possible, this returns a quantisation that can be used for this clip.

N.B. This will always be the clip's LaunchQuantisation, to find out if you should use the Edit's LaunchQuantisation, check usesGlobalLaunchQuatisation first

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ getFollowActions()

virtual FollowActions * tracktion::engine::Clip::getFollowActions ( )

virtual

Some clip types can be launched, if that's possible, this can be used to determine the action to perform after a clip has played.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ getPosition()

ClipPosition tracktion::engine::Clip::getPosition ( ) const

overridevirtual

Returns the ClipPosition on the parent Track.

Implements tracktion::engine::TrackItem.

Reimplemented in tracktion::engine::StepClip.

◆ getContentBeatAtTime()

BeatPosition tracktion::engine::Clip::getContentBeatAtTime ( TimePosition ) const

Returns the beat number (with offset) at the given time.

◆ getTimeOfContentBeat()

TimePosition tracktion::engine::Clip::getTimeOfContentBeat ( BeatPosition ) const

Returns time of a beat number.

◆ getMaximumLength()

virtual TimeDuration tracktion::engine::Clip::getMaximumLength ( )

virtual

Returns the maximum length this clip can have.

Reimplemented in tracktion::engine::AudioClipBase.

References tracktion::engine::Edit::getMaximumEditEnd().

◆ getInterestingTimes()

virtual juce::Array< TimePosition > tracktion::engine::Clip::getInterestingTimes ( )

virtual

Returns times for snapping to, relative to the Edit.

Base class adds start and end time.

◆ getSpottingPoint()

TimePosition tracktion::engine::Clip::getSpottingPoint ( ) const

Returns the first marked time in the source file which can be used for syncronising newly added clips.

◆ canLoop()

virtual bool tracktion::engine::Clip::canLoop ( ) const

virtual

Returns true if this clip is capable of looping.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ isLooping()

virtual bool tracktion::engine::Clip::isLooping ( ) const

virtual

Returns true if this clip is currently looping.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ beatBasedLooping()

virtual bool tracktion::engine::Clip::beatBasedLooping ( ) const

virtual

Returns true if this clip's looping is based on beats or false if absolute time.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ setNumberOfLoops()

virtual void tracktion::engine::Clip::setNumberOfLoops ( int )

virtual

Sets the clip looping a number of times.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ disableLooping()

virtual void tracktion::engine::Clip::disableLooping ( )

virtual

Disables all looping.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ getLoopStartBeats()

virtual BeatPosition tracktion::engine::Clip::getLoopStartBeats ( ) const

virtual

Returns the beat position of the loop start point.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

Referenced by getLoopRangeBeats().

◆ getLoopStart()

virtual TimePosition tracktion::engine::Clip::getLoopStart ( ) const

virtual

Returns the start time of the loop start point.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

Referenced by getLoopRange().

◆ getLoopLengthBeats()

virtual BeatDuration tracktion::engine::Clip::getLoopLengthBeats ( ) const

virtual

Returns the length of loop in beats.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

Referenced by getLoopRangeBeats().

◆ getLoopLength()

virtual TimeDuration tracktion::engine::Clip::getLoopLength ( ) const

virtual

Returns the length of loop in seconds.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

Referenced by getLoopRange().

◆ getLoopRange()

TimeRange tracktion::engine::Clip::getLoopRange ( ) const

Returns the loop range in seconds.

References getLoopLength(), and getLoopStart().

◆ getLoopRangeBeats()

BeatRange tracktion::engine::Clip::getLoopRangeBeats ( ) const

Returns the loop range in beats.

References getLoopLengthBeats(), and getLoopStartBeats().

◆ setLoopRange()

virtual void tracktion::engine::Clip::setLoopRange ( TimeRange )

virtual

Sets the loop range the clip should use in seconds.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ setLoopRangeBeats()

virtual void tracktion::engine::Clip::setLoopRangeBeats ( BeatRange )

virtual

Sets the loop range the clip should use in beats.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::ContainerClip, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ isMuted()

virtual bool tracktion::engine::Clip::isMuted ( ) const

pure virtual

Returns true if the clip is muted.

Implemented in tracktion::engine::ArrangerClip, tracktion::engine::AudioClipBase, tracktion::engine::ChordClip, tracktion::engine::MarkerClip, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ setMuted()

virtual void tracktion::engine::Clip::setMuted ( bool )

virtual

Mutes or unmutes the clip.

Reimplemented in tracktion::engine::MidiClip, tracktion::engine::StepClip, and tracktion::engine::AudioClipBase.

◆ setSyncType()

virtual void tracktion::engine::Clip::setSyncType ( SyncType sync )

virtual

Sets the sync type for the clip.

References syncType.

◆ getSyncType()

SyncType tracktion::engine::Clip::getSyncType ( ) const

Returns the sync type clip is using.

References syncType.

◆ setPosition()

void tracktion::engine::Clip::setPosition ( ClipPosition newPosition )

Sets the position of the clip.

◆ setStart()

void tracktion::engine::Clip::setStart	(	TimePosition	newStart,
		bool	preserveSync,
		bool	keepLength
	)

Sets the start time of the clip.

Parameters

newStart	The start time in seconds
preserveSync	Whether the source material position should be kept static in relation to the Edit's timeline.
keepLength	Whether the end should be moved to keep the same length.

◆ setLength()

void tracktion::engine::Clip::setLength	(	TimeDuration	newLength,
		bool	preserveSync
	)

Sets the length of the clip.

Parameters

newLength	The length in seconds
preserveSync	Whether the source material position should be kept static in relation to the Edit's timeline.

◆ setEnd()

void tracktion::engine::Clip::setEnd	(	TimePosition	newEnd,
		bool	preserveSync
	)

Sets the end of the clip.

Parameters

newEnd	The end time in seconds
preserveSync	Whether the source material position should be kept static in relation to the Edit's timeline.

◆ setOffset()

void tracktion::engine::Clip::setOffset ( TimeDuration newOffset )

Sets the offset of the clip, i.e.

how much the clip's content should be shifted within the clip boundary.

Parameters

newOffset The offset in seconds

◆ trimAwayOverlap()

void tracktion::engine::Clip::trimAwayOverlap ( TimeRange editRangeToTrim )

Trims away any part of the clip that overlaps this region.

◆ removeFromParent()

void tracktion::engine::Clip::removeFromParent ( )

Removes this clip from the parent track or container clip.

◆ moveTo()

bool tracktion::engine::Clip::moveTo ( ClipOwner & )

Moves the clip to a new parent (if possible).

Returns: true if the clip could be moved.

◆ getSpeedRatio()

double tracktion::engine::Clip::getSpeedRatio ( ) const

noexcept

Returns the speed ratio i.e.

how quickly the clip plays back.

References speedRatio.

◆ setSpeedRatio()

virtual void tracktion::engine::Clip::setSpeedRatio ( double )

virtual

Sets a speed ratio i.e.

how quickly the clip plays back.

Reimplemented in tracktion::engine::AudioClipBase.

◆ rescale()

virtual void tracktion::engine::Clip::rescale	(	TimePosition	pivotTimeInEdit,
		double	factor
	)

virtual

stretches and scales this clip relative to a fixed point in the edit.

Parameters

pivotTimeInEdit	The time to keep fixed
factor	The scale factor

Reimplemented in tracktion::engine::MidiClip.

◆ isGrouped()

bool tracktion::engine::Clip::isGrouped ( ) const

overridevirtual

Returns true if the clip is part of a group.

Reimplemented from tracktion::engine::TrackItem.

References groupID.

◆ getGroupParent()

TrackItem * tracktion::engine::Clip::getGroupParent ( ) const

overridevirtual

Returns the parent TrackItem if part of a group.

Reimplemented from tracktion::engine::TrackItem.

◆ setGroup()

void tracktion::engine::Clip::setGroup ( EditItemID newGroupID )

Sets the clip to be part of a group.

◆ getGroupID()

EditItemID tracktion::engine::Clip::getGroupID ( ) const

noexcept

Returns the ID of the group.

References groupID.

◆ getGroupClip()

CollectionClip * tracktion::engine::Clip::getGroupClip ( ) const

Returns this as a CollectionClip if it is one.

◆ isLinked()

bool tracktion::engine::Clip::isLinked ( ) const

Returns true if this clip is linked with any others.

References linkID.

◆ setLinkGroupID()

void tracktion::engine::Clip::setLinkGroupID ( juce::String newLinkID )

Sets the link ID to link this clip with others.

References linkID.

◆ getLinkGroupID()

juce::String tracktion::engine::Clip::getLinkGroupID ( ) const

Returns the link ID of this clip.

References linkID.

◆ getParent()

ClipOwner * tracktion::engine::Clip::getParent ( ) const

Returns the parent ClipOwner this clip is on.

◆ getClipTrack()

ClipTrack * tracktion::engine::Clip::getClipTrack ( ) const

Returns the parent ClipTrack this clip is on (if any).

◆ getTrack()

Track * tracktion::engine::Clip::getTrack ( ) const

overridevirtual

Returns the parent Track this clip is on (if any).

Implements tracktion::engine::TrackItem.

◆ getClipSlot()

ClipSlot * tracktion::engine::Clip::getClipSlot ( ) const

Returns the parent ClipSlot this clip is on (if any).

◆ getColour()

virtual juce::Colour tracktion::engine::Clip::getColour ( ) const

virtual

Returns the colour property of this clip.

Reimplemented in tracktion::engine::ChordClip, and tracktion::engine::MarkerClip.

◆ setColour()

void tracktion::engine::Clip::setColour ( juce::Colour col )

Sets the colour property of this clip.

References colour.

◆ removePlugin()

virtual void tracktion::engine::Clip::removePlugin ( const Plugin::Ptr & )

virtual

Removes the given plugin from the clip if the clip supports plugins.

◆ addClipPlugin()

virtual bool tracktion::engine::Clip::addClipPlugin	(	const Plugin::Ptr &	,
		SelectionManager &
	)

virtual

Adds a plugin to the clip.

Returns: false if the clip contain plugins.

Reimplemented in tracktion::engine::AudioClipBase.

◆ getAllPlugins()

virtual Plugin::Array tracktion::engine::Clip::getAllPlugins ( )

virtual

Returns all the plugins on the clip.

Reimplemented in tracktion::engine::AudioClipBase.

◆ sendMirrorUpdateToAllPlugins()

virtual void tracktion::engine::Clip::sendMirrorUpdateToAllPlugins ( Plugin & ) const

virtual

Sends an update to all plugins mirroing the one passed in.

Reimplemented in tracktion::engine::AudioClipBase.

◆ getPluginList()

virtual PluginList * tracktion::engine::Clip::getPluginList ( )

virtual

Returns the PluginList for this clip if it has one.

Reimplemented in tracktion::engine::AudioClipBase.

◆ getDefaultColour()

virtual juce::Colour tracktion::engine::Clip::getDefaultColour ( ) const

pure virtual

Returns the default colour for this clip.

Implemented in tracktion::engine::ArrangerClip, tracktion::engine::AudioClipBase, tracktion::engine::ChordClip, tracktion::engine::MarkerClip, tracktion::engine::MidiClip, and tracktion::engine::StepClip.

◆ clearTakes()

virtual void tracktion::engine::Clip::clearTakes ( )

virtual

Clears any takes this clip has.

Reimplemented in tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

◆ hasAnyTakes()

virtual bool tracktion::engine::Clip::hasAnyTakes ( ) const

virtual

Returns true if this clip has any takes.

Reimplemented in tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

◆ getTakeDescriptions()

virtual juce::StringArray tracktion::engine::Clip::getTakeDescriptions ( ) const

virtual

Returns the descriptions of any takes.

Reimplemented in tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

◆ setCurrentTake()

virtual void tracktion::engine::Clip::setCurrentTake ( int )

virtual

Sets a given take index to be the current take.

Reimplemented in tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

◆ getCurrentTake()

virtual int tracktion::engine::Clip::getCurrentTake ( ) const

virtual

Returns the current take index.

Reimplemented in tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

Referenced by tracktion::engine::CompManager::getActiveTakeIndex().

◆ getNumTakes()

virtual int tracktion::engine::Clip::getNumTakes ( bool )

virtual

Returns the total number of takes.

Parameters

includeComps Whether comps should be included in the count

Reimplemented in tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

◆ isCurrentTakeComp()

virtual bool tracktion::engine::Clip::isCurrentTakeComp ( )

virtual

Returns true if the current take is a comp.

Reimplemented in tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

◆ setShowingTakes()

virtual void tracktion::engine::Clip::setShowingTakes ( bool shouldShow )

virtual

Sets whether the clip should be showing takes.

References showingTakes.

◆ isShowingTakes()

virtual bool tracktion::engine::Clip::isShowingTakes ( ) const

virtual

Returns true if the clip is showing takes.

References showingTakes.

◆ unpackTakes()

virtual Clip::Array tracktion::engine::Clip::unpackTakes ( bool )

virtual

Attempts to unpack the takes to new clips.

Parameters

toNewTracks If true this will create new tracks for the new clips, otherwise they'll be placed on existing tracks

Reimplemented in tracktion::engine::MidiClip, and tracktion::engine::WaveAudioClip.

◆ cloneFrom()

virtual void tracktion::engine::Clip::cloneFrom ( Clip * )

virtual

Clones the given clip to this clip.

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::ContainerClip, tracktion::engine::EditClip, tracktion::engine::MidiClip, tracktion::engine::StepClip, and tracktion::engine::WaveAudioClip.

◆ updateLinkedClips()

void tracktion::engine::Clip::updateLinkedClips ( )

Triggers a call to cloneFrom for all clips with the same linkID.

See also: setLinkGroupID

◆ getPatternGenerator()

virtual PatternGenerator * tracktion::engine::Clip::getPatternGenerator ( )

virtual

Returns the PatternGenerator for this clip if it has one.

See also: MidiClip

Reimplemented in tracktion::engine::AudioClipBase, tracktion::engine::ChordClip, and tracktion::engine::MidiClip.

◆ addListener()

void tracktion::engine::Clip::addListener ( Listener * )

Adds a Listener.

◆ removeListener()

void tracktion::engine::Clip::removeListener ( Listener * )

Removes a Listener.

◆ getListeners()

juce::ListenerList< Listener > & tracktion::engine::Clip::getListeners ( )

Returns the listener list so Nodes can manually call them.

References listeners.

◆ changed()

void tracktion::engine::Clip::changed ( )

overridevirtual

Reimplemented from tracktion::engine::Selectable.

Reimplemented in tracktion::engine::EditClip.

◆ getUndoManager()

juce::UndoManager * tracktion::engine::Clip::getUndoManager ( ) const

Returns the UndoManager.

See also: Edit::getUndoManager.

◆ setParent()

virtual void tracktion::engine::Clip::setParent ( ClipOwner * )

virtual

. Not intended for public use!

Reimplemented in tracktion::engine::AudioClipBase.

◆ setCurrentSourceFile()

void tracktion::engine::Clip::setCurrentSourceFile ( const juce::File & )

protected

Sets a new source file for this clip.

◆ getRescaledMarkPoints()

virtual juce::Array< TimePosition > tracktion::engine::Clip::getRescaledMarkPoints ( ) const

protectedvirtual

Returns the mark points relative to the start of the clip, rescaled to the current speed.

Reimplemented in tracktion::engine::AudioClipBase.

◆ valueTreePropertyChanged()

void tracktion::engine::Clip::valueTreePropertyChanged	(	juce::ValueTree &	,
		const juce::Identifier &
	)

overrideprotected

◆ valueTreeParentChanged()

void tracktion::engine::Clip::valueTreeParentChanged ( juce::ValueTree & )

overrideprotected

Member Data Documentation

◆ followActionDurationType

juce::CachedValue<FollowActionDurationType> tracktion::engine::Clip::followActionDurationType

The type of duration to use for when to trigger the follow action.

◆ followActionBeats

juce::CachedValue<BeatDuration> tracktion::engine::Clip::followActionBeats

Determines the time for which a launched clip will play before a follow action is taken.

◆ followActionNumLoops

juce::CachedValue<double> tracktion::engine::Clip::followActionNumLoops

Determines the number of loops for which a launched clip will play before a follow action is taken.

◆ state

juce::ValueTree tracktion::engine::Clip::state

The ValueTree of the Clip state.

◆ colour

juce::CachedValue<juce::Colour> tracktion::engine::Clip::colour

The colour property.

Referenced by setColour().

◆ disabled

juce::CachedValue<bool> tracktion::engine::Clip::disabled

Whether the Clip is disabled or not.

Changed to disabled clips won't rebuild the audio graph and they won't get added to playback graph.

◆ isInitialised

bool tracktion::engine::Clip::isInitialised = false

protected

◆ cloneInProgress

bool tracktion::engine::Clip::cloneInProgress = false

protected

◆ clipName

juce::CachedValue<juce::String> tracktion::engine::Clip::clipName

protected

Referenced by getName().

◆ parent

ClipOwner* tracktion::engine::Clip::parent = nullptr

protected

◆ clipStart

juce::CachedValue<TimePosition> tracktion::engine::Clip::clipStart

protected

◆ length

juce::CachedValue<TimeDuration> tracktion::engine::Clip::length

protected

◆ offset

juce::CachedValue<TimeDuration> tracktion::engine::Clip::offset

protected

◆ speedRatio

juce::CachedValue<double> tracktion::engine::Clip::speedRatio

protected

Referenced by getSpeedRatio().

◆ sourceFileReference

SourceFileReference tracktion::engine::Clip::sourceFileReference

protected

Referenced by getSourceFileReference().

◆ groupID

juce::CachedValue<EditItemID> tracktion::engine::Clip::groupID

protected

Referenced by getGroupID(), and isGrouped().

◆ linkID

juce::CachedValue<juce::String> tracktion::engine::Clip::linkID

protected

Referenced by getLinkGroupID(), isLinked(), and setLinkGroupID().

◆ currentSourceFile

juce::File tracktion::engine::Clip::currentSourceFile

protected

Referenced by getCurrentSourceFile().

◆ syncType

juce::CachedValue<SyncType> tracktion::engine::Clip::syncType

protected

Referenced by getSyncType(), tracktion::engine::MarkerClip::isSyncAbsolute(), tracktion::engine::MarkerClip::isSyncBarsBeats(), and setSyncType().

◆ showingTakes

juce::CachedValue<bool> tracktion::engine::Clip::showingTakes

protected

Referenced by isShowingTakes(), and setShowingTakes().

◆ patternGenerator

std::unique_ptr<PatternGenerator> tracktion::engine::Clip::patternGenerator

protected

◆ updateLinkedClipsCaller

AsyncCaller tracktion::engine::Clip::updateLinkedClipsCaller

protected

◆ listeners

juce::ListenerList<Listener> tracktion::engine::Clip::listeners

protected

Referenced by getListeners().

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

tracktion_Clip.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

◆ Array

Member Enumeration Documentation

◆ FollowActionDurationType

◆ SyncType

Constructor & Destructor Documentation

◆ Clip()

◆ ~Clip()

Member Function Documentation

◆ initialise()

◆ isClipState() [1/2]

◆ isClipState() [2/2]

◆ createClipForState()

◆ flushStateToValueTree()

◆ sourceMediaChanged()

◆ pitchTempoTrackChanged()

◆ getName()

◆ setName()

◆ isMidi()

◆ canBeAddedTo()

◆ usesSourceFile()

◆ getSourceFileReference()

◆ getCurrentSourceFile()

◆ getReferencedItems()

◆ reassignReferencedItem()

◆ getLaunchHandle()

◆ setUsesGlobalLaunchQuatisation()

◆ usesGlobalLaunchQuatisation()

◆ getLaunchQuantisation()

◆ getFollowActions()

◆ getPosition()

◆ getContentBeatAtTime()

◆ getTimeOfContentBeat()

◆ getMaximumLength()

◆ getInterestingTimes()

◆ getSpottingPoint()

◆ canLoop()

◆ isLooping()

◆ beatBasedLooping()

◆ setNumberOfLoops()

◆ disableLooping()

◆ getLoopStartBeats()

◆ getLoopStart()

◆ getLoopLengthBeats()

◆ getLoopLength()

◆ getLoopRange()

◆ getLoopRangeBeats()

◆ setLoopRange()

◆ setLoopRangeBeats()

◆ isMuted()

◆ setMuted()

◆ setSyncType()

◆ getSyncType()

◆ setPosition()

◆ setStart()

◆ setLength()

◆ setEnd()

◆ setOffset()

◆ trimAwayOverlap()

◆ removeFromParent()

◆ moveTo()

◆ getSpeedRatio()

◆ setSpeedRatio()

◆ rescale()

◆ isGrouped()

◆ getGroupParent()

◆ setGroup()

◆ getGroupID()

◆ getGroupClip()

◆ isLinked()

◆ setLinkGroupID()