Cattura CaptureCast HTTP API Documentation

PublishRequest

The PublishRequest object represents a request for CaptureCast to publish an existing media package. At its most basic, the CaptureRequest specifies the ID of a MediaPackage and some publishing configurations. However, the PublishRequest contains additional options mostly concerning to metadata and publishing.

Fields of a PublishRequest

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
mediaPackageID	string	Yes	ID of media package to publish.
configs	array of PublishPlatformConfigurations	Yes	Publisher configurations. See below for an example.
options	object	No	Arbitrary options attached to the publish request. These are not used by the core CaptureCast platform but may be used by plugins.
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.
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.
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.
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.

Fields of a PublishPlatformConfiguration

Name	Type	Required	Description
publisherID	string	Yes	ID of a plugin to publish with, for example com.cattura.kaltura_plugin.KalturaPlugin.
config	object	Yes	Publisher-specific configuration.
ingests	array of strings	No	Indicators for things that are published. The special word "all" indicates that everything is published. Default is "all"

JSON Example

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

{
    "mediaPackageID": "my-lecture-capture",
    "options": { },
    "configs": [
        {
            "publisherID": "com.cattura.kaltura_plugin.KalturaPlugin",
            "config": {
                "url": "www.kaltura.com",
                "userID": "fred@foobarinc.com",
                "secret": "********",
                "partnerID": "12345",
                "ownerID": "bob@example.com"
            },
            "ingests": [
                "all"
            ]
        },
        {
            "publisherID": "com.cattura.youtube_plugin.YoutubePlugin",
            "config": {
                "username": "fred@foobarinc.com",
                "password": "********",
                "description": "This is my lecture capture."
            },
            "ingests": [
                "all"
            ]
        }
    ],
    "publishingRedundantCopies": true,
    "publishingSpeakerFiles": true,
    "publishingSpeakerInformation": true,
    "publishingTableOfContents": true
}