Class VinylGlobal

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

Hierarchy (View Summary)

VinylGlobal
- VinylAmznGlobal

Index

Constructors

Accessors

bandwidth logs network player players userAgentInfo version

Methods

Constructors

constructor

new VinylGlobal(): VinylGlobal
Returns VinylGlobal

Accessors

bandwidth

get bandwidth(): number
Returns the EWMA low estimate for the client's current bandwidth.

Returns number
- Defined in vinyl/dist/types/current/global/globalRef.d.ts:24

logs

get logs(): undefined | readonly HistoryLogItem[]
Returns undefined | readonly HistoryLogItem[]
- Defined in vinyl/dist/types/current/global/globalRef.d.ts:17

network

get network(): NetworkMetrics
Returns NetworkMetrics
- Defined in vinyl/dist/types/current/global/globalRef.d.ts:20

player

get player(): AnyRecord
Returns the first player.

Returns AnyRecord
- Defined in vinyl/dist/types/current/global/globalRef.d.ts:16

players

get players(): readonly AnyRecord[]
Returns readonly AnyRecord[]
- Defined in vinyl/dist/types/current/global/globalRef.d.ts:12

userAgentInfo

get userAgentInfo(): UserAgentInfo
Returns UserAgentInfo
- Defined in vinyl/dist/types/current/global/globalRef.d.ts:19

version

get version(): string
Returns string
- Defined in vinyl/dist/types/current/global/globalRef.d.ts:18

Methods

throwError

throwError(): void
Throws an error. Can be used to test Vinyl's uncaught error handling.

Returns void
- Defined in vinyl/dist/types/current/global/globalRef.d.ts:28