@dolbyio/dolbyio-rest-apis-client - v6.3.1
    Preparing search index...

    Interface CreateAssetClipRequest

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

    interface CreateAssetClipRequest {
        channelId?: string | null;
        customPath?: string | null;
        expiration?: string | null;
        mediaDistributionId?: string | null;
        name?: string | null;
        priority?: number | null;
        simulcastId?: string | null;
        sourceId?: string | null;
        startTime: string;
        stopTime?: string | null;
        storage?: MediaAssetStorageModel | null;
        streamName: string;
        targetFormat?: "mp4" | "hls" | null;
        tokenId?: number | null;
    }
    Index
    channelId? customPath? expiration? mediaDistributionId? name? priority? simulcastId? sourceId? startTime stopTime? storage? streamName targetFormat? tokenId?
    channelId?: string | null

    Optional. Id of the OptiView Live channel to create live clip.

    customPath?: string | null

    Optional. Customize the download url path. Typically the download url has format https://<domain>/<orgId>/<mediaAssetId>/<fileName>. The customPath replaces the mediaAssetId so that the url looks like https://<domain>/<orgId>/<customPath>/<fileName>. The customPath must be unique.

    Possible values: non-empty and <= 512 characters.

    expiration?: string | null

    Optional. Provide expiry time for live recording clip.

    mediaDistributionId?: string | null

    Optional. ID of the media distribution used to authenticate viewing of this media asset.

    name?: string | null

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

    priority?: number | null

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

    simulcastId?: string | null

    Optional, Simulcast ID if required.

    sourceId?: string | null

    Optional, source identifier.

    startTime: string

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

    stopTime?: string | null

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

    storage?: MediaAssetStorageModel | null

    Optional, storage information.

    streamName: string

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

    targetFormat?: "mp4" | "hls" | null

    Optional. Format of the media asset.

    tokenId?: number | null

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

    Settings
    Member Visibility

    On This Page
    Properties