Skip to content

Commit c857e94

Browse files
committed
Augment and extend TypeScript definitions
Lots of disambiguation.
1 parent 19f8c6b commit c857e94

File tree

1 file changed

+52
-6
lines changed

1 file changed

+52
-6
lines changed

PProPanel/jsx/PremierePro.15.0.d.ts

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,15 @@ declare class SequenceSettings {
9393
workingColorSpace: String
9494
}
9595

96+
/**
97+
* Structure describing audio channel mapping for a projectItem.
98+
*/
99+
declare class AudioChannelMapping {
100+
audioClipsNumber: number
101+
audioChannelsType: number
102+
setMappingForChannel(number:channelIndex, number:sourceChannelIndex): function
103+
}
104+
96105
/**
97106
* A sequence.
98107
*/
@@ -666,7 +675,6 @@ declare class ProjectManager {
666675
isProductionOpen(): boolean
667676

668677
/**
669-
* Inserts a clip (`trackItem`) into the sequence.
670678
* @returns An array of open productions (), or null if no productions are open.
671679
*/
672680
listProductions(): RemoteProductionCollection
@@ -898,9 +906,10 @@ declare class ProjectManager {
898906
bind(eventName: string, function_: any): void
899907

900908
/**
901-
*
909+
* @param saveBeforeClosing: boolean, indicating whether to save the project before closing
910+
* @param promptUserIfDirty: boolean, indicating whether to prompt the user to save before closing
902911
*/
903-
closeDocument(): boolean
912+
closeDocument(saveBeforeClosing?: boolean, promptUserIfDirty?: boolean): boolean
904913

905914
/**
906915
*
@@ -1478,7 +1487,44 @@ declare class ProjectManager {
14781487
*
14791488
*/
14801489
isMergedClip(): boolean
1481-
1490+
1491+
/**
1492+
*
1493+
* @returns boolean indicating whether projectItem is offline.
1494+
*/
1495+
isOffline(): boolean
1496+
1497+
/**
1498+
*
1499+
* @returns a boolean indicating whether setting the projectItem offline was successful.
1500+
*/
1501+
setOffline(): boolean
1502+
1503+
/**
1504+
*
1505+
* @returns a footageInterpretation object, or null if none was available.
1506+
*/
1507+
getFootageInterpretation(): FootageInterpretation
1508+
1509+
/**
1510+
*
1511+
* @param FootageInterpretation object containing desired settings
1512+
* @returns a boolean indicating whether setting the interpretation was successful.
1513+
*/
1514+
setFootageInterpretation(FootageInterpretation): boolean
1515+
1516+
/**
1517+
*
1518+
* @returns an audio channel mapping object, or null if none was available.
1519+
*/
1520+
getAudioChannelMapping: AudioChannelMapping
1521+
1522+
/**
1523+
*
1524+
* @param AudioChannelMapping object describing desired audio channel mapping.
1525+
* @returns boolean indicating whether setting the audio channel mapping was successful.
1526+
*/
1527+
setAudioChannelMapping(mapping:AudioChannelMapping): boolean
14821528
/**
14831529
*
14841530
*/
@@ -1850,7 +1896,7 @@ declare class ProjectManager {
18501896
bind(eventName: string, function_: any): void
18511897

18521898
/**
1853-
*
1899+
* @param propertyKey Indicates which property to clear.
18541900
*/
18551901
clearProperty(propertyKey: string): void
18561902

@@ -2038,7 +2084,7 @@ declare class ProjectManager {
20382084

20392085
/**
20402086
* @param newValueForTranscodeOnIngest
2041-
* @returns the newly-set state for whether or not PPro transcodes files upon ingest.
2087+
* @returns Boolean indicating whether transcode on ingest is enabled.
20422088
*/
20432089
setEnableTranscodeOnIngest(newValueForTranscodeOnIngest: boolean)
20442090

0 commit comments

Comments
 (0)