Skip to content

Commit 1b3c4bb

Browse files
zlovattzlovatt
committed
Convert Sequence
1 parent 3ea1ae7 commit 1b3c4bb

File tree

4 files changed

+197
-212
lines changed

4 files changed

+197
-212
lines changed

‎docs/sequence/component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
#### Description
99

10-
The **component** object represents something which has been added or applied to a trackItem.
10+
The Component object represents something which has been added or applied to a trackItem.
1111

1212
---
1313

‎docs/sequence/componentparam.md

Lines changed: 60 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@
99

1010
The **component parameter** object represents a parameter associated with a component, applied to a [TrackItem object](../item/trackitem.md).
1111

12-
NOTE:
13-
For a developer working across different localizations, it's possible to find the corresponding keys by comparing ZStrings.
14-
Below is an example between En and De. Here are the paths to the files:
12+
!!! note
13+
For a developer working across different localizations, it's possible to find the corresponding keys by comparing ZStrings.
1514

16-
C:Program FilesAdobeAdobe Premiere Pro 2024Dictionariesde_DEzdictionary_PPRO_de_DE.dat ("…anti-Flimmer Filter")
17-
18-
C:Program FilesAdobeAdobe Premiere Pro 2024Dictionariesen_USzdictionary_PPRO_en_US.dat ("…anti-flicker Filter")
15+
Below is an example between En and De. Here are the paths to the files:
16+
`C:\Program Files\Adobe\Adobe Premiere Pro 2024\Dictionaries\de_DE\zdictionary_PPRO_de_DE.dat` - ("…anti-Flimmer Filter")
17+
`C:\Program Files\Adobe\Adobe Premiere Pro 2024\Dictionaries\en_DE\zdictionary_PPRO_en_US.dat` - ("…anti-flicker Filter")
1918

2019
---
2120

@@ -53,9 +52,9 @@ Adds a keyframe to the component parameter stream, at the specified time. Note:
5352

5453
#### Parameters
5554

56-
| Argument | Type | Description |
57-
|------------|--------------------------------------|------------------------------------|
58-
| `time` | [Time object](../other/time.md) | When the keyframe should be added. |
55+
| Argument | Type | Description |
56+
| -------- | ------------------------------- | ---------------------------------- |
57+
| `time` | [Time object](../other/time.md) | When the keyframe should be added. |
5958

6059
#### Returns
6160

@@ -97,14 +96,14 @@ Sets whether the component parameter varies, over time. Note: This can only be s
9796

9897
#### Parameters
9998

100-
| Argument | Type | Description |
101-
|---------------|--------|---------------------------------------------------------|
102-
| `timeToCheck` | | Start search from a given time |
103-
| `threshold` | | A temporal distance, in either direction, in **ticks**. |
99+
| Argument | Type | Description |
100+
| ------------- | ------- | ------------------------------------------------------- |
101+
| `timeToCheck` | | Start search from a given time |
102+
| `threshold` | Integer | A temporal distance, in either direction, in **ticks**. |
104103

105104
#### Returns
106105

107-
Returns a **Time** value, indicating when the closest keyframe is.
106+
Returns a Time value, indicating when the closest keyframe is.
108107

109108
---
110109

@@ -121,13 +120,13 @@ Returns the keyframe temporally subsequent to the provided `timeToCheck`. Note:
121120

122121
#### Parameters
123122

124-
| Argument | Type | Description |
125-
|---------------|--------|---------------------------------|
126-
| `timeToCheck` | | Start search from a given time. |
123+
| Argument | Type | Description |
124+
| ------------- | ---- | ------------------------------- |
125+
| `timeToCheck` | | Start search from a given time. |
127126

128127
#### Returns
129128

130-
Returns a **Time** value, indicating when the closest keyframe is, or `0` if there is no available subsequent keyframe.
129+
Returns a Time value, indicating when the closest keyframe is, or `0` if there is no available subsequent keyframe.
131130

132131
---
133132

@@ -144,13 +143,13 @@ Returns the keyframe temporally previous to the provided `timeToCheck`. Note: Th
144143

145144
#### Parameters
146145

147-
| Argument | Type | Description |
148-
|---------------|--------|---------------------------------|
149-
| `timeToCheck` | | Start search from a given time. |
146+
| Argument | Type | Description |
147+
| ------------- | ---- | ------------------------------- |
148+
| `timeToCheck` | | Start search from a given time. |
150149

151150
#### Returns
152151

153-
Returns a **Time** value, indicating when the closest keyframe is, or `0` if there is no available previous keyframe.
152+
Returns a Time value, indicating when the closest keyframe is, or `0` if there is no available previous keyframe.
154153

155154
---
156155

@@ -171,7 +170,7 @@ None.
171170

172171
#### Returns
173172

174-
Returns a **Color** containing the values found in the component parameter stream, or `0` if unsuccessful.
173+
Returns a Color containing the values found in the component parameter stream, or `0` if unsuccessful.
175174

176175
---
177176

@@ -192,7 +191,7 @@ None.
192191

193192
#### Returns
194193

195-
Returns an **Array** of **Time** values, indicating at what time each keyframe occurs, or `0` if no keyframes are available.
194+
Returns an array of Time values, indicating at what time each keyframe occurs, or `0` if no keyframes are available.
196195

197196
---
198197

@@ -230,9 +229,9 @@ Retrieves the value of the component parameter stream, at the specified keyframe
230229

231230
#### Parameters
232231

233-
| Argument | Type | Description |
234-
|------------|--------------------------------------|-----------------------------------------------------------|
235-
| `time` | [Time object](../other/time.md) | A time from which the keyframe value should be retrieved. |
232+
| Argument | Type | Description |
233+
| -------- | ------------------------------- | --------------------------------------------------------- |
234+
| `time` | [Time object](../other/time.md) | A time from which the keyframe value should be retrieved. |
236235

237236
#### Returns
238237

@@ -253,9 +252,9 @@ Retrieves the value of the component parameter stream, at the specified time. If
253252

254253
#### Parameters
255254

256-
| Argument | Type | Description |
257-
|------------|--------------------------------------|-----------------------------------------------------------|
258-
| `time` | [Time object](../other/time.md) | A time from which the keyframe value should be retrieved. |
255+
| Argument | Type | Description |
256+
| -------- | ------------------------------- | --------------------------------------------------------- |
257+
| `time` | [Time object](../other/time.md) | A time from which the keyframe value should be retrieved. |
259258

260259
#### Returns
261260

@@ -297,9 +296,9 @@ Removes a keyframe on the component parameter stream, at the specified time. Not
297296

298297
#### Parameters
299298

300-
| Argument | Type | Description |
301-
|------------|--------------------------------------|---------------------------------------------------------------|
302-
| `time` | [Time object](../other/time.md) | A time value, indicating when the keyframe should be removed. |
299+
| Argument | Type | Description |
300+
| -------- | ------------------------------- | ------------------------------------------------------------- |
301+
| `time` | [Time object](../other/time.md) | A time value, indicating when the keyframe should be removed. |
303302

304303
#### Returns
305304

@@ -320,10 +319,10 @@ Removes all keyframes from the component parameter stream, between the specified
320319

321320
#### Parameters
322321

323-
| Argument | Type | Description |
324-
|-------------|--------------------------------------|--------------------------------------------------------------|
325-
| `startTime` | [Time object](../other/time.md) | At what times (inclusive) to begin the removal of keyframes. |
326-
| `endTime` | [Time object](../other/time.md) | at what times to end the removal of keyframes. |
322+
| Argument | Type | Description |
323+
| ----------- | ------------------------------- | -------------------------------------------------------- |
324+
| `startTime` | [Time object](../other/time.md) | The times (inclusive) to begin the removal of keyframes. |
325+
| `endTime` | [Time object](../other/time.md) | The times to end the removal of keyframes. |
327326

328327
#### Returns
329328

@@ -344,13 +343,13 @@ Sets the values within a component parameter stream, representing a Color.
344343

345344
#### Parameters
346345

347-
| Argument | Type | Description |
348-
|------------|-----------|------------------------------------------------------------|
349-
| `alpha` | Integer | Alpha value. |
350-
| `red` | Integer | Red value. |
351-
| `green` | Integer | Green value. |
352-
| `blue` | Integer | Blue value. |
353-
| `updateUI` | Integer | Force to update UI after updating the value of the stream. |
346+
| Argument | Type | Description |
347+
| ---------- | ------- | ------------------------------------------------------------------------------------- |
348+
| `alpha` | Integer | Alpha value. |
349+
| `red` | Integer | Red value. |
350+
| `green` | Integer | Green value. |
351+
| `blue` | Integer | Blue value. |
352+
| `updateUI` | Integer | If `1`, will force Premiere Pro to update UI, after updating the value of the stream. |
354353

355354
#### Returns
356355

@@ -360,9 +359,9 @@ Returns `0` if successful.
360359

361360
### ComponentParam.setInterpolationTypeAtKey()
362361

363-
`app.project.sequences[index].audioTracks[index].clips[index].components[index].properties[index].setInterpolationTypeAtKey(time, interpretationType)`
362+
`app.project.sequences[index].audioTracks[index].clips[index].components[index].properties[index].setInterpolationTypeAtKey(time, interpretationType, [updateUI])`
364363
<br/>
365-
`app.project.sequences[index].videoTracks[index].clips[index].components[index].properties[index].setInterpolationTypeAtKey(time, interpretationType)`
364+
`app.project.sequences[index].videoTracks[index].clips[index].components[index].properties[index].setInterpolationTypeAtKey(time, interpretationType, [updateUI])`
366365
<br/>
367366

368367
#### Description
@@ -371,11 +370,11 @@ Specifies the interpolation type to be assigned to the keyframe, at the specifie
371370

372371
#### Parameters
373372

374-
| Argument | Type | Description |
375-
|---------------------|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
376-
| `time` | [Time object](../other/time.md) | A time of keyframe to modify. |
377-
| `interpolationType` | `type` | Must be one of the following:<br/><br/>- `0` - `KF_Interp_Mode_Linear`<br/>- `1` - `kfInterpMode_EaseIn_Obsolete`<br/>- `2` - `kfInterpMode_EaseOut_Obsolete`<br/>- `3` - `kfInterpMode_EaseInEaseOut_Obsolete`<br/>- `4` - `KF_Interp_Mode_Hold`<br/>- `5` - `KF_Interp_Mode_Bezier`<br/>- `6` - `KF_Interp_Mode_Time`<br/>- `7` - `kfInterpMode_TimeTransitionStart`<br/>- `8` - `kfInterpMode_TimeTransitionEnd` |
378-
| `updateUI` | Boolean | Whether to update UI afterward. |
373+
| Argument | Type | Description |
374+
| ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
375+
| `time` | [Time object](../other/time.md) | A time of keyframe to modify. |
376+
| `interpolationType` | `type` | One of:<ul><li>`0` - `KF_Interp_Mode_Linear`</li><li>`1` - `kfInterpMode_EaseIn_Obsolete`</li><li>`2` - `kfInterpMode_EaseOut_Obsolete`</li><li>`3` - `kfInterpMode_EaseInEaseOut_Obsolete`</li><li>`4` - `KF_Interp_Mode_Hold`</li><li>`5` - `KF_Interp_Mode_Bezier`</li><li>`6` - `KF_Interp_Mode_Time`</li><li>`7` - `kfInterpMode_TimeTransitionStart`</li><li>`8` - `kfInterpMode_TimeTransitionEnd`</li></ul> |
377+
| `updateUI` | Boolean | Whether to update UI afterward. |
379378

380379
#### Returns
381380

@@ -396,9 +395,9 @@ Sets whether the component parameter varies, over time. Note: This can only be s
396395

397396
#### Parameters
398397

399-
| Argument | Type | Description |
400-
|------------|-----------|---------------------------------------------------------------------------|
401-
| `varying` | Boolean | If `true`, component parameter will vary over time; if `false`, it won't. |
398+
| Argument | Type | Description |
399+
| --------- | ------- | ------------------------------------------------------------------------- |
400+
| `varying` | Boolean | If `true`, component parameter will vary over time; if `false`, it won't. |
402401

403402
#### Returns
404403

@@ -419,9 +418,9 @@ Sets the value of the component parameter stream. Note: This can only work on pa
419418

420419
#### Parameters
421420

422-
| Argument | Type | Description |
423-
|------------|-----------|---------------------------------------------------------------------------------------|
424-
| `value` | | Must be of the appropriate type for the component parameter stream. |
421+
| Argument | Type | Description |
422+
| ---------- | ------- | ------------------------------------------------------------------------------------- |
423+
| `value` | | Must be of the appropriate type for the component parameter stream. |
425424
| `updateUI` | Integer | If `1`, will force Premiere Pro to update UI, after updating the value of the stream. |
426425

427426
#### Returns
@@ -443,11 +442,11 @@ Sets the value of the component parameter stream, at the specified keyframe time
443442

444443
#### Parameters
445444

446-
| Argument | Type | Description |
447-
|------------|--------------------------------------|---------------------------------------------------------------------------------------|
445+
| Argument | Type | Description |
446+
| ---------- | ------------------------------- | ------------------------------------------------------------------------------------- |
448447
| `time` | [Time object](../other/time.md) | A time at which the keyframe value should be set. |
449-
| `value` | | A value to be set. |
450-
| `updateUI` | Integer | If `1`, will force Premiere Pro to update UI, after updating the value of the stream. |
448+
| `value` | | A value to be set. |
449+
| `updateUI` | Integer | If `1`, will force Premiere Pro to update UI, after updating the value of the stream. |
451450

452451
#### Returns
453452

0 commit comments

Comments
 (0)