wxBatchTextToMP3Encoder Class Reference

A class for doing text to MP3 encoding in the background. More...

#include <tts/tts_batchencoder.h>

List of all members.

Public Member Functions

 wxBatchTextToMP3Encoder ()
 ~wxBatchTextToMP3Encoder ()
void Init ()
 Member initialisation.
virtual bool SetData (const wxArrayString &textFilenames, const wxArrayString &audioFilenames, const wxID3InfoArray &infoArray)
 Set data.
virtual bool Start (int options=0, wxString *log=NULL)
 Starting encoding the text files to MP3.
virtual bool Process (wxString *log=NULL, bool *finished=NULL)
 Check whether the next step should be done.
virtual bool IsBusy ()
 Is it busy?
virtual bool Stop ()
 Stop encoding.
void SetOptions (int options)
 Set/get the options.
int GetOptions () const
void SetMP3EncoderOptions (int options)
 Set/get the MP3 encoder options.
int GetMP3EncoderOptions () const
wxTextToSpeechGetSpeech ()
 Get the wxEspeak object.
const wxTextToSpeechGetSpeech () const
wxMP3EncoderGetMP3Encoder ()
 Get the wxMP3Encoder object.
const wxMP3EncoderGetMP3Encoder () const
void SetCurrentFile (int currentFile)
 Set/get the current file.
int GetCurrentFile () const
void SetStatus (wxBatchTextToMP3EncoderStatus status)
 Set/get the current status.
wxBatchTextToMP3EncoderStatus GetStatus () const
void SetFrame (wxFrame *frame, int statusField=0)
 Set/get the frame whose status line should be used for information.
wxFrame * GetFrame () const
void SetVerbosity (int verbosity)
 Set/get the verbosity.
int GetVerbosity () const
const wxArrayString & GetTextFilenames () const
const wxArrayString & GetOutputFilenames () const
const wxID3InfoArray & GetID3InfoArray () const

Protected Attributes

int m_options
int m_mp3EncoderOptions
wxTextToSpeech m_textToSpeech
wxMP3Encoder m_mp3Encoder
wxArrayString m_textFilenames
wxArrayString m_outputFilenames
wxID3InfoArray m_infoArray
int m_currentFile
wxBatchTextToMP3EncoderStatus m_status
wxFrame * m_frame
int m_statusField
int m_verbosity


Detailed Description

A class for doing text to MP3 encoding in the background.


Constructor & Destructor Documentation

wxBatchTextToMP3Encoder::wxBatchTextToMP3Encoder (  ) 

wxBatchTextToMP3Encoder::~wxBatchTextToMP3Encoder (  ) 


Member Function Documentation

void wxBatchTextToMP3Encoder::Init (  ) 

Member initialisation.

bool wxBatchTextToMP3Encoder::SetData ( const wxArrayString &  textFilenames,
const wxArrayString &  audioFilenames,
const wxID3InfoArray &  infoArray 
) [virtual]

Set data.

bool wxBatchTextToMP3Encoder::Start ( int  options = 0,
wxString *  log = NULL 
) [virtual]

Starting encoding the text files to MP3.

bool wxBatchTextToMP3Encoder::Process ( wxString *  log = NULL,
bool *  finished = NULL 
) [virtual]

Check whether the next step should be done.

If it returns false, the whole batch process has finished. finished can be set to true if the whole process has _just_ finished.

virtual bool wxBatchTextToMP3Encoder::IsBusy (  )  [inline, virtual]

Is it busy?

bool wxBatchTextToMP3Encoder::Stop (  )  [virtual]

Stop encoding.

void wxBatchTextToMP3Encoder::SetOptions ( int  options  )  [inline]

Set/get the options.

int wxBatchTextToMP3Encoder::GetOptions (  )  const [inline]

void wxBatchTextToMP3Encoder::SetMP3EncoderOptions ( int  options  )  [inline]

Set/get the MP3 encoder options.

int wxBatchTextToMP3Encoder::GetMP3EncoderOptions (  )  const [inline]

wxTextToSpeech& wxBatchTextToMP3Encoder::GetSpeech (  )  [inline]

Get the wxEspeak object.

const wxTextToSpeech& wxBatchTextToMP3Encoder::GetSpeech (  )  const [inline]

wxMP3Encoder& wxBatchTextToMP3Encoder::GetMP3Encoder (  )  [inline]

Get the wxMP3Encoder object.

const wxMP3Encoder& wxBatchTextToMP3Encoder::GetMP3Encoder (  )  const [inline]

void wxBatchTextToMP3Encoder::SetCurrentFile ( int  currentFile  )  [inline]

Set/get the current file.

int wxBatchTextToMP3Encoder::GetCurrentFile (  )  const [inline]

void wxBatchTextToMP3Encoder::SetStatus ( wxBatchTextToMP3EncoderStatus  status  )  [inline]

Set/get the current status.

wxBatchTextToMP3EncoderStatus wxBatchTextToMP3Encoder::GetStatus (  )  const [inline]

void wxBatchTextToMP3Encoder::SetFrame ( wxFrame *  frame,
int  statusField = 0 
) [inline]

Set/get the frame whose status line should be used for information.

wxFrame* wxBatchTextToMP3Encoder::GetFrame (  )  const [inline]

void wxBatchTextToMP3Encoder::SetVerbosity ( int  verbosity  )  [inline]

Set/get the verbosity.

int wxBatchTextToMP3Encoder::GetVerbosity (  )  const [inline]

const wxArrayString& wxBatchTextToMP3Encoder::GetTextFilenames (  )  const [inline]

const wxArrayString& wxBatchTextToMP3Encoder::GetOutputFilenames (  )  const [inline]

const wxID3InfoArray& wxBatchTextToMP3Encoder::GetID3InfoArray (  )  const [inline]


Member Data Documentation

int wxBatchTextToMP3Encoder::m_options [protected]

int wxBatchTextToMP3Encoder::m_mp3EncoderOptions [protected]

wxTextToSpeech wxBatchTextToMP3Encoder::m_textToSpeech [protected]

wxMP3Encoder wxBatchTextToMP3Encoder::m_mp3Encoder [protected]

wxArrayString wxBatchTextToMP3Encoder::m_textFilenames [protected]

wxArrayString wxBatchTextToMP3Encoder::m_outputFilenames [protected]

wxID3InfoArray wxBatchTextToMP3Encoder::m_infoArray [protected]

int wxBatchTextToMP3Encoder::m_currentFile [protected]

wxBatchTextToMP3EncoderStatus wxBatchTextToMP3Encoder::m_status [protected]

wxFrame* wxBatchTextToMP3Encoder::m_frame [protected]

int wxBatchTextToMP3Encoder::m_statusField [protected]

int wxBatchTextToMP3Encoder::m_verbosity [protected]


The documentation for this class was generated from the following files:
Generated on Wed May 6 19:20:22 2009 for AxTk by  doxygen 1.5.1