Member Function Documentation

The provided stream reference is valid as long as the SoundFileReader is alive, so it is safe to use/store it during the whole lifetime of the reader.

Parameters

stream

Source stream to read from

info

Structure to fill with the properties of the loaded sound

Returns

True if the file was successfully opened

virtual Uint64 sf::SoundFileReader::read

(

Int16 *

samples,

Uint64

maxCount

)

pure virtual

Read audio samples from the open file.

Parameters

samples

Pointer to the sample array to fill

maxCount

Maximum number of samples to read

Returns

Number of samples actually read (may be less than maxCount)

virtual void sf::SoundFileReader::seek

(

Uint64

sampleOffset

)

pure virtual

Change the current read position to the given sample offset.

The sample offset takes the channels into account. Offsets can be calculated like this: sampleNumber * sampleRate * channelCount If the given offset exceeds to total number of samples, this function must jump to the end of the file.

Parameters

sampleOffset

Index of the sample to jump to, relative to the beginning

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