A class that represents a region of a sound resource and its playback parameters. More...

#include <omSoundRegion.h>

Public Member Functions
	SoundRegion ()
	Create a new default sound region without a valid sound resource. More...

	SoundRegion (Sound *newSound)
	Create a new default sound region with the specified sound resource. More...

Public Attributes
Sound *	sound
	A pointer to the sound that this region uses for sound data. More...

om::sound::plugins::SoundPlugin *	insert
	A plugin that should be used to process the audio for the region. More...

Time	start
	The starting playback position in the sound resource of this region. More...

Time	length
	The length of time to play from the sound resource. More...

Time	fadeInTime
	The length of time that should be used to fade in the sound resource to its full volume. More...

Time	fadeOutTime
	The length of time that should be used to fade out the sound resource from its full volume to silence. More...

Float	speed
	A scale factor for the playback speed, where 1 is the normal speed. More...

Float	gain
	A linear gain factor for the sound from this region. More...

PanDirection	pan
	The panning direction that should be used when playing this region. More...

Detailed Description

A class that represents a region of a sound resource and its playback parameters.

Constructor & Destructor Documentation

om::sound::base::SoundRegion::SoundRegion ( )

inline

Create a new default sound region without a valid sound resource.

om::sound::base::SoundRegion::SoundRegion ( Sound * newSound )

inline

Create a new default sound region with the specified sound resource.

Sound* om::sound::base::SoundRegion::sound

A pointer to the sound that this region uses for sound data.

om::sound::plugins::SoundPlugin* om::sound::base::SoundRegion::insert

A plugin that should be used to process the audio for the region.

Time om::sound::base::SoundRegion::start

The starting playback position in the sound resource of this region.

Time om::sound::base::SoundRegion::length

The length of time to play from the sound resource.

A value of zero indicates the entire sound should be played.

Time om::sound::base::SoundRegion::fadeInTime

The length of time that should be used to fade in the sound resource to its full volume.

A value of zero indicates there is no fading performed.

Time om::sound::base::SoundRegion::fadeOutTime

The length of time that should be used to fade out the sound resource from its full volume to silence.

A value of zero indicates there is no fading performed.

Float om::sound::base::SoundRegion::speed

A scale factor for the playback speed, where 1 is the normal speed.

Float om::sound::base::SoundRegion::gain

A linear gain factor for the sound from this region.

PanDirection om::sound::base::SoundRegion::pan

The panning direction that should be used when playing this region.

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