@ctrl/plex
    Preparing search index...

    Class SubtitleStream

    Represents a single Subtitle stream within a MediaPart.

    Hierarchy (View Summary)

    Index
    constructor
    bitrate? canAutoSync? codec container? decision? default displayTitle? extendedDisplayTitle? forced format? headerCompression? hearingImpaired id index? key? language? languageCode? languageTag? location? parent? perfectMatch? providerTitle? requiredBandwidths? score? selected? server sourceKey? streamType title? transient? userID? STREAMTYPE TAG TYPE
    isChildOf refresh reload setSelected
    bitrate?: number
    canAutoSync?: boolean

    True if the subtitle stream can be auto synced.

    codec: string
    container?: string

    The container of the subtitle stream.

    decision?: string
    default: boolean
    displayTitle?: string
    extendedDisplayTitle?: string
    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

    Stream download path, returned for sidecar streams such as lyrics.

    language?: string
    languageCode?: string
    languageTag?: string
    location?: string
    parent?: WeakRef<PlexObject>

    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.

    requiredBandwidths?: string
    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
    title?: string
    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 = 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>

    • 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