Cattura CaptureCast HTTP API Documentation

Event

The Event object represents a scheduled media capture event. The structure of an Event is very similar to that of the CaptureRequest.

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
`id`	`string`	Yes	ID of event.
`title`	`string`	Yes	The title of the event. This will also be used as the title of the generated media package.
`groupID`	`string`	No	ID of the event group this event is part of, or null if not part of a group.
`templateID`	`string`	Yes	ID or name of template to use for this capture session.
`startTime`	`number`	Yes	Scheduled start time, in milliseconds since the epoch.
`stopTime`	`number`	Yes	Scheduled end time, in milliseconds since the epoch.
`speaker`	`number`	No	ID of presenter (a.k.a. "speaker") to use for this capture session, or 0 if no speaker.
`tags`	`array` of `string`s	No	Tags attached to the output media package.
`started`	`boolean`	No	Whether the scheduled event has started capturing.
`completed`	`boolean`	No	Whether the scheduled event has finished capturing.
`mediaPackageID`	`string`	No	If this scheduled event has produced a media package, this is its ID. If not, this is null.
`assets`	`array` of `Asset`s and/or `Link`s	No	Assets (a.k.a. "speaker files") to attach to this scheduled capture session. These can be either `Asset`s or `Link`s.
`publishingRedundantCopies`	`boolean`	No	If this is `true` then source copies (a.k.a. "redundant copies") will be published along with the primary media file. If `false` then publishing of these files is disabled. Default is `true`. Has no effect if `publishing` is `false`.
`publishingSpeakerFiles`	`boolean`	No	If this is `true` then attached assets (a.k.a. "speaker files") will be published. If `false` then publishing of these files is disabled. Default is `true`. Has no effect if `publishing` is `false`.
`publishingSpeakerInformation`	`boolean`	No	If this is `true` then presenter (a.k.a. "speaker") information and image be published. If `false` then publishing of these items is disabled. Default is `true`. Has no effect if `publishing` is `false`.
`publishingTableOfContents`	`boolean`	No	If this is `true` then Table of Contents metadata generated during the capture session will be published. If `false` then publishing of these files is disabled. Default is `true`. Has no effect if `publishing` is `false`.

JSON Example

Note that not all of these fields are required (see above for information on which fields are required).

{
    "id": "638",
    "startTime": 1411779600000,
    "stopTime": 1411786800000,
    "title": "Scheduled Capture Example",
    "template": "Ocr-177154533",
    "groupID": null,
    "speaker": 5,
    "assets": [
        {
            "@class": "com.cattura.share.processor.data_provider.elements.Asset",
            "id": "speaker:Cheetos",
            "name": "Cheetos",
            "tags": [],
            "mimeType": "application/x-octet-stream",
            "path": "/files/55c4fdcfe4ac8c4fdf6135e9c86e365f/cheetos.png",
            "fileAlias": "cheetos.png",
            "description": "",
            "mode": "DISPLAY",
            "creationDate": 0
        },
        {
            "@class": "com.cattura.share.processor.data_provider.elements.Asset",
            "id": "speaker:Le",
            "name": "Le",
            "tags": [],
            "mimeType": "application/x-octet-stream",
            "path": "/files/07a16cb74a6e971cbe2d91cfd6696221/le.png",
            "fileAlias": "le.png",
            "description": "",
            "mode": "DISPLAY",
            "creationDate": 0
        },
        {
            "@class": "com.cattura.share.processor.data_provider.elements.Link",
            "id": "speaker:link-Google",
            "name": "Google",
            "tags": [],
            "title": "Google",
            "url": "http://google.com/"
        }
    ],
    "completed": false,
    "mediaPackageID": null,
    "publishingRedundantCopies": true,
    "publishingSpeakerFiles": true,
    "publishingSpeakerInformation": true,
    "publishingTableOfContents": true,
    "started": false,
    "tags": [
        "cheetos",
        "le"
    ]
}