input_info_reader Class Reference

#include <input.h>

Inheritance diagram for input_info_reader:

service_base input_decoder input_info_writer

List of all members.

Public Types

typedef input_info_reader t_interface
typedef service_base t_interface_parent

Public Member Functions

virtual t_uint32 get_subsong_count ()=0
virtual t_uint32 get_subsong (t_uint32 p_index)=0
virtual void get_info (t_uint32 p_subsong, file_info &p_info, abort_callback &p_abort)=0
virtual t_filestats get_file_stats (abort_callback &p_abort)=0
 Retrieves file stats. Equivalent to calling get_stats() on file object.

Static Public Attributes

static const GUID class_guid


Detailed Description

Class providing interface for retrieval of information (metadata, duration, replaygain, other tech infos) from files. Also see: file_info.
Instantiating: see input_entry.
Implementing: see input_impl.

Member Typedef Documentation

Reimplemented from service_base.

Reimplemented in input_decoder, and input_info_writer.

Reimplemented in input_decoder, and input_info_writer.


Member Function Documentation

virtual t_uint32 input_info_reader::get_subsong_count (  )  [pure virtual]

Retrieves count of subsongs in the file. 1 for non-multisubsong-enabled inputs. Note: multi-subsong handling is disabled for remote files (see: filesystem::is_remote) for performance reasons. Remote files are always assumed to be single-subsong, with null index.

virtual t_uint32 input_info_reader::get_subsong ( t_uint32  p_index  )  [pure virtual]

Retrieves identifier of specified subsong; this identifier is meant to be used in playable_location as well as a parameter for input_info_reader::get_info().

Parameters:
p_index Index of subsong to query. Must be >=0 and < get_subsong_count().

virtual void input_info_reader::get_info ( t_uint32  p_subsong,
file_info p_info,
abort_callback &  p_abort 
) [pure virtual]

Retrieves information about specified subsong.

Parameters:
p_subsong Identifier of the subsong to query. See: input_info_reader::get_subsong(), playable_location.
p_info file_info object to fill. Must be empty on entry.
p_abort abort_callback object signaling user aborting the operation.

virtual t_filestats input_info_reader::get_file_stats ( abort_callback &  p_abort  )  [pure virtual]

Retrieves file stats. Equivalent to calling get_stats() on file object.


Member Data Documentation

const GUID input_info_reader::class_guid [static]

Initial value:

 
{ 0x8e9bb1d4, 0xa52b, 0x4df6, { 0xa9, 0x29, 0x1a, 0xae, 0x40, 0x75, 0x38, 0x8a } }

Reimplemented in input_decoder, and input_info_writer.


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

Generated on Fri Apr 18 13:56:52 2008 for foobar2000 SDK by  doxygen 1.5.5