@ctrl/plex
    Preparing search index...

    Class AudioStream

    Represents a single Audio stream within a MediaPart.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    albumGain? albumPeak? albumRange? audioChannelLayout? bitDepth? bitrateMode? channels? codec duration? endRamp? gain? id index key language? languageCode? loudness? lra? parent? peak? profile? samplingRate? selected? server startRamp? streamIdentifier? streamType? visualImpaired STREAMTYPE TAG TYPE

    Methods

    isChildOf refresh reload setSelected

    Constructors

    Properties

    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).

    bitrateMode?: string

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

    channels?: number

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

    codec: string
    duration?: number

    The duration of audio stream in milliseconds.

    endRamp?: string

    The end ramp for the track.

    gain?: number

    The gain for the track.

    id: number
    index: number
    key: string

    plex relative url

    language?: string
    languageCode?: string
    loudness?: number

    The loudness for the track.

    lra?: number

    The lra for the track.

    parent?: WeakRef<any>

    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.

    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
    visualImpaired: boolean

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

    STREAMTYPE: number = 2
    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 audio stream as the selected audio stream. Alias for MediaPart.setSelectedAudioStream.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods