engine::LiveClipLevel Struct Reference

Provides a thread-safe way to share a clip's levels with an audio engine without worrying about the Clip being deleted from underneath you. More...

#include <tracktion_Clip.h>

Public Member Functions
	LiveClipLevel () noexcept=default
	Creates an empty LiveClipLevel.
	LiveClipLevel (std::shared_ptr< ClipLevel > l) noexcept
	Creates a LiveClipLevel from a ClipLevel.
float	getGain () const noexcept
	Returns the clip's absolute gain.
float	getPan () const noexcept
	Returns the clip's pan from -1.0 to 1.0.
bool	isMute () const noexcept
	Returns true if the clip is muted.
float	getGainIncludingMute () const noexcept
	Returns the clip's gain if the clip is not muted.
void	getLeftAndRightGains (float &left, float &right) const noexcept
	Reutrns the left and right gains taking in to account mute and pan values.

Detailed Description

Provides a thread-safe way to share a clip's levels with an audio engine without worrying about the Clip being deleted from underneath you.

Constructor & Destructor Documentation

LiveClipLevel() [1/2]

engine::LiveClipLevel::LiveClipLevel ( )

defaultnoexcept

Creates an empty LiveClipLevel.

LiveClipLevel() [2/2]

engine::LiveClipLevel::LiveClipLevel ( std::shared_ptr< ClipLevel >  l )

noexcept

Creates a LiveClipLevel from a ClipLevel.

Member Function Documentation

getGain()

float engine::LiveClipLevel::getGain ( ) const

noexcept

Returns the clip's absolute gain.

References engine::dbToGain().

Referenced by engine::MidiNodeHelpers::createMessagesForTime().

getPan()

float engine::LiveClipLevel::getPan ( ) const

noexcept

Returns the clip's pan from -1.0 to 1.0.

isMute()

bool engine::LiveClipLevel::isMute ( ) const

noexcept

Returns true if the clip is muted.

Referenced by engine::MidiNodeHelpers::createMessagesForTime().

getGainIncludingMute()

float engine::LiveClipLevel::getGainIncludingMute ( ) const

noexcept

Returns the clip's gain if the clip is not muted.

getLeftAndRightGains()

void engine::LiveClipLevel::getLeftAndRightGains ( float &  left, float &  right  ) const

noexcept

Reutrns the left and right gains taking in to account mute and pan values.

---

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

• tracktion_Clip.h