### getSettings

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the sequence settings object.

```APIDOC
## getSettings

### Description
Get sequence settings object

### Returns
- _SequenceSettings_
```

--------------------------------

### createSetStartAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/media

Returns an action that sets the start time of the media.

```APIDOC
## createSetStartAction

### Description
Returns an action that sets the start time of the media.

### Method
(Implicitly a method call, not HTTP)

### Parameters
#### Parameters
- **time** (_TickTime_) - Description: -
```

--------------------------------

### createSetStartAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocliptrackitem

Create set start time action for sequence.

```APIDOC
## createSetStartAction

### Description
Create set start time action for sequence.

### Parameters
#### Path Parameters
- **tickTime** (TickTime) - Description: -

### Returns
_Action_
```

--------------------------------

### getStartTime

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocliptrackitem

Returns a TickTime object representing the starting sequence time of this track item relative to the sequence start time.

```APIDOC
## getStartTime

### Description
Returns a TickTime object representing the starting sequence time of this track item relative to the sequence start time.

### Returns
_TickTime_
```

--------------------------------

### createSetXMPMetadataAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/metadata

Gets an action to set project XMP metadata.

```APIDOC
## createSetXMPMetadataAction

### Description
Get set project XMP metadata action.

### Parameters
#### Path Parameters
- **projectItem** (ProjectItem) - Required - Description for projectItem
- **metadata** (string) - Required - Description for metadata
```

--------------------------------

### createSetProjectMetadataAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/metadata

Gets an action to set project metadata.

```APIDOC
## createSetProjectMetadataAction

### Description
Get set project metadata action.

### Parameters
#### Path Parameters
- **projectItem** (ProjectItem) - Required - Description for projectItem
- **metadata** (string) - Required - Description for metadata
- **updatedFields** (string[]) - Required - Description for updatedFields
```

--------------------------------

### Guid.toString

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/guid

Returns the string representation of the Guid.

```APIDOC
## Guid.toString

### Description
Return string representation of the GUID.

### Method
instance

### Returns
- **string** - The string representation of the Guid.
```

--------------------------------

### createSetStartAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/videocliptrackitem

Creates an action to set the start time of the track item.

```APIDOC
## createSetStartAction

### Description
Create set start time action for sequence

### Parameters
#### Parameters
- **tickTime** (_TickTime_) - The new start time for the track item.
```

--------------------------------

### setApplyToStart

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/addtransitionoptions

Sets whether a transition should be applied to the start or end of a track item.

```APIDOC
## setApplyToStart

### Description
Set whether to apply transition to the start or end of trackitem.

### Method
SetApplyToStart

### Parameters
#### Path Parameters
- **applyToStart** (boolean) - Required - Description for applyToStart
```

--------------------------------

### getStartValue

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/componentparam

Retrieves the initial keyframe (start value) of the component parameter.

```APIDOC
## getStartValue

### Description
Returned promise will be fulfilled with the start value (keyframe) of the component param.

### Returns
- **Keyframe**: The starting keyframe of the component parameter.

### Min Version
25.0
```

--------------------------------

### FolderItem.getProject

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/folderitem

Gets the parent Project of this projectItem.

```APIDOC
## FolderItem.getProject

### Description
Get the parent Project of this projectItem.
```

--------------------------------

### getProjectItem

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the associated ProjectItem of the sequence.

```APIDOC
## getProjectItem

### Description
Get the associated projectItem of the sequence.

### Returns
- _ProjectItem_
```

--------------------------------

### SequenceEditor.getInstalledMogrtPath

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequenceeditor

Gets the local directory path where Adobe Motion Graphics Templates (MOGRTs) are stored.

```APIDOC
## SequenceEditor.getInstalledMogrtPath

### Description
Get local directory path to adobe mogrt files.

### Returns
- _String_ - The local directory path to Adobe MOGRT files.
```

--------------------------------

### getFrameSize

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the size of the sequence frame.

```APIDOC
## getFrameSize

### Description
Gets the size of the frame

### Returns
- _RectF_
```

--------------------------------

### getTimebase

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the time base of the sequence.

```APIDOC
## getTimebase

### Description
Gets the time base of sequence

### Returns
- _string_
```

--------------------------------

### getOutPoint

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the time representing the out-point of the sequence.

```APIDOC
## getOutPoint

### Description
Get time representing the outPoint of sequence.

### Returns
- _TickTime_
```

--------------------------------

### getProjectItem

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sourcemonitor

Gets the ProjectItem currently loaded in the Source Monitor.

```APIDOC
## getProjectItem

### Description
Gets the ProjectItem currently displayed in the Source Monitor.

### Returns
- _ProjectItem_: The ProjectItem object.
```

--------------------------------

### FolderItem.getColorLabelIndex

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/folderitem

Gets the color label index of the projectItem.

```APIDOC
## FolderItem.getColorLabelIndex

### Description
Get color label index of projectItem
```

--------------------------------

### Guid.fromString

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/guid

Creates a Guid object from a string representation.

```APIDOC
## Guid.fromString

### Description
Creates a guid from a string.

### Method
static

### Parameters
#### Path Parameters
- **stringValue** (string) - Required - The string to parse into a Guid.
```

--------------------------------

### getInPoint

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the time representing the in-point of the sequence.

```APIDOC
## getInPoint

### Description
Get time representing the inPoint of sequence.

### Returns
- _TickTime_
```

--------------------------------

### getSequenceAudioTimeDisplayFormat

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the audio time display format of the sequence.

```APIDOC
## getSequenceAudioTimeDisplayFormat

### Description
Get audio time display format of this sequence

### Returns
- _TimeDisplay_
```

--------------------------------

### getAudioTrackCount

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the total number of audio tracks in the sequence.

```APIDOC
## getAudioTrackCount

### Description
Get audio track count from this sequence

### Returns
- _number_
```

--------------------------------

### getIndex

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/videotrack

Gets the index of the video track within its track group.

```APIDOC
## getIndex()

### Description
Index representing the track index of this track within the track group.

### Returns
- **Type**: number
```

--------------------------------

### PRProduction.getScratchDiskSettings

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/prproduction

Retrieves the scratch disk settings instance for a given production.

```APIDOC
## getScratchDiskSettings

### Description
Get the scratch disk settings instance for this production.

### Method
Instance method

### Returns
_ScratchDiskSettings_
```

--------------------------------

### Get Active Project

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference

Retrieve the currently active project in Premiere Pro. This is an asynchronous operation.

```javascript
const project = await app.Project.getActiveProject();
```

--------------------------------

### getProjectFromViewId

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/projectutils

Retrieves a project object using its unique view GUID.

```APIDOC
## getProjectFromViewId

### Description
Get project based on input view guid.

### Parameters
#### Path Parameters
- **guid** (_Guid_) - Description: -
```

--------------------------------

### createSetScratchDiskSettingsAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/projectsettings

Returns an action that can be used to set the project's scratch disk settings.

```APIDOC
## createSetScratchDiskSettingsAction

### Description
Returns an action which sets ScratchDiskSetting.

### Parameters
#### Path Parameters
- **project** (_Project_) - Description: -
- **scratchDiskSettings** (_ScratchDiskSettings_) - Description: -
```

--------------------------------

### Get VR Layout

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the VR layout type of the footage.

```APIDOC
## getVrLayout

### Description
Get vr layout type of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _number_: The VR layout type.
```

--------------------------------

### openFilePath

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sourcemonitor

Opens a media file from the specified path and loads it into the Source Monitor for preview.

```APIDOC
## openFilePath

### Description
Opens the item at the specified path and sends it to the Source Monitor for preview.

### Parameters
#### Path Parameters
- **filePath** (_string_) - Description: The full path to the media file.
```

--------------------------------

### createSetInPointAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocliptrackitem

Create SetInPointAction for setting the track item in point relative to the start time of the project item referenced by this track item.

```APIDOC
## createSetInPointAction

### Description
Create SetInPointAction for setting the track item in point relative to the start time of the project item referenced by this track item.

### Parameters
#### Path Parameters
- **tickTime** (TickTime) - Description: Sets the In-Point in TickTime

### Returns
_Action_
```

--------------------------------

### createSetOutPointAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocliptrackitem

Create SetOutPointAction for setting the track item out point relative to the start time of the project item referenced by this track item.

```APIDOC
## createSetOutPointAction

### Description
Create SetOutPointAction for setting the track item out point relative to the start time of the project item referenced by this track item.

### Parameters
#### Path Parameters
- **tickTime** (TickTime) - Description: Sets the Out-Point in TickTime

### Returns
_Action_
```

--------------------------------

### Project Creation and Management

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/project

Methods for creating, opening, and saving projects.

```APIDOC
## createProject

### Description
Creates a new project.

### Method
static Project createProject(string path)

### Parameters
- **path** (string) - The path for the new project.
```

```APIDOC
## getActiveProject

### Description
Returns the currently active project.

### Method
static Project getActiveProject()
```

```APIDOC
## getProject

### Description
Retrieves a project by its unique identifier.

### Method
static Project getProject(Guid projectGuid)

### Parameters
- **projectGuid** (Guid) - The unique identifier of the project.
```

```APIDOC
## isProject

### Description
Checks if a file at the given path can be opened as a Premiere Pro project.

### Method
static boolean isProject(string projectPath)

### Parameters
- **projectPath** (string) - The path to the project file.
```

```APIDOC
## open

### Description
Opens a project file.

### Method
static Project open(string path, OpenProjectOptions openProjectOptions)

### Parameters
- **path** (string) - The path to the project file.
- **openProjectOptions** (OpenProjectOptions) - Options for opening the project.
```

```APIDOC
## save

### Description
Saves the current project.

### Method
boolean save()

### Returns
- **boolean** - True if the project was saved successfully.
```

```APIDOC
## saveAs

### Description
Saves the project to a specified path.

### Method
boolean saveAs(string path)

### Parameters
- **path** (string) - The path where the project will be saved.

### Returns
- **boolean** - True if the project was saved successfully.
```

--------------------------------

### Get VR Conform

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the VR conform projection type of the footage.

```APIDOC
## getVrConform

### Description
Get vr conform projection type of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _number_: The VR conform projection type.
```

--------------------------------

### getComponentCount

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocomponentchain

Gets the total number of audio components currently in the component chain.

```APIDOC
## getComponentCount

### Description
Gets the number of components in the component chain.

### Returns
- _number_ - The total count of components in the chain.
```

--------------------------------

### getZeroPoint

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the time representing the zero-point of the sequence.

```APIDOC
## getZeroPoint

### Description
Time representing the zero point of the sequence.

### Returns
- _TickTime_
```

--------------------------------

### getScratchDiskSettings

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/projectsettings

Retrieves the current scratch disk settings for the project.

```APIDOC
## getScratchDiskSettings

### Description
Returns project ScratchDiskSettings.

### Parameters
#### Path Parameters
- **project** (_Project_) - Description: -
```

--------------------------------

### ProjectItem Instance Methods

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/projectitem

Instance methods available on ProjectItem objects.

```APIDOC
## ProjectItem Instance Methods

### createSetColorLabelAction

- **Min Version**: 25.0
- **Returns**: _Action_
- **Description**: Create an action for setting the color label for a project item by index.

#### Parameters

- **inColorLabelIndex** (_number_) - Description: -
```

```APIDOC
### createSetNameAction

- **Min Version**: 25.0
- **Returns**: _Action_
- **Description**: Returns an action that renames a project item.

#### Parameters

- **inName** (_string_) - Description: -
```

```APIDOC
### getColorLabelIndex

- **Min Version**: 25.0
- **Returns**: _number_
- **Description**: Get the color label index of the project item.
```

```APIDOC
### getId

- **Min Version**: 25.0
- **Returns**: _string_
- **Description**: Get the ID of the project item.
```

```APIDOC
### getParentBin

- **Min Version**: 25.0
- **Returns**: _FolderItem_
- **Description**: Get the parent FolderItem of the project item.
```

```APIDOC
### getProject

- **Min Version**: 25.0
- **Returns**: _Project_
- **Description**: Get the parent Project of this project item.
```

--------------------------------

### isAEInstalled

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/utils

Checks if Adobe After Effects is currently installed on the user's system. This can be useful for determining compatibility or enabling AE-specific features.

```APIDOC
## isAEInstalled

### Description
Checks if Adobe After Effects is installed.

### Method
Static Method

### Returns
- **boolean**: Returns `true` if After Effects is installed, `false` otherwise.
```

--------------------------------

### getEndTime

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the time representing the end of the sequence.

```APIDOC
## getEndTime

### Description
Time representing the end of the sequence

### Returns
- _TickTime_
```

--------------------------------

### getTemporalInterpolationMode

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/keyframe

Gets the temporal interpolation mode of a keyframe.

```APIDOC
## getTemporalInterpolationMode

### Description
Gets temporal interpolation mode of a keyframe

### Returns
- **Type**: number
- **Min Version**: 25.0
```

--------------------------------

### Importing and Utilities

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/project

Methods for importing assets and other utility functions.

```APIDOC
## executeTransaction

### Description
Executes an undoable transaction by passing a compound action.

### Method
boolean executeTransaction(callback: (compoundAction: CompoundAction) => void, undoString?: string)

### Parameters
- **callback** ((compoundAction: CompoundAction) => void) - The function to execute as a transaction.
- **undoString** (string, optional) - A string describing the undo action.
```

```APIDOC
## getColorSettings

### Description
Retrieves the project's color settings object.

### Method
ProjectColorSettings getColorSettings()
```

```APIDOC
## getInsertionBin

### Description
Retrieves the current insertion bin for the project.

### Method
ProjectItem getInsertionBin()
```

```APIDOC
## getRootItem

### Description
Retrieves the root item of the project, which contains all project items.

### Method
FolderItem getRootItem()
```

```APIDOC
## importAEComps

### Description
Imports After Effects compositions into the project.

### Method
boolean importAEComps(string aepPath, string[] compNames, ProjectItem TargetBin)

### Parameters
- **aepPath** (string) - The path to the After Effects project file.
- **compNames** (string[]) - An array of composition names to import.
- **TargetBin** (ProjectItem) - The bin where the compositions will be imported.
```

```APIDOC
## importAllAEComps

### Description
Imports all After Effects compositions from a specified project file.

### Method
boolean importAllAEComps(string aepPath, ProjectItem TargetBin)

### Parameters
- **aepPath** (string) - The path to the After Effects project file.
- **TargetBin** (ProjectItem) - The bin where the compositions will be imported.
```

```APIDOC
## importFiles

### Description
Imports files into the project's root or target bin.

### Method
boolean importFiles(string[] filePaths, boolean suppressUI, ProjectItem targetBin, boolean asNumberedStills)

### Parameters
- **filePaths** (string[]) - An array of file paths to import.
- **suppressUI** (boolean) - If true, suppresses the import UI.
- **targetBin** (ProjectItem) - The target bin for the imported files.
- **asNumberedStills** (boolean) - If true, imports files as numbered stills.
```

```APIDOC
## importSequences

### Description
Imports sequences from a project file into the current project.

### Method
boolean importSequences(string projectPath, Guid[] sequenceIds)

### Parameters
- **projectPath** (string) - The path to the project file containing the sequences.
- **sequenceIds** (Guid[]) - An array of sequence IDs to import.
```

```APIDOC
## lockedAccess

### Description
Obtains read/upgrade locked access to the project, ensuring its state remains unchanged during callback execution. Can execute transactions while holding locked access.

### Method
void lockedAccess(callback: () => void)

### Parameters
- **callback** (() => void) - The function to execute with locked access.
```

```APIDOC
## pauseGrowing

### Description
Pauses or resumes the growing of files instead of swapping them.

### Method
boolean pauseGrowing(boolean pause)

### Parameters
- **pause** (boolean) - If true, pauses growing; if false, resumes.
```

--------------------------------

### getOutPoint

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocliptrackitem

Returns a TickTime object representing the track item out point relative to the start time of the project item referenced by this track item.

```APIDOC
## getOutPoint

### Description
Returns a TickTime object representing the track item out point relative to the start time of the project item referenced by this track item.

### Returns
_TickTime_
```

--------------------------------

### createSetSettingsAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Returns an action that sets sequence settings.

```APIDOC
## createSetSettingsAction

### Description
Returns action that set sequence settings

### Parameters
- **sequenceSettings** (_SequenceSettings_) - Description: -

### Returns
- _Action_
```

--------------------------------

### FolderItem.getItems

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/folderitem

Gets the collection of child items of this folder.

```APIDOC
## FolderItem.getItems

### Description
Collection of child items of this folder.
```

--------------------------------

### createSetIngestSettingsAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/projectsettings

Returns an action that can be used to set the project's ingest settings.

```APIDOC
## createSetIngestSettingsAction

### Description
Returns an action which sets IngestSettings.

### Parameters
#### Path Parameters
- **project** (_Project_) - Description: -
- **ingestSettings** (_IngestSettings_) - Description: -
```

--------------------------------

### openProjectItem

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sourcemonitor

Opens a specified ProjectItem in the Source Monitor.

```APIDOC
## openProjectItem

### Description
Opens the input ProjectItem on the Source Monitor.

### Parameters
#### Path Parameters
- **projectItem** (_ProjectItem_) - Description: The ProjectItem to open.
```

--------------------------------

### AudioTrack Instance Methods

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiotrack

Instance methods available on the AudioTrack class.

```APIDOC
## Instance Methods

### getIndex

Returns the index representing the track index of this track within the track group.

_Returns:_ _number_

### getMediaType

Returns the UUID representing the underlying media type of this track.

_Returns:_ _Guid_

### getTrackItems

Returns an array of AudioClipTrackItem from the track item type.

#### Parameters

* **trackItemType** (_Constants.TrackItemType_): Constants.TrackItemType.CLIP, Constants.TrackItemType.TRANSITION etc..
* **includeEmptyTrackItems** (_boolean_): -

_Returns:_ _AudioClipTrackItem[]_

### isMuted

Gets the mute state of the track.

_Returns:_ _boolean_

### setMute

Sets the mute state of the track to muted/unmuted.

#### Parameters

* **mute** (_boolean_): -
```

--------------------------------

### getVideoTrackCount

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the total number of video tracks in the sequence.

```APIDOC
## getVideoTrackCount

### Description
Get video track count from this sequence

### Returns
- _number_
```

--------------------------------

### ClipProjectItem Instance Methods

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/clipprojectitem

Instance methods available for ClipProjectItem objects.

```APIDOC
## ClipProjectItem Instance Methods

### attachProxy

- **Description**: Attach proxy or high resolution footage to projectItem and returns true if successful. Not undoable.
- **Min Version**: 25.0
- **Returns**: boolean

#### Parameters

- **mediaPath** (_string_): -
- **isHiRes** (_boolean_): -
- **inMakeAlternateLinkInTeamProjects** (_boolean_): -
```

```APIDOC
### canChangeMediaPath

- **Description**: Returns true if Premiere Pro can change the path associated with this project item; otherwise, returns false.
- **Min Version**: 25.0
- **Returns**: boolean
```

```APIDOC
### canProxy

- **Description**: Indicates whether it is possible to attach a proxy to this project item.
- **Min Version**: 25.0
- **Returns**: boolean
```

```APIDOC
### changeMediaFilePath

- **Description**: Change media file path of projectItem and returns true if successful. Not undoable.
- **Min Version**: 25.0
- **Returns**: boolean

#### Parameters

- **newPath** (_string_): -
- **overrideCompatibilityCheck** (_boolean_): -
```

```APIDOC
### createClearInOutPointsAction

- **Description**: Create Clear the in or out point of the Project item action.
- **Min Version**: 25.0
- **Returns**: Action
```

```APIDOC
### createSetColorLabelAction

- **Description**: Create an action for set color label to projectItem by index.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **inColorLabelIndex** (_number_): -
```

```APIDOC
### createSetFootageInterpretationAction

- **Description**: Set the footage interpretation object for project item.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **footageInterpretation** (_FootageInterpretation_): -
```

```APIDOC
### createSetInOutPointsAction

- **Description**: Set the in or out point of the Project item.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **inPoint** (_TickTime_): -
- **outPoint** (_TickTime_): -
```

```APIDOC
### createSetInPointAction

- **Description**: Returns an action which Sets the in point of the Project item.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **tickTime** (_TickTime_): -
```

```APIDOC
### createSetInputLUTIDAction

- **Description**: Create action for setting Guid of Input LUT on media. This applies for Video Clips only.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **stringLUTID** (_string_): -
```

```APIDOC
### createSetNameAction

- **Description**: Returns action that renames projectItem.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **inName** (_string_): -
```

```APIDOC
### createSetOfflineAction

- **Description**: Returns an action which sets the media offline.
- **Min Version**: 25.0
- **Returns**: Action
```

```APIDOC
### createSetOutPointAction

- **Description**: Returns an action which Sets the out point of the Project item.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **tickTime** (_TickTime_): -
```

```APIDOC
### createSetOverrideFrameRateAction

- **Description**: Returns an action which sets the override frame rate.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **inOverriddenFrameRateValue** (_number_): -
```

```APIDOC
### createSetOverridePixelAspectRatioAction

- **Description**: Returns an action which sets Override pixel aspect ratio.
- **Min Version**: 25.0
- **Returns**: Action

#### Parameters

- **inNumerator** (_number_): -
- **inDenominator** (_number_): -
```

```APIDOC
### createSetScaleToFrameSizeAction

- **Description**: Returns an action which sets the scale to frame to true.
- **Min Version**: 25.0
- **Returns**: Action
```

```APIDOC
### findItemsMatchingMediaPath

- **Description**: Returns array of project's items with media paths containing match string.
- **Min Version**: 25.0
- **Returns**: ProjectItem[]

#### Parameters

- **matchString** (_string_): -
- **ignoreSubclips** (_boolean_): -
```

```APIDOC
### getColorLabelIndex

- **Description**: Get color label index of projectItem.
- **Min Version**: 25.0
- **Returns**: number
```

```APIDOC
### getComponentChain

- **Description**: Gets the component chain associated with this project item.
- **Min Version**: 25.0
- **Returns**: string

#### Parameters

- **mediaType** (_Constants.MediaType_): Media type can be audio, video or data/caption
```

```APIDOC
### getContentType

- **Description**: Get content type of the Project item.
- **Min Version**: 25.0
- **Returns**: Constants.ContentType
```

```APIDOC
### getEmbeddedLUTID

- **Description**: Get GUID of LUT embedded in media.
- **Min Version**: 25.0
- **Returns**: string
```

```APIDOC
### getFootageInterpretation

- **Description**: Get the footage interpretation object for project item.
- **Min Version**: 25.0
- **Returns**: FootageInterpretation
```

```APIDOC
### getInPoint

- **Description**: Get the in point of the Project item.
- **Min Version**: 25.0
- **Returns**: TickTime

#### Parameters

- **mediaType** (_Constants.MediaType_): Media type can be audio, video or data/caption
```

```APIDOC
### getInputLUTID

- **Description**: Get Guid of Input LUT overridden on media.
- **Min Version**: 25.0
- **Returns**: string
```

```APIDOC
### getMedia

- **Description**: Return media associated with clipProjectItem.
- **Min Version**: 25.0
- **Returns**: Media
```

```APIDOC
### getMediaFilePath

- **Description**: Get the media file path of the Project item.
- **Min Version**: 25.0
- **Returns**: string
```

```APIDOC
### getOriginatingProjectPath

- **Description**: Return originating project path associated with clipProjectItem.
- **Min Version**: 25.0
- **Returns**: string
```

```APIDOC
### getOutPoint

- **Description**: Get the out point of the Project item.
- **Min Version**: 25.0
- **Returns**: TickTime
```

--------------------------------

### Import Premiere API

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference

This line allows access to the Premiere DOM via UXP. It should be included at the beginning of your script.

```javascript
const app = require('premierepro');
```

--------------------------------

### getSequenceVideoTimeDisplayFormat

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the video time display format of the sequence.

```APIDOC
## getSequenceVideoTimeDisplayFormat

### Description
Get video time display format of this sequence

### Returns
- _TimeDisplay_
```

--------------------------------

### FolderItem.createBinAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/folderitem

Returns an action that lets users create a new bin.

```APIDOC
## FolderItem.createBinAction

### Description
Returns an action that lets users create a new bin.

### Parameters
- **name** (string) - Description: -
- **makeUnique** (boolean) - Description: -
```

--------------------------------

### getCaptionTrackCount

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the total number of caption tracks in the sequence.

```APIDOC
## getCaptionTrackCount

### Description
Get caption track count from this sequence

### Returns
- _number_
```

--------------------------------

### createAddVideoTransitionAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/videocliptrackitem

Creates an action to add a video transition to a sequence. Requires a TransitionFactory and optional transition options.

```APIDOC
## createAddVideoTransitionAction

### Description
Create add transition action for sequence

### Parameters
#### Parameters
- **videoTransition** (_TransitionFactory_) - The transition to apply, obtained from `TransitionFactory`.
- **addTransitionOptionsProperties** (_AddTransitionOptions_) - Optional parameters for adding the transition.
```

--------------------------------

### createAppendComponentAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocomponentchain

Creates and returns an action to append an audio component to the chain.

```APIDOC
## createAppendComponentAction

### Description
Creates and returns an append component action.

### Parameters
#### component
- **component** (_Component_ or _AudioFilterComponent_) - Required - Audio filter component to append.
```

--------------------------------

### ProjectItem Static Methods

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/projectitem

Static methods available on the ProjectItem class.

```APIDOC
## ProjectItem Static Methods

### cast

- **Min Version**: 25.0
- **Returns**: _ProjectItem_
- **Description**: Cast FolderItem or ClipProjectItem into ProjectItem.

#### Parameters

- **item** (_FolderItem_ or _ClipProjectItem_) - Description: -
```

--------------------------------

### getValueAtTime

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/componentparam

Gets the value of the component parameter at a specified time.

```APIDOC
## getValueAtTime

### Description
Gets the value of the component Param at the given time.

### Parameters
#### Parameters
- **time** (TickTime) - The time at which to get the value of the component param.

### Returns
- **number | string | boolean | PointF | Color**: The value of the component parameter at the specified time.

### Min Version
25.0
```

--------------------------------

### getComponentChain

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocliptrackitem

Returns AudioComponentChain.

```APIDOC
## getComponentChain

### Description
Returns AudioComponentChain.

### Returns
_AudioComponentChain_
```

--------------------------------

### Get Frame Rate

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the frame rate of the footage.

```APIDOC
## getFrameRate

### Description
Get frame rate of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _number_: The frame rate.
```

--------------------------------

### Get Field Type

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the field type of the footage.

```APIDOC
## getFieldType

### Description
Get field type of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _number_: The field type.
```

--------------------------------

### setIsAppBeingPreparedToQuit

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/closeprojectoptions

Sets whether the application should be prepared to quit when opening or closing a project.

```APIDOC
## Instance Methods

### setIsAppBeingPreparedToQuit
- **Min Version**: 25.0
- **Description**: Set whether the app should be prepared to quit when open/closing a project.
- **Parameters**:
  - **isAppBeingPreparedToQuit** (boolean) - Description: -
```

--------------------------------

### getIngestSettings

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/projectsettings

Retrieves the current ingest settings for the project.

```APIDOC
## getIngestSettings

### Description
Returns project ingest settings.

### Parameters
#### Path Parameters
- **project** (_Project_) - Description: -
```

--------------------------------

### getParamCount

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/component

Gets the total number of parameters available for the component.

```APIDOC
## getParamCount

### Description
Gets the number of parameters in the component.

### Returns
- `number`: The total count of parameters for the component.
```

--------------------------------

### createAppendComponentAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/videocomponentchain

Creates and returns an action to append a video component to the chain.

```APIDOC
## createAppendComponentAction

### Description
Creates and returns an append component action.

### Parameters
#### Parameters
- **component** (_Component_ or _VideoFilterComponent_) - Description: Video filter component
```

--------------------------------

### createInsertComponentAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocomponentchain

Creates and returns an action to insert an audio component at a specific index in the chain.

```APIDOC
## createInsertComponentAction

### Description
Creates and returns an insert component action.

### Parameters
#### component
- **component** (_Component_ or _AudioFilterComponent_) - Required - Audio filter component to insert.
#### componentInsertionIndex
- **componentInsertionIndex** (_number_) - Required - Index at which the component shall be inserted.
```

--------------------------------

### getXMPMetadata

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/metadata

Retrieves project XMP metadata.

```APIDOC
## getXMPMetadata

### Description
Get project XMP metadata.

### Parameters
#### Path Parameters
- **projectItem** (ProjectItem) - Required - Description for projectItem
```

--------------------------------

### Application Version

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/application

Retrieve the version string of the running Premiere Pro application.

```APIDOC
## GET /application/version

### Description
Gets the version string of the running Premiere Pro application.

### Method
GET

### Endpoint
/application/version

### Parameters
None

### Response
#### Success Response (200)
- **version** (string) - The version string of the running Premiere Pro application.

### Response Example
{
  "version": "25.0"
}
```

--------------------------------

### getComponentCount

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/videocomponentchain

Gets the total number of components currently in the component chain.

```APIDOC
## getComponentCount

### Description
Gets the number of components in the component chain.

### Returns
- _number_ - The count of components.
```

--------------------------------

### FolderItem.createSmartBinAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/folderitem

Creates a smart bin with the given name and returns the Folder object.

```APIDOC
## FolderItem.createSmartBinAction

### Description
Creates a smart bin with given name and returns the Folder object

### Parameters
- **name** (string) - Description: -
- **searchQuery** (string) - Description: -
```

--------------------------------

### getPlayerPosition

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Gets the player's current position within the sequence.

```APIDOC
## getPlayerPosition

### Description
Get the player's current position

### Returns
- _TickTime_
```

--------------------------------

### createInsertComponentAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/videocomponentchain

Creates and returns an action to insert a video component at a specific index in the chain.

```APIDOC
## createInsertComponentAction

### Description
Creates and returns an insert component action.

### Parameters
#### Parameters
- **component** (_Component_ or _VideoFilterComponent_) - Description: Video filter component
- **componentInsertionIndex** (_number_) - Description: Index which the component shall be inserted
```

--------------------------------

### Get Invert Alpha

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves whether the alpha channel is inverted.

```APIDOC
## getInvertAlpha

### Description
Get invert alpha property of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _boolean_: True if alpha is inverted, false otherwise.
```

--------------------------------

### Accessing Premiere Pro Objects

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference

This snippet demonstrates how to access the Premiere Pro DOM using the 'premierepro' module and retrieve the active project and sequence.

```APIDOC
## Accessing Premiere Pro Objects

### Description
This section shows how to import the 'premierepro' module and use it to get the currently active project and sequence.

### Usage

1. **Import the module:**
   ```javascript
   const app = require('premierepro');
   ```

2. **Get the active project:**
   ```javascript
   const project = await app.Project.getActiveProject();
   ```

3. **Get the active sequence from the project:**
   ```javascript
   const sequence = await project.getActiveSequence();
   ```

### Notes
- All UXP method calls are asynchronous and do not block the UI thread.
- Property access (get and set) is synchronous.
```

--------------------------------

### Get Ignore Alpha

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves whether the alpha channel should be ignored.

```APIDOC
## getIgnoreAlpha

### Description
Get ignore alpha property of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _boolean_: True if alpha should be ignored, false otherwise.
```

--------------------------------

### CaptionTrack Instance Methods

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/captiontrack

Instance methods available on a CaptionTrack object.

```APIDOC
## CaptionTrack Instance Methods

### getIndex
- **Min Version**: 25.0
- **Returns**: number
- **Description**: Index representing the track index of this track within the track group.

### getMediaType
- **Min Version**: 25.0
- **Returns**: Guid
- **Description**: UUID representing the underlying media type of this track.

### getTrackItems
- **Min Version**: 25.0
- **Returns**: Array
- **Description**: Returns the track items of the specified media type from the given track.
  #### Parameters
  - **trackItemType** (number) - Description: -
  - **includeEmptyTrackItems** (boolean) - Description: -

### isMuted
- **Min Version**: 25.0
- **Returns**: boolean
- **Description**: Get mute state of the track.

### setMute
- **Min Version**: 25.0
- **Description**: Sets the mute state of the track to muted/unmuted.
  #### Parameters
  - **mute** (boolean) - Description: -
```

--------------------------------

### createCloneAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Creates an action to clone the given sequence.

```APIDOC
## createCloneAction

### Description
Creates an action to clone the given sequence.

### Returns
- _Action_
```

--------------------------------

### setPromptIfDirty

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/closeprojectoptions

Sets whether to display a prompt if a project is dirty when opening or closing it.

```APIDOC
## Instance Methods

### setPromptIfDirty
- **Min Version**: 25.0
- **Description**: Set whether to prompt if a project is dirty on project open/close.
- **Parameters**:
  - **promptIfDirty** (boolean) - Description: -
```

--------------------------------

### Get Remove Pull Down

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves whether pull down removal is enabled for the footage.

```APIDOC
## getRemovePullDown

### Description
Get removePullDown property of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _boolean_: True if pull down removal is enabled, false otherwise.
```

--------------------------------

### setPreviewFileFormat

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequencesettings

Sets the preview file format for the sequence.

```APIDOC
## setPreviewFileFormat

### Description
Set preview file format of sequence.

### Method
POST

### Endpoint
/sequence/settings/previewFileFormat

### Parameters
#### Request Body
- **inPreviewCodec** (_string_) - Required - The desired preview file format.
```

--------------------------------

### Get Pixel Aspect Ratio

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the pixel aspect ratio of the footage.

```APIDOC
## getPixelAspectRatio

### Description
Get pixel aspect ratio of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _number_: The pixel aspect ratio.
```

--------------------------------

### getPreviewFileFormat

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequencesettings

Retrieves the preview file format configured for the sequence.

```APIDOC
## getPreviewFileFormat

### Description
Get preview file format of sequence.

### Returns
- _string_ - The preview file format of the sequence.
```

--------------------------------

### SequenceEditor.createInsertProjectItemAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequenceeditor

Creates an action to insert a ProjectItem into a sequence at a specified time and track index. New tracks can be created if the index exceeds existing tracks.

```APIDOC
## SequenceEditor.createInsertProjectItemAction

### Description
Create insert ProjectItem into Sequence Action. Note: If you pass a track index greater than the number of existing tracks, a new track will be created.

### Parameters
#### Path Parameters
- **projectItem** (_ProjectItem_) - Description: -
- **time** (_TickTime_) - Description: -
- **videoTrackIndex** (_Number_) - Description: -
- **audioTrackIndex** (_Number_) - Description: -
- **limitShift** (_Boolean_) - Description: -

### Returns
- _Action_ - The created action for inserting a project item.
```

--------------------------------

### Get Input LUT ID

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the input LUT ID of the footage.

```APIDOC
## getInputLUTID

### Description
Get input LUTID of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _string_: The input LUT ID.
```

--------------------------------

### Get Alpha Usage

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the alpha channel usage type for the footage.

```APIDOC
## getAlphaUsage

### Description
Get alpha usage type property of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _number_: The alpha usage type.
```

--------------------------------

### createSetInPointAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sequence

Creates an action to set the in-point for the sequence.

```APIDOC
## createSetInPointAction

### Description
Create SetInPointAction for sequence

### Parameters
- **tickTime** (_TickTime_) - Description: -

### Returns
- _Action_
```

--------------------------------

### Core Object

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/events

The `core` object provides access to lower-level APIs that allow for direct interfacing with the Premiere Pro user interface and user interactions.

```APIDOC
## Core APIs

### core

• **core** : _typeof premiereproCore_

The set of lower level APIs for directly interfacing with Premiere UI and user.
```

--------------------------------

### Color Properties

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/color

Properties of the Color class to get and set color values.

```APIDOC
## Color Properties

### red

- **Type**: _number_
- **Access**: W (Read/Write)
- **Min Version**: 25.0
- **Description**: Read/Write property to get/set red value of color object.

### green

- **Type**: _number_
- **Access**: W (Read/Write)
- **Min Version**: 25.0
- **Description**: Read/Write property to get/set green value of color object.

### blue

- **Type**: _number_
- **Access**: W (Read/Write)
- **Min Version**: 25.0
- **Description**: Read/Write property to get/set blue value of color object.

### alpha

- **Type**: _number_
- **Access**: W (Read/Write)
- **Min Version**: 25.0
- **Description**: Read/Write property to get/set alpha value of color object.
```

--------------------------------

### createSetEndAction

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocliptrackitem

Create set end time action for sequence.

```APIDOC
## createSetEndAction

### Description
Create set end time action for sequence.

### Parameters
#### Path Parameters
- **tickTime** (TickTime) - Description: -

### Returns
_Action_
```

--------------------------------

### getDuration

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/audiocliptrackitem

Returns timecode representing the duration of this track item relative to the sequence start.

```APIDOC
## getDuration

### Description
Returns timecode representing the duration of this track item relative to the sequence start.

### Returns
_TickTime_
```

--------------------------------

### premierepro

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes

The root of the API, accessed via require("premierepro"). It exposes properties like 'constants' and 'core'.

```APIDOC
## Object: premierepro

### Description
The root object for the Premiere Pro UXP API. It is accessed by calling `require("premierepro")`.

### Properties

*   **constants** (`Constants`): Provides access to various constants and enumerations used within the DOM APIs.
*   **core** (`typeof premiereproCore`): Offers a set of lower-level APIs for direct interaction with the Premiere Pro UI and user functionalities.
```

--------------------------------

### Get Active Sequence

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference

Retrieve the active sequence from the current project. This is an asynchronous operation.

```javascript
const sequence = await project.getActiveSequence();
```

--------------------------------

### Get VR Vertical View

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the VR vertical view setting of the footage.

```APIDOC
## getVrVertView

### Description
Get vr vertical view of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _number_: The VR vertical view setting.
```

--------------------------------

### ClipProjectItem Static Methods

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/clipprojectitem

Static methods available for the ClipProjectItem class.

```APIDOC
## ClipProjectItem Static Methods

### cast

- **Description**: Cast ProjectItem in to ClipProjectItem.
- **Min Version**: 25.0

#### Parameters

- **projectItem** (_ProjectItem_): - 
```

--------------------------------

### setScratchDiskPath

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/scratchdisksettings

Sets the project's scratch disk path. Returns a boolean indicating success.

```APIDOC
## setScratchDiskPath

### Description
Sets project ScratchDisk Path.

### Method
POST or PUT (or equivalent SDK method call)

### Parameters
#### Path Parameters
- **ScratchDiskType** (Constants.ScratchDiskFolderType) - Required - The type of scratch disk folder to set.
- **ScratchDiskValue** (Constants.ScratchDiskFolder) - Required - The desired path for the scratch disk folder.

### Response
#### Success Response (200)
- **boolean** - True if the scratch disk path was set successfully, false otherwise.
```

--------------------------------

### Get VR Horizontal View

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/footageinterpretation

Retrieves the VR horizontal view setting of the footage.

```APIDOC
## getVrHorzView

### Description
Get vr horizontal view of footage.

### Method
GET (assumed, as it's a getter)

### Endpoint
Not specified, typically called on a footage object instance.

### Returns
- _number_: The VR horizontal view setting.
```

--------------------------------

### play

Source: https://developer.adobe.com/premiere-pro/uxp/ppro_reference/classes/sourcemonitor

Plays the clip currently in the Source Monitor at a specified playback speed.

```APIDOC
## play

### Description
Plays the clip at the Source Monitor with the input speed.

### Parameters
#### Path Parameters
- **speed** (_number_) - Description: The playback speed.
```