The ExportVideoDlg JavaScript class. A dialog that can be used before an export to query the user about various settings. More...

Public Slots
int	getFromRange ()
	Get the first scene frame index to export. More...

int	getToRange ()
	Get the last scene frame index to export. More...

int	getResX ()
	Get the x resolution of the scene. More...

int	getResY ()
	Get the y resolution of the scene. More...

String	getDisplayName ()
	Get the name to display. More...

String	getOutputFile ()
	Get the output file. More...

String	getVideoConfig ()
	Get the video configuration. More...

void	setVideoConfig (String &config)
	Set the video configuration. More...

String	getAudioConfig ()
	Get the audio configuration. More...

void	setAudioConfig (String &config)
	Set the audio configuration. More...

String	getVideoAndAudioConfig ()
	Get the video and audio configuration. More...

void	setVideoAndAudioConfig (String &config)
	Set the both video and audio configuration. More...

String	getTitle ()
	Get the title of the dialog. More...

void	setTitle (String &title)
	Set the title of the dialog. More...

String	getPrefPrefix ()
	Get the prefix used to set preferences. More...

void	setPrefPrefix (String &prefix)
	Set the prefix used to set preferences. More...

String	getColorSpace ()
	Get colour space. More...

void	setColorSpace (String &colorSpace)
	Set colour space. More...

void	addFileType (String &type, String &typeDesc, String &key=String::null)
	Add a file extension to be known by the dialog, displaying it in the file explorer. More...

void	clearFileTypes ()
	Clear all the file extensions. More...

void	init ()
	Initialize dialog and settings for export. More...

int	Exec ()
	Open the dialog widget. More...

void	enableProgress ()
	Enable the progress bar for the export. More...

void	updateProgress (int progress)
	Update the progress for the export. More...

void	startExport ()
	Open a dialog for the export frame progress. More...

void	endExport ()
	Close the export progress dialog. More...

void	disableAVButtons ()
	Disable AV buttons. More...

void	disableResolution ()
	Disable Resolution box. More...

String	getOutputFrameFile (int frame)
	Get the output file with appended frame number. More...

Signals
void	exportCanceled ()
	Reports when the export is canceled. More...

void	showAudioOptions ()
	Support audio options. More...

void	showVideoOptions ()
	Support video options. More...

void	showVideoAndAudioOptions ()
	Support video and audio options. More...

void	fileFormatChanged (int)
	Sends the index of the newly selected format, depending on the order of format registration. More...

Properties
int	fromFrame
	Begin index frame used for export. More...

int	toFrame
	End index frame used for export. More...

String	display
	Name displayed of the dialog. More...

String	outputFile
	File used for output. More...

String	videoConfig
	Video configuration. More...

String	audioConfig
	Audio configuration. More...

String	title
	title of the dialog More...

String	prefPrefix
	the prefix to use for the preference items More...

String	colorSpace
	Colour space name. More...

Detailed Description

The ExportVideoDlg JavaScript class. A dialog that can be used before an export to query the user about various settings.

By default, it provides a field for asking an output file location, for specifying a range of frame and for specifying a vertical and horizontal resolution. However, it does not provide an exporting backend module.

It is then your responsibility to export the video in a fitting format. To support audio and video options, you have to connect to the showAudioOptions and showVideoOptions signals and show an appropriate dialog whenever the signals are sent. Additionally, you must register the file formats available from your exporter. If there are more than one, you should listen to the fileFormatChanged signal and rewire the video and audio options if needed. To retrieve the options, use the getters for the settings property after the dialog is closed. The start export/update progress/end export serves to provides a progress bar if desired

Member Function Documentation

◆ addFileType

void ExportVideoDlg::addFileType	(	String &	type,
		String &	typeDesc,
		String &	key = `String::null`
	)

slot

Add a file extension to be known by the dialog, displaying it in the file explorer.

Parameters

type	: The desired file type to be added.
typeDesc	: A description of the file type to be added.
key	(optional) Unique identifier for the file type, if not provided, type will be used

◆ clearFileTypes

void ExportVideoDlg::clearFileTypes ( )

slot

Clear all the file extensions.

◆ disableAVButtons

void ExportVideoDlg::disableAVButtons ( )

slot

Disable AV buttons.

◆ disableResolution

void ExportVideoDlg::disableResolution ( )

slot

Disable Resolution box.

◆ enableProgress

void ExportVideoDlg::enableProgress ( )

slot

Enable the progress bar for the export.

◆ endExport

void ExportVideoDlg::endExport ( )

slot

Close the export progress dialog.

◆ Exec

int ExportVideoDlg::Exec ( )

slot

Open the dialog widget.

Returns: Returns '1' if successful to match the QDialog::Accepted value.

◆ exportCanceled

void ExportVideoDlg::exportCanceled ( )

signal

Reports when the export is canceled.

◆ fileFormatChanged

void ExportVideoDlg::fileFormatChanged ( int )

signal

Sends the index of the newly selected format, depending on the order of format registration.

◆ getAudioConfig

String ExportVideoDlg::getAudioConfig ( )

slot

Get the audio configuration.

Returns: Returns the audio configuration.

◆ getColorSpace

String ExportVideoDlg::getColorSpace ( )

slot

Get colour space.

Returns: colour space name, empty if working colour space

◆ getDisplayName

String ExportVideoDlg::getDisplayName ( )

slot

Get the name to display.

Returns: Returns the name to display.

◆ getFromRange

int ExportVideoDlg::getFromRange ( )

slot

Get the first scene frame index to export.

Returns: Returns the first scene frame index to export.

◆ getOutputFile

String ExportVideoDlg::getOutputFile ( )

slot

Get the output file.

Returns: Returns the output file.

◆ getOutputFrameFile

String ExportVideoDlg::getOutputFrameFile ( int frame )

slot

Get the output file with appended frame number.

Returns: Returns the output file appended with frame number

◆ getPrefPrefix

String ExportVideoDlg::getPrefPrefix ( )

slot

Get the prefix used to set preferences.

Returns: Returns the prefix used to set preferences.

◆ getResX

int ExportVideoDlg::getResX ( )

slot

Get the x resolution of the scene.

Returns: Returns the x resolution of the scene.

◆ getResY

int ExportVideoDlg::getResY ( )

slot

Get the y resolution of the scene.

Returns: Returns the y resolution of the scene.

◆ getTitle

String ExportVideoDlg::getTitle ( )

slot

Get the title of the dialog.

Returns: Returns the title of the dialog.

◆ getToRange

int ExportVideoDlg::getToRange ( )

slot

Get the last scene frame index to export.

Returns: Returns the last scene frame index to export.

◆ getVideoAndAudioConfig

String ExportVideoDlg::getVideoAndAudioConfig ( )

slot

Get the video and audio configuration.

Returns: Returns the video and audio configuration.

◆ getVideoConfig

String ExportVideoDlg::getVideoConfig ( )

slot

Get the video configuration.

Returns: Returns the video configuration.

◆ init

void ExportVideoDlg::init ( )

slot

Initialize dialog and settings for export.

◆ setAudioConfig

void ExportVideoDlg::setAudioConfig ( String & config )

slot

Set the audio configuration.

Parameters

config : The audio configuration.

◆ setColorSpace

void ExportVideoDlg::setColorSpace ( String & colorSpace )

slot

Set colour space.

Parameters

colorSpace : Color space name to be set.

◆ setPrefPrefix

void ExportVideoDlg::setPrefPrefix ( String & prefix )

slot

Set the prefix used to set preferences.

Parameters

prefix : The desired prefix used to set preferences.

◆ setTitle

void ExportVideoDlg::setTitle ( String & title )

slot

Set the title of the dialog.

Parameters

title : The desired title of the dialog.

◆ setVideoAndAudioConfig

void ExportVideoDlg::setVideoAndAudioConfig ( String & config )

slot

Set the both video and audio configuration.

Parameters

config : The video and audio configuration.

◆ setVideoConfig

void ExportVideoDlg::setVideoConfig ( String & config )

slot

Set the video configuration.

Parameters

config : The video configuration.

◆ showAudioOptions

void ExportVideoDlg::showAudioOptions ( )

signal

Support audio options.

◆ showVideoAndAudioOptions

void ExportVideoDlg::showVideoAndAudioOptions ( )

signal

Support video and audio options.

◆ showVideoOptions

void ExportVideoDlg::showVideoOptions ( )

signal

Support video options.

◆ startExport

void ExportVideoDlg::startExport ( )

slot

Open a dialog for the export frame progress.

◆ updateProgress

void ExportVideoDlg::updateProgress ( int progress )

slot

Update the progress for the export.

Parameters

progress : The current progress.

Property Documentation

◆ audioConfig

String ExportVideoDlg::audioConfig

read

Audio configuration.

◆ colorSpace

String ExportVideoDlg::colorSpace

readwrite

Colour space name.

◆ display

String ExportVideoDlg::display

read

Name displayed of the dialog.

◆ fromFrame

int ExportVideoDlg::fromFrame

read

Begin index frame used for export.

◆ outputFile

String ExportVideoDlg::outputFile

read

File used for output.

◆ prefPrefix

String ExportVideoDlg::prefPrefix

readwrite

the prefix to use for the preference items

◆ title

String ExportVideoDlg::title

readwrite

title of the dialog

◆ toFrame

int ExportVideoDlg::toFrame

read

End index frame used for export.

◆ videoConfig

String ExportVideoDlg::videoConfig

read

Video configuration.

Public Slots

Signals

Properties

Detailed Description

Member Function Documentation

◆ addFileType

◆ clearFileTypes

◆ disableAVButtons

◆ disableResolution

◆ enableProgress

◆ endExport

◆ Exec

◆ exportCanceled

◆ fileFormatChanged

◆ getAudioConfig

◆ getColorSpace

◆ getDisplayName

◆ getFromRange

◆ getOutputFile

◆ getOutputFrameFile

◆ getPrefPrefix

◆ getResX

◆ getResY

◆ getTitle

◆ getToRange

◆ getVideoAndAudioConfig

◆ getVideoConfig

◆ init

◆ setAudioConfig

◆ setColorSpace

◆ setPrefPrefix

◆ setTitle

◆ setVideoAndAudioConfig

◆ setVideoConfig

◆ showAudioOptions

◆ showVideoAndAudioOptions

◆ showVideoOptions

◆ startExport

◆ updateProgress

Property Documentation

◆ audioConfig

◆ colorSpace

◆ display

◆ fromFrame

◆ outputFile

◆ prefPrefix

◆ title

◆ toFrame

◆ videoConfig