A class that represents the result of a sound frame. More...

#include <omSoundResult.h>

Public Types
enum	Status { SUCCESS = 1, SILENCE = 0, END = 2, ERROR = -1 }
	An enum type which describes the different allowed result statuses. More...

Public Member Functions
	SoundResult ()
	Create new result with the END status that has 0 valid output samples. More...

	SoundResult (Size newNumSamples)
	Create new result with the SUCCESS status that has the specified number of valid output samples. More...

	SoundResult (Status newStatus)
	Create new result with the specified status that has 0 valid output samples. More...

	SoundResult (Status newStatus, Size newNumSamples)
	Create new result with the given status that has the specified number of valid output samples. More...

Size	getSampleCount () const
	Return the total number of samples that were produced as part of this sound result. More...

Status	getStatus () const
	Return an enum value representing the status of this sound result. More...

	operator Status () const
	Convert this sound result to an enum value representing its status. More...

	operator Bool () const
	Convert this sound result to a boolean value indicating if the result is a successful one. More...

	operator Size () const
	Convert this sound result into an integer representing the number of samples that were processed. More...

Detailed Description

A class that represents the result of a sound frame.

Member Enumeration Documentation

An enum type which describes the different allowed result statuses.

Enumerator
SUCCESS	A result status indicating that sound processing was successful. The number of samples that were successfully processed is stored in the result.
SILENCE	A result status indicating that sound processing was successful and that the result is silence. This status means that all outputs of the given sound processing step should be interpreted as silent for the number of samples given by the result. This status can be used to ignore sound outputs that produce no sound and thus don't need to be processed.
END	A result status indicating that there are no more sound samples to process. This status is primarily valid when used by a sound that does not depend on any input (such as a sound player). It indicates that the end of the given sound source has been reached and will not produce anymore sound. Therefore, this status could be used to halt usage of a particular output-only sound once it has produced all sound it can.
ERROR	A result status indicating that an error occurred during processing. The number of samples that were successfully processed is stored in the result. Therefore, a sound can indicate if an error occurred while still producing some audio.

om::sound::base::SoundResult::SoundResult ( )

inline

Create new result with the END status that has 0 valid output samples.

om::sound::base::SoundResult::SoundResult ( Size newNumSamples )

inline

Create new result with the SUCCESS status that has the specified number of valid output samples.

om::sound::base::SoundResult::SoundResult ( Status newStatus )

inline

Create new result with the specified status that has 0 valid output samples.

om::sound::base::SoundResult::SoundResult	(	Status	newStatus,
		Size	newNumSamples
	)

inline

Create new result with the given status that has the specified number of valid output samples.

Size om::sound::base::SoundResult::getSampleCount ( ) const

inline

Return the total number of samples that were produced as part of this sound result.

Status om::sound::base::SoundResult::getStatus ( ) const

inline

Return an enum value representing the status of this sound result.

om::sound::base::SoundResult::operator Status ( ) const

inline

Convert this sound result to an enum value representing its status.

om::sound::base::SoundResult::operator Bool ( ) const

inline

Convert this sound result to a boolean value indicating if the result is a successful one.

The result statuses that indicate a successful result are SUCCESS and SILENCE.

om::sound::base::SoundResult::operator Size ( ) const

inline

Convert this sound result into an integer representing the number of samples that were processed.

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