wxBatchTextToMP3Encoder Class Reference
[Text to speech classes]

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 Espeak options.
int	GetMP3EncoderOptions () const
wxTextToSpeech &	GetSpeech ()
	Get the wxEspeak object.
const wxTextToSpeech &	GetSpeech () const
wxMP3Encoder &	GetMP3Encoder ()
	Get the wxMP3Encoder object.
const wxMP3Encoder &	GetMP3Encoder () 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

int wxBatchTextToMP3Encoder::GetCurrentFile

(

)

const [inline]

wxFrame* wxBatchTextToMP3Encoder::GetFrame

(

)

const [inline]

const wxID3InfoArray& wxBatchTextToMP3Encoder::GetID3InfoArray

(

)

const [inline]

const wxMP3Encoder& wxBatchTextToMP3Encoder::GetMP3Encoder

(

)

const [inline]

wxMP3Encoder& wxBatchTextToMP3Encoder::GetMP3Encoder

(

)

[inline]

Get the wxMP3Encoder object.

int wxBatchTextToMP3Encoder::GetMP3EncoderOptions

(

)

const [inline]

int wxBatchTextToMP3Encoder::GetOptions

(

)

const [inline]

const wxArrayString& wxBatchTextToMP3Encoder::GetOutputFilenames

(

)

const [inline]

const wxTextToSpeech& wxBatchTextToMP3Encoder::GetSpeech

(

)

const [inline]

wxTextToSpeech& wxBatchTextToMP3Encoder::GetSpeech

(

)

[inline]

Get the wxEspeak object.

wxBatchTextToMP3EncoderStatus wxBatchTextToMP3Encoder::GetStatus

(

)

const [inline]

const wxArrayString& wxBatchTextToMP3Encoder::GetTextFilenames

(

)

const [inline]

int wxBatchTextToMP3Encoder::GetVerbosity

(

)

const [inline]

void wxBatchTextToMP3Encoder::Init

(

)

Member initialisation.

virtual bool wxBatchTextToMP3Encoder::IsBusy

(

)

[inline, virtual]

Is it busy?

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.

void wxBatchTextToMP3Encoder::SetCurrentFile

(

int

currentFile

)

[inline]

Set/get the current file.

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

Set data.

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

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

void wxBatchTextToMP3Encoder::SetMP3EncoderOptions

(

int

options

)

[inline]

Set/get the Espeak options.

Set/get the MP3 encoder options

void wxBatchTextToMP3Encoder::SetOptions

(

int

options

)

[inline]

Set/get the options.

void wxBatchTextToMP3Encoder::SetStatus

(

wxBatchTextToMP3EncoderStatus

status

)

[inline]

Set/get the current status.

void wxBatchTextToMP3Encoder::SetVerbosity

(

int

verbosity

)

[inline]

Set/get the verbosity.

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

Starting encoding the text files to MP3.

bool wxBatchTextToMP3Encoder::Stop

(

)

[virtual]

Stop encoding.

---

Member Data Documentation

int wxBatchTextToMP3Encoder::m_currentFile [protected]

wxFrame* wxBatchTextToMP3Encoder::m_frame [protected]

wxID3InfoArray wxBatchTextToMP3Encoder::m_infoArray [protected]

wxMP3Encoder wxBatchTextToMP3Encoder::m_mp3Encoder [protected]

int wxBatchTextToMP3Encoder::m_mp3EncoderOptions [protected]

int wxBatchTextToMP3Encoder::m_options [protected]

wxArrayString wxBatchTextToMP3Encoder::m_outputFilenames [protected]

wxBatchTextToMP3EncoderStatus wxBatchTextToMP3Encoder::m_status [protected]

int wxBatchTextToMP3Encoder::m_statusField [protected]

wxArrayString wxBatchTextToMP3Encoder::m_textFilenames [protected]

wxTextToSpeech wxBatchTextToMP3Encoder::m_textToSpeech [protected]

int wxBatchTextToMP3Encoder::m_verbosity [protected]

---

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

• include/tts/tts_batchencoder.h
• src/tts/tts_batchencoder.cpp