AudioClip Class Reference

#include <AudioClip.h>

Inheritance diagram for AudioClip:

Public Member Functions
	DECLARE_CLIP (AudioClip, TimelineClip)
	AudioClip ()
virtual	~AudioClip ()
virtual void	SaveStream (Stream &stream) override
virtual void	LoadStream (Stream &stream, uint32_t version) override
virtual void	GatherProperties (std::vector< Property > &outProps) override
SoundWaveRef	GetSoundWave () const
void	SetSoundWave (SoundWaveRef soundWave)
float	GetVolume () const
float	GetPitch () const
float	GetFadeInDuration () const
float	GetFadeOutDuration () const
AudioClipEndMode	GetEndMode () const
bool	GetLoop () const
Public Member Functions inherited from TimelineClip
	DECLARE_FACTORY_MANAGER (TimelineClip)
	DECLARE_FACTORY (TimelineClip, TimelineClip)
	DECLARE_OBJECT (TimelineClip, Object)
	TimelineClip ()
virtual	~TimelineClip ()
float	GetStartTime () const
void	SetStartTime (float time)
float	GetDuration () const
void	SetDuration (float duration)
float	GetEndTime () const
float	GetClipInTime () const
void	SetClipInTime (float time)
float	GetClipOutTime () const
void	SetClipOutTime (float time)
float	GetSpeed () const
void	SetSpeed (float speed)
bool	ContainsTime (float globalTime) const
float	GetLocalTime (float globalTime) const
bool	OverlapsWith (const TimelineClip *other) const
virtual bool	SupportsKeyframes () const
virtual uint32_t	GetNumKeyframes () const
virtual float	GetKeyframeTime (uint32_t index) const
virtual void	AddKeyframeAtTime (float localTime, Node *targetNode)
virtual void	SetKeyframeTime (uint32_t index, float time)
virtual void	RemoveKeyframe (uint32_t index)
Public Member Functions inherited from Object
virtual	~Object ()=default
virtual const char *	RuntimeName () const =0
virtual const char *	RuntimeParentName () const =0
virtual RuntimeId	InstanceRuntimeId () const =0
virtual Object *	QueryInterface (RuntimeId id) const
virtual bool	Is (RuntimeId id) const
virtual bool	Is (const char *name) const
virtual bool	DrawCustomProperty (Property &prop)
template<typename T >
T *	As () const
virtual bool	Equals (const Object *rhs) const

Protected Attributes
SoundWaveRef	mSoundWave
float	mVolume = 1.0f
float	mPitch = 1.0f
float	mFadeInDuration = 0.0f
float	mFadeOutDuration = 0.0f
AudioClipEndMode	mEndMode = AudioClipEndMode::Stop
bool	mLoop = false
Protected Attributes inherited from TimelineClip
float	mStartTime = 0.0f
float	mDuration = 1.0f
float	mClipInTime = 0.0f
float	mClipOutTime = 0.0f
float	mSpeed = 1.0f

Additional Inherited Members
Static Public Member Functions inherited from Object
static const char *	ClassRuntimeName ()

Constructor & Destructor Documentation

AudioClip()

AudioClip::AudioClip

(

)

~AudioClip()

AudioClip::~AudioClip ( )

virtual

Member Function Documentation

DECLARE_CLIP()

AudioClip::DECLARE_CLIP	(	AudioClip	,
		TimelineClip
	)

GatherProperties()

void AudioClip::GatherProperties ( std::vector< Property > &  outProps )

overridevirtual

Reimplemented from TimelineClip.

GetEndMode()

AudioClipEndMode AudioClip::GetEndMode ( ) const

inline

GetFadeInDuration()

float AudioClip::GetFadeInDuration ( ) const

inline

GetFadeOutDuration()

float AudioClip::GetFadeOutDuration ( ) const

inline

GetLoop()

bool AudioClip::GetLoop ( ) const

inline

GetPitch()

float AudioClip::GetPitch ( ) const

inline

GetSoundWave()

SoundWaveRef AudioClip::GetSoundWave ( ) const

inline

GetVolume()

float AudioClip::GetVolume ( ) const

inline

LoadStream()

void AudioClip::LoadStream ( Stream &  stream, uint32_t  version  )

overridevirtual

Reimplemented from TimelineClip.

SaveStream()

void AudioClip::SaveStream ( Stream &  stream )

overridevirtual

Reimplemented from TimelineClip.

SetSoundWave()

void AudioClip::SetSoundWave ( SoundWaveRef  soundWave )

inline

Member Data Documentation

mEndMode

AudioClipEndMode AudioClip::mEndMode = AudioClipEndMode::Stop

protected

mFadeInDuration

float AudioClip::mFadeInDuration = 0.0f

protected

mFadeOutDuration

float AudioClip::mFadeOutDuration = 0.0f

protected

mLoop

bool AudioClip::mLoop = false

protected

mPitch

float AudioClip::mPitch = 1.0f

protected

mSoundWave

SoundWaveRef AudioClip::mSoundWave

protected

mVolume

float AudioClip::mVolume = 1.0f

protected

---

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

• Engine/Source/Engine/Timeline/Tracks/AudioClip.h
• Engine/Source/Engine/Timeline/Tracks/AudioClip.cpp