disguise developers

Designer Plugins

Plugins for Disguise Designer software.

VideoClip

Base class: Resource

Properties

Video_Input : LogicalVideoInDevice

Category: Versions

acesExposure : float

Input exposure transform (stops)

Category: Colour Shift
UserName: Input exposure

acesGamma : float

Input gamma transform

Category: Colour Shift
UserName: Input gamma

acesTransform : AcesInputTransformParameters

ACES Input transform (IDT)

Category: Colour Shift
UserName: Input transform

audioBiasSec : float

If multi-channel audio files are not synchronised correctly, adjust this value to delay (-ve) or advance (+ve) audio relative to video

Category: Audio
UserName: Audio bias (s)

audioOuts : AudioOutputs

set up the audio outputs used for each channel by creating a new AudioOut object, setting its outputs, and then sharing between all clips needing that configuration

Category: Audio
UserName: Audio outputs

audioTracks : List[AudioTrack]

Additional audio tracks will play synchronously with the video clip, to logical audio outputs 0, 1, 2, etc

Category: Audio
UserName: Audio tracks

bilinear_filtering : int

Set to ‘on’ if the video file should be bilinear filtered when scaled; otherwise, uses point-samping

Options: {0: ‘Off’, 1: ‘On’}
Category: Filtering
UserName: Bilinear filtering

bottom : int

Amount to crop from the bottom edge of the video frame, in pixels

Category: Cropping
UserName: Crop bottom

clip : Rect

clip_type : int

Controls how the video file is scaled to fit the canvas size

Options: {0: ‘Clip to canvas’, 1: ‘Fit into canvas’, 2: ‘Stretch to canvas’, 3: ‘Pixel-perfect’}
Category: Cropping
UserName: Clip type

colourProfile : ColourProfile

Colour/Gamma space of the video clip

Category: Colour Shift
UserName: Colour profile

colourShift : ColourShift

Colour parameters for video file

Category: Colour Shift
UserName: Colour shift

dataRate : float (Read-Only)

Data rate of the clip playback (MB/sec)

UserName: Data rate (MB/sec)

end : int

End frame index of the video clip. Use this to trim frames from the end of the clip

Category: Edit
UserName: Clip end

file : VideoAsset

Select video asset

Category: Versions
UserName: Video asset

fileFps : float (Read-Only)

FPS of the original video

UserName: Original FPS

fileFrameSize : Vec2 (Read-Only)

Resolution of the original video file (pixels)

UserName: Resolution

fileNFrames : int (Read-Only)

Number of frames in the original video file

UserName: Number of frames

fps : float

Current frames-per-second of the video clip

Category: Edit
UserName: FPS

frame_blending : int

Set to ‘on’ if the video file should be frame-blended for smoothness. Use this when playback frame-rate is different to original frame rate

Options: {0: ‘Off’, 1: ‘On’, 2: ‘Auto’}
Category: Filtering
UserName: Frame blending

in_ : int

Loop in-point of the video clip

Category: Edit
UserName: Loop in

isVideoIn : bool (Read-Only)

left : int

Amount to crop from the left edge of the video frame, in pixels

Category: Cropping
UserName: Crop left

logicalVideoIn : LogicalVideoInDevice (Read-Only)

nBeats : float

If quantised, the video file will play over this number of beats

Category: Quantisation
UserName: Beats

ocioShaderProperties : OcioShaderProperties

Available OCIO transform parameters for a given colour space.

Category: Colour Shift
UserName: OCIO transform properties

ocioTransform : OcioColourSpace

OCIO colour space of the clip

Category: Colour Shift
UserName: Input transform

out : int

Loop out-point of the video clip

Category: Edit
UserName: Loop out

prefetchOptions : PrefetchLookaheads

Advanced : edit these settings if the clip isn’t playing well. Usually only required for very large clips

Category: Prefetch
UserName: Prefetch options

quantised : int

If set to ‘yes’, the video file will play over a specified number of beats, rather than at defined frame rate

Options: {0: ‘No’, 1: ‘Yes’}
Category: Quantisation
UserName: Quantised

right : int

Amount to crop from the right edge of the video frame, in pixels

Category: Cropping
UserName: Crop right

sampleRateOption : int

Options: {0: ‘44.1’, 1: ‘48’}
Category: Versions

speed : float

Category: Versions
UserName: Speed

start : int

Start frame index of the video clip. Use this to trim frames from the start of the clip

Category: Edit
UserName: Clip start

top : int

Amount to crop from the top edge of the video frame, in pixels

Category: Cropping
UserName: Crop top

transportDuration : Timecode (Read-Only)

video_file : VideoAsset

Select video asset

Category: Versions
UserName: Video asset

zoom : Vec2

The point of interest zoomed in towards when the content is scaled

Category: Cropping
UserName: Zoom point

zoom_point : Vec2

Variables

consolidateAllClips : Callable

createVideoInClip : Callable