@ctrl/plex
    Preparing search index...

    Class AudioStream

    Represents a single Audio stream within a MediaPart.

    Hierarchy (View Summary)

    Index
    constructor
    albumGain? albumPeak? albumRange? audioChannelLayout? bitDepth? bitrate? bitrateMode? canNormalizeLoudness channels? codec decision? default displayTitle? duration? endRamp? extendedDisplayTitle? gain? gainOffset? id index? key? language? languageCode? languageTag? location? loudness? loudnessAnalysisVersion? lra? parent? peak? profile? requiredBandwidths? samplingRate? selected? server startRamp? streamIdentifier? streamType threshold? title? visualImpaired STREAMTYPE TAG TYPE
    isChildOf levels refresh reload setSelected
    albumGain?: number

    The gain for the album.

    albumPeak?: number

    The peak for the album.

    albumRange?: number

    The range for the album.

    audioChannelLayout?: string

    The audio channel layout of the audio stream (ex: 5.1(side)).

    bitDepth?: number

    The bit depth of the audio stream (ex: 16).

    bitrate?: number
    bitrateMode?: string

    The bitrate mode of the audio stream (ex: cbr).

    canNormalizeLoudness: boolean

    True if the audio stream can be normalized for loudness.

    channels?: number

    The number of audio channels of the audio stream (ex: 6).

    codec: string
    decision?: string
    default: boolean
    displayTitle?: string
    duration?: number

    The duration of audio stream in milliseconds.

    endRamp?: string

    The end ramp for the track.

    extendedDisplayTitle?: string
    gain?: number

    The gain for the track.

    gainOffset?: number

    The gain offset of the audio stream.

    id: number
    index?: number
    key?: string

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

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

    The loudness for the track.

    loudnessAnalysisVersion?: number

    The loudness analysis version of the audio stream.

    lra?: number

    The lra for the track.

    parent?: WeakRef<PlexObject>

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

    peak?: number

    The peak for the track.

    profile?: string

    The profile of the audio stream.

    requiredBandwidths?: string
    samplingRate?: number

    The sampling rate of the audio stream (ex: 48000)

    selected?: boolean
    server: PlexServer
    startRamp?: string

    The start ramp for the track.

    streamIdentifier?: number

    The stream identifier of the audio stream.

    streamType: number
    threshold?: number

    The loudness threshold of the audio stream.

    title?: string
    visualImpaired: boolean

    True if this is a visually impaired (AD) audio stream.

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