Cattura CaptureCast HTTP API Documentation

Graph

The Graph represents the processing workflow for a capture session.

Fields of a Graph

Note: The terms "object," "array," "string," and "number," refer to JSON data types. The term "boolean" refers to the JSON values true and false. All other type names refer to data types specific to the CaptureCast platform.
Name Type Required Description
nodes array of Nodes Yes Nodes of the graph.

Fields of a Node

Name Type Required Description
nodeID number Yes ID of node.
workingDir string No Working directory of node. If not specified, it is automatically generated.
connectedTo array of numbers Yes IDs of child nodes. This node will send data to these indicated nodes.
config string Yes Configuration used to create a processor. This is usually a JSON string.

JSON Example

Note that not all of these fields are required (see above for information on which fields are required).
{
    "nodes": [
        {
            "nodeID": 0,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844",
            "connectedTo": [
                1,
                10,
                2,
                3,
                17
            ],
            "config": "{\"pluginID\":\"root\",\"type\":\"OPTION\",\"baseDirectory\":\"/var/cattura/storage/templates/El-Stitcho--1---1--1641841844\"}"
        },
        {
            "nodeID": 1,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.java_sound_capture_plugin.JavaSoundCapturePlugin/1",
            "connectedTo": [
                12,
                8,
                5
            ],
            "config": "{\"device\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Group\",\"elements\":[{\"@class\":\"com.cattura.share.processor.data_provider.elements.Metadata\",\"vendor\":\"ALSA (http://www.alsa-project.org)\",\"name\":\"Juli\",\"friendlyName\":\"ESI Juli@\",\"usbInfo\":\"\",\"version\":\"3.13.0-24-generic\"},{\"@class\":\"com.cattura.share.processor.data_provider.elements.AudioFormat\",\"sampleRate\":44100,\"numberChannels\":1,\"sampleSizeInBits\":50000,\"isSigned\":false,\"isBigEndian\":true}]},\"pluginID\":\"com.cattura.java_sound_capture_plugin.JavaSoundCapturePlugin\",\"type\":\"READ\"}"
        },
        {
            "nodeID": 10,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.static_frame_plugin.StaticFramePlugin/10",
            "connectedTo": [
                11
            ],
            "config": "{\"asset\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Asset\",\"mimeType\":\"image/png\",\"path\":\"/var/cattura/storage/files/40e3017b394a2085dc7eff0009fdf76e.jpg\",\"fileAlias\":\"40e3017b394a2085dc7eff0009fdf76e.jpg\",\"description\":\"/var/cattura/storage/files/40e3017b394a2085dc7eff0009fdf76e.jpg\"},\"pluginID\":\"com.cattura.static_frame_plugin.StaticFramePlugin\",\"type\":\"READ\"}"
        },
        {
            "nodeID": 2,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.plugins.capture.video.MockVideoDeviceCapturePlugin/2",
            "connectedTo": [
                4,
                11
            ],
            "config": "{\"device\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Group\",\"id\":null,\"name\":null,\"elements\":[{\"@class\":\"com.cattura.share.processor.data_provider.elements.Metadata\",\"id\":null,\"name\":null,\"tags\":[],\"map\":{\"Driver\":\"com.cattura.plugins.capture.video.MockVideoDeviceCapturePlugin\",\"valid\":true,\"Device Path\":\"kuhn\",\"Friendly Name\":\"Bradley Kuhn\"}},{\"@class\":\"com.cattura.share.processor.data_provider.elements.Asset\",\"id\":null,\"name\":null,\"tags\":[],\"mimeType\":\"image/png\",\"path\":\"/var/cattura/plugins/processor/mock-video-device-capture-plugin/temp/thumbnail_kuhn.png\",\"fileAlias\":\"thumbnail for device Bradley Kuhn\",\"description\":\"\",\"mode\":\"DISPLAY\",\"creationDate\":0},{\"@class\":\"com.cattura.share.processor.data_provider.elements.VideoFrame\",\"id\":null,\"name\":null,\"tags\":[],\"width\":1024,\"height\":768,\"fps\":20,\"colorspace\":[],\"sourceID\":\"kuhn\"}],\"tags\":[]},\"pluginID\":\"com.cattura.plugins.capture.video.MockVideoDeviceCapturePlugin\",\"type\":\"READ\"}"
        },
        {
            "nodeID": 3,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.plugins.capture.blackmagic.BlackMagicVideoCapturePlugin/3",
            "connectedTo": [
                11,
                7
            ],
            "config": "{\"device\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Group\",\"id\":null,\"name\":null,\"elements\":[{\"@class\":\"com.cattura.share.processor.data_provider.elements.Metadata\",\"id\":null,\"name\":null,\"tags\":[],\"map\":{\"Driver\":\"Blackmagic\",\"valid\":true,\"USB Port\":null,\"Device Path\":\"bmd:0:hdmi:12\",\"Friendly Name\":\"DeckLink Studio 2 (card #1) (hdmi) (HD 1080i 60)\"}},{\"@class\":\"com.cattura.share.processor.data_provider.elements.Asset\",\"id\":null,\"name\":null,\"tags\":[],\"mimeType\":\"image/png\",\"path\":\"/var/cattura/plugins/processor/blackmagic-video-capture-plugin/temp/thumbnail_bmd-0-hdmi_DISP_MODE_HD1080i6000.png\",\"fileAlias\":\"thumbnail for device DeckLink Studio 2 (card #1) (hdmi)\",\"description\":\"\",\"mode\":\"DISPLAY\",\"creationDate\":0},{\"@class\":\"com.cattura.share.processor.data_provider.elements.VideoFrame\",\"id\":null,\"name\":null,\"tags\":[],\"width\":1920,\"height\":1080,\"fps\":30,\"colorspace\":[],\"sourceID\":\"bmd:0:hdmi:12\"}],\"tags\":[]},\"pluginID\":\"com.cattura.plugins.capture.blackmagic.BlackMagicVideoCapturePlugin\",\"type\":\"READ\"}"
        },
        {
            "nodeID": 17,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.metadata_plugin.MetadataPlugin/17",
            "connectedTo": [],
            "config": "{\"metadata\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Metadata\",\"id\":\"internal\",\"name\":\"Template metadata\",\"tags\":[],\"map\":{\"id\":\"El-Stitcho--1---1--1641841844\",\"title\":\"El Stitcho (1) (1)\",\"description\":\"\"}},\"pluginID\":\"com.cattura.metadata_plugin.MetadataPlugin\",\"type\":\"METADATA\"}"
        },
        {
            "nodeID": 12,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.xuggle_writer_plugin.XuggleWriterPlugin/12",
            "connectedTo": [
                13
            ],
            "config": "{\"mediaType\":\"AUDIO_VIDEO\",\"id\":\"primary:${mediaPackage.id}\",\"name\":\"${mediaPackage.title}\",\"fileName\":\"media_output\",\"video\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.VideoFrame\",\"width\":1920,\"height\":1080,\"fps\":30,\"colorspace\":[\"yuv420p\"]},\"tags\":\"primary\",\"preset_keyword\":\"ultrafast\",\"audio\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.AudioFormat\",\"sampleRate\":44100,\"numberChannels\":1,\"sampleSizeInBits\":50000,\"isSigned\":false,\"isBigEndian\":true},\"pluginID\":\"com.cattura.xuggle_writer_plugin.XuggleWriterPlugin\",\"type\":\"WRITE\"}"
        },
        {
            "nodeID": 8,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.xuggle_writer_plugin.XuggleWriterPlugin/8",
            "connectedTo": [
                9
            ],
            "config": "{\"mediaType\":\"AUDIO_VIDEO\",\"id\":\"source:bmd:0:hdmi:12\",\"name\":\"DeckLink Studio 2 (card #1) (hdmi) (HD 1080i 60)\",\"fileName\":\"media_output\",\"video\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.VideoFrame\",\"width\":1920,\"height\":1080,\"fps\":30,\"colorspace\":[\"yuv420p\"]},\"tags\":\"secondary\",\"preset_keyword\":\"ultrafast\",\"audio\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.AudioFormat\",\"sampleRate\":44100,\"numberChannels\":1,\"sampleSizeInBits\":50000,\"isSigned\":false,\"isBigEndian\":true},\"pluginID\":\"com.cattura.xuggle_writer_plugin.XuggleWriterPlugin\",\"type\":\"WRITE\"}"
        },
        {
            "nodeID": 5,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.xuggle_writer_plugin.XuggleWriterPlugin/5",
            "connectedTo": [
                6
            ],
            "config": "{\"mediaType\":\"AUDIO_VIDEO\",\"id\":\"source:kuhn\",\"name\":\"Bradley Kuhn\",\"fileName\":\"media_output\",\"video\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.VideoFrame\",\"width\":1024,\"height\":768,\"fps\":30,\"colorspace\":[\"yuv420p\"]},\"tags\":\"secondary\",\"preset_keyword\":\"ultrafast\",\"audio\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.AudioFormat\",\"sampleRate\":44100,\"numberChannels\":1,\"sampleSizeInBits\":50000,\"isSigned\":false,\"isBigEndian\":true},\"pluginID\":\"com.cattura.xuggle_writer_plugin.XuggleWriterPlugin\",\"type\":\"WRITE\"}"
        },
        {
            "nodeID": 11,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.video_stitcher_plugin.VideoStitcherPlugin/11",
            "connectedTo": [
                12
            ],
            "config": "{\"backgroundColor\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Color\",\"color\":\"#0b0b0b\"},\"fps\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Range\",\"min\":0,\"max\":30,\"value\":30},\"resolution\":\"1920x1080\",\"inputs\":{\"@class\":\"com.cattura.share.processor.data_provider.forms.ElementList\",\"mode\":\"MULTI\",\"enabled\":true,\"values\":[{\"@class\":\"com.cattura.share.processor.data_provider.elements.Group\",\"elements\":[{\"@class\":\"com.cattura.share.processor.data_provider.elements.VideoFrame\",\"colorspace\":[],\"fps\":0,\"width\":1452,\"height\":817,\"sourceID\":\"bmd:0:hdmi:12\"},{\"@class\":\"com.cattura.share.processor.data_provider.elements.Rectangle\",\"width\":1452,\"height\":817,\"x\":468,\"y\":263,\"isBoundary\":false}]},{\"@class\":\"com.cattura.share.processor.data_provider.elements.Group\",\"elements\":[{\"@class\":\"com.cattura.share.processor.data_provider.elements.VideoFrame\",\"colorspace\":[],\"fps\":0,\"width\":752,\"height\":565,\"sourceID\":\"kuhn\"},{\"@class\":\"com.cattura.share.processor.data_provider.elements.Rectangle\",\"width\":752,\"height\":565,\"x\":0,\"y\":0,\"isBoundary\":false}]},{\"@class\":\"com.cattura.share.processor.data_provider.elements.Group\",\"elements\":[{\"@class\":\"com.cattura.share.processor.data_provider.elements.VideoFrame\",\"colorspace\":[],\"fps\":0,\"width\":225,\"height\":225,\"sourceID\":\"40e3017b394a2085dc7eff0009fdf76e.jpg\"},{\"@class\":\"com.cattura.share.processor.data_provider.elements.Rectangle\",\"width\":225,\"height\":225,\"x\":0,\"y\":855,\"isBoundary\":false}]}]},\"pluginID\":\"com.cattura.video_stitcher_plugin.VideoStitcherPlugin\",\"type\":\"ADAPT\"}"
        },
        {
            "nodeID": 4,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.agent.plugin.xuggler_resampler.XugglerVideoResamplerPlugin/4",
            "connectedTo": [
                5
            ],
            "config": "{\"bounds\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Rectangle\",\"x\":0,\"y\":0,\"width\":1024,\"height\":768},\"pluginID\":\"com.cattura.agent.plugin.xuggler_resampler.XugglerVideoResamplerPlugin\",\"type\":\"ADAPT\"}"
        },
        {
            "nodeID": 7,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.agent.plugin.xuggler_resampler.XugglerVideoResamplerPlugin/7",
            "connectedTo": [
                8
            ],
            "config": "{\"bounds\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.Rectangle\",\"x\":0,\"y\":0,\"width\":1920,\"height\":1080},\"pluginID\":\"com.cattura.agent.plugin.xuggler_resampler.XugglerVideoResamplerPlugin\",\"type\":\"ADAPT\"}"
        },
        {
            "nodeID": 13,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.qtfaststart_plugin.QTFaststartPlugin/13",
            "connectedTo": [
                14,
                15
            ],
            "config": "{\"pluginID\":\"com.cattura.qtfaststart_plugin.QTFaststartPlugin\",\"type\":\"ADAPT\"}"
        },
        {
            "nodeID": 9,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.qtfaststart_plugin.QTFaststartPlugin/9",
            "connectedTo": [
                14,
                15
            ],
            "config": "{\"pluginID\":\"com.cattura.qtfaststart_plugin.QTFaststartPlugin\",\"type\":\"ADAPT\"}"
        },
        {
            "nodeID": 6,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.qtfaststart_plugin.QTFaststartPlugin/6",
            "connectedTo": [
                14,
                15
            ],
            "config": "{\"pluginID\":\"com.cattura.qtfaststart_plugin.QTFaststartPlugin\",\"type\":\"ADAPT\"}"
        },
        {
            "nodeID": 14,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.local_storage_plugin.LocalStoragePlugin/14",
            "connectedTo": [],
            "config": "{\"pluginID\":\"com.cattura.local_storage_plugin.LocalStoragePlugin\",\"type\":\"INTEGRATION\"}"
        },
        {
            "nodeID": 15,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.youtube_plugin.YoutubePlugin/15",
            "connectedTo": [],
            "config": "{\"username\":\"[email protected]\",\"password\":\"**********\",\"category\":\"Film & Animation\",\"private\":\"Public\",\"pluginID\":\"com.cattura.youtube_plugin.YoutubePlugin\",\"type\":\"INTEGRATION\"}"
        },
        {
            "nodeID": 16,
            "workingDir": "/var/cattura/storage/templates/El-Stitcho--1---1--1641841844/com.cattura.google_docs_plugin.GoogleDocsPlugin/16",
            "connectedTo": [],
            "config": "{\"token\":{\"@class\":\"com.cattura.share.processor.data_provider.elements.OAuthToken\",\"id\":null,\"name\":null,\"tags\":[],\"service\":\"google\",\"token\":\"\",\"secret\":\"\"},\"username\":\"[email protected]\",\"password\":\"**********\",\"pluginID\":\"com.cattura.google_docs_plugin.GoogleDocsPlugin\",\"type\":\"INTEGRATION\"}"
        }
    ]
}