@ctrl/plex
    Preparing search index...

    Class Media

    Hierarchy

    • PlexObject
      • Media
    Index

    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

    • Parameters

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

      Returns Media

    Properties

    aspectRatio: number
    audioChannels: number

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

    audioCodec: string

    Audio codec used within the video (ex: ac3)

    bitrate: number

    Bitrate of the video (ex: 1624)

    duration: number

    Length of the video in milliseconds (ex: 6990483)

    has64bitOffsets: boolean

    True if video has 64 bit offsets

    height: number

    Height of the video in pixels (ex: 256)

    id: number

    Plex ID of this media item

    key: string

    plex relative url

    optimizedForStreaming: boolean
    parent?: WeakRef<any>

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

    parts: MediaPart[]
    server: PlexServer
    title?: string
    videoCodec: string
    videoFrameRate: string
    videoProfile: string
    width: number

    Width of the video in pixels

    TAG: "Media" = ...

    xml element tag

    TYPE: string = null

    xml element type

    Methods

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

      Parameters

      • cls: any

      Returns boolean

    • 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 the data for this object from this.key.

      Parameters

      • Optionalekey: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods