ark::SoundRegion Class Reference

#include <SoundRegion.h>

List of all members.

Public Types
enum	ChannelMask { AllChannels = 0, LeftChannel, RightChannel }
Public Member Functions
	SoundRegion ()
	SoundRegion (unsigned begin, unsigned len, ChannelMask chan=AllChannels)
unsigned	offset () const
unsigned	endOffset () const
unsigned	length () const
void	setOffset (unsigned n)
void	setLength (unsigned n)
ChannelMask	channels () const
void	setChannels (ChannelMask n)
bool	operator== (SoundRegion const &reg) const
bool	operator!= (SoundRegion const &reg) const
bool	operator< (SoundRegion const &reg) const
bool	containsFrame (unsigned frame) const
bool	containsRegion (SoundRegion const &reg) const
Static Public Member Functions
static SoundRegion const &	empty ()
Private Types
typedef Loki::SingletonHolder< SoundRegion >	_emptyReg
Private Attributes
unsigned	_beginOff
int	_frames
ChannelMask	_channels

---

Detailed Description

SoundRegion SoundRegion is a C++ POD which represents a range of samples in a sound resource. TODO: Currently channel mask is ignored, implement it's use.

---

Member Typedef Documentation

typedef Loki::SingletonHolder<SoundRegion> ark::SoundRegion::_emptyReg [private]

---

Member Enumeration Documentation

enum ark::SoundRegion::ChannelMask

Enumerator: AllChannels  LeftChannel  RightChannel

---

Constructor & Destructor Documentation

ark::SoundRegion::SoundRegion (   )  [inline]

ark::SoundRegion::SoundRegion (  unsigned  begin, unsigned  len, ChannelMask  chan = AllChannels )  [inline]

---

Member Function Documentation

ChannelMask ark::SoundRegion::channels (   )  const [inline]

bool ark::SoundRegion::containsFrame (  unsigned  frame  )  const [inline]

bool ark::SoundRegion::containsRegion (  SoundRegion const &  reg  )  const [inline]

static SoundRegion const& ark::SoundRegion::empty (   )  [inline, static]

unsigned ark::SoundRegion::endOffset (   )  const [inline]

unsigned ark::SoundRegion::length (   )  const [inline]

unsigned ark::SoundRegion::offset (   )  const [inline]

bool ark::SoundRegion::operator!= (  SoundRegion const &  reg  )  const [inline]

bool ark::SoundRegion::operator< (  SoundRegion const &  reg  )  const [inline]

bool ark::SoundRegion::operator== (  SoundRegion const &  reg  )  const [inline]

void ark::SoundRegion::setChannels (  ChannelMask  n  )  [inline]

void ark::SoundRegion::setLength (  unsigned  n  )  [inline]

void ark::SoundRegion::setOffset (  unsigned  n  )  [inline]

---

Member Data Documentation

unsigned ark::SoundRegion::_beginOff [private]

ChannelMask ark::SoundRegion::_channels [private]

int ark::SoundRegion::_frames [private]

---

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

• /Users/Arketype/Projects/WaveEdit copy/Sound/SoundRegion.h

---