replaygain_scanner

#include <replaygain_scanner.h>

Inheritance diagram for replaygain_scanner:

Public Member Functions
virtual replaygain_result::ptr	finalize ()=0
virtual void	process_chunk (const audio_chunk &chunk)=0
Public Member Functions inherited from service_base
template<typename outPtr_t >
bool	cast (outPtr_t &outPtr)
virtual int	service_add_ref ()=0 throw ()
virtual bool	service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)
template<class T >
bool	service_query_t (service_ptr_t< T > &p_out)
virtual int	service_release ()=0 throw ()

Private Member Functions
	FB2K_MAKE_SERVICE_INTERFACE (replaygain_scanner, service_base)

Additional Inherited Members
Public Types inherited from service_base
typedef service_base	t_interface
Protected Member Functions inherited from service_base
	service_base ()
	~service_base ()

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.
.

Definition at line 21 of file replaygain_scanner.h.

Member Function Documentation

replaygain_scanner::FB2K_MAKE_SERVICE_INTERFACE ( replaygain_scanner  , service_base    )

private

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.

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.

---

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

• foobar2000/SDK/replaygain_scanner.h