Interface CreateAssetClipRequest

The allowable parameters for requesting the creation of an asset clip.

interface CreateAssetClipRequest {
    name?: string;
    priority?: number;
    simulcastId?: string;
    sourceId?: string;
    startTime: string;
    stopTime?: string;
    storage?: MediaAssetStorageModel;
    streamName: string;
    tokenId?: number;
}

Properties

name? priority? simulcastId? sourceId? startTime stopTime? storage? streamName tokenId?

Properties

Optional name

name?: string

Optional, Name of the asset once clipped. If not provided it will be generated.

Optional priority

priority?: number

Optional, int32, The requests with the highest priority are processed first.

Optional simulcastId

simulcastId?: string

Optional, Simulcast ID if required.

Optional sourceId

sourceId?: string

Optional, source identifier.

startTime

startTime: string

Required, ISO 8601 date string, Start time of the clip.

Optional stopTime

stopTime?: string

Optional, ISO 8601 date string, End time of the clip. If not required defaults to current time.

Optional storage

storage?: MediaAssetStorageModel

Optional, storage information.

streamName

streamName: string

Required, length ≥ 1, Name of the stream you want to clip.

Optional tokenId

tokenId?: number

Optional, Token ID of the stream you want to clip.

Settings

Member Visibility

Theme

On This Page

nameprioritysimulcastIdsourceIdstartTimestopTimestoragestreamNametokenId