Cinder  0.9.1
Public Member Functions | Friends | List of all members
cinder::audio::Event Class Reference

#include <Param.h>

Public Member Functions

double getTimeBegin () const
 
double getTimeEnd () const
 
double getDuration () const
 
float getValueBegin () const
 
float getValueEnd () const
 
const RampFngetRampFn () const
 
bool getCopyValueOnBegin () const
 
void setValueBegin (float value)
 
void cancel ()
 
bool isComplete () const
 
const std::string & getLabel () const
 

Friends

class Param
 

Detailed Description

Class representing a sample-accurate parameter control instruction.

See also
Param::applyRamp(), Param::appendRamp()

Member Function Documentation

double cinder::audio::Event::getTimeBegin ( ) const
double cinder::audio::Event::getTimeEnd ( ) const
double cinder::audio::Event::getDuration ( ) const
float cinder::audio::Event::getValueBegin ( ) const
Note
if getCopyValueOnBegin() is true then the begin value may not be known until the Event begins to be processed.
float cinder::audio::Event::getValueEnd ( ) const
const RampFn& cinder::audio::Event::getRampFn ( ) const
bool cinder::audio::Event::getCopyValueOnBegin ( ) const

Returns whether the Param's current value will be copied when this Event begins or not.

void cinder::audio::Event::setValueBegin ( float  value)

Sets the value that will be used when this Event begins.

void cinder::audio::Event::cancel ( )
bool cinder::audio::Event::isComplete ( ) const
const std::string& cinder::audio::Event::getLabel ( ) const

Returns the label that was assigned when the Event was created, or an empty string. Useful when debugging.

Friends And Related Function Documentation

friend class Param
friend

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