ClipProjectItem

Since: 25.6

Properties

Name

Type

Access

Min Version

Description

type

number

25.6

Get the type of the Project Item.

name

string

25.6

The name of this project item.

Static Methods

cast

Cast ProjectItem in to ClipProjectItem

Since: 25.6

Returns: ClipProjectItem

Parameters

Name

Type

Description

projectItem

ProjectItem

Instance Methods

attachProxy

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

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

mediaPath

string

isHiRes

boolean

inMakeAlternateLinkInTeamProjects

boolean

canChangeMediaPath

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

Since: 25.6

Returns: Promise<boolean>

canProxy

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

Since: 25.6

Returns: Promise<boolean>

changeMediaFilePath

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

Since: 25.6

Returns: Promise<boolean>

Parameters

Name

Type

Description

newPath

string

overrideCompatibilityCheck

boolean

createClearInOutPointsAction

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

Since: 25.6

Returns: Action

createSetColorLabelAction

Create an action for set color label to projectItem by index

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inColorLabelIndex

number

createSetFootageInterpretationAction

Set the footage interpretation object for project item

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

footageInterpretation

FootageInterpretation

createSetInOutPointsAction

Set the in or out point of the Project item

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inPoint

TickTime

outPoint

TickTime

createSetInPointAction

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

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

tickTime

TickTime

createSetInputLUTIDAction

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

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

stringLUTID

string

createSetNameAction

Returns action that renames projectItem

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inName

string

createSetOfflineAction

Returns an action which sets the media offline

Since: 25.6

Returns: Action

createSetOutPointAction

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

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

tickTime

TickTime

createSetOverrideFrameRateAction

Returns an action which sets the override frame rate

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

overriddenFrameRateValue

number

createSetOverridePixelAspectRatioAction

Returns an action which sets Override pixel aspect ratio

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

numerator

number

denominator

number

createSetScaleToFrameSizeAction

Returns an action which sets the scale to frame to true

Since: 25.6

Returns: Action

createSubClipAction

Returns a deferred Action that creates a subclip when committed inside a transaction. hasHardBoundaries: if true, prevents trimming beyond the subclip boundaries. Takes additional options (defaulting to true).

Since: 26.3

Returns: Action

Parameters

Name

Type

Description

name

string

startTime

TickTime

endTime

TickTime

hasHardBoundaries

boolean

options

{ takeVideo?: boolean, takeAudio?: boolean }

findItemsMatchingMediaPath

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

Since: 25.6

Returns: Promise<ProjectItem[]>

Parameters

Name

Type

Description

matchString

string

ignoreSubclips

boolean

getColorLabelIndex

Get color label index of projectItem

Since: 25.6

Returns: Promise<number>

getComponentChain

Get the component chain of the Project item for the given media type.

Since: 25.6

Returns: Promise<string>

Parameters

Name

Type

Description

mediaType

Constants.MediaType

Media type can be audio or video

getContentType

Get content type of the Project item

Since: 25.6

Returns: Promise<Constants.ContentType>

getEmbeddedLUTID

Get GUID of LUT embedded in media

Since: 25.6

Returns: Promise<string>

getFootageInterpretation

Get the footage interpretation object for project item

Since: 25.6

Returns: Promise<FootageInterpretation>

getInPoint

Get the in point of the Project item

Since: 25.6

Returns: Promise<TickTime>

Parameters

Name

Type

Description

mediaType

Constants.MediaType

Media type can be audio, video or data/caption

getInputLUTID

Get Guid of Input LUT overridden on media

Since: 25.6

Returns: Promise<string>

getMedia

Return media associated with clipProjectItem

Since: 25.6

Returns: Promise<Media>

getMediaFilePath

Get the media file path of the Project item.

Since: 25.6

Returns: Promise<string>

getOriginatingProjectPath

Return originating project path associated with clipProjectItem

Since: 26.2

Returns: Promise<string>

getOutPoint

Get the out point of the Project item

Since: 25.6

Returns: Promise<TickTime>

Parameters

Name

Type

Description

mediaType

Constants.MediaType

Media type can be audio, video or data/caption

getProject

Get the parent Project of this projectItem.

Since: 25.6

Returns: Promise<Project>

getProxyPath

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

Since: 25.6

Returns: Promise<string>

getSequence

Get the sequence of the Project item

Since: 25.6

Returns: Promise<Sequence>

hasProxy

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

Since: 25.6

Returns: Promise<boolean>

isMergedClip

Returns true if the clip Project item is a merged clip

Since: 25.6

Returns: Promise<boolean>

isMulticamClip

Returns true if the clip Project item is a multicam clip

Since: 25.6

Returns: Promise<boolean>

isOffline

Returns true if the media is offline

Since: 25.6

Returns: Promise<boolean>

isSequence

Returns true if the project item is a sequence

Since: 25.6

Returns: Promise<boolean>

refreshMedia

Updates representation of the media associated with the project item

Since: 25.6

Returns: Promise<boolean>