Project Item object¶
projectItem
Description
Each item in a given Premiere Pro project is a projectItem. The root item of each project is also, itself, a projectItem.
Attributes¶
children¶
projectItem.children
Description
A read-only array of project items, which are themselves contained within the specified project item.
Type
Array; read-only.
treePath¶
projectItem.treePath
Description
The path within the project, to the current location of the project item. For example, an .mxf file located in a bin named “MXF”, within a bin named “Media”, would have a tree path of
\ProjectName.prproj\Media\MXF\filename.mxf
Type
String; read-only.
type¶
projectItem.type
Description
The type of the project Item. Value will be one of the following: CLIP, BIN, ROOT, or FILE.
Type
Enumeration; read-only.
nodeID¶
projectItem.nodeID
Description
A unique ID assigned to the project item, upon its addition to the project.
NOTE: This allows for differentiation between two different project items, associated with the same source media.
Type
String; read-only.
videoComponents¶
projectItem.videoComponents
Description
An array of video components associated with the ‘Master Clip’ of this project item.
Type
Array of video components. While the parameters associated with these components are read/write, this array of components is, itself, read-only.
teamProjectsAssetId¶
projectItem.teamProjectsAssetId
Description
The Team Projects Asset ID of the project item.
Type String; read-only.
Methods¶
createSmartBin()¶
projectItem.createSmartBin(String nameOfNewBin, String queryString)
Description
Creates a smart bin (also known as a search bin), within the project item. Only works within project items which are bins.
Parameters
Name of new bin. Query string for search.
Returns
Returns 0 if creation if smart bin was successful.
createBin()¶
projectItem.createBin(String nameOfNewBin)
Description
Creates an empty bin, within the project item. Only works within project items which are bins.
Parameters
Name of new bin.
Returns
Returns 0 if creation of bin was successful.
renameBin()¶
projectItem.renameBin(newName)
Description
Changes name of bin. Only works on project items which are bins.
Parameters
New bin name.
Returns
Returns 0 if renaming bin was successful.
moveBin()¶
projectItem.moveBin(newParentBinProjectItem)
Description
Moves the projectItem into a new parent bin.
Parameters
None.
Returns
Returns 0 if move was successful.
deleteBin()¶
projectItem.deleteBin()
Description
Deletes a bin, AND ALL ITS CONTENTS, from the project. Only works on project items which are bins.
Parameters
None.
Returns
Returns 0 if deletion was successful.
getstartTime()¶
projectItem.getStartTime()
Description
Returns a Time object, representing the start time of the project item.
Parameters
None.
Returns
A Time object.
getXMPMetadata()¶
projectItem.getXMPMetadata()
Description
Retrieves the XMP metadata associated with the project item, as a String.
Parameters
None.
Returns
A String containing all XMP metadata, serialized.
setXMPMetadata()¶
projectItem.setXMPMetadata(newXMPAsString)
Description
Sets the XMP metadata associated with the project item.
Parameters
A String representing the new, serialized XMP metadata.
Returns
Returns 0 if update was successful.
getProjectMetadata()¶
projectItem.getProjectMetadata()
Description
Retrieves Premiere Pro’s private project metadata associated with the project item, as a String. NOTE While this data is also valid XMP, it is distinct from the XMP metadata associated with the media.
Parameters
None.
Returns
A String containing all Premiere Pro private project metadata, serialized.
setProjectMetadata()¶
projectItem.setProjectMetadata(String newPrivateProjectMetadata, arrayOfUpdatedFields)
Description
Sets the private project metadata associated with the project item.
Parameters
A String representing the new, serialized private project metadata, and an array containing the names of the fields to be updated.
Returns
Returns 0 if update was successful.
getMarkers()¶
projectItem.getMarkers()
Description
Retrieves the markers associated with this project item.
Parameters
None.
Returns
An array of markers associated with the project item, or 0 if there are no markers.
refreshMedia()¶
projectItem.refreshMedia()
Description
Forces Premiere Pro to update its representation of the media associated with the project item. If the media was previously off-line, this can cause it to become online (if previously missing media has become available).
Parameters
None.
Returns
An array of markers associated with the project item, or 0 if there are no markers.
getMediaPath()¶
projectItem.getMediaPath()
Description
Returns the path associated with the project item’s media, as a String. NOTE: This only works for atomic media; this call cannot provide meaningful paths for media which has no actual path (which will be the case for any media generated by synthetic importers, like Premiere Pro’s own Universal Counting Leader).
Parameters
None.
Returns
A String containing the path to the media associate with the project item.
canChangeMediaPath()¶
projectItem.canChangeMediaPath()
Description
Returns true if Premiere Pro can change the path, associated with this project item; otherwise, returns false.
Parameters
None.
Returns
Boolean; true if media can be replaced, false if not.
changeMediaPath()¶
projectItem.changeMediaPath(String newPath)
Description
Updates the project item to point to a new media path.
Parameters
A String, representing the new path.
Returns
Returns 0 if replacement was successful.
select()¶
projectItem.select()
Description
Sets the project item (which must be a bin), as the target for subsequent imports into the project.
Parameters
None.
Returns
Returns 0 if the project item has successfully been made the target, for subsequent imports.
setOverridePixelAspectRatio()¶
projectItem.setOverridePixelAspectRatio(int numerator, int denominator)
Description
Sets the pixel aspect ratio for the project item.
Parameters
Integers representing the new numerator and denominator.
Returns
Returns 0 if the aspect ratio has successfully been changed.
setOverrideFrameRate()¶
projectItem.setOverrideFrameRate(float newFrameRate)
Description
Sets the frame rate of the project item.
Parameters
Float representing the new frame rate.
Returns
Returns 0 if the frame rate has successfully been changed.
setScaleToFrameSize()¶
projectItem.setScaleToFrameSize()
Description
Turns on scaling to frame size, for when media from this project item is inserted into a sequence.
Parameters
None.
Returns
Undefined return value.
createSubClip()¶
projectItem.createSubClip(subclipName, startTime, endTime,hasHardBoundaries, takeAudio, takeVideo)
Description
Creates a new project item for a sub-clip of the existing project item.
Parameters
subclipName |
Name of new subclip. |
startTime |
Start time of subclip, in Ticks. |
endTime |
End time of subclip, in Ticks. |
hasHardBoundaries |
0 or 1; if 1, the user cannot extend in and out. |
takeVideo |
0 or 1; if 1, use video from source. |
takeAudio |
0 or 1; if 1, use video from source. |
Returns
Returns a project item representing the new subclip, or 0 if creation failed.
findItemsMatchingMediaPath()¶
projectItem.findItemsMatchingMediaPath(pathToMatch, ignoreSubClips)
Description
Returns an array of project items, all of which reference the same media path.
Parameters
pathToMatch |
Path to match, as String. |
ignoreSubClips |
0 or 1; if 1, no subclips will be returned. |
Returns
Returns an array of project items, or 0 if no project items matching the matchPath were found.
canProxy()¶
projectItem.canProxy()
Description
Indicates whether it’s possible to attach a proxy, to this project item.
Parameters
None.
Returns
Returns true if the project item permits a proxy to be attached; false if not.
hasProxy()¶
projectItem.hasProxy()
Description
Indicates whether a proxy has already been attached, to the project item.
Parameters
None.
Returns
Returns true if the project item has a proxy attached; false if not.
getProxyPath()¶
projectItem.getProxyPath()
Description
Retrieves the path to the proxy media associated with this project item.
Parameters
None.
Returns
Returns the path (as String) to the proxy media associated with the proxy item, or 0 if none is found.
attachProxy()¶
projectItem.attachProxy(String newMediaPath, int isHiRes)
Description
Attaches the media at newMediaPath to the project item, as either hi-res or proxy media.
Parameters
The path the the newly-assigned media (as String), and an int indicating whether the new media should be attached as the proxy (0) or high resolution (1) media.
Returns
Returns 0 if successful.
IsSequence()¶
projectItem.IsSequence()
Description
Indicates whether the project item refers to a sequence.
Parameters
None.
Returns
Returns true if the project item is a sequence, false if it isn’t.
setStartTime()¶
projectItem.setStartTime(timeInTicks)
Description
Assigns a new start time to the project item
Parameters
New starting time, represented in ticks.
Returns
Returns 0 if successful.
getOutPoint()¶
projectItem.getOutPoint(mediaType)
Description
Retrieves the current out point for specified media type.
Parameters
mediaType is an int; pass 1 for video only, or 2 for audio only. If no mediaType is passed, function gets the out point for all media.
Returns
Returns a Time object.
setOutPoint()¶
projectItem.setOutPoint(timeInTicks, mediaType)
Description
Sets the out point to timeInTicks, for specified media types. mediaType defaults to all; pass 1 for video only, or 2 for audio only.
Parameters
A Time object, and an int; pass 1 for video only, or 2 for audio only. If no mediaType is passed, function sets the out point for all media.
Returns
Returns 0 if successful.
clearOutPoint()¶
projectItem.clearOutPoint()
Description
Clears any assigned out point; the project item will then start at startTime.
Parameters
None
Returns
Returns 0 if successful.
getColorLabel()¶
projectItem.getColorLabel()
Description
Retrieves the project item’s color label.
Parameters
None.
Returns
| labelColor |
|
setColorLabel()¶
projectItem.setColorLabel(newLabelColor)
Description
Sets the project item’s color label.
Parameters
New label color; see projectItem.getColorLabel.
Returns
0 if successful.
getFootageInterpretation()¶
projectItem.getFootageInterpretation()
Description
Returns a structure describing the current interpretation of the projectItem.
Parameters
None.
Returns
A footage interpretation structure, or 0 if unsuccessful.
alphaUsage |
|
fieldType |
|
ignoreAlpha |
true or false. |
invertAlpha |
true or false. |
frameRate |
Frame rate as floating point value. |
pixelAspectRatio |
Pixel aspect ratio as floating point value. |
removePulldown |
true or false. |
vrConformProjectionType |
|
vrLayoutType |
|
vrHorizontalView |
The horizontal view in use, for VR footage. |
vrVerticalView |
The vertical view in use, for VR footage. |
setFootageInterpretation()¶
projectItem.setFootageInterpretation(newInterpretation)
Description
Returns a structure describing the current interpretation of the projectItem.
Parameters
A footage interpretation structure.
Returns
0 if successful.
isOffline()¶
projectItem.isOffline()
Description
Returns a Boolean indicating whether the project item is offline.
Parameters
None.
Returns
Boolean, true if offline.
setOffline()¶
projectItem.setOffline()
Description
Makes the project item offline.
Parameters
None.
Returns
true if successful.