Audio::SubSeekableAudioStream Class Reference

#include <audiostream.h>

Inheritance diagram for Audio::SubSeekableAudioStream:

Public Member Functions
	SubSeekableAudioStream (SeekableAudioStream *parent, const Timestamp start, const Timestamp end, DisposeAfterUse::Flag disposeAfterUse=DisposeAfterUse::YES)
int	readBuffer (int16 *buffer, const int numSamples)
bool	isStereo () const
int	getRate () const
bool	endOfData () const
bool	endOfStream () const
bool	seek (const Timestamp &where)
Timestamp	getLength () const
Public Member Functions inherited from Audio::SeekableAudioStream
bool	seek (uint32 where)
virtual bool	rewind ()

Additional Inherited Members
Static Public Member Functions inherited from Audio::SeekableAudioStream
static SeekableAudioStream *	openStreamFile (const Common::Path &basename)

Detailed Description

A SubSeekableAudioStream class that provides access to a SeekableAudioStream just in the range [start, end).

The same caveats apply to SubSeekableAudioStream as do to SeekableAudioStream.

Manipulating the parent stream directly will break the substream.

Constructor & Destructor Documentation

SubSeekableAudioStream()

Audio::SubSeekableAudioStream::SubSeekableAudioStream	(	SeekableAudioStream *	parent,
		const Timestamp	start,
		const Timestamp	end,
		DisposeAfterUse::Flag	disposeAfterUse = DisposeAfterUse::YES
	)

Create a new SubSeekableAudioStream.

Parameters

parent	Parent stream object.
start	Start time.
end	End time.
disposeAfterUse	Whether the parent stream object should be destroyed on destruction of the SubSeekableAudioStream.

Member Function Documentation

readBuffer()

int Audio::SubSeekableAudioStream::readBuffer ( int16 *  buffer, const int  numSamples  )

virtual

Fill the given buffer with up to numSamples samples.

Data must be in native endianness, 16 bits per sample, signed. For stereo stream, the buffer will be filled with interleaved left and right channel samples, starting with the left sample. Furthermore, the samples in the left and right are summed up. So if you request 4 samples from a stereo stream, you will get a total of two left channel and two right channel samples.

Returns

The actual number of samples read, or -1 if a critical error occurred.

Note

You must check whether the returned value is less than what you requested. This indicates that the stream is fully used up.

Implements Audio::AudioStream.

isStereo()

bool Audio::SubSeekableAudioStream::isStereo ( ) const

inlinevirtual

Check whether this is a stereo stream.

Implements Audio::AudioStream.

getRate()

int Audio::SubSeekableAudioStream::getRate ( ) const

inlinevirtual

Sample rate of the stream.

Implements Audio::AudioStream.

endOfData()

bool Audio::SubSeekableAudioStream::endOfData ( ) const

inlinevirtual

Check whether end of data has been reached.

If this returns true, it indicates that at this time there is no data available in the stream. However, there might be more data in the future.

This is used by e.g. a rate converter to decide whether to keep on converting data or to stop.

Implements Audio::AudioStream.

endOfStream()

bool Audio::SubSeekableAudioStream::endOfStream ( ) const

inlinevirtual

Check whether end of stream has been reached.

If this returns true, it indicates that all data in this stream is used up and no additional data will appear in it in the future.

This is used by the mixer to decide whether a given stream shall be removed from the list of active streams (and thus be destroyed). By default, this maps to endOfData().

Reimplemented from Audio::AudioStream.

seek()

bool Audio::SubSeekableAudioStream::seek ( const Timestamp &  where )

virtual

Seek to a given offset in the stream.

Parameters

where

Offset as a timestamp.

Returns

True on success, false on failure.

Implements Audio::SeekableAudioStream.

getLength()

Timestamp Audio::SubSeekableAudioStream::getLength ( ) const

inlinevirtual

Return the length of the stream.

Returns

Length as a timestamp.

Implements Audio::SeekableAudioStream.

---

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

• audio/audiostream.h