@ctrl/plex
    Preparing search index...

    Class Optimized

    A Plex optimized-media group and its conversion status.

    Hierarchy

    • PlexObject
      • Optimized
    Index
    constructor
    composite device id key location mediaSettings parent? policy server status target targetTagID? title type TAG TYPE
    isChildOf items refresh reload remove rename reprocess

    • Parameters

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

      Returns Optimized

    composite: string
    device: OptimizationDevice
    id: number
    key: string

    Plex relative url, when the payload includes one.

    location: OptimizationLocation
    mediaSettings: OptimizationMediaSettings
    parent?: WeakRef<PlexObject>

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

    policy: OptimizationPolicy
    server: PlexServer
    status: OptimizationStatus
    target: string
    targetTagID?: number
    title: string
    type: 42 = ...
    TAG: string = 'Item'

    xml element tag

    TYPE: string | null = null

    xml element type

    • 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>

    • Remove this optimized group and its generated media.

      Returns Promise<void>

    • Re-enable processing for a removed member that remains in this optimized group.

      Parameters

      • ratingKey: string | number

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods