Interface SignageAIImage

One candidate produced by a job. Slots are null in SignageAIJob.images until the candidate for that slot lands

interface SignageAIImage {
    bytes: number;
    height: null | number;
    index: number;
    item_id?: string;
    mime: string;
    state: string;
    upload_id: string;
    url: string;
    width: null | number;
}

Properties

bytes height index item_id? mime state upload_id url width

Properties

bytes

bytes: number

Size of the stored image in bytes

height

height: null | number

Height of the image in pixels, when it could be read

index

index: number

Position of the candidate in the job's image list

Optionalitem_id

item_id?: string

ID of the media item the candidate was kept as. Set by claiming the image

mime

mime: string

Content type of the stored image

state

state: string

State of the candidate

upload_id

upload_id: string

ID of the upload holding the image

url

url: string

Endpoint returning a signed URL for the image

width

width: null | number

Width of the image in pixels, when it could be read

Settings

Member Visibility

On This Page

Properties