Video Devices DAT

From Derivative
Jump to navigation Jump to search

Summary
[edit]

The Video Devices DAT provides information about all detected video devices including driver, direction (input or output), label, and name that can be referenced in the Video Device In TOP and Video Device Out TOP.

You can also set it to display all available video devices.

It runs a callback script when a change in video devices has been detected and returns a list of names corresponding to the changed devices.

The 'name' column is a unique identifier for the device that is built up using a few pieces. The pieces are separated using ||| as a delimiter E.g

V1|||83514832|||0|||0|||DeckLink 8K Pro (1)

Which splits up into:

Name Version Number ||| Unique Device ID ||| Device Index ||| Device Sub Index ||| Device Label

Where:
Name Version Number - If the format of this name changes in the future, this will allow future versions know how to parse this. For now it's always set to V1.
Device Unique ID - A unique ID obtained for the device, when possible. Sometimes it's serial number, sometimes it's based on the PCIe port is connected to. Some manufacturers such as Blackmagic assign a different ID to each connector, while others such as AJA have one ID for the entire card, and the extra connectors are differentiated via the 'Device Sub Index' field.
Device Index - The index of the device, in the order it was enumerated from the driver.
Device Sub Index - Within a device, the connectors may be referenced by a sub-index, which would change here.
Device Label - An English-readable label for the device. Usually unique by adding extra (#) and - # suffixes to differentiate between identical devices.

Unlike most menus, the contents of the string the menu is set to does not need to be an exact match to the devices available on the system. This is done to allow falling back to other devices when a project moves from one machine to another. It will first try to find devices that match using both 'Device Unique ID' and 'Device Sub Index'. If there are no devices on the system that match both of those it will then try to match using both 'Device Label' and 'Device Sub Index'. If there are still no matches, it will finally try to match using both 'Device Index' and 'Device Sub Index'.

PythonIcon.pngvideodevicesDAT_Class


Parameters - Video Devices Page

Driver driver - - Menu of available drivers, table will only include devices belonging to selected driver.
  • DirectShow (WDM) directshow -
  • Media Foundation mediafoundation -
  • Imaging Source - Not Supported imagingsource -
  • DataPath (RGBEASY) datapath -
  • Blackmagic blackmagic -
  • Allied Vision (GigE) alliedvisiongige -
  • Imaging Development Systems (IDS) ids -
  • FLIR / Point Grey (FlyCapture2) pointgreyflycapture -
  • FLIR / Point Grey (Spinnaker) flirspinnaker -
  • AVFoundation (macOS) avfoundation -
  • BlueFish444 bluefish444 -
  • AJA aja -
  • Ximea ximea -
  • Deltacast deltacast -

All Drivers alldrivers - While on, the table will display devices from all available drivers.

Input Devices input - Toggle to include input devices.

Output Devices output - Toggle to include output devices.

Callbacks DAT callbacks - Runs this script once for each change to the table (ie. device state change).


Parameters - Common Page

Language language - - Select how the DAT decides which script language to operate on.
  • Input input - The DAT uses the inputs script language.
  • Node node - The DAT uses it's own script language.

Edit/View Extension extension - - Select the file extension this DAT should expose to external editors.
  • dat dat - various common file extensions.
  • From Language language - pick extension from DATs script language.
  • Custom Extension custom - Specify a custom extension.

Custom Extension customext - Specifiy the custom extension.

Word Wrap wordwrap - - Enable Word Wrap for Node Display.
  • Input input - The DAT uses the inputs setting.
  • On on - Turn on Word Wrap.
  • Off off - Turn off Word Wrap.


Info CHOP Channels

Extra Information for the Video Devices DAT can be accessed via an Info CHOP.

Common DAT Info Channels

  • num_rows - Number of rows in this DAT.
  • num_cols - Number of columns in this DAT.

Common Operator Info Channels

  • total_cooks - Number of times the operator has cooked since the process started.
  • cook_time - Duration of the last cook in milliseconds.
  • cook_frame - Frame number when this operator was last cooked relative to the component timeline.
  • cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
  • cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
  • cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
  • cooked_this_frame - 1 if operator was cooked this frame.
  • warnings - Number of warnings in this operator if any.
  • errors - Number of errors in this operator if any.


TouchDesigner Build:

DATs
Art-Net • Audio Devices • CHOP Execute • CHOP to • Clip • Convert • CPlusPlus • DAT •  Execute • DAT Export • Error • EtherDream • Evaluate • Examine • Execute • FIFO • File In • File Out • Folder • In • Indices • Info • Insert • JSON • Keyboard In • Lookup • Media File Info • Merge • MIDI Event • MIDI In • Monitors • MPCDI • MQTT Client • Multi Touch In • NDI • Null • OP Execute • OP Find • OSC In • OSC Out • Out • Panel Execute • Parameter • Parameter Execute • ParGroup Execute • Perform • POP to • Render Pick • Reorder • Script • Select • Serial • Serial Devices • SocketIO • SOP to • Sort • Substitute • Switch • Table • TCP/IP • Text • Touch In • Touch Out • Transpose • TUIO In • UDP In • UDP Out • UDT In • UDT Out • Video Devices • Web Client • Web • Web Server • WebRTC • WebSocket • XML