Cattura CaptureCast HTTP API Documentation

Element

The term Element refers to a set of data types used for configuration and metadata. All Elements have a field called "@class" that identifies the type of Element. Elements also have the fields id and name, which respectively specify an identifier and human-consumable name.

Types of Element

Asset

These represent files on the filesystem.

Fields

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
@class	string	Yes	com.cattura.share.processor.data_provider.elements.Asset
id	string	No	An identifier.
name	string	No	A human-readable name.
path	string	Yes	Path to file on the filesystem.
mimeType	string	No	Mime type for file, such as image/png
fileAlias	string	No	Alias for file.
description	string	No	Alias for file.
creationDate	number	No	Datetime of creation, expressed as milliseconds since Unix epoch

JSON Example

{
    "@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_bbb.png",
    "fileAlias": "thumbnail for device BBB",
    "description": "",
    "mode": "DISPLAY",
    "creationDate": 0
}
            

Link

These represent hyperlinks.

Fields

Name	Type	Required	Description
@class	string	Yes	com.cattura.share.processor.data_provider.elements.Link
id	string	No	An identifier.
name	string	No	A human-readable name.
title	string	Yes	Title of link.
url	string	Yes	URL of link.
description	string	No	Alias for file.

JSON Example

{
    "@class": "com.cattura.share.processor.data_provider.elements.Link", 
    "title": "Google",
    "url": "http://google.com",
    "description": "Search engine"
}