OMH::ExportQuicktimeSettings Class Reference

Detailed Description

The Quicktime export options.

Example:

from ToonBoom import harmony
scene = harmony.session().project.scene
export_handler = harmony.session().project.export_handler
quicktime_settings = harmony.ExportQuicktimeSettings( r"C:/myPath/", 'TheQuickTime', True, 1, 1, 25, 960, 540, True, True, True, 16, 22050)
export_handler(scene,quicktime_settings)

Public Member Functions
	ExportQuicktimeSettings (QString i_file_path="", QString i_file_name="", bool i_generate_thumbnail=false, int i_thumbnail_frame=1, int i_start_frame=1, int i_end_frame=-1, int i_width=-1, int i_height=-1, bool i_sound=true, bool i_alpha=true, 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	generate_thumbnail
	Wether or not to use a thumbnail as the movie image. More...
int	thumbnail_frame
	The thumbnail frame to use as the movie image. More...
QString	file_name
	The file name of the generated movie. More...
int	width
	The horizontal pixel resolution. The width resolution of the scene by default. More...
int	height
	The vertical pixel resolution. The height resolution of the scene by default. More...
bool	sound
	Export with sound if option availablle on the given format. true by default. More...
bool	alpha
	Export with alpha if option availablle on the given format. true by default. More...
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...
bool	merge_soundtrack
	Whether to merge all audio tracks into one exported audio file (true), or export each audio track separately (false). Supported when exporting only the audio tracks with ExportAudioSettings. 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

ExportQuicktimeSettings()

OMH::ExportQuicktimeSettings::ExportQuicktimeSettings	(	QString	i_file_path = "",
		QString	i_file_name = "",
		bool	i_generate_thumbnail = false,
		int	i_thumbnail_frame = 1,
		int	i_start_frame = 1,
		int	i_end_frame = -1,
		int	i_width = -1,
		int	i_height = -1,
		bool	i_sound = true,
		bool	i_alpha = true,
		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

alpha

bool OMH::ExportMovieSettings::alpha

inherited

Export with alpha if option availablle on the given format. true by default.

audio_channel_size

int OMH::ExportAudioSettings::audio_channel_size

inherited

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

audio_sample_rate

int OMH::ExportAudioSettings::audio_sample_rate

inherited

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_name

QString OMH::ExportMovieSettings::file_name

inherited

The file name of the generated movie.

file_path

QString OMH::ExportSettingsBase::file_path

inherited

The complete file path to the generated file.

generate_thumbnail

bool OMH::ExportQuicktimeSettings::generate_thumbnail

Wether or not to use a thumbnail as the movie image.

height

int OMH::ExportMovieSettings::height

inherited

The vertical pixel resolution. The height resolution of the scene by default.

merge_soundtrack

bool OMH::ExportAudioSettings::merge_soundtrack

inherited

Whether to merge all audio tracks into one exported audio file (true), or export each audio track separately (false). Supported when exporting only the audio tracks with ExportAudioSettings.

sound

bool OMH::ExportMovieSettings::sound

inherited

Export with sound if option availablle on the given format. true by default.

start_frame

int OMH::ExportSettingsBase::start_frame

inherited

The first frame to be exported. 1 by default.

stereo

bool OMH::ExportAudioSettings::stereo

inherited

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

thumbnail_frame

int OMH::ExportQuicktimeSettings::thumbnail_frame

The thumbnail frame to use as the movie image.

width

int OMH::ExportMovieSettings::width

inherited

The horizontal pixel resolution. The width resolution of the scene by default.

Inheritance diagram for OMH::ExportQuicktimeSettings:

Collaboration diagram for OMH::ExportQuicktimeSettings: