OMH::ExportAudioSettings Class Reference

Detailed Description

The audio export options.

Example:

from ToonBoom import harmony
scene = harmony.session().project.scene
export_handler = harmony.session().project.export_handler
audio_settings = harmony.ExportAudioSettings( r"C:/myPath/", 1, -1, True, 8, 22050 )
export_handler.export_audio(scene,audio_settings,True)

Public Member Functions
	ExportAudioSettings (QString i_file_path="", int i_start_frame=1, int i_end_frame=-1, bool i_stereo=true, int i_audio_channel_size=16, int i_audio_sample_rate=22050)
	The default constructor, with all parameters optional. More...

Public Attributes
bool	stereo
	True if the exported file contains the left and right sound channels. True by default. More...
int	audio_channel_size
	The sound channel bit rate (either 8 or 16 bits per second). 16 by default. More...
int	audio_sample_rate
	The audio sample rate. 22050 by default. More...
QString	file_path
	The complete file path to the generated file. More...
int	start_frame
	The first frame to be exported. 1 by default. More...
int	end_frame
	The last frame to be exported. The last frame of the scene by default. More...

Constructor & Destructor Documentation

ExportAudioSettings()

OMH::ExportAudioSettings::ExportAudioSettings	(	QString	i_file_path = "",
		int	i_start_frame = 1,
		int	i_end_frame = -1,
		bool	i_stereo = true,
		int	i_audio_channel_size = 16,
		int	i_audio_sample_rate = 22050
	)

The default constructor, with all parameters optional.

Member Data Documentation

audio_channel_size

int OMH::ExportAudioSettings::audio_channel_size

The sound channel bit rate (either 8 or 16 bits per second). 16 by default.

audio_sample_rate

int OMH::ExportAudioSettings::audio_sample_rate

The audio sample rate. 22050 by default.

end_frame

int OMH::ExportSettingsBase::end_frame

inherited

The last frame to be exported. The last frame of the scene by default.

file_path

QString OMH::ExportSettingsBase::file_path

inherited

The complete file path to the generated file.

start_frame

int OMH::ExportSettingsBase::start_frame

inherited

The first frame to be exported. 1 by default.

stereo

bool OMH::ExportAudioSettings::stereo

True if the exported file contains the left and right sound channels. True by default.

Inheritance diagram for OMH::ExportAudioSettings:

Collaboration diagram for OMH::ExportAudioSettings: