Class Media

Hierarchy

  • PlexObject
    • Media

Constructors

constructor

Properties

aspectRatio audioChannels audioCodec bitrate duration has64bitOffsets height id key optimizedForStreaming parent? parts server title? videoCodec videoFrameRate videoProfile width TAG TYPE

Methods

isChildOf refresh reload

Constructors

constructor

  • new Media(server, data, initpath?, parent?): Media

  • Parameters

    • server: PlexServer
    • data: any
    • Optionalinitpath: string
    • Optionalparent: PlexObject

    Returns Media

Properties

aspectRatio

aspectRatio: number

audioChannels

audioChannels: number

Number of audio channels for this video (ex: 6)

audioCodec

audioCodec: string

Audio codec used within the video (ex: ac3)

bitrate

bitrate: number

Bitrate of the video (ex: 1624)

duration

duration: number

Length of the video in milliseconds (ex: 6990483)

has64bitOffsets

has64bitOffsets: boolean

True if video has 64 bit offsets

height

height: number

Height of the video in pixels (ex: 256)

id

id: number

Plex ID of this media item

key

key: string

plex relative url

optimizedForStreaming

optimizedForStreaming: boolean

Optional Readonlyparent

parent?: WeakRef<any>

WeakRef to the parent object that this object is built from.

parts

parts: MediaPart[]

Readonlyserver

server: PlexServer

Optionaltitle

title?: string

videoCodec

videoCodec: string

videoFrameRate

videoFrameRate: string

videoProfile

videoProfile: string

width

width: number

Width of the video in pixels

StaticTAG

TAG: "Media" = ...

xml element tag

StaticTYPE

TYPE: string = null

xml element type

Methods

isChildOf

  • isChildOf(cls): boolean

  • Returns True if this object is a child of the given class.

    Parameters

    • cls: any

    Returns boolean

refresh

  • refresh(): Promise<void>

  • Refreshing a Library or individual item causes the metadata for the item to be refreshed, even if it already has metadata. You can think of refreshing as "update metadata for the requested item even if it already has some". You should refresh a Library or individual item if:

    Returns Promise<void>

reload

  • reload(ekey?): Promise<void>

  • Reload the data for this object from this.key.

    Parameters

    • Optionalekey: string

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods