Cinder  0.9.1
Public Member Functions | List of all members
cinder::audio::Param::Options Struct Reference

#include <Param.h>

Public Member Functions

 Options ()
 
Optionsdelay (double delay)
 
OptionsbeginTime (double time)
 
OptionsrampFn (const RampFn &rampFn)
 
Optionslabel (const std::string &label)
 
double getDelay () const
 
double getBeginTime () const
 
const RampFngetRampFn () const
 
const std::string & getLabel () const
 

Detailed Description

Optional parameters when applying or appending ramps.

See also
applyRamp()
appendRamp()

Constructor & Destructor Documentation

cinder::audio::Param::Options::Options ( )

Member Function Documentation

Options& cinder::audio::Param::Options::delay ( double  delay)

Specifies a delay of delay in seconds.

Options& cinder::audio::Param::Options::beginTime ( double  time)

Specifies the begin time in seconds. If this is value is greater or equal to zero, delay() is ignored.

Options& cinder::audio::Param::Options::rampFn ( const RampFn rampFn)

Specifies the ramping function used during evaluation.

Options& cinder::audio::Param::Options::label ( const std::string &  label)

Sets a label that will be assigned to the Event. Useful when debugging.

double cinder::audio::Param::Options::getDelay ( ) const

Returns the delay specified in seconds.

double cinder::audio::Param::Options::getBeginTime ( ) const

Returns the begin time specified in seconds.

const RampFn& cinder::audio::Param::Options::getRampFn ( ) const

Returns the ramping function that will be used during evaluation.

const std::string& cinder::audio::Param::Options::getLabel ( ) const

Returns a label that will be assigned to the Event. Useful when debugging.


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