![]() |
Avidemux 2.6 Scripting Reference
|
The Editor object exposes most of the video and audio editing functionality available in Avidemux's graphical user interface to the ECMA scripting engine. More...
Public Types | |
enum | ImageType { Bitmap = 1, Jpeg = 2 } |
Specifies a type of image file. More... | |
enum | SeekFrameType { Any = 0, Intra = 1, Black = 2 } |
Specifies a type of frame to seek. More... |
Public Member Functions | |
VideoFileProperties | appendVideo (String path) |
Appends an additional video file to the end of the currently open video. | |
void | clearMarkers () |
Sets marker A to the start of the video and marker B to the end of the video. | |
void | closeVideo () |
Closes the video in the editor. | |
Boolean | isVideoOpen () |
Indicates whether a video file is currently open in the editor. | |
VideoFileProperties | openVideo (String path) |
Opens a video file at the given path in the editor. | |
void | saveAudio (String path, Number audioIndex=0) |
Saves the specified audio track of the currently open video to a file. | |
void | saveImage (String path, ImageType imageType) |
Save the current frame as an image file. | |
void | saveVideo (String path) |
Encodes or copies the video to the specified file. | |
void | seekNextFrame (Number frameCount=1, SeekFrameType seekFrameType=Editor::Any) |
Seeks forward to the next frame(s) of the specified type. | |
void | seekPreviousFrame (Number frameCount=1, SeekFrameType seekFrameType=Editor::Any) |
Seeks backward to the next frame(s) of the specified type. | |
void | setMarkers (Number markerA, Number markerB) |
Sets the time (in milliseconds) of marker A (selection start) and marker B (selection end). |
Properties | |
Array | activeVideoDecoders |
Gets the video decoders currently being used to decode the video files that are open in the editor. | |
VideoFilterCollection | appliedVideoFilters |
Gets the filters that will be applied to the encoded video. | |
AudioOutputCollection | audioOutputs |
Gets the intended audio outputs for the encoded video. | |
FrameProperties | currentFrameProperties |
Gets extended information about the editor's currently selected frame. | |
Number | currentFrameTime |
Gets or sets the time (in milliseconds) of the editor's navigation bar. | |
Muxer | currentMuxer |
Gets or sets the current muxer. | |
VideoEncoder | currentVideoEncoder |
Gets or sets the current video encoder. | |
Number | markerA |
Gets or sets the time (in milliseconds) of marker A (selection start). | |
Number | markerB |
Gets or sets the time (in milliseconds) of marker B (selection end). | |
Number | position |
Gets or sets the time (in milliseconds) of the editor's position. | |
SegmentCollection | segments |
Gets extended information about the video segments that have been added to the editor. | |
Number | videoCount |
Returns the number of video files currently open in the editor. | |
Array | videoFileProperties |
Gets extended information about the video files that have been added to the editor. |
The Editor object exposes most of the video and audio editing functionality available in Avidemux's graphical user interface to the ECMA scripting engine.
It can only be accessed using static properties and methods as it doesn't have a constructor. Editor is usually the first object that an individual should become familiar with when starting to write Avidemux ECMA scripts.
enum ImageType |
enum SeekFrameType |
VideoFileProperties appendVideo | ( | String | path | ) |
Appends an additional video file to the end of the currently open video.
void clearMarkers | ( | ) |
Sets marker A to the start of the video and marker B to the end of the video.
void closeVideo | ( | ) |
Closes the video in the editor.
Boolean isVideoOpen | ( | ) |
Indicates whether a video file is currently open in the editor.
VideoFileProperties openVideo | ( | String | path | ) |
Opens a video file at the given path in the editor.
void saveAudio | ( | String | path, |
Number | audioIndex = 0 |
||
) |
Saves the specified audio track of the currently open video to a file.
void saveImage | ( | String | path, |
ImageType | imageType | ||
) |
void seekNextFrame | ( | Number | frameCount = 1 , |
SeekFrameType | seekFrameType = Editor::Any |
||
) |
Seeks forward to the next frame(s) of the specified type.
void seekPreviousFrame | ( | Number | frameCount = 1 , |
SeekFrameType | seekFrameType = Editor::Any |
||
) |
Seeks backward to the next frame(s) of the specified type.
void setMarkers | ( | Number | markerA, |
Number | markerB | ||
) |
Sets the time (in milliseconds) of marker A (selection start) and marker B (selection end).
|
read |
Gets the video decoders currently being used to decode the video files that are open in the editor.
|
read |
Gets the filters that will be applied to the encoded video.
|
read |
Gets extended information about the editor's currently selected frame.
|
readwrite |
Gets or sets the current muxer.
Example usage:
|
readwrite |
Gets or sets the current video encoder.
Example usage:
|
readwrite |
Gets or sets the time (in milliseconds) of marker A (selection start).
|
readwrite |
Gets or sets the time (in milliseconds) of marker B (selection end).
|
readwrite |
Gets or sets the time (in milliseconds) of the editor's position.
|
read |
Gets extended information about the video segments that have been added to the editor.
|
read |
Returns the number of video files currently open in the editor.
|
read |
Gets extended information about the video files that have been added to the editor.