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 () |
Add a file extension to be known by the dialog, displaying it in the file explorer. More... | |
void | setColorSpace (String &colorSpace) |
Set colour space. More... | |
void | addFileType (String &type, String &typeDesc, String &key=String::null) |
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... | |
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
|
slot |
|
slot |
Clear all the file extensions.
|
slot |
Disable AV buttons.
|
slot |
Disable Resolution box.
|
slot |
Enable the progress bar for the export.
|
slot |
Close the export progress dialog.
|
slot |
Open the dialog widget.
|
signal |
Reports when the export is canceled.
|
signal |
Sends the index of the newly selected format, depending on the order of format registration.
|
slot |
Get the audio configuration.
|
slot |
Add a file extension to be known by the dialog, displaying it in the file explorer.
type | : The desired file type to be added. |
typeDesc | : A description of the file type to be added.Get colour space |
|
slot |
Get the name to display.
|
slot |
Get the first scene frame index to export.
|
slot |
Get the output file.
|
slot |
Get the output file with appended frame number.
|
slot |
Get the prefix used to set preferences.
|
slot |
Get the x resolution of the scene.
|
slot |
Get the y resolution of the scene.
|
slot |
Get the title of the dialog.
|
slot |
Get the last scene frame index to export.
|
slot |
Get the video and audio configuration.
|
slot |
Get the video configuration.
|
slot |
Initialize dialog and settings for export.
|
slot |
Set the audio configuration.
config | : The audio configuration. |
|
slot |
Set colour space.
colorSpace | : Color space name to be set. |
|
slot |
Set the prefix used to set preferences.
prefix | : The desired prefix used to set preferences. |
|
slot |
Set the title of the dialog.
title | : The desired title of the dialog. |
|
slot |
Set the both video and audio configuration.
config | : The video and audio configuration. |
|
slot |
Set the video configuration.
config | : The video configuration. |
|
signal |
Support audio options.
|
signal |
Support video and audio options.
|
signal |
Support video options.
|
slot |
Open a dialog for the export frame progress.
|
slot |
Update the progress for the export.
progress | : The current progress. |
|
read |
Audio configuration.
|
readwrite |
Colour space name.
|
read |
Name displayed of the dialog.
|
read |
Begin index frame used for export.
|
read |
File used for output.
|
readwrite |
the prefix to use for the preference items
|
readwrite |
title of the dialog
|
read |
End index frame used for export.
|
read |
Video configuration.