Audacity 3.2.0
Public Member Functions | List of all members
ExportOpus Class Referencefinal
Inheritance diagram for ExportOpus:
[legend]
Collaboration diagram for ExportOpus:
[legend]

Public Member Functions

 ExportOpus ()
 
int GetFormatCount () const override
 
FormatInfo GetFormatInfo (int) const override
 Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique. More...
 
std::vector< std::string > GetMimeTypes (int) const override
 
std::unique_ptr< ExportOptionsEditorCreateOptionsEditor (int, ExportOptionsEditor::Listener *) const override
 Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting. More...
 
std::unique_ptr< ExportProcessorCreateProcessor (int format) const override
 
- Public Member Functions inherited from ExportPlugin
 ExportPlugin ()
 
virtual ~ExportPlugin ()
 
virtual int GetFormatCount () const =0
 
virtual FormatInfo GetFormatInfo (int index) const =0
 Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique. More...
 
virtual std::unique_ptr< ExportOptionsEditorCreateOptionsEditor (int formatIndex, ExportOptionsEditor::Listener *listener) const =0
 Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting. More...
 
virtual std::vector< std::string > GetMimeTypes (int formatIndex) const
 
virtual bool ParseConfig (int formatIndex, const rapidjson::Value &config, ExportProcessor::Parameters &parameters) const
 Attempt to parse configuration JSON object and produce a suitable set of parameters. Configuration is format dependent. More...
 
virtual bool CheckFileName (wxFileName &filename, int format=0) const
 
virtual std::unique_ptr< ExportProcessorCreateProcessor (int format) const =0
 

Detailed Description

Definition at line 469 of file ExportOpus.cpp.

Constructor & Destructor Documentation

◆ ExportOpus()

ExportOpus::ExportOpus ( )
default

Member Function Documentation

◆ CreateOptionsEditor()

std::unique_ptr< ExportOptionsEditor > ExportOpus::CreateOptionsEditor ( int  formatIndex,
ExportOptionsEditor::Listener listener 
) const
overridevirtual

Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting.

Parameters
listenerOption listener object that could be used by the editor to report on option changes.

Implements ExportPlugin.

Definition at line 506 of file ExportOpus.cpp.

507{
508 return std::make_unique<PlainExportOptionsEditor>(
510 ExportOptionsEditor::SampleRateList { 8000, 12000, 16000, 24000, 48000 },
511 listener);
512}
std::vector< int > SampleRateList
const std::initializer_list< PlainExportOptionsEditor::OptionDesc > OPUSOptions
Definition: ExportOpus.cpp:105

References anonymous_namespace{ExportOpus.cpp}::OPUSOptions.

◆ CreateProcessor()

std::unique_ptr< ExportProcessor > ExportOpus::CreateProcessor ( int  format) const
overridevirtual
Parameters
formatControl 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.

Definition at line 514 of file ExportOpus.cpp.

515{
516 return std::make_unique<OpusExportProcessor>();
517}

◆ GetFormatCount()

int ExportOpus::GetFormatCount ( ) const
overridevirtual

Implements ExportPlugin.

Definition at line 488 of file ExportOpus.cpp.

489{
490 return 1;
491}

◆ GetFormatInfo()

FormatInfo ExportOpus::GetFormatInfo ( int  index) const
overridevirtual

Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique.

Parameters
indexShould not exceed the number of formats provided by GetFormatCount()

Implements ExportPlugin.

Definition at line 493 of file ExportOpus.cpp.

494{
495 return {
496 wxT("Opus"), XO("Opus Files"), { wxT("opus") }, 255, true
497 };
498}
wxT("CloseDown"))
XO("Cut/Copy/Paste")

References wxT(), and XO().

Here is the call graph for this function:

◆ GetMimeTypes()

std::vector< std::string > ExportOpus::GetMimeTypes ( int  formatIndex) const
overridevirtual
Returns
Mime type(s) supported by the format.

Reimplemented from ExportPlugin.

Definition at line 500 of file ExportOpus.cpp.

501{
502 return { "audio/opus" };
503}

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