@bitmovin/api-sdk/dist/models/SceneAnalysisListItem.d.ts

Bitmovin JS/TS API SDK

/**
 * @export
 * @class SceneAnalysisListItem
 */
export declare class SceneAnalysisListItem {
    /**
     * AI scene analysis ID (required)
     * @type {string}
     * @memberof SceneAnalysisListItem
     */
    id?: string;
    /**
     * ID of the associated encoding (required)
     * @type {string}
     * @memberof SceneAnalysisListItem
     */
    encodingId?: string;
    /**
     * Creation timestamp, returned as UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ (required)
     * @type {Date}
     * @memberof SceneAnalysisListItem
     */
    createdAt?: Date;
    /**
     * Analysis description. Empty when analysis metadata is unavailable (required)
     * @type {string}
     * @memberof SceneAnalysisListItem
     */
    description?: string;
    /**
     * Inferred title representing the analyzed content as a whole. If omitted or null, the title is not available.
     * @type {string}
     * @memberof SceneAnalysisListItem
     */
    title?: string;
    /**
     * Analysis keywords in their original order and casing, including duplicates. Omitted or empty when analysis metadata is unavailable; consumers must treat both representations as an empty list
     * @type {string[]}
     * @memberof SceneAnalysisListItem
     */
    keywords?: string[];
    /**
     * Number of scenes in the analysis. Zero when analysis metadata is unavailable (required)
     * @type {number}
     * @memberof SceneAnalysisListItem
     */
    sceneCount?: number;
    /**
     * Unique language codes for available translated analysis details in backend-defined deterministic order. Order and casing are returned unchanged. Omitted or empty when no translations are available; consumers must treat both representations as an empty list
     * @type {string[]}
     * @memberof SceneAnalysisListItem
     */
    outputLanguageCodes?: string[];
    constructor(obj?: Partial<SceneAnalysisListItem>);
}
export default SceneAnalysisListItem;