Interface MediaAsset

Represents a media asset.

interface MediaAsset {
    clipMetadata: {
        clipName?: string;
        clipRequestId: string;
        expiresOn?: string;
        startTime?: string;
        stopTime?: string;
        storage: {
            storagePath: string;
            storageType: "Default" | "Gcs" | "AwsS3";
        };
    };
    download: {
        downloadExpiresOn: string;
        downloadUrl: string;
    };
    id: string;
    itemType: "FullRecording" | "Clip";
    metadata: {
        duration: number;
        format: string;
        sizes?: any;
        thumbnails: string[];
        tracks: {
            bitrate: number;
            channels?: number;
            codec: string;
            framerate?: number;
            height?: number;
            samplerate?: number;
            type: string;
            width?: number;
        };
    };
    recordedOn: string;
    removedOn?: string;
    simulcastId?: string;
    sourceId?: string;
    status: "Started" | "Transcode" | "Complete" | "Deleting" | "Error";
    stoppedOn?: string;
    streamName: string;
    tokenId?: number;
}

Properties

clipMetadata download id itemType metadata recordedOn removedOn? simulcastId? sourceId? status stoppedOn? streamName tokenId?

Properties

clipMetadata

clipMetadata: {
    clipName?: string;
    clipRequestId: string;
    expiresOn?: string;
    startTime?: string;
    stopTime?: string;
    storage: {
        storagePath: string;
        storageType: "Default" | "Gcs" | "AwsS3";
    };
}

Type declaration

  • Optional clipName?: string

    Clip label if assigned by user.

  • clipRequestId: string

    Id associated with clipping request. Multiple clips generated from the same request can share a single clipRequestId.

  • Optional expiresOn?: string
  • Optional startTime?: string
  • Optional stopTime?: string
  • storage: {
        storagePath: string;
        storageType: "Default" | "Gcs" | "AwsS3";
    }

    Storage information.

    • storagePath: string

      Prefix to clip storage location. Available only for external storage configurations.

    • storageType: "Default" | "Gcs" | "AwsS3"

      Storage provider type.

download

download: {
    downloadExpiresOn: string;
    downloadUrl: string;
}

Type declaration

  • downloadExpiresOn: string
  • downloadUrl: string

id

id: string

itemType

itemType: "FullRecording" | "Clip"

metadata

metadata: {
    duration: number;
    format: string;
    sizes?: any;
    thumbnails: string[];
    tracks: {
        bitrate: number;
        channels?: number;
        codec: string;
        framerate?: number;
        height?: number;
        samplerate?: number;
        type: string;
        width?: number;
    };
}

Type declaration

  • duration: number
  • format: string
  • Optional sizes?: any
  • thumbnails: string[]
  • tracks: {
        bitrate: number;
        channels?: number;
        codec: string;
        framerate?: number;
        height?: number;
        samplerate?: number;
        type: string;
        width?: number;
    }
    • bitrate: number
    • Optional channels?: number
    • codec: string
    • Optional framerate?: number
    • Optional height?: number
    • Optional samplerate?: number
    • type: string
    • Optional width?: number

recordedOn

recordedOn: string

Optional removedOn

removedOn?: string

Optional simulcastId

simulcastId?: string

Optional sourceId

sourceId?: string

status

status: "Started" | "Transcode" | "Complete" | "Deleting" | "Error"

Optional stoppedOn

stoppedOn?: string

streamName

streamName: string

Optional tokenId

tokenId?: number

Settings

Member Visibility

Theme

On This Page

clipMetadatadownloadiditemTypemetadatarecordedOnremovedOnsimulcastIdsourceIdstatusstoppedOnstreamNametokenId