@ctrl/plex
    Preparing search index...

    Class SubtitleStream

    Represents a single Subtitle stream within a MediaPart.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    canAutoSync? codec container? forced format? headerCompression? hearingImpaired id index key language? languageCode? parent? perfectMatch? providerTitle? score? selected? server sourceKey? streamType? transient? userID? STREAMTYPE TAG TYPE

    Methods

    isChildOf refresh reload setSelected

    Constructors

    Properties

    canAutoSync?: boolean

    True if the subtitle stream can be auto synced.

    codec: string
    container?: string

    The container of the subtitle stream.

    forced: boolean

    True if this is a forced subtitle.

    format?: string

    The format of the subtitle stream (ex: srt).

    headerCompression?: string

    The header compression of the subtitle stream.

    hearingImpaired: boolean

    True if this is a hearing impaired (SDH) subtitle.

    id: number
    index: number
    key: string

    plex relative url

    language?: string
    languageCode?: string
    parent?: WeakRef<any>

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

    perfectMatch?: boolean

    True if the on-demand subtitle is a perfect match.

    providerTitle?: string

    The provider title where the on-demand subtitle is downloaded from.

    score?: number

    The match score (download count) of the on-demand subtitle.

    selected?: boolean
    server: PlexServer
    sourceKey?: string

    The source key of the on-demand subtitle.

    streamType?: number
    transient?: string

    Unknown.

    userID?: number

    The user id of the user that downloaded the on-demand subtitle.

    STREAMTYPE: number = 3
    TAG: "Stream" = ...

    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>

    • Sets this subtitle stream as the selected subtitle stream. Alias for MediaPart.setSelectedSubtitleStream.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods