ExportVideoDlg Class Reference

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 both 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...
 
void addFileType (String &type, String &typeDesc)
 Add a file extension to be known by the dialog, displaying it in the file explorer. More...
 
void clearFileTypes ()
 Clear all the file extension and description know. More...
 
void init ()
 Initialize dialog and settings for export. More...
 
int Exec ()
 Open the dialog widget. More...
 
void enableProgress ()
 Enable the progress 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...
 

Signals

void exportCanceled ()
 
void showAudioOptions ()
 
void showVideoOptions ()
 
void showVideoAndAudioOptions ()
 
void fileFormatChanged (int)
 

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...
 

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 
)
slot

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

◆ clearFileTypes

void ExportVideoDlg::clearFileTypes ( )
slot

Clear all the file extension and description know.

◆ enableProgress

void ExportVideoDlg::enableProgress ( )
slot

Enable the progress for the export.

◆ endExport

void ExportVideoDlg::endExport ( )
slot

Close the export progress dialog.

◆ Exec

int ExportVideoDlg::Exec ( )
slot

Open the dialog widget.

◆ exportCanceled

void ExportVideoDlg::exportCanceled ( )
signal

◆ fileFormatChanged

void ExportVideoDlg::fileFormatChanged ( int  )
signal

◆ getAudioConfig

String ExportVideoDlg::getAudioConfig ( )
slot

Get the audio configuration.

◆ getDisplayName

String ExportVideoDlg::getDisplayName ( )
slot

Get the name to display.

◆ getFromRange

int ExportVideoDlg::getFromRange ( )
slot

Get the first scene frame index to export.

◆ getOutputFile

String ExportVideoDlg::getOutputFile ( )
slot

Get the output file.

◆ getPrefPrefix

String ExportVideoDlg::getPrefPrefix ( )
slot

Get the prefix used to set preferences.

◆ getResX

int ExportVideoDlg::getResX ( )
slot

Get the x resolution of the scene.

◆ getResY

int ExportVideoDlg::getResY ( )
slot

Get the y resolution of the scene.

◆ getTitle

String ExportVideoDlg::getTitle ( )
slot

Get the title of the dialog.

◆ getToRange

int ExportVideoDlg::getToRange ( )
slot

Get the last scene frame index to export.

◆ getVideoAndAudioConfig

String ExportVideoDlg::getVideoAndAudioConfig ( )
slot

Get the both video and audio configuration.

◆ getVideoConfig

String ExportVideoDlg::getVideoConfig ( )
slot

Get 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.

◆ setPrefPrefix

void ExportVideoDlg::setPrefPrefix ( String &  prefix)
slot

Set the prefix used to set preferences.

◆ setTitle

void ExportVideoDlg::setTitle ( String &  title)
slot

Set the title of the dialog.

◆ setVideoAndAudioConfig

void ExportVideoDlg::setVideoAndAudioConfig ( String &  config)
slot

Set the both video and audio configuration.

◆ setVideoConfig

void ExportVideoDlg::setVideoConfig ( String &  config)
slot

Set the video configuration.

◆ showAudioOptions

void ExportVideoDlg::showAudioOptions ( )
signal

◆ showVideoAndAudioOptions

void ExportVideoDlg::showVideoAndAudioOptions ( )
signal

◆ showVideoOptions

void ExportVideoDlg::showVideoOptions ( )
signal

◆ 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.

Property Documentation

◆ audioConfig

String ExportVideoDlg::audioConfig
read

Audio configuration.

◆ 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.