@ctrl/plex
    Preparing search index...

    Class MediaPart

    Hierarchy

    • PlexObject
      • MediaPart
    Index
    constructor
    accessible? audioProfile? container decision? deepAnalysisVersion? duration? exists? file? has64bitOffsets? hasThumbnail? id indexes? key optimizedForStreaming packetLength? parent? protocol? requiredBandwidths? selected? server size? streams syncItemId? syncState? videoProfile? TAG TYPE
    hasPreviewThumbnails
    audioStreams isChildOf lyricStreams refresh reload resetSelectedSubtitleStream setSelectedAudioStream setSelectedSubtitleStream subtitleStreams videoStreams

    • Parameters

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

      Returns MediaPart

    accessible?: boolean

    True if the file is readable by Plex. Only returned when checking files.

    audioProfile?: string

    Audio profile of the part (ex: lc).

    container: string
    decision?: string

    Transcode decision for this part in a playback session (ex: directplay).

    deepAnalysisVersion?: number

    Deep analysis version Plex used for this part.

    duration?: number
    exists?: boolean
    file?: string

    Local path, absent for media without a file on this server.

    has64bitOffsets?: boolean

    True if the file uses 64 bit offsets.

    hasThumbnail?: boolean

    True if the file has embedded artwork.

    id: number
    indexes?: string
    key: string

    Plex relative url, when the payload includes one.

    optimizedForStreaming: boolean
    packetLength?: number

    Packet length of the part, when Plex analyzed it.

    parent?: WeakRef<PlexObject>

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

    protocol?: string

    Streaming protocol for this part in a playback session (ex: dash).

    requiredBandwidths?: string

    Required bandwidths for streaming this part.

    selected?: boolean

    True if this part is selected in a playback session.

    server: PlexServer
    size?: number
    streams: MediaPartStream[]
    syncItemId?: string
    syncState?: string
    videoProfile?: string
    TAG: "Part" = ...

    xml element tag

    TYPE: string | null = null

    xml element type

    • get hasPreviewThumbnails(): boolean

      Returns boolean

    • Returns true if this object was built from a parent of the given class.

      Parameters

      • cls: new (...args: any[]) => PlexObject

      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
    Accessors
    Methods