import StreamController from 'hls.js/src/controller/stream-controller.js'

public class | source

StreamController

Extends:

EventHandler → TaskLoop → StreamController

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	altAudio: boolean
public	appended: boolean
public	audioCodecSwap: boolean
public	audioCodecSwitch: *
public	bitrateTest: boolean
public	config: *
public get	currentLevel: *
public	demuxer: *
public	forceStartLoad: boolean
public	fragCurrent: *
public	fragLastKbps: *
public	fragLoadError: number
public	fragPlaying: *
public	fragPrevious: *
public	fragmentTracker: *
public	immediateSwitch: boolean
public	lastCurrentTime: *
public	level: *
public	levelLastLoaded: *
public	levels: *
public set	liveSyncPosition
public get	liveSyncPosition: *
public	loadedmetadata: boolean
public	media: *
public	mediaBuffer: *
public get	nextBufferedFrag: *
public get	nextLevel: *
public	nextLoadPosition: *
public	nudgeRetry: number
public	onvended: *
public	onvseeked: *
public	onvseeking: *
public	pendingBuffering: boolean
public	previouslyPaused: *
public	retryDate: *
public	stallReported: boolean
public	stalled: boolean
public	startFragRequested: boolean
public	startPosition: *
public set	state
public get	state: *
public	stats: *
public	videoBuffer: *

Private Members
private	_liveSyncPosition: *
private	_state: *

Method Summary

Public Methods
public	computeLivePosition(sliding: , levelDetails: ): *
public	doTick()
public	flushMainBuffer(startOffset: , endOffset: )
public	followingBufferedFrag(frag: ):
public	getBufferedFrag(position: ):
public	immediateLevelSwitch()
public	immediateLevelSwitchEnd() on immediate level switch end, after new fragment has been buffered: nudge video decoder by slightly adjusting video currentTime (if currentTime buffered) resume the playback if needed
public	nextLevelSwitch() try to switch ASAP without breaking video playback: in order to ensure smooth but quick level switching, we need to find the next flushable buffer range we should take into account new segment fetch time
public	onAudioTrackSwitched(data: *)
public	onAudioTrackSwitching(data: *)
public	onBufferAppended(data: *)
public	onBufferCreated(data: *)
public	onBufferFlushed()
public	onError(data: *)
public	onFragLoadEmergencyAborted()
public	onFragLoaded(data: *)
public	onFragParsed(data: *)
public	onFragParsingData(data: *)
public	onFragParsingInitSegment(data: *)
public	onHandlerDestroyed()
public	onHandlerDestroying()
public	onKeyLoaded()
public	onLevelLoaded(data: *)
public	onManifestLoading()
public	onManifestParsed(data: *)
public	onMediaAttached(data: *)
public	onMediaDetaching()
public	onMediaEnded()
public	onMediaSeeked()
public	onMediaSeeking()
public	startLoad(startPosition: *)
public	stopLoad()
public	swapAudioCodec()

Private Methods
private	_checkAppendedParsed()
private	_checkBuffer() Checks the health of the buffer and attempts to resolve playback stalls.
private	_checkFragmentChanged()
private	_doTickIdle()
private	_ensureFragmentAtLivePoint(levelDetails: , bufferEnd: , start: , end: , fragPrevious: , fragments: , fragLen: ):
private	_fetchPayloadOrEos(pos: , bufferInfo: , levelDetails: *)
private	_findFragment(start: , fragPrevious: , fragLen: , fragments: , bufferEnd: , end: , levelDetails: ):
private	_loadFragment(frag: *)
private	_loadKey(frag: *)
private	_reduceMaxBufferLength(minLength: *): boolean
private	_reportStall(bufferLen: *) Triggers a BUFFER_STALLED_ERROR event, but only once per stall period.
private	_seekToStartPos() Seeks to the set startPosition if not equal to the mediaElement's current time.
private	_tryFixBufferStall(bufferInfo: , stalledDuration: ) Detects and attempts to fix known buffer stalling issues.
private	_tryNudgeBuffer() Attempts to fix buffer stalls by advancing the mediaElement's current time by a small amount.
private	_trySkipBufferHole(partial: *) Attempts to fix buffer stalls by jumping over known gaps caused by partial fragments

Inherited Summary

From class EventHandler
public	handledEvents: *
public	hls: *
public	useGenericHandler: boolean
public	destroy()
public	isEventHandler(): *
public	onEvent(event: , data: ) arguments: event (string), data (any)
public	onEventGeneric(event: , data: )
public	onHandlerDestroyed()
public	onHandlerDestroying()
public	registerListeners()
public	unregisterListeners()

From class TaskLoop
private	_boundTick: *
private	_tickCallCount: number
private	_tickInterval: *
private	_tickTimer: *
public	clearInterval(): boolean
public	clearNextTick(): boolean
public abstract	doTick() For subclass to implement task logic
public	hasInterval(): boolean
public	hasNextTick(): boolean
public	onHandlerDestroying()
public	setInterval(millis: number): boolean
public	tick() Will call the subclass doTick implementation in this main loop tick or in the next one (via setTimeout(,0)) in case it has already been called in this tick (in case this is a re-entrant call).

Public Constructors

public constructor() source

Override:

TaskLoop#constructor

Public Members

public altAudio: boolean source

public appended: boolean source

public audioCodecSwap: boolean source

public audioCodecSwitch: * source

public bitrateTest: boolean source

public config: * source

public get currentLevel: * source

public demuxer: * source

public forceStartLoad: boolean source

public fragCurrent: * source

public fragLastKbps: * source

public fragLoadError: number source

public fragPlaying: * source

public fragPrevious: * source

public fragmentTracker: * source

public immediateSwitch: boolean source

public lastCurrentTime: * source

public level: * source

public levelLastLoaded: * source

public levels: * source

public set liveSyncPosition source

public get liveSyncPosition: * source

public loadedmetadata: boolean source

public media: * source

public mediaBuffer: * source

public get nextBufferedFrag: * source

public get nextLevel: * source

public nextLoadPosition: * source

public nudgeRetry: number source

public onvended: * source

public onvseeked: * source

public onvseeking: * source

public pendingBuffering: boolean source

public previouslyPaused: * source

public retryDate: * source

public stallReported: boolean source

public stalled: boolean source

public startFragRequested: boolean source

public startPosition: * source

public set state source

public get state: * source

public stats: * source

public videoBuffer: * source

Private Members

private _liveSyncPosition: * source

private _state: * source

Public Methods

public computeLivePosition(sliding: , levelDetails: ): * source

Params:

Name	Type	Attribute	Description
sliding	*
levelDetails	*

Return:

public doTick() source

For subclass to implement task logic

Override:

TaskLoop#doTick

public flushMainBuffer(startOffset: , endOffset: ) source

Params:

Name	Type	Attribute	Description
startOffset	*
endOffset	*

public followingBufferedFrag(frag: ): source

Params:

Name	Type	Attribute	Description
frag	*

Return:

public getBufferedFrag(position: ): source

Params:

Name	Type	Attribute	Description
position	*

Return:

public immediateLevelSwitch() source

public immediateLevelSwitchEnd() source

on immediate level switch end, after new fragment has been buffered:

nudge video decoder by slightly adjusting video currentTime (if currentTime buffered)
resume the playback if needed

public nextLevelSwitch() source

try to switch ASAP without breaking video playback: in order to ensure smooth but quick level switching, we need to find the next flushable buffer range we should take into account new segment fetch time

public onAudioTrackSwitched(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onAudioTrackSwitching(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onBufferAppended(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onBufferCreated(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onBufferFlushed() source

public onError(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onFragLoadEmergencyAborted() source

public onFragLoaded(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onFragParsed(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onFragParsingData(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onFragParsingInitSegment(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onHandlerDestroyed() source

Override:

EventHandler#onHandlerDestroyed

public onHandlerDestroying() source

Override:

TaskLoop#onHandlerDestroying

public onKeyLoaded() source

public onLevelLoaded(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onManifestLoading() source

public onManifestParsed(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onMediaAttached(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onMediaDetaching() source

public onMediaEnded() source

public onMediaSeeked() source

public onMediaSeeking() source

public startLoad(startPosition: *) source

Params:

Name	Type	Attribute	Description
startPosition	*

public stopLoad() source

public swapAudioCodec() source

Private Methods

private _checkAppendedParsed() source

private _checkBuffer() source

Checks the health of the buffer and attempts to resolve playback stalls.

private _checkFragmentChanged() source

private _doTickIdle() source

private _ensureFragmentAtLivePoint(levelDetails: , bufferEnd: , start: , end: , fragPrevious: , fragments: , fragLen: ): source

Params:

Name	Type	Attribute	Description
levelDetails	*
bufferEnd	*
start	*
end	*
fragPrevious	*
fragments	*
fragLen	*

Return:

private _fetchPayloadOrEos(pos: , bufferInfo: , levelDetails: *) source

Params:

Name	Type	Attribute	Description
pos	*
bufferInfo	*
levelDetails	*

private _findFragment(start: , fragPrevious: , fragLen: , fragments: , bufferEnd: , end: , levelDetails: ): source

Params:

Name	Type	Attribute	Description
start	*
fragPrevious	*
fragLen	*
fragments	*
bufferEnd	*
end	*
levelDetails	*

Return:

private _loadFragment(frag: *) source

Params:

Name	Type	Attribute	Description
frag	*

private _loadKey(frag: *) source

Params:

Name	Type	Attribute	Description
frag	*

private _reduceMaxBufferLength(minLength: *): boolean source

Params:

Name	Type	Attribute	Description
minLength	*

Return:

boolean

private _reportStall(bufferLen: *) source

Triggers a BUFFER_STALLED_ERROR event, but only once per stall period.

Params:

Name	Type	Attribute	Description
bufferLen	*		The playhead distance from the end of the current buffer segment.

private _seekToStartPos() source

Seeks to the set startPosition if not equal to the mediaElement's current time.

private _tryFixBufferStall(bufferInfo: , stalledDuration: ) source

Detects and attempts to fix known buffer stalling issues.

Params:

Name	Type	Attribute	Description
bufferInfo	*		The properties of the current buffer.
stalledDuration	*		The amount of time Hls.js has been stalling for.

private _tryNudgeBuffer() source

Attempts to fix buffer stalls by advancing the mediaElement's current time by a small amount.

private _trySkipBufferHole(partial: *) source

Attempts to fix buffer stalls by jumping over known gaps caused by partial fragments

Params:

Name	Type	Attribute	Description
partial	*		The partial fragment found at the current time (where playback is stalling).

StreamController

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public altAudio: boolean source

public appended: boolean source

public audioCodecSwap: boolean source

public audioCodecSwitch: * source

public bitrateTest: boolean source

public config: * source

public get currentLevel: * source

public demuxer: * source

public forceStartLoad: boolean source

public fragCurrent: * source

public fragLastKbps: * source

public fragLoadError: number source

public fragPlaying: * source

public fragPrevious: * source

public fragmentTracker: * source

public immediateSwitch: boolean source

public lastCurrentTime: * source

public level: * source

public levelLastLoaded: * source

public levels: * source

public set liveSyncPosition source

public get liveSyncPosition: * source

public loadedmetadata: boolean source

public media: * source

public mediaBuffer: * source

public get nextBufferedFrag: * source

public get nextLevel: * source

public nextLoadPosition: * source

public nudgeRetry: number source

public onvended: * source

public onvseeked: * source

public onvseeking: * source

public pendingBuffering: boolean source

public previouslyPaused: * source

public retryDate: * source

public stallReported: boolean source

public stalled: boolean source

public startFragRequested: boolean source

public startPosition: * source

public set state source

public get state: * source

public stats: * source

public videoBuffer: * source

Private Members

private _liveSyncPosition: * source

private _state: * source

Public Methods

public computeLivePosition(sliding: *, levelDetails: *): * source

Params:

Return:

public doTick() source

Override:

public flushMainBuffer(startOffset: *, endOffset: *) source

Params:

public followingBufferedFrag(frag: *): * source

Params:

Return:

public getBufferedFrag(position: *): * source

Params:

Return:

public immediateLevelSwitch() source

public immediateLevelSwitchEnd() source

public nextLevelSwitch() source

public onAudioTrackSwitched(data: *) source

Params:

public onAudioTrackSwitching(data: *) source

Params:

public onBufferAppended(data: *) source

Params:

public onBufferCreated(data: *) source

public computeLivePosition(sliding: , levelDetails: ): * source

public flushMainBuffer(startOffset: , endOffset: ) source

public followingBufferedFrag(frag: ): source

public getBufferedFrag(position: ): source

private _ensureFragmentAtLivePoint(levelDetails: , bufferEnd: , start: , end: , fragPrevious: , fragments: , fragLen: ): source

private _fetchPayloadOrEos(pos: , bufferInfo: , levelDetails: *) source

private _findFragment(start: , fragPrevious: , fragLen: , fragments: , bufferEnd: , end: , levelDetails: ): source

private _tryFixBufferStall(bufferInfo: , stalledDuration: ) source