Audacity  2.2.0
BatchCommands Class Referencefinal

Maintains the chain of commands used in batch processing. See also BatchCommandDialog and BatchProcessDialog. More...

#include <BatchCommands.h>

Public Member Functions

 BatchCommands ()
 
bool ApplyChain (const wxString &filename=wxT(""))
 
bool ApplyCommand (const wxString &command, const wxString &params)
 
bool ApplyCommandInBatchMode (const wxString &command, const wxString &params)
 
bool ApplySpecialCommand (int iCommand, const wxString &command, const wxString &params)
 
bool ApplyEffectCommand (const PluginID &ID, const wxString &command, const wxString &params)
 
bool ReportAndSkip (const wxString &command, const wxString &params)
 
void AbortBatch ()
 
wxString BuildCleanFileName (const wxString &fileName, const wxString &extension)
 
bool WriteMp3File (const wxString &Name, int bitrate)
 
double GetEndTime ()
 
bool IsMono ()
 
void ResetChain ()
 
bool ReadChain (const wxString &chain)
 
bool WriteChain (const wxString &chain)
 
bool AddChain (const wxString &chain)
 
bool DeleteChain (const wxString &name)
 
bool RenameChain (const wxString &oldchain, const wxString &newchain)
 
void AddToChain (const wxString &command, int before=-1)
 
void AddToChain (const wxString &command, const wxString &params, int before=-1)
 
void DeleteFromChain (int index)
 
wxString GetCommand (int index)
 
wxString GetParams (int index)
 
int GetCount ()
 
void SetWavToMp3Chain ()
 
bool IsFixed (const wxString &name)
 
void RestoreChain (const wxString &name)
 
void Split (const wxString &str, wxString &command, wxString &param)
 
wxString Join (const wxString &command, const wxString &param)
 

Static Public Member Functions

static wxArrayString GetNames ()
 
static wxArrayString GetAllCommands ()
 
static wxString GetCurrentParamsFor (const wxString &command)
 
static wxString PromptForParamsFor (const wxString &command, const wxString &params, wxWindow *parent)
 
static wxString PromptForPresetFor (const wxString &command, const wxString &params, wxWindow *parent)
 

Public Attributes

wxArrayString mCommandChain
 
wxArrayString mParamsChain
 
bool mAbort
 
Exporter mExporter
 
wxString mFileName
 

Detailed Description

Maintains the chain of commands used in batch processing. See also BatchCommandDialog and BatchProcessDialog.

Constructor & Destructor Documentation

BatchCommands::BatchCommands ( )

Member Function Documentation

void BatchCommands::AbortBatch ( )

References mAbort.

bool BatchCommands::AddChain ( const wxString &  chain)
void BatchCommands::AddToChain ( const wxString &  command,
int  before = -1 
)
void BatchCommands::AddToChain ( const wxString &  command,
const wxString &  params,
int  before = -1 
)

References mCommandChain, and mParamsChain.

bool BatchCommands::ApplyCommand ( const wxString &  command,
const wxString &  params 
)
bool BatchCommands::ApplyCommandInBatchMode ( const wxString &  command,
const wxString &  params 
)
bool BatchCommands::ApplySpecialCommand ( int  iCommand,
const wxString &  command,
const wxString &  params 
)
wxString BatchCommands::BuildCleanFileName ( const wxString &  fileName,
const wxString &  extension 
)
bool BatchCommands::DeleteChain ( const wxString &  name)

References FileNames::ChainDir(), and name.

Referenced by EditChainsDialog::OnRemove().

void BatchCommands::DeleteFromChain ( int  index)
wxString BatchCommands::GetCommand ( int  index)
int BatchCommands::GetCount ( )

References mCommandChain.

Referenced by EditChainsDialog::PopulateList().

wxString BatchCommands::GetCurrentParamsFor ( const wxString &  command)
static
double BatchCommands::GetEndTime ( )
wxArrayString BatchCommands::GetNames ( )
static
wxString BatchCommands::GetParams ( int  index)
bool BatchCommands::IsFixed ( const wxString &  name)
wxString BatchCommands::Join ( const wxString &  command,
const wxString &  param 
)
wxString BatchCommands::PromptForParamsFor ( const wxString &  command,
const wxString &  params,
wxWindow *  parent 
)
static
wxString BatchCommands::PromptForPresetFor ( const wxString &  command,
const wxString &  params,
wxWindow *  parent 
)
static
bool BatchCommands::RenameChain ( const wxString &  oldchain,
const wxString &  newchain 
)
bool BatchCommands::ReportAndSkip ( const wxString &  command,
const wxString &  params 
)

References _(), and gPrefs.

Referenced by ApplyEffectCommand(), and ApplySpecialCommand().

void BatchCommands::ResetChain ( )
void BatchCommands::RestoreChain ( const wxString &  name)
void BatchCommands::SetWavToMp3Chain ( )

References AddToChain(), and ResetChain().

Referenced by RestoreChain().

void BatchCommands::Split ( const wxString &  str,
wxString &  command,
wxString &  param 
)
bool BatchCommands::WriteChain ( const wxString &  chain)
bool BatchCommands::WriteMp3File ( const wxString &  Name,
int  bitrate 
)

Member Data Documentation

bool BatchCommands::mAbort

Referenced by AbortBatch(), and ApplyChain().

wxArrayString BatchCommands::mCommandChain
Exporter BatchCommands::mExporter
wxString BatchCommands::mFileName

Referenced by ApplyChain(), and ApplySpecialCommand().

wxArrayString BatchCommands::mParamsChain

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