Interface Details

interface Details {
    accessControlEntities: Entity[];
    approval: {
        approvalProcessId: null | string;
        approvalProcessName: null | string;
        approvalProcessReferenced: boolean;
        status: ApprovalStatus;
        stepId: null | string;
        steps: {
            approverId: string;
            approverName: string;
            status: string;
            stepId: string;
            stepName: string;
            whenRequested: string;
            whenResponded: string;
        }[];
        whenSubmittedForApproval: null
        | string;
    };
    approvalStatus: ApprovalStatus;
    audioTracks: {
        isDefault: boolean;
        languageId: string;
        languageName: string;
        status: Transcription.Status;
        track: number;
    }[];
    avgRating: number;
    categories: string[];
    categoryPaths: { categoryId: string; fullPath: string; name: string }[];
    chapters: {
        chapters: {
            extension: string;
            imageId: string;
            time: string;
            title: string;
        }[];
    };
    closeCaptionsEnabled: boolean;
    commentsCount: number;
    customFields: Admin.CustomField[];
    description: string;
    duration: string;
    enableAutoShowChapterImages: boolean;
    enableComments: boolean;
    enableDownloads: boolean;
    enableExternalApplicationAccess: boolean;
    enableExternalViewersAccess: boolean;
    enableRatings: boolean;
    expiration: | null
    | {
        deleteOnExpiration: null
        | boolean;
        expirationDate: null | string;
        expiryRuleType: ExpiryRule;
        numberOfDays: null | number;
        ruleId: null | string;
    };
    expirationAction: null
    | ExpirationAction;
    expirationDate: null | string;
    hasAudioOnly: boolean;
    htmlDescription: string;
    id: string;
    instances: {
        id: string;
        isOriginalInstance: boolean;
        name: null | string;
        preset: { container?: string };
        size: number;
        status: LiteralString<
            | "Initialized"
            | "Transcoding"
            | "Transcoded"
            | "TranscodingFailed"
            | "Storing"
            | "Stored"
            | "StoringFailed",
        >;
        videoKey: string;
    }[];
    is360: boolean;
    isActive: boolean;
    isProcessing: boolean;
    lastViewed: string;
    linkedUrl: null
    | LinkedUrl;
    overallProgress: number;
    owner: {
        firstName: string;
        lastName: string;
        userId: string;
        userName: string;
    };
    password: null
    | string;
    publishDate:
        | null
        | `${number}${number}${number}${number}-${number}${number}-${number}${number}`;
    ratingsCount: number;
    sensitiveContent: boolean;
    source: LiteralString<
        | "Upload"
        | "Link"
        | "ScheduledEvent"
        | "Webex"
        | "Upload360"
        | "ScheduledRecording",
    >;
    sourceType: SourceType;
    status: Video.StatusEnum;
    tags: string[];
    thumbnailKey: string;
    thumbnailUrl: string;
    title: string;
    totalViews: number;
    transcodeFailed: boolean;
    type: VideoType;
    unlisted: boolean;
    uploadedBy: string;
    userTags: { displayName: string; userId: string }[];
    videoAccessControl: Video.AccessControl;
    videoConference?:
        | null
        | {
            bitrateKbps: number;
            microsoftTeamsMeetingUrl: string;
            sipAddress: string;
            sipPin: string;
            whenRecordingStarted: string;
        };
    viewerIdEnabled: boolean;
    whenModified: string;
    whenUploaded: string;
}

Properties

accessControlEntities approval approvalStatus audioTracks avgRating categories categoryPaths chapters closeCaptionsEnabled commentsCount customFields description duration enableAutoShowChapterImages enableComments enableDownloads enableExternalApplicationAccess enableExternalViewersAccess enableRatings expiration expirationAction expirationDate hasAudioOnly htmlDescription id instances is360 isActive isProcessing lastViewed linkedUrl overallProgress owner password publishDate ratingsCount sensitiveContent source sourceType status tags thumbnailKey thumbnailUrl title totalViews transcodeFailed type unlisted uploadedBy userTags videoAccessControl videoConference? viewerIdEnabled whenModified whenUploaded

Properties

accessControlEntities

accessControlEntities: Entity[]

This provides explicit rights to a User/Group/Collection with/without CanEdit access to a This is an array with properties; Name (entity name), Type (User/Group/Collection), CanEdit (true/false). If any value is invalid, it will be rejected while valid values are still associated with the

approval

approval: {
    approvalProcessId: null | string;
    approvalProcessName: null | string;
    approvalProcessReferenced: boolean;
    status: ApprovalStatus;
    stepId: null | string;
    steps: {
        approverId: string;
        approverName: string;
        status: string;
        stepId: string;
        stepName: string;
        whenRequested: string;
        whenResponded: string;
    }[];
    whenSubmittedForApproval: null
    | string;
}

approvalStatus

approvalStatus: ApprovalStatus

audioTracks

audioTracks: {
    isDefault: boolean;
    languageId: string;
    languageName: string;
    status: Transcription.Status;
    track: number;
}[]

avgRating

avgRating: number

categories

categories: string[]

An array of category IDs

categoryPaths

categoryPaths: { categoryId: string; fullPath: string; name: string }[]

An array of categories with full details (id + full path)

chapters

chapters: {
    chapters: {
        extension: string;
        imageId: string;
        time: string;
        title: string;
    }[];
}

closeCaptionsEnabled

closeCaptionsEnabled: boolean

commentsCount

commentsCount: number

customFields

customFields: Admin.CustomField[]

An array of customFields that is attached to the

description

description: string

Description in plain text

duration

duration: string

enableAutoShowChapterImages

enableAutoShowChapterImages: boolean

enableComments

enableComments: boolean

enableDownloads

enableDownloads: boolean

enableExternalApplicationAccess

enableExternalApplicationAccess: boolean

enableExternalViewersAccess

enableExternalViewersAccess: boolean

enableRatings

enableRatings: boolean

expiration

expiration:
    | null
    | {
        deleteOnExpiration: null
        | boolean;
        expirationDate: null | string;
        expiryRuleType: ExpiryRule;
        numberOfDays: null | number;
        ruleId: null | string;
    }

expirationAction

expirationAction: null | ExpirationAction

This sets action when video expires. This is an enum and can have the following values: Delete/Inactivate.

expirationDate

expirationDate: null | string

hasAudioOnly

hasAudioOnly: boolean

htmlDescription

htmlDescription: string

Description with HTML tags included

id

id: string

Video ID

instances

instances: {
    id: string;
    isOriginalInstance: boolean;
    name: null | string;
    preset: { container?: string };
    size: number;
    status: LiteralString<
        | "Initialized"
        | "Transcoding"
        | "Transcoded"
        | "TranscodingFailed"
        | "Storing"
        | "Stored"
        | "StoringFailed",
    >;
    videoKey: string;
}[]

is360

is360: boolean

isActive

isActive: boolean

if video is active or not

isProcessing

isProcessing: boolean

lastViewed

lastViewed: string

linkedUrl

linkedUrl: null | LinkedUrl

overallProgress

overallProgress: number

owner

owner: { firstName: string; lastName: string; userId: string; userName: string }

password

password: null | string

A Password for Public Video Access Control. Use this field when the videoAccessControl is set to Public. If not this field is ignored.

publishDate

publishDate:
    | null
    | `${number}${number}${number}${number}-${number}${number}-${number}${number}`

date video will be published NOTE: Must be in YYYY-MM-DD format

ratingsCount

ratingsCount: number

sensitiveContent

sensitiveContent: boolean

source

source: LiteralString<
    | "Upload"
    | "Link"
    | "ScheduledEvent"
    | "Webex"
    | "Upload360"
    | "ScheduledRecording",
>

sourceType

sourceType: SourceType

source of original video

status

status: Video.StatusEnum

This is the processing status of a

tags

tags: string[]

An array of strings that are tagged to the

thumbnailKey

thumbnailKey: string

thumbnailUrl

thumbnailUrl: string

title

title: string

Title of the video being uploaded. If title is not specified, API will use uploaded filename as the title.

totalViews

totalViews: number

transcodeFailed

transcodeFailed: boolean

type

type: VideoType

type of video - live or VOD

unlisted

unlisted: boolean

uploadedBy

uploadedBy: string

the full name of user who uploaded video

userTags

userTags: { displayName: string; userId: string }[]

videoAccessControl

videoAccessControl: Video.AccessControl

This sets access control for the This is an enum and can have the following values: Public/AllUsers/Private/Channels.

OptionalvideoConference

videoConference?:
    | null
    | {
        bitrateKbps: number;
        microsoftTeamsMeetingUrl: string;
        sipAddress: string;
        sipPin: string;
        whenRecordingStarted: string;
    }

viewerIdEnabled

viewerIdEnabled: boolean

whenModified

whenModified: string

When video was last modified (ISO Date)

whenUploaded

whenUploaded: string

when video was uploaded (ISO Date)

Settings

Member Visibility

On This Page

Properties