CavPlayerInput.CavPlayerInput Class Reference

Cav file input properties for Script Engine. Read the documentation for more info.

Properties

MediaPlayerState MediaPlayerState [get]
 Playback state.
 
Command PlayCommand [get]
 Start playback.
 
Command RewindCommand [get]
 Rewind to start.
 
Command PauseCommand [get]
 Pause playback.
 
Command StopCommand [get]
 Stop playback.
 
Command NextCuePointCommand [get]
 Jumps to the next cue point in the CAV file.
 
Command PreviousCuePointCommand [get]
 Jumps to the previous cue point (Note: not to the recently passed cue point)
 
Command NextFrameCommand [get]
 Step one frame forward (Playback needs to be paused)
 
Command PreviousFrameCommand [get]
 Step one frame backward (Playback needs to be paused)
 
PlayBackEndCondition PlayBackEndCondition [get, set]
 Action to perform at the end of file.
 
bool AutoPlay [get, set]
 Start playing when loaded.
 
Dictionary< string, object >? CuePointsTrackInfo [get, set]
 Cue points info.
 
int JumpToCuePointIndex [get, set]
 Cue point index to jump to.
 
string JumpToCuePointName [get, set]
 Cue point name to jump to.
 
Command JumpToIndexedCuePointCommand [get]
 Jump to cue point index specified in JumpToCuePointIndex.
 
Command JumpToNamedCuePointCommand [get]
 Jump to cue point name specified in JumpToCuePointName.
 
CuePointBehaviour CuePointBehaviour [get, set]
 Action taken when playback reaches a cue point.
 
CavCuePoint? PassedCuePoint [get]
 Most recent passed cue point.
 
int Width [get, protected set]
 Width.
 
int Height [get, protected set]
 Height.
 
Dictionary< string, object >? VideoTrackInfo [get, set]
 Detailed debug information on video track properties.
 
Dictionary< string, object >? AudioTrackInfo [get, set]
 Detailed debug information on audio track properties.
 
FormattedMessage MiniLog [get]
 Info message.
 
int CurrentFrame [get]
 Current playback frames.
 
TimeCode CurrentTime [get]
 Current playback time (Time code) in hours:minutes:seconds:frames.
 
- Properties inherited from VindralEngineBaseTypes.VindralBaseClasses.AbstractInput
float StereoGainDb [get, set]
 Gain (db)
 
float StereoGain [get]
 Gain (Stereo) multiplier.
 
float Pan [get, set]
 Pan audio left or right. [min = -100, max = 100].
 
float Send1Gain [get, set]
 Audio level sent to the auxiliary bus Send 1. [min = -100, max = 100].
 
AudioMixerPrePost Send1PrePost [get, set]
 Defines whether the signal sent to Send 1 is taken before or after Send 1 Gain.
 
bool Mute [get, set]
 Mute audio.
 
bool Solo [get, set]
 Isolate the audio signal by muting all other sources. Only audible when Audio Preview in Composer is active.
 
bool PFL [get, set]
 Routes the signal to monitoring outputs before the gain is applied. Only audible when Audio Preview in Composer is active.
 
bool HideInAudioMixer [get, set]
 Hides and removes the input from the Audio Mixer view in the Composer GUI without disabling its audio.
 
AudioStereoRemap StereoRemap [get, set]
 Audio channel reassignment for the stereo output.
 
AudioRemap AudioRemapLeft1 [get, set]
 Remap Left 1 to another audio channel.
 
AudioRemap AudioRemapRight1 [get, set]
 Remap Right 1 to another audio channel.
 
AudioRemap AudioRemapLeft2 [get, set]
 Remap Left 2 to another audio channel.
 
AudioRemap AudioRemapRight2 [get, set]
 Remap Right 2 to another audio channel.
 
AudioRemap AudioRemapLeft3 [get, set]
 Remap Left 3 to another audio channel.
 
AudioRemap AudioRemapRight3 [get, set]
 Remap Right 3 to another audio channel.
 
AudioRemap AudioRemapLeft4 [get, set]
 Remap Left 4 to another audio channel.
 
AudioRemap AudioRemapRight4 [get, set]
 Remap Right 4 to another audio channel.
 
string Tag [get, set]
 Tag input with a name. Tags can be used with Smart Search to search for tags.
 
int Width [get, protected set]
 Input source width.
 
int Height [get, protected set]
 Input source height.