Avid Console Commands 4.0.5

[avidguy]

aafklv -- Enable KLV AAF export format.
aaflog -- Sets AAF Import logging. state may be "console", or "file", or "both"
add -- Add an expression to a variable.
AddDigIntCols -- <no description>
AddPE -- <no description>
admpassthru -- Enable/Disable OSX software audio passthru.
admpreload -- Set the ADM preload amount
admvsync -- Toggle ADM vsync synchronization
afeklv -- Enable KLV AFE export format.
AllDrives -- Allows all drives to act as media drives. (Type 'AllDrives -1' for help)
AllocateMem -- <no description>
AllocChecker -- Toggles the memory allocation tracking gear on/off
AllowCrossRateTranscode -- <no description>
AllowUNCWrite -- Allow writing to UNC paths. Persistent.

AMA_SetCachedBitRateLimit -- Sets maximum bit rate for cached AMA video material (set to 0 to disable)
answer -- Present a popup with 1-3 choices, and return the response
AROaddClient -- adds a machine name or IP address to the list of authorized clients for the Avid Remote Objects server
AROdebug -- enable or disable debugging statements in the Avid Remote Objects server
AROlog -- enable or disable logging traffic for the Avid Remote Objects server
AROremoveClient -- removes a machine name or IP address from the list of authorized clients for the Avid Remote Objects server
AROstart -- starts the Avid Remote Objects server
AROstatus -- display status for the Avid Remote Objects server
AROstop -- shuts down and unloads the Avid Remote Objects server
asserT -- Assert that a given condition is true or generate an exception.
AsyncResColumnDrawing -- <no description>
AtticInfo -- Toggles displaying attic related information to user
audiobuffertime -- Set Nitris audio playback buffer size in microseconds
audioextras -- Enable or disable extra audio features
AudioHWCalibration -- Displays and allows for setting the software side of Audio Hardware Calibration
audiopreread -- Set the audio preread amount in seconds
AudioRateMonVerbose -- Set AudioRateMonitor console logging
AvHLockDebugTogglE -- <no description>
aviddevicehwunderrun -- Enable/Disable HW Underrun detection.
aviddeviceinfo -- Get FireBOB Information from the hardware
avslog -- Routing of Video Slave logs to console or output
avstrc -- Delay Tracing and Override. Traces coincidence point and StartIO timings. Allows to override.
AVXRedrawRate -- Change the millisecond rate that background windows are refreshed
AVXSetupCleanup -- AVXSetupCleanup on/off
AVXToggleAltFrameOpt -- Toggles GetAlternateFrame UI Optimization
BinRescan -- Enable/Disable MSMRescan when opening shared bins.
BuildTrace -- <no description>
CacheBadLocators -- Enables/disables caching of bad network paths for batch import
ChangeProjType -- Change the project type
ChangeXDCAMReadFlags -- Changes the XDCAM read flags. Boolean UseDirectIO param specifies using DirectIO/BufferedIO. Integer PageSizeKb param specifies read sizes (only 64, 128, 256 are supported)
CheckCommands -- <no description>
CheckDecks -- Re-initializes serial communications with decks
checkmem -- <no description>
CheckMob -- Attempts to diagnose a broken mob.
CheckSequences -- Check sequences for errors
ChromaFilt411 -- Apply chroma filtering during DV25 title renders
ChromaHueReverse -- Reverses the Software Color Effect Chroma Hue rotation
CkPE -- <no description>
cleanupdatabases -- <no description>
ClearCachedLocators -- Clears cached locators found during batch import
ClearPE -- <no description>
ClearProtocolErrors -- Resets protocol error logs
CloseAllAVXPlugins -- Close down all AVX plug-ins
cmd_setImportSlideLength -- Sets the number of frames for subsequent imports of single frame graphics.
cmdDumpPrecomputes -- Display a list of precomputes for the current project
CoalesceMem -- <no description>
CodecBug -- toggle for possible codec bug, optional destination for dump file
CodecInfo -- Extract codecs info from Compression Manager and save in a header file
CodecLog -- Show codec error log.
dump - dump tail (most recent) portion of logs to the console (use Redir first to dump to file)
dumpall - dump all logs to the console (use Redir first to dump to file)
on - show the logs in the console as they come in
off - do not show the logs in the console as they come in
level - set the log level, higher level for more logs, must also specify level parameter

CompactMeM -- <no description>
ConcurrentLocators -- enables concurrent locators
Console -- Type 'Console help' for complete help.
consoleloG -- Turns Console logging on and off.
consolelogofF -- Turns Console logging off.
consoleWindow -- Get or set the size and position of the console window.
ConsolidateGroupsOnExport -- Toggles whether or not group clips are consolidated on export.
ConvertAVSMT -- <no description>
ConvertColorSpace -- When on, converts 709 HD to 601
CoreEvent -- Type 'CoreEvent help' for complete help.
CoreEventLogger -- Type 'CoreEventLogger help' for complete help.
CountThings -- Display count and list of all consumers/converters/producers in current pipes
DebugACFMemAllocation -- Toggle debugging info for the ACFMemAllocation interface
DebugMenu -- <no description>
DebugWin -- <no description>
DefaultImageStartAlignment -- Sets the default value of image start alignment
DesktopSampleOffset -- Set the sample offset to sync desktop audio and video
DeveloperDongleMode -- Enables or disables DeveloperDongle privileges
DigitalCutFrames -- <no description>
digitalCutPlayDelay -- Set the timeout value to wait before starting player when doing Digital Cut
DigitalCutPlayerCycles -- Set minimum player cycles for UI update.
Disable3D -- Disables 3DFX on subsequent launches
DisableSWDecode -- Disables SW Decode of specified resolutions...
disco -- <no description>
DisplayControllerTraffic -- Display controller messages to Composer
dms -- DMS Test
dmslog -- Toggles DMS logging on and off
dmsmonikers -- Toggles DMS moniker source from node to checkin
DoFtlAssert -- DoFtlAssert behavior.
DontWrite -- Enable/Disable DIDWriter
DPE -- <no description>
DPEX -- <no description>
DPEXM -- <no description>
dump -- Dump system state to console
DumpCacheDetails -- Dumps a SingleLevelWaveformCache's cache map details to a text file in the app startup folder
DumpClipSummary -- Dump a summary of clips found in the currently loaded sequence.
By default, all tracks in the sequence are checked, ignoring any In-Out marks.
DumpComponent -- Dumps a Component to the console.
DumpDrives -- Dumps internal drive list.
DumpEffectDepth -- DumpEffectDepth on/off
DumpFXLocation -- Dump a list of effects found in the currently loaded sequence with track and timecode location information.
By default, all tracks in the sequence are checked, ignoring any In-Out marks.
DumpFXSummary -- Dump a summary of effects found in the currently loaded sequence.
By default, all tracks in the sequence are checked, ignoring any In-Out marks.
dumpinputmixer -- Dump state of input mixer
DumpLocalVolumes -- Dumps LocalVolume list.
DumpMachineAttributes -- Displays template attributes for each machine
DumpMachineTemplates -- Displays deck templates read into system
DumpMaxPeaks -- Display Audio Meter Max Peaks
DumpMediaFilePaths -- Enables print of media file paths during creation of media files.
DumpMemInfo -- Write a dump file containing memory usage and heap information
dumpmetertimestats -- Dump stats on the meters
DumpMob -- Dumps a Mob to the console.
DumpOverrunInfo -- Dump error logs after overruns.
DumpPlayHistory -- <no description>
dumppmr -- dumppmr drive
drive is the refnum of the drive to be dumped
No drive means all mobs on all drives including well known mobs are to be dumped.
If drive is wkm, only the well known mobs are to be dumped.
If drive is mdirs, only media directories with their drives refnums are to be dumped

DumpProfileByTotal -- <no description>
DumpProtocolErrors -- Displays serial communications errors
DumpRecordMon -- Dumps to the console the composition in the Record Monitor.
DumpRenderGraph -- Enable the Player to dump Render Graph
DumpSlots -- Dumps to the console the pending memory alloc/lock (slots) list
DumpSourceMon -- Dumps to the console the composition in the Source Monitor.
DumpSourceSummary -- Dump a summary of sources found in the currently loaded sequence.
By default, all tracks in the sequence are checked, ignoring any In-Out marks.
DumpStartupTimeLog -- Dumps startup time log info - does not reset data
DumpVolumeGroups -- Dumps list of VolumeGroups.
DumpVolumes -- Dumps internal volume list.
DumpWaveformEngine -- Dump the WaveformCache state to a text file in the app startup folder
DynDialog -- Use "DynDialog help" for a list of possible dialogs
DynPane -- Use "DynPane help" for a list of possible views.
DynView -- Use "DynView help" for a list of possible views.
ebi -- <no description>
echo -- Enables or disables echoing script commands to the console.
EmbedDNXCC -- Toggles whether to embed closed captioning in DNX media.
EmbedDNXCCdefault -- Sets ancillary data slot defaults.
EmbedDNXCCOptions -- Sets the options for ancillary data in DNX media. (slot DID SDID on)
Enable3D -- Enables 3DFX on subsequent launches
EnableBinDialogue -- Toggles displaying Bin dialogue to user during Bin operations
enableHD -- Reset the firehose board and get out of the decoder hung state.
EnablePCEdit -- <no description>
EnableSWCC -- Enables software color correction
EnableSWDecode -- Enables SW Decode of specified resolutions...
EncodeAVCHD -- Enables AVC HD Encode
EncodeMPEG2IFrame -- Enables MPEG2 I Frame Encode
EncodeMPEG4 -- Enables MPEG4 Encode
eqt -- <no description>
exiT -- Exit a script.
Expect -- Assert that every line in a block will generate a given exception.
exportOMFI -- Export an OMFI composition.
FakeDeck -- Uses a 'virtual' deck for deck control
fatal -- Abort a script with an assertion 'fatal' error message.
fillmem -- <no description>
FixOMFIMobInSrcMon -- <no description>
FlushAllWaveformData -- Flushes all the waveform cache data
ForceCheckin -- Toggles forced full checkin on and off.
ForceHDTranscode -- Force Transcode of HD to SD when Digital Cutting HD material in a SD Project.
ForceImportResolve -- Forces all imported mobs to wn the mob resolution. Non-persistent.

ForceVideoUnderrun -- Forces video underruns. (Type: 'ForceVideoUnderrun -1' for full help.)
foreach -- Foreach statement using a comma separated list.
forEachBinMob -- Executes a command for each Mob.
forEachMob -- Executes a command for each Mob.
FrameRateMixMatch -- Enable/Disable support for frame rate mix & match.
FSP -- Full Screen Playback: 'FSP Help' for more info
FtlAssert -- FtlAssert behavior.
FulfillAll -- Fulfill all pending requests at once to make sure cache is full
FullQualFX -- Allows Full Quality Play with SWRTFX
GammaConform -- GammaConform toggle 8 bit color correction gamma control range between 16-235/0-255
GetClips -- Populate the specified bin with the clips from the specified path using AMA.

GetP2Clips -- Places all the master mobs located in rootPath if it's a media directory into targetBin.
If rootPath is "dlg", a directory selection dialog is presented.
Global -- Create a global variable.
GPP -- Display a graph of the player pipes (and, optionally, vdm devices) from the current player
GPPOptions -- Sets options for the GraphPlayerPipes/GPP commands. Type GPPOptions help for more information.
GraphPlayerPipes -- Display a graph of the player pipes from the current SF & RT players
GraphPlayerPipesRemote -- Dumps dotty description of player pipes (and, optionally, vdm devices) from the current player to remote console
HDTitleFilter -- Enable/Disable filtering of HD titles and mattes for downconvert to SD.
help -- Help the user.
hwtrc -- Hardware Tracing tools
hwtrctest -- Hardware Tracing tools test
iF -- iF statement (scripts only).
Single-statement if structure:
iF cond THEN stmt [ELSE stmt]
iF condition THEN statement
[ELSE statement]
iF condition
THEN statement
[ELSE statement]
Multiple-statement if structure:
iF condition
THEN Statement-List
END iF
iF condition THEN
Statement-List
ELSE statement
iF condition
THEN Statement-List
ELSE Statement-List
END iF
If statements are valid in scripts only.
IgnoreQTRate -- This will ignore the edit rate in a Quicktime file and import the file as if it is sampled at the current project rate
ImportEvents -- See more detailed import events.
iNewsDebug -- Temporary debugging for iNews Capture Mgr Control
LastDownsampleFactor -- Reports the last downsample factor requested in GetWaveform()
LBDebug -- Sets debugging flags in the buildpipes load balancing code
LegacyOverlay -- Force legacy overlay for desktop video: 'LegacyOvelay Help' for more info
LockMixdownMem -- Toggle locking down of memory for mixdowns
Log -- Open a log file or close the current log file.
LogCalls -- Direct all calls to Avidtalk commands into the logfile.
LogClaims -- <no description>
LogLocateBuffers -- Enables/disables locate buffer log
LogLoopPlay -- Toggle the logging of Loop Play
LogOnException -- When enabled, generates coreevent log on first player exception.
LogTest -- Test the log file triggers
ltcphase -- Set LTC phase offset in frames (+1, -1, or 0)
MarkToLoopDelay -- <no description>
MarqueeDebug -- Enable/Disable Marquee debug messages
MaxBrushStroke -- <no description>
mcsessionlog -- Toggles MCSession logging on and off
mdo -- Sets display options for dumping Mobs to the Console. (shortcut for MobDumpOptions)
mem_more_masters -- <no description>
MemClearTotals -- <no description>
MemPrintStats -- <no description>
MeridienColorFX -- Rotates hue on all color effects in sequence
MeridienDSK -- <no description>
midi002 -- Enable or disable Digi 002 as MIDI control surface on Mac
MixdownDebug -- displays debug info during Mixdown in app console
MixMatchRefreshPrompt -- Enable/Disable prompt for automatic refresh of Motion Adapters in sequences loaded into monitors.
mixtool -- Open deprocated mix tool
MobDumpOptions -- Sets display options for dumping Mobs to the Console.
MobSummary -- Displays a one-line summary of a Mob.
MonitorProtocol -- Select protocol to monitor
MotionFXSize -- MotionFXSize on/off
MpegExportOptions -- Flip MPEG Export Option.
verbose - turn on/off debug messages.
elementary - turn on/off elementary stream keeping.
splicing - turn on/off splicing.
VBV - observe/ignore VBV constraint.

msm -- Type 'msm help' for complete help.
MSMContinuousBG -- Run AsyncMSMRescan continuously for debugging
MsmIsOnlineFileCheck -- true means IsOnline uses filesystem (slower, accurate) vs cache (faster, less accurate).
MulticamPreload -- Allows the user to override the default number of frames to pre-load when beginning multicam playback. This can help reduce dropped frames.
MultithreadFX -- Enable/Disable multithreaded rendering of FX
nolocks -- toggles filesystem locks off and on
OMMCheckAllMasterMobs -- Ask asset mgr about all master mobs in a bin, not just mobs on shared storage(toggle)
on -- Define an event handler.
openBin -- Open a Bin.
OpenProject -- <no description>
OsPrintf -- Enables/Disables OsPrintf. Type 'OsPrintf help' for complete help.
PaneIDkey -- sets up F12 to be the Pane Dump key
PaneIDToolTips -- Toggle paneID tooltip
PauseToStopDelay -- <no description>
PerfTest -- Peformance Tests
PinnacleOptions -- Change MPEG Export Pinnacle Encoder Options.
PlayEvent -- Type 'PlayEvent help' for complete help.
PlayLength -- <no description>
playStats -- play stats command
Plog -- Play event logging: Plog <numEvents> <highmask> <lowmask> <zoneLogging=false>
powerman -- Enable/Disable handling Power Management broadcast messages from OS
PreventCachingWaveforms -- forces the WaveformCache into the prevent caching state
PrintACFDefinition -- List the registered ACF Component definitions.
PrintBBPAllocs -- Print the current allocations in the Big Buffer Pool to the debugger console
PrintPlayerParams -- Prints out PlayerParam info from settings
PrintPlayerPipes -- Display the player pipes from the current player
PrintPlayHist -- <no description>
ProfileFix -- Change the way we create the clip on the Profile using the extended BVW commands.
PurgeAllUnreferenced -- <no description>
put -- Store expression into a variable.
QuitMC -- Exits from the MediaComposer application
RecreateTitleMedia -- <no description>
Redir -- <no description>
RenameMediaFiles -- <no description>
reneW -- Resets the problem and error counters.
RepairKNMasks -- <no description>
RepairKNStart -- <no description>
RepairMob -- Attempts to repair a broken mob.
RepairSequences -- Check sequences for errors and attempt to repair errors
RepairSoundTC -- <no description>
repeat -- General looping keyword.
ResampleCapturedAudio -- Turn on/off DV audio resampling during capture
ResetDiskBlockSize -- Toggle between block size and chunk size for reported disk block size (requires the pipes to be rebuilt)
RestoreMaxALBMSize -- Restores the maximum size of the Locate Buffer Manager to its default - Requires relaunch
RestoreMaxStreams -- <no description>
Run -- Load a script file & execute any non-definition commands.
The script file name is taken literally and must not be enclosed in quotes.
Run -- Load a script file & execute any non-definition commands.
The script file name is taken literally and must not be enclosed in quotes.
RunScript -- Load a script file & execute any non-definition commands.
The script file name may be any string expression.
RunScript -- Load a script file & execute any non-definition commands.
The script file name may be any string expression.
ScratchMode -- ScratchMode [0 = dup, 1 = both]
ScrubLen -- Sets the range of frames to use when building the single frame player
setamimode -- Sets the AMI mode.
SetAudioLoopPlayPerformance -- <no description>
SetAudioTestingState -- <no description>
SetAVX2DebugLevel -- Set the verbosity of console reporting.
SetBorrowCarry -- Allow user to adjust borrow carry operations in build-pipes
SetCacheReq -- Set number of waveform cache requests to fulfill each Idle cycle
SetConstantBinTitles -- Toggles modification to the bin name in the window title
SetDoNotRetFromPlay -- If (1) then play will NEVER allow the UI to update.
SetEcho -- Flag to echo all executed commands to the console.
SetMAIOLimit -- Sets num of Multi Async per Stream
SetMaxALBMSize -- Sets the maximum size of the Locate Buffer Manager - Requires relaunch
SetMaxStreams -- <no description>
SetMixdownConserve -- Set mixdown memory conserve factor
SetMonitorExceptionVerbosity -- Sets the user feedback level used by the AMonitorPane when it encounters player exceptions
SetMouse -- Set mouse play parameters
setnamefile -- sets preempting input for AFileDialog::NameFile.
path - path to be used during preemption
null args echos the current values

SetPE -- <no description>
SetPEmask -- <no description>
SetPEsize -- <no description>
SetPlayerUIbalance -- This command alters the delicate balance that adjusts the UI update frequency vs Player underruns/dmfas
SetPlayStats -- Set the showing of play stats
SetPrecompAutoDelete -- Enable/Disable automatic deletion of unsaved precomputes
SetRenderThreadWait -- Change the amount of time the scheduler waits to let the render thread run
SetRescanWarnings -- <no description>
setrunoncebuffer -- Enable/Disable direct sound run once capture buffer.
SetSBReqListSize -- Sets num of ms in SpringBuffer Streaming request list
SetSFStats -- Set the showing of play stats
SetShowBuildPipes -- Display the player pipes whenever the pipes are rebuilt: (graph = use dotty graph)
SetSleepTime -- Set time to sleep between null events
SetSWFXSubPipes -- Force upstream effects of a SW effect to also be in SW (default = play). (Type: 'SetSWFXSubPipes help' for help using this command.
SetUndoMan -- <no description>
SetUpdateWhilePlayingOn -- Set whether globalState should be updated during play.
SetVideoVitalsFromTrackGroup -- Enable/Disable SetVideoVitalsFromTrackGroup
SetVolumeLatency -- Slows down the volume's I/O to simulate the slow volumes. Latency is in msec
sf -- Toggle to display the count of late and skipped frames in the console at the end of streaming play.
ShowAdvancedMem -- Enable/Disable advanced memory stats on project window
showbptime -- Toggles display of build pipes times in the console
ShowCmd -- Hidden command to enable using hidden commands.
ShowHeapErrors -- <no description>
ShowMixdownMemStats -- Toggle showing mixdown memory statistics
ShowPending -- Shows Current State of Waveform Cache Pending Mechanism, ON/OFF
ShowPlayStats -- Toggle the showing of play stats
ShowPlayStats -- Toggle the showing of play stats
ShowSFStats -- Toggle the showing of single frame play stats
ShowVolumeInfo -- Shows the information about all volumes
SkippedFrames -- Toggle to display the count of late and skipped frames in the console at the end of streaming play.
StatTest -- <no description>
StepToTrim -- <no description>
Subsys -- Control the debug parameters
SuppressUnderruns -- Turn suppression of underruns on/off. (Type: 'SuppressUnderruns help' for help using this command.
TCBreakTolerance -- Continuous Timeode Checking: If the difference between 2 consecutive timecodes is more than 6 frames,
Avid considers this a break in timecode on the tape. You can override the 6 frame tolerance by setting this value.
TCChecking -- <no description>
tearingfix -- Toggle tearing fix for Source/Record monitor windows
TestColorConversion -- <no description>
testerr -- <no description>
testNew -- <no description>
tmDump -- <no description>
tmDumpAllMethodLists -- <no description>
tmDumpAllTools -- <no description>
Toggle720pSkipMode -- A persistent command that enables/disables the legacy performance optimization for 720p 50/60Hz projects.
ToggleACFClientMonitorForAVX -- Toggles use of ACF Client Monitor for avxInstance_v1::DrawToVideoBuffer.
ToggleAVXRedraw -- Toggle background redrawing when plug-in UI is up
ToggleAVXResizing -- Enable/Disable AVX effect resizing
ToggleCheckDSCalc -- Toggles checking of downsample calculations
ToggleCnvtrs -- Toggles use of new asynch converters
ToggleDebugTools -- Toggle the enabling/disabling of the debug tools - requires restart.
ToggleDefEC -- Toggles enabling of deferred tasks for effects
toggledhdump --
ToggleDXMouseSupport -- Enables/Disables Experimental Mouse Jog & Shuttle support with Nitris/Mojo DX
ToggleHWDecode -- Toggles use of Hardware Decode converters
ToggleMAIO -- Toggles Multiple Asyncio per Stream
ToggleMonPaneBlip -- Toggle single frame display in the monitors.
ToggleMPEGCache -- Enable/Disable Long GOP media parameters cache.

TogglePending -- Toggles whether or not we're using new Pending Cache Mechanism
TogglePreRead -- Toggles whether PreReads are issued to ISIS volumes
ToggleReadRate -- Toggles whether ReadRates are osprintf'd
togglerunmetersinplaycmd -- Toggle doing the meters directly in PlayCmd
toggleStatSpace -- Toggle statistics space calculation
ToggleThreadedScheduler -- Toggles the default use of the threaded scheduler on real-time pipes
ToggleThreadedSFMode -- Enables/Disables Threaded Single Frame Mode
ToggleWFfailLoudly -- Toggle advanced waveforme engine propagating exceptions
ToggleYUV -- Toggles use of board for 1:1 <-> YUV
TopOffStream -- Turn topping off of stream on/off. Type 'TopOffStream help' for help using this command.
tracefd -- Enables and disables file dialog tracing.
tracesuspendresume -- <no description>
TrimToUpdateDelay -- <no description>
UseNTSCAudioRate -- Toggles use bad NTSC value 29.97
UseThreadedScheduler -- Use the threded buffer scheduler or make the schedule calls right from the player->play() loop
UseVC3Labels -- Enable/Disable the use of VC3 labels when creating DNxHD MXF media
ValidateConfig -- Validates the current deck configuration against the decks actually connected.
verbosE -- Sets the level of information that goes to the screen. Verbose level must be between 0 and 5. 0 means don't echo anything, 5 means echo it all. Standard level is 4.
VideoReadLowBoundDivisor -- Set the lower bound of video reads to a buffer divisor. Type 'VideoReadLowBoundDivisor help' for help using this command.
VTRE -- Accesses VTR Emulation debug information. Type 'vtre help' for more info.
VTREPriority -- Reports the current priority setting and whether setting the thread priority for VTRE was successful.
WatchSequence -- Toggle watch sequence mode, which watches the integrity of the sequence in the timeline and alerts if it becomes corrupted.
WaveformCacheStats -- displays memory usage to the console
WaveformCommands -- Displays commands that affect the Advanced Waveform Engine
WGPurgeAllOnDelete -- <no description>
WriteFrameIndex -- <no description>
WriteSizeMegs -- Set Megs to Write
XDebug -- <no description>
xfermgr -- TransferStatusWindow debug