new SabrStream(config): SabrStream

Defined in: src/core/SabrStream.ts:130

Parameters

config

SabrStreamConfig

Returns

SabrStream

Overrides

EventEmitterLike.constructor

Accessors

isLive

Get Signature

get isLive(): boolean

Defined in: src/core/SabrStream.ts:155

Returns

boolean

isBusy

Get Signature

get isBusy(): boolean

Defined in: src/core/SabrStream.ts:159

Returns

boolean

isAborted

Get Signature

get isAborted(): boolean

Defined in: src/core/SabrStream.ts:163

Returns

boolean

isErrored

Get Signature

get isErrored(): boolean

Defined in: src/core/SabrStream.ts:167

Returns

boolean

videoEndTimeMs

Get Signature

get videoEndTimeMs(): number

Defined in: src/core/SabrStream.ts:171

Returns

number

audioEndTimeMs

Get Signature

get audioEndTimeMs(): number

Defined in: src/core/SabrStream.ts:175

Returns

number

livePlaybackLatencyMs

Get Signature

get livePlaybackLatencyMs(): number | undefined

Defined in: src/core/SabrStream.ts:179

Returns

number | undefined

streamingURL

Get Signature

get streamingURL(): URL

Defined in: src/core/SabrStream.ts:184

Returns

URL

Methods

setStreamingURL()

setStreamingURL(url): void

Defined in: src/core/SabrStream.ts:189

Parameters

url

string | URL

Returns

void

setUstreamerConfig()

setUstreamerConfig(config): void

Defined in: src/core/SabrStream.ts:195

Parameters

config

string

Returns

void

waitForIdle()

waitForIdle(): Promise<void>

Defined in: src/core/SabrStream.ts:199

Returns

Promise<void>

snapshot()

snapshot(): Promise<SabrSnapshot>

Defined in: src/core/SabrStream.ts:205

Returns

Promise<SabrSnapshot>

abort()

abort(options): Promise<SabrSnapshot | undefined>

Defined in: src/core/SabrStream.ts:213

Parameters

options

AbortOptions = {}

Returns

Promise<SabrSnapshot | undefined>

start()

start(options): StreamStartResult

Defined in: src/core/SabrStream.ts:230

Parameters

options

SabrPlaybackOptions

Returns

StreamStartResult

emit()

emit<K>(type, ...args): void

Defined in: src/utils/EventEmitterLike.ts:7

Type Parameters

K

K extends keyof SabrStreamEvents

Parameters

type

K

args

...Parameters<SabrStreamEvents[K]>

Returns

void

Inherited from

EventEmitterLike.emit

on()

on<K>(type, listener): void

Defined in: src/utils/EventEmitterLike.ts:17

Type Parameters

K

K extends keyof SabrStreamEvents

Parameters

type

K

listener

SabrStreamEvents[K]

Returns

void

Inherited from

EventEmitterLike.on

once()

once<K>(type, listener): void

Defined in: src/utils/EventEmitterLike.ts:28

Type Parameters

K

K extends keyof SabrStreamEvents

Parameters

type

K

listener

SabrStreamEvents[K]

Returns

void

Inherited from

EventEmitterLike.once

off()

off<K>(type, listener): void

Defined in: src/utils/EventEmitterLike.ts:45

Type Parameters

K

K extends keyof SabrStreamEvents

Parameters

type

K

listener

SabrStreamEvents[K]

Returns

void

Inherited from

EventEmitterLike.off

removeAllListeners()

removeAllListeners(type?): void

Defined in: src/utils/EventEmitterLike.ts:70

Parameters

type?

keyof SabrStreamEvents

Returns

void

Inherited from

EventEmitterLike.removeAllListeners