SourceMonitor object
SourceMonitor object
Section titled “SourceMonitor object”app.sourceMonitor
Description
Section titled “Description”The Source object represents Premiere Pro’s Source monitor.
Attributes
Section titled “Attributes”None.
Methods
Section titled “Methods”SourceMonitor.closeAllClips()
Section titled “SourceMonitor.closeAllClips()”app.sourceMonitor.closeAllClips()
Description
Section titled “Description”Closes all clips in the Source monitor.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns 0
if successful.
SourceMonitor.closeClip()
Section titled “SourceMonitor.closeClip()”app.sourceMonitor.closeClip()
Description
Section titled “Description”Closes the front-most clip in the Source monitor.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns 0
if successful.
SourceMonitor.getPosition()
Section titled “SourceMonitor.getPosition()”app.sourceMonitor.getPosition()
Description
Section titled “Description”Retrieves the position of the Source monitor’s current time indicator.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns a Time object containing the position of the Source monitor’s current time indicator.
SourceMonitor.getProjectItem()
Section titled “SourceMonitor.getProjectItem()”app.sourceMonitor.getProjectItem()
Description
Section titled “Description”Retrieves the project item corresponding to the media open in the Source monitor.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns projectItem if successful; null if not.
SourceMonitor.openFilePath()
Section titled “SourceMonitor.openFilePath()”app.sourceMonitor.openFilePath(path)
Description
Section titled “Description”Open a file in the Source monitor.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
path | String | A path to the file to open. |
Returns
Section titled “Returns”Returns true
if successful.
SourceMonitor.openProjectItem()
Section titled “SourceMonitor.openProjectItem()”app.sourceMonitor.openProjectItem(projectItem)
Description
Section titled “Description”Open a project item in the Source monitor.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
projectItem | ProjectItem object | A project item to open. |
Returns
Section titled “Returns”Returns 0
if successful.
SourceMonitor.play()
Section titled “SourceMonitor.play()”app.sourceMonitor.play(playbackSpeed)
Description
Section titled “Description”Begins playing back the Source monitor, at the specified playback speed.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
playbackSpeed | Float | The playback speed. |
Returns
Section titled “Returns”Returns 0
if successful.