Audacity: ExportOptionsEditor Class Reference

Audacity 3.2.0

Editor objects are used to retrieve a set of export options, and configure exporting parameters according the plugin internal logic. Each option is assigned with internal index that should not change. More...

#include <ExportOptionsEditor.h>

Inheritance diagram for ExportOptionsEditor:

Classes
class	Listener
	Listener object that is used to report on option changes. More...

Public Types
using	SampleRateList = std::vector< int >

Public Member Functions
virtual	~ExportOptionsEditor ()

virtual int	GetOptionsCount () const =0

virtual bool	GetOption (int index, ExportOption &option) const =0

virtual bool	GetValue (ExportOptionID id, ExportValue &value) const =0

virtual bool	SetValue (ExportOptionID id, const ExportValue &value)=0

virtual SampleRateList	GetSampleRateList () const =0

virtual void	Store (audacity::BasicSettings &settings) const =0

virtual void	Load (const audacity::BasicSettings &config)=0

Detailed Description

Editor objects are used to retrieve a set of export options, and configure exporting parameters according the plugin internal logic. Each option is assigned with internal index that should not change.

Definition at line 23 of file ExportOptionsEditor.h.

Member Typedef Documentation

◆ SampleRateList

using ExportOptionsEditor::SampleRateList = std::vector<int>

Definition at line 26 of file ExportOptionsEditor.h.

Constructor & Destructor Documentation

◆ ~ExportOptionsEditor()

ExportOptionsEditor::~ExportOptionsEditor ( )

virtualdefault

Member Function Documentation

◆ GetOption()

virtual bool ExportOptionsEditor::GetOption	(	int	index,
		ExportOption &	option
	)		const

pure virtual

Implemented in PlainExportOptionsEditor, ExportOptionsCLEditor, anonymous_namespace{ExportFFmpeg.cpp}::ExportOptionsFFmpegCustomEditor, MP2ExportOptionsEditor, MP3ExportOptionsEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor, anonymous_namespace{ExportWavPack.cpp}::ExportOptionsWavPackEditor, anonymous_namespace{ExportOGG.cpp}::ExportOptionOGGEditor, and anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor.

Referenced by ExportUtils::ParametersFromEditor().

Here is the caller graph for this function:

◆ GetOptionsCount()

virtual int ExportOptionsEditor::GetOptionsCount ( ) const

pure virtual

Implemented in PlainExportOptionsEditor, ExportOptionsCLEditor, anonymous_namespace{ExportFFmpeg.cpp}::ExportOptionsFFmpegCustomEditor, MP2ExportOptionsEditor, MP3ExportOptionsEditor, anonymous_namespace{ExportOGG.cpp}::ExportOptionOGGEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor, and anonymous_namespace{ExportWavPack.cpp}::ExportOptionsWavPackEditor.

Referenced by ExportUtils::ParametersFromEditor().

Here is the caller graph for this function:

◆ GetSampleRateList()

virtual SampleRateList ExportOptionsEditor::GetSampleRateList ( ) const

pure virtual

Implemented in PlainExportOptionsEditor, ExportOptionsCLEditor, anonymous_namespace{ExportFFmpeg.cpp}::ExportOptionsFFmpegCustomEditor, MP2ExportOptionsEditor, MP3ExportOptionsEditor, anonymous_namespace{ExportOGG.cpp}::ExportOptionOGGEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor, and anonymous_namespace{ExportWavPack.cpp}::ExportOptionsWavPackEditor.

◆ GetValue()

virtual bool ExportOptionsEditor::GetValue	(	ExportOptionID	id,
		ExportValue &	value
	)		const

pure virtual

Implemented in anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor, anonymous_namespace{ExportOGG.cpp}::ExportOptionOGGEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor, and ExportOptionsCLEditor.

Referenced by ExportUtils::ParametersFromEditor().

Here is the caller graph for this function:

◆ Load()

virtual void ExportOptionsEditor::Load ( const audacity::BasicSettings & config )

pure virtual

Implemented in PlainExportOptionsEditor, ExportOptionsCLEditor, anonymous_namespace{ExportFFmpeg.cpp}::ExportOptionsFFmpegCustomEditor, MP2ExportOptionsEditor, MP3ExportOptionsEditor, anonymous_namespace{ExportOGG.cpp}::ExportOptionOGGEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor, and anonymous_namespace{ExportWavPack.cpp}::ExportOptionsWavPackEditor.

◆ SetValue()

virtual bool ExportOptionsEditor::SetValue	(	ExportOptionID	id,
		const ExportValue &	value
	)

pure virtual

Implemented in anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor, anonymous_namespace{ExportOGG.cpp}::ExportOptionOGGEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor, and ExportOptionsCLEditor.

◆ Store()

virtual void ExportOptionsEditor::Store ( audacity::BasicSettings & settings ) const

pure virtual

Implemented in PlainExportOptionsEditor, ExportOptionsCLEditor, MP2ExportOptionsEditor, MP3ExportOptionsEditor, anonymous_namespace{ExportOGG.cpp}::ExportOptionOGGEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFTypedEditor, anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor, anonymous_namespace{ExportWavPack.cpp}::ExportOptionsWavPackEditor, and anonymous_namespace{ExportFFmpeg.cpp}::ExportOptionsFFmpegCustomEditor.

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