Vinyl
    Preparing search index...

    Class VinylAmznGlobal

    For console debugging, gives access to currently active players, logs, and client information.

    Extended global state from Vinyl Global.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    bandwidth logs network player players userAgentInfo version vinylAmznVersion

    Methods

    throwError

    Constructors

    Accessors

    • get bandwidth(): number

      Returns the EWMA low estimate for the client's current bandwidth.

      Returns number

    • get logs(): undefined | readonly HistoryLogItem[]

      Returns undefined | readonly HistoryLogItem[]

    • get network(): NetworkMetrics

      Returns NetworkMetrics

    • get player(): AnyRecord

      Returns the first player.

      Returns AnyRecord

    • get players(): readonly AnyRecord[]

      Returns readonly AnyRecord[]

    • get userAgentInfo(): UserAgentInfo

      Returns UserAgentInfo

    • get version(): string

      Returns string

    • get vinylAmznVersion(): string

      Returns string

    Methods

    • Throws an error. Can be used to test Vinyl's uncaught error handling.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods