ClipProjectItem

Properties

Name

Type

Access

Min Version

Description

type

number

25.0

Get the type of the Project Item.

name

string

25.0

The name of this project item.

Static Methods

cast

25.0

ClipProjectItem

Cast ProjectItem in to ClipProjectItem

Parameters

Name

Type

Description

projectItem

ProjectItem

Instance Methods

attachProxy

25.0

boolean

Attach proxy or high resolution footage to projectItem and returns true if successful. Not undoable.

Parameters

Name

Type

Description

mediaPath

string

isHiRes

boolean

inMakeAlternateLinkInTeamProjects

boolean

canChangeMediaPath

25.0

boolean

Returns true if Premiere Pro can change the path associated with this project item; otherwise, returns false

canProxy

25.0

boolean

Indicates whether it is possible to attach a proxy to this project item.

changeMediaFilePath

25.0

boolean

Change media file path of projectItem and returns true if successful. Not undoable.

Parameters

Name

Type

Description

newPath

string

overrideCompatibilityCheck

boolean

createClearInOutPointsAction

25.0

Action

Create Clear the in or out point of the Project item action

createSetColorLabelAction

25.0

Action

Create an action for set color label to projectItem by index

Parameters

Name

Type

Description

inColorLabelIndex

number

createSetFootageInterpretationAction

25.0

Action

Set the footage interpretation object for project item

Parameters

Name

Type

Description

footageInterpretation

FootageInterpretation

createSetInOutPointsAction

25.0

Action

Set the in or out point of the Project item

Parameters

Name

Type

Description

inPoint

TickTime

outPoint

TickTime

createSetInPointAction

25.0

Action

Returns an action which Sets the in point of the Project item

Parameters

Name

Type

Description

tickTime

TickTime

createSetInputLUTIDAction

25.0

Action

Create action for setting Guid of Input LUT on media. This applies for Video Clips only.

Parameters

Name

Type

Description

stringLUTID

string

createSetNameAction

25.0

Action

Returns action that renames projectItem

Parameters

Name

Type

Description

inName

string

createSetOfflineAction

25.0

Action

Returns an action which sets the media offline

createSetOutPointAction

25.0

Action

Returns an action which Sets the out point of the Project item

Parameters

Name

Type

Description

tickTime

TickTime

createSetOverrideFrameRateAction

25.0

Action

Returns an action which sets the override frame rate

Parameters

Name

Type

Description

inOverriddenFrameRateValue

number

createSetOverridePixelAspectRatioAction

25.0

Action

Returns an action which sets Override pixel aspect ratio

Parameters

Name

Type

Description

inNumerator

number

inDenominator

number

createSetScaleToFrameSizeAction

25.0

Action

Returns an action which sets the scale to frame to true

findItemsMatchingMediaPath

25.0

ProjectItem[]

Returns array of project's items with media paths containing match string

Parameters

Name

Type

Description

matchString

string

ignoreSubclips

boolean

getColorLabelIndex

25.0

number

Get color label index of projectItem

getComponentChain

25.0

string

Gets the component chain associated with this project item.

Parameters

Name

Type

Description

mediaType

Constants.MediaType

Media type can be audio, video or data/caption

getContentType

25.0

Constants.ContentType

Get content type of the Project item

getEmbeddedLUTID

25.0

string

Get GUID of LUT embedded in media

getFootageInterpretation

25.0

FootageInterpretation

Get the footage interpretation object for project item

getInPoint

25.0

TickTime

Get the in point of the Project item

Parameters

Name

Type

Description

mediaType

Constants.MediaType

Media type can be audio, video or data/caption

getInputLUTID

25.0

string

Get Guid of Input LUT overridden on media

getMedia

25.0

Media

Return media associated with clipProjectItem

getMediaFilePath

25.0

string

Get the media file path of the Project item.

getOriginatingProjectPath

25.0

string

Return originating project path associated with clipProjectItem

getOutPoint

25.0

TickTime

Get the out point of the Project item

Parameters

Name

Type

Description

mediaType

Constants.MediaType

Media type can be audio, video or data/caption

getProject

25.0

Project

Get the parent Project of this projectItem.

getProxyPath

25.0

string

Returns the proxy path if the project item has a proxy attached

getSequence

25.0

Sequence

Get the sequence of the Project item

hasProxy

25.0

boolean

Indicates whether a proxy has already been attached to the project item.

isMergedClip

25.0

boolean

Returns true if the clip Project item is a merged clip

isMulticamClip

25.0

boolean

Returns true if the clip Project item is a multicam clip

isOffline

25.0

boolean

Returns true if the media is offline

isSequence

25.0

boolean

Returns true if the project item is a sequence

refreshMedia

25.0

boolean

Updates representation of the media associated with the project item