replaygain_scanner Class Reference
#include <replaygain_scanner.h>
Inheritance diagram for replaygain_scanner:
Public Member Functions | |
| virtual void | process_chunk (const audio_chunk &chunk)=0 |
| virtual replaygain_result::ptr | finalize ()=0 |
Detailed Description
Instance of a ReplayGain scanner.Use static_api_ptr_t<replaygain_scanner_entry>()->instantiate() to create a replaygain_scanner object; see replaygain_scanner_entry for more info.
Typical use: call process_chunk() with each chunk read from your track, call finalize() to obtain results for this track and reset replaygain_scanner's state for scanning another track; to obtain album gain/peak values, merge results (replaygain_result::merge) from all tracks.
Member Function Documentation
| virtual void replaygain_scanner::process_chunk | ( | const audio_chunk & | chunk | ) | [pure virtual] |
Processes a PCM chunk.
May throw exception_io_data if the chunk contains something that can't be processed properly.
| virtual replaygain_result::ptr replaygain_scanner::finalize | ( | ) | [pure virtual] |
Finalizes the scanning process; resets scanner's internal state and returns results for the track we've just scanned.
After calling finalize(), scanner's state becomes the same as after instantiation; you can continue with processing another track without creating a new scanner object.
The documentation for this class was generated from the following files:
- foobar2000/SDK/replaygain_scanner.h
- foobar2000/SDK/guids.cpp
