Audacity  2.2.0
ExportCL Class Referencefinal
Inheritance diagram for ExportCL:

Public Member Functions

 ExportCL ()
wxWindow * OptionsCreate (wxWindow *parent, int format)
ProgressResult Export (AudacityProject *project, unsigned channels, const wxString &fName, bool selectedOnly, double t0, double t1, MixerSpec *mixerSpec=NULL, const Tags *metadata=NULL, int subformat=0) override
 called to export audio into a file. More...
- Public Member Functions inherited from ExportPlugin
 ExportPlugin ()
virtual ~ExportPlugin ()
int AddFormat ()
 Add a NEW entry to the list of formats this plug-in can export. More...
void SetFormat (const wxString &format, int index)
void SetDescription (const wxString &description, int index)
void AddExtension (const wxString &extension, int index)
void SetExtensions (const wxArrayString &extensions, int index)
void SetMask (const wxString &mask, int index)
void SetMaxChannels (unsigned maxchannels, unsigned index)
void SetCanMetaData (bool canmetadata, int index)
virtual int GetFormatCount ()
virtual wxString GetFormat (int index)
virtual wxString GetDescription (int index)
virtual wxString GetExtension (int index=0)
 Return the (first) file name extension for the sub-format. More...
virtual wxArrayString GetExtensions (int index=0)
 Return all the file name extensions used for the sub-format. More...
virtual wxString GetMask (int index)
virtual unsigned GetMaxChannels (int index)
virtual bool GetCanMetaData (int index)
virtual bool IsExtension (const wxString &ext, int index)
virtual bool DisplayOptions (wxWindow *parent, int format=0)
virtual bool CheckFileName (wxFileName &filename, int format=0)
virtual int SetNumExportChannels ()
 Exporter plug-ins may override this to specify the number of channels in exported file. -1 for unspecified. More...

Additional Inherited Members

- Protected Member Functions inherited from ExportPlugin
std::unique_ptr< MixerCreateMixer (const WaveTrackConstArray &inputTracks, const TimeTrack *timeTrack, double startTime, double stopTime, unsigned numOutChannels, size_t outBufferSize, bool outInterleaved, double outRate, sampleFormat outFormat, bool highQuality=true, MixerSpec *mixerSpec=NULL)

Constructor & Destructor Documentation

Member Function Documentation

ProgressResult ExportCL::Export ( AudacityProject project,
unsigned  channels,
const wxString &  fName,
bool  selectedOnly,
double  t0,
double  t1,
MixerSpec mixerSpec = NULL,
const Tags metadata = NULL,
int  subformat = 0 

called to export audio into a file.

selectedOnlySet to true if all tracks should be mixed, to false if only the selected tracks should be mixed and exported.
metadataA Tags object that will over-ride the one in *project and be used to tag the file that is exported.
subformatControl which of the multiple formats this exporter is capable of exporting should be used. Used where a single export plug-in handles a number of related formats, but they have separate entries in the Format drop-down list box. For example, the options to export to "Other PCM", "AIFF 16 Bit" and "WAV 16 Bit" are all the same libsndfile export plug-in, but with subformat set to 0, 1, and 2 respectively.

Implements ExportPlugin.

References _(), ShuttleGuiBase::AddButton(), ShuttleGuiBase::AddTextWindow(), wav_header::avgBytesPerSec, wav_header::bitsPerSample, wav_header::blockAlign, Cancelled, wav_header::channels, ExportPlugin::CreateMixer(), wav_header::dataID, wav_header::dataLen, Drain(), eIsCreating, wav_header::fmtID, wav_header::formatChunkLen, wav_header::formatTag, AudacityProject::GetRate(), TrackList::GetTimeTrack(), AudacityProject::GetTracks(), TrackList::GetWaveTrackConstArray(), gPrefs, ShuttleGui::Id(), wav_header::lenAfterRiff, lrint, wav_header::riffID, wav_header::riffType, wav_header::sampleRate, ShuttleGuiBase::StartHorizontalLay(), Success, and ProgressDialog::Update().

wxWindow * ExportCL::OptionsCreate ( wxWindow *  parent,
int  format 

Implements ExportPlugin.

References safenew.

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