| 
 | Nestopia Core API | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
File IO interface.
| Inner Classes, Typedefs, and Enums | |
| enum | Nes::Api::User::File::ActionAction event. | 
| enum | Nes::Api::User::File::PatchSupported patch formats. | 
| Method Summary | |
|  virtual Nes::Api::User::File::Action | GetAction() const = 0Returns type of action. | 
|  virtual Result | GetContent( const void*& mem, ulong& size ) constReturns a pointer to the content to be saved and its size. | 
|  virtual Result | GetContent( std::ostream& stream ) constSaves the content into an output stream. | 
|  virtual uint | GetId() constReturns the sound file ID to load. | 
|  virtual ulong | GetMaxSize() constReturns the maximum allowed size for the content to load. | 
|  virtual const wchar_t* | GetName() constReturns the name of the file to load. | 
|  virtual Result | GetPatchContent( Nes::Api::User::File::Patch patch, std::ostream& stream ) constSaves the patch content into an output stream. | 
|  virtual Result | SetContent( const void* mem, ulong size )Loads content into the core. | 
|  virtual Result | SetContent( std::istream& stream )Loads content into the core through stream. | 
|  virtual Result | SetPatchContent( std::istream& stream )Loads patch content into the core. | 
|  virtual Result | SetSampleContent( const void* mem, ulong length, bool stereo, uint bits, ulong rate )Loads audio content into the core. | 
| Method Detail | 
public virtual Nes::Api::User::File::Action GetAction() const throw()= 0;
public virtual Result GetContent( const void*& mem, ulong& size ) const throw();
mem - pointer to content
size - size of content
result - codepublic virtual Result GetContent( std::ostream& stream ) const throw();
stream - output stream
result - codepublic virtual uint GetId() const throw();
public virtual ulong GetMaxSize() const throw();
public virtual const wchar_t* GetName() const throw();
public virtual Result GetPatchContent( Nes::Api::User::File::Patch patch, std::ostream& stream ) const throw();
patch - patch format to use
stream - output streampublic virtual Result SetContent( const void* mem, ulong size ) throw();
mem - content
size - size of contentpublic virtual Result SetContent( std::istream& stream ) throw();
stream - input streampublic virtual Result SetPatchContent( std::istream& stream ) throw();
stream - input stream to patchpublic virtual Result SetSampleContent( const void* mem, ulong length, bool stereo, uint bits, ulong rate ) throw();
mem - sample content
length - number of samples
stereo - dual channel if true
bits - bits per sample
rate - sample rate| 
 | Nestopia Core API | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||