input_info_writer Class Reference
#include <input.h>
Inheritance diagram for input_info_writer:
Public Types | |
| typedef input_info_writer | t_interface |
| typedef input_info_reader | t_interface_parent |
Public Member Functions | |
| virtual void | set_info (t_uint32 p_subsong, const file_info &p_info, abort_callback &p_abort)=0 |
| virtual void | commit (abort_callback &p_abort)=0 |
Static Public Attributes | |
| static const GUID | class_guid |
Detailed Description
Class providing interface for writing metadata and replaygain info to files. Also see: file_info.Instantiating: see input_entry.
Implementing: see input_impl.
Member Typedef Documentation
Reimplemented from input_info_reader.
Reimplemented from input_info_reader.
Member Function Documentation
| virtual void input_info_writer::set_info | ( | t_uint32 | p_subsong, | |
| const file_info & | p_info, | |||
| abort_callback & | p_abort | |||
| ) | [pure virtual] |
Tells the service to update file tags with new info for specified subsong.
- Parameters:
-
p_subsong Subsong to update. Should be always 0 for non-multisubsong-enabled inputs. p_info New info to write. Sometimes not all contents of p_info can be written. Caller will typically read info back after successful write, so e.g. tech infos that change with retag are properly maintained. p_abort abort_callback object signaling user aborting the operation. WARNING: abort_callback object is provided for consistency; if writing tags actually gets aborted, user will be likely left with corrupted file. Anything calling this should make sure that aborting is either impossible, or gives appropriate warning to the user first.
| virtual void input_info_writer::commit | ( | abort_callback & | p_abort | ) | [pure virtual] |
Commits pending updates. In case of multisubsong inputs, set_info should queue the update and perform actual file access in commit(). Otherwise, actual writing can be done in set_info() and then Commit() can just do nothing and always succeed.
- Parameters:
-
p_abort abort_callback object signaling user aborting the operation. WARNING: abort_callback object is provided for consistency; if writing tags actually gets aborted, user will be likely left with corrupted file. Anything calling this should make sure that aborting is either impossible, or gives appropriate warning to the user first.
Member Data Documentation
const GUID input_info_writer::class_guid [static] |
Initial value:
{ 0xfe40ff66, 0x64c9, 0x4234, { 0xb6, 0x39, 0x2, 0x8d, 0xc8, 0x6, 0xc, 0xf7 } }
Reimplemented from input_info_reader.
The documentation for this class was generated from the following files:
