Skip to Content
PublisherPlayerAPI ReferenceIntegration APIInterfacesSourceMediaItemDrm

title: SourceMediaItemDrm

Interface: SourceMediaItemDrm

Extends

interface SourceMediaItemDrm {    drmSystem: DrmSystem;    licenseUrl: string;    src: string;    certificateUrl?: string;    duration?: number;    id?: string;    liveEdgeOnly?: boolean;    mimetype?: Mimetype;    playbackMode?: PlaybackMode;    token?: string;    userTier?: UserTier;    validUntil?: number;    wasExpiredAtLoad?: boolean;}

Properties

drmSystem

drmSystem: DrmSystem

The DRM system this source requires.

licenseUrl

licenseUrl: string

License server URL for the selected DRM system.

src

src: string

The source URL of this media source.

Inherited from

SourceMediaItemBase.src

certificateUrl?

optional certificateUrl: string

Certificate URL (relevant for FairPlay).

duration?

optional duration: number

Duration in seconds. Only relevant for dynamic content.

Inherited from

SourceMediaItemBase.duration

id?

optional id: string

Unique identifier of the media source.

Default Value

V1StGXR8_Z5jdHi6B-myT a generated identifier

Inherited from

SourceMediaItemBase.id

liveEdgeOnly?

optional liveEdgeOnly: boolean

When true, playback must always remain at the live edge. Seeking behind the live edge is not permitted.

Default Value

undefined (treated as false — timeshift / seek-back is allowed)

Inherited from

SourceMediaItemBase.liveEdgeOnly

mimetype?

optional mimetype: Mimetype

Mimetype of the media source.

Default Value

detected from file extension of given src or undefined

Inherited from

SourceMediaItemBase.mimetype

playbackMode?

optional playbackMode: PlaybackMode

Playback mode of the media source (e.g. determines VOD or Live).

Default Value

PlaybackMode.VOD

Inherited from

SourceMediaItemBase.playbackMode

token?

optional token: string

DRM token to include in license requests for the selected DRM system.

userTier?

optional userTier: UserTier

Classification of the user’s access level for this source.

Default Value

undefined (user tier is unknown or not applicable)

Inherited from

SourceMediaItemBase.userTier

validUntil?

optional validUntil: number

Until the media source is valid. Unix timestamp in milliseconds.

Inherited from

SourceMediaItemBase.validUntil

wasExpiredAtLoad?

optional wasExpiredAtLoad: boolean

true when this source’s signed token was already expired when resolved. Used to skip the expiry reload, which would otherwise re-resolve the same dead token in a loop. Re-derived on every resolve.

Inherited from

SourceMediaItemBase.wasExpiredAtLoad

SourceMediaItemBaseSourceMediaItemWithToken