View on GitHub

Library API Documentation

Documentation for Library API Packages

Library Core / types/dto / MediaCatalogItemDTO

Interface: MediaCatalogItemDTO

types/dto.MediaCatalogItemDTO

Table of contents

Properties

Properties

doc

doc: string | number

Either the docID or pubSymbol depending on the kind of media.

Defined in

types/dto.d.ts:139


duration

duration: number

Duration in seconds. Also includes millisecond precision.

Defined in

types/dto.d.ts:172


format

format: "VIDEO" | "AUDIO"

Either 'VIDEO' or 'AUDIO'.

Defined in

types/dto.d.ts:160


id

id: string

A unique id for this item among all languages.

Defined in

types/dto.d.ts:135


image

image: string

A URL of the highest quality image for this media.

Defined in

types/dto.d.ts:176


imageSqr

imageSqr: string

A URL of the highest quality square image for this media.

Defined in

types/dto.d.ts:180


issue

Optional issue: string

An optional issue, this is a similar format to other instances of issue just shorter.

example // equivalent video.issue: 20210500 detail.issueDate: ‘202105’

// equivalent missing issue video.issue: 0 detail.issueDate: undefined

Defined in

types/dto.d.ts:156


key

key: string

The primaryCategory which correlates to key in other areas.

Defined in

types/dto.d.ts:164


languageAgnosticId

languageAgnosticId: string

An id that can be used to identify the same item in a different language’s media catalog.

Defined in

types/dto.d.ts:131


title

title: string

The displayed title for this media.

Defined in

types/dto.d.ts:168


track

track: number

The track number.

Defined in

types/dto.d.ts:143