Used as a template parameter for AudioData::Pointer. More...

Public Member Functions
	Pointer (typename Constness::VoidType *sourceData) noexcept
	Creates a non-interleaved pointer from some raw data in the appropriate format.
	Pointer (typename Constness::VoidType *sourceData, int numInterleavedChannels) noexcept
	Creates a pointer from some raw data in the appropriate format with the specified number of interleaved channels.
	Pointer (const Pointer &other) noexcept
	Creates a copy of another pointer.
Pointer &	operator= (const Pointer &other) noexcept
float	getAsFloat () const noexcept
	Returns the value of the first sample as a floating point value.
void	setAsFloat (float newValue) noexcept
	Sets the value of the first sample as a floating point value.
int32	getAsInt32 () const noexcept
	Returns the value of the first sample as a 32-bit integer.
void	setAsInt32 (int32 newValue) noexcept
	Sets the value of the first sample as a 32-bit integer.
Pointer &	operator++ () noexcept
	Moves the pointer along to the next sample.
Pointer &	operator-- () noexcept
	Moves the pointer back to the previous sample.
Pointer &	operator+= (int samplesToJump) noexcept
	Adds a number of samples to the pointer's position.
void	convertSamples (Pointer source, int numSamples) const noexcept
	Writes a stream of samples into this pointer from another pointer.
template<class OtherPointerType >
void	convertSamples (OtherPointerType source, int numSamples) const noexcept
	Writes a stream of samples into this pointer from another pointer.
void	clearSamples (int numSamples) const noexcept
	Sets a number of samples to zero.
int	getNumInterleavedChannels () const noexcept
	Returns the number of interleaved channels in the format.
int	getNumBytesBetweenSamples () const noexcept
	Returns the number of bytes between the start address of each sample.
const void *	getRawData () const noexcept
	Returns a pointer to the underlying data.
Static Public Member Functions
static bool	isFloatingPoint () noexcept
	Returns true if the pointer is using a floating-point format.
static bool	isBigEndian () noexcept
	Returns true if the format is big-endian.
static int	getBytesPerSample () noexcept
	Returns the number of bytes in each sample (ignoring the number of interleaved channels).
static int	get32BitResolution () noexcept
	Returns the accuracy of this format when represented as a 32-bit integer.

Detailed Description

template<typename SampleFormat, typename Endianness, typename InterleavingType, typename Constness>
class AudioData::Pointer< SampleFormat, Endianness, InterleavingType, Constness >

Used as a template parameter for AudioData::Pointer.

Indicates that the samples can only be used for const data.. A pointer to a block of audio data with a particular encoding.

This object can be used to read and write from blocks of encoded audio samples. To create one, you specify the audio format as a series of template parameters, e.g.

        // this creates a pointer for reading from a const array of 16-bit little-endian packed samples.
        AudioData::Pointer <AudioData::Int16,
                            AudioData::LittleEndian,
                            AudioData::NonInterleaved,
                            AudioData::Const> pointer (someRawAudioData);

        // These methods read the sample that is being pointed to
        float firstSampleAsFloat = pointer.getAsFloat();
        int32 firstSampleAsInt = pointer.getAsInt32();
        ++pointer; // moves the pointer to the next sample.
        pointer += 3; // skips the next 3 samples.

The convertSamples() method lets you copy a range of samples from one format to another, automatically converting its format.

See also:: AudioData::Converter