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

#include <Voice.h>

Public Member Functions

 Options ()
 
Optionschannels (size_t ch)
 
OptionsmaxFramesForBufferPlayback (size_t frames)
 
OptionsconnectToMaster (bool shouldConnect)
 
size_t getChannels () const
 
size_t getMaxFramesForBufferPlayback () const
 
bool getConnectToMaster () const
 

Protected Attributes

size_t mChannels
 
size_t mMaxFramesForBufferPlayback
 
bool mConnectToMaster
 

Detailed Description

Optional parameters passed into Voice::create() methods.

Constructor & Destructor Documentation

cinder::audio::Voice::Options::Options ( )

Member Function Documentation

Options& cinder::audio::Voice::Options::channels ( size_t  ch)

Sets the number of channels for the Voice.

Options& cinder::audio::Voice::Options::maxFramesForBufferPlayback ( size_t  frames)

Sets the maximum number of frames acceptable for a VoiceSamplePlayerNode to use in-memory buffer playback via BufferPlayerNode.

If the file is larger than this, it will be streamed from disk using a FilePlayerNode. Default = 96,000.

Options& cinder::audio::Voice::Options::connectToMaster ( bool  shouldConnect)

Sets whether the Voice's output is automatically connected to master()->getOutput().

If set to false, the user must manage the connection of its output node. Default = true, automaitically connects to master output.

size_t cinder::audio::Voice::Options::getChannels ( ) const

Returns the number of configured channels.

See also
channels()
size_t cinder::audio::Voice::Options::getMaxFramesForBufferPlayback ( ) const

Returns the configured frame allowance for buffer playback.

See also
maxFramesForBufferPlayback()
bool cinder::audio::Voice::Options::getConnectToMaster ( ) const

Returns whether or not the Voice will be automatically connected to master()->getOutput().

Member Data Documentation

size_t cinder::audio::Voice::Options::mChannels
protected
size_t cinder::audio::Voice::Options::mMaxFramesForBufferPlayback
protected
bool cinder::audio::Voice::Options::mConnectToMaster
protected

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