Namespaces

VoiceSamplePlayerNode /

#include “cinder/audio/Voice.h”

Typedefs:

VoiceSamplePlayerNodeRef

Class Hierarchy:

cinder::audio::Voice
cinder::audio::VoiceSamplePlayerNode

Related Links:

Audio in Cinder

Concrete Voice for sample playback.

Depending on the size of the specified file, playback will either be done in-memory (with BufferPlayerNode ) or streaming (with FilePlayerNode ). The maximum frames for in-memory playback can be specified with Voice::Options::maxFramesForBufferPlayback() Create with Voice::create( const SourceFileRef &sourceFile, const Options &options )

Public Member Functions

NodeRef

getInputNode () const override

Returns the Node that is the source of this Voice 's audio production. The Node type is determined by the Voice subclassed.
SamplePlayerNodeRef

getSamplePlayerNode () const

Returns a shared_ptr of the owned SamplePlayerNode .
void

start () override

Starts the Voice . Does nothing if currently playing.

In the case of a VoiceSamplePlayerNode and the sample has reached EOF, start() will start from the beginning.
void

stop () override

Stops the Voice , resetting its state to the same as when it was created.
void

pause ()

Pauses the Voice inits current state. start() will resume from here.
bool

isPlaying () const

Returns whether the Voice is currently playing or not.
NodeRef

getOutputNode () const

Returns the Node that is used for connected the Voice to the greater audio graph (by default, it is connected to Context::master() ).
void

setVolume (float volume)
void

setPan (float pos)
float

getVolume () const
float

getPan () const

Static Public Member Functions

VoiceSamplePlayerNodeRef

create (const SourceFileRef &sourceFile, const Options &options=Options())

Creates a Voice that manages sample playback of an audio file pointed at with sourceFile .
VoiceRef

create (const CallbackProcessorFn &callbackFn, const Options &options=Options())

Creates a Voice that continuously calls callbackFn to process a Buffer of samples.
void

clearBufferCache ()

Clears all audio file buffers that that are cached in the Mixer.

Protected Member Functions

VoiceSamplePlayerNode (const SourceFileRef &sourceFile, const Options &options)

Protected Attributes

SamplePlayerNodeRef

mNode

Friends

friend class

Voice