@ctrl/plex
    Preparing search index...

    Class LyricStream

    Represents a single Lyric stream within a MediaPart.

    Hierarchy (View Summary)

    Index
    constructor
    bitrate? codec decision? default displayTitle? extendedDisplayTitle? format? id index? key? language? languageCode? languageTag? location? minLines? parent? provider? requiredBandwidths? selected? server streamType timed title? STREAMTYPE TAG TYPE
    isChildOf refresh reload
    bitrate?: number
    codec: string
    decision?: string
    default: boolean
    displayTitle?: string
    extendedDisplayTitle?: string
    format?: string

    The format of the lyric stream (ex: lrc).

    id: number
    index?: number
    key?: string

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

    language?: string
    languageCode?: string
    languageTag?: string
    location?: string
    minLines?: number

    The minimum number of lines in the (timed) lyric stream.

    parent?: WeakRef<PlexObject>

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

    provider?: string

    The provider of the lyric stream (ex: com.plexapp.agents.lyricfind).

    requiredBandwidths?: string
    selected?: boolean
    server: PlexServer
    streamType: number
    timed: boolean

    True if the lyrics are timed to the track.

    title?: string
    STREAMTYPE: number = 4
    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>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods