Cattura CaptureCast HTTP API Documentation

CaptureRequest

The CaptureRequest object represents a request for CaptureCast to begin a capture session. At its most basic, the CaptureRequest specifies the name of a template which forms the basis of the capture session. However, the CaptureRequest contains additional options mostly concerning to metadata and publishing.

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
`title`	`string`	No	Specifies the title of the media package generated by this capture session. If not provided, a default title will be generated.
`templateID`	`string`	Yes	ID or name of template to use for this capture session.
`duration`	`number`	No	Duration of capture session, in milliseconds. If not specified then the capture session will run indefinitely until it is stopped manually.
`speaker`	`string`	No	ID or name of presenter (a.k.a. "speaker") to use for this capture session.
`tags`	`array` of `string`s	No	Tags attached to the media package.
`options`	`object`	No	Arbitrary options attached to the capture request. These are not used by the core CaptureCast platform but may be used by plugins.
`metadata`	`object`	No	Arbitrary metadata to be attached to the media package.
`publishingOverrides`	`object`	No	Keys are publisher names or IDs (e.g. "kaltura"), values are objects containing publisher configuration which is merged with publisher configuration from the template.
`assets`	`array` of `Asset`s and/or `Link`s	No	Assets (a.k.a. "speaker files") to attach to this capture session. These can be either `Asset`s or `Link`s.
`publishing`	`boolean`	No	If this is `true` the media package will be published as specified in the template. If `false` then publishing is disabled. Default is `true`
`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).

{
    "title": "My Lecture Capture",
    "duration": 36000000,
    "tags": ["Chemistry 101"],
    "templateID": "chemistry",
    "options": { },
    "metadata": { },
    "publishingOverrides": {
        "youtube": {
            "description": "This is my lecture capture."
        },
        "kaltura": {
            "ownerID": "bob@example.com"
        }
    },
    "speaker": "Almighty Bob",
    "publishing": true,
    "publishingRedundantCopies": true,
    "publishingSpeakerFiles": true,
    "publishingSpeakerInformation": true,
    "publishingTableOfContents": true
}