@ctrl/plex
    Preparing search index...

    Class LyricStream

    Represents a single Lyric stream within a MediaPart.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    codec format? id index key language? languageCode? minLines? parent? provider? selected? server streamType? timed STREAMTYPE TAG TYPE

    Methods

    isChildOf refresh reload

    Constructors

    Properties

    codec: string
    format?: string

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

    id: number
    index: number
    key: string

    plex relative url

    language?: string
    languageCode?: string
    minLines?: number

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

    parent?: WeakRef<any>

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

    provider?: string

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

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

    True if the lyrics are timed to the track.

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods