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

public class | source

StreamController

Extends:

src/task-loop.js~TaskLoop → BaseStreamController → StreamController

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	altAudio: boolean
public	appended: boolean
public	audioCodecSwap: boolean
public	audioCodecSwitch: *
public	audioOnly: boolean
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	gapController: *
public	immediateSwitch: boolean
public	lastCurrentTime: *
public	level: *
public	levelLastLoaded: *
public	levels: *
public get	liveSyncPosition: *
public set	liveSyncPosition
public	loadedmetadata: boolean
public	media: *
public	mediaBuffer: *
public get	nextBufferedFrag: *
public get	nextLevel: *
public	nextLoadPosition: *
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	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	onKeyLoaded()
public	onLevelLoaded(data: *)
public	onLevelsUpdated(data: *)
public	onManifestLoading()
public	onManifestParsed(data: *)
public	onMediaAttached(data: *)
public	onMediaDetaching()
public	onMediaSeeked()
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: ): *
private	_fetchPayloadOrEos(pos: , bufferInfo: , levelDetails: *)
private	_findFragment(start: , fragPreviousLoad: , fragmentIndexRange: , fragments: , bufferEnd: , end: , levelDetails: ):
private	_getAudioCodec(currentLevel: ):
private	_loadFragment(frag: , levelDetails: , pos: , bufferEnd: )
private	_loadKey(frag: , levelDetails: )
private	_reduceMaxBufferLength(minLength: *): boolean
private	_seekToStartPos() Seeks to the set startPosition if not equal to the mediaElement's current time.

Inherited Summary

From class BaseStreamController
public	demuxer: *
public	fragCurrent: *
public	fragPrevious: *
public	fragmentTracker: *
public	lastCurrentTime: *
public	nextLoadPosition: *
public	startPosition: *
public	state: *
public	computeLivePosition(sliding: , levelDetails: ): *
public	doTick()
public	onHandlerDestroyed()
public	onHandlerDestroying()
public	onMediaEnded()
public	onMediaSeeking()
public	startLoad()
public	stopLoad()
private	_streamEnded(bufferInfo: , levelDetails: ): boolean

Public Constructors

public constructor() source

Public Members

public altAudio: boolean source

public appended: boolean source

public audioCodecSwap: boolean source

public audioCodecSwitch: * source

public audioOnly: boolean source

public bitrateTest: boolean source

public config: * source

public get currentLevel: * source

public demuxer: * source

Override:

BaseStreamController#demuxer

public forceStartLoad: boolean source

public fragCurrent: * source

Override:

BaseStreamController#fragCurrent

public fragLastKbps: * source

public fragLoadError: number source

public fragPlaying: * source

public fragPrevious: * source

Override:

BaseStreamController#fragPrevious

public fragmentTracker: * source

Override:

BaseStreamController#fragmentTracker

public gapController: * source

public immediateSwitch: boolean source

public lastCurrentTime: * source

Override:

BaseStreamController#lastCurrentTime

public level: * source

public levelLastLoaded: * source

public levels: * source

public get liveSyncPosition: * source

public set liveSyncPosition source

public loadedmetadata: boolean source

public media: * source

public mediaBuffer: * source

public get nextBufferedFrag: * source

public get nextLevel: * source

public nextLoadPosition: * source

Override:

BaseStreamController#nextLoadPosition

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

Override:

BaseStreamController#startPosition

public set state source

Override:

BaseStreamController#state

public get state: * source

Override:

BaseStreamController#state

public stats: * source

public videoBuffer: * source

Private Members

private _liveSyncPosition: * source

private _state: * source

Public Methods

public doTick() source

Override:

BaseStreamController#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 onKeyLoaded() source

public onLevelLoaded(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onLevelsUpdated(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 onMediaSeeked() source

public startLoad(startPosition: *) source

Override:

BaseStreamController#startLoad

Params:

Name	Type	Attribute	Description
startPosition	*

public stopLoad() source

Override:

BaseStreamController#stopLoad

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: ): * source

Params:

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

Return:

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

Params:

Name	Type	Attribute	Description
pos	*
bufferInfo	*
levelDetails	*

private _findFragment(start: , fragPreviousLoad: , fragmentIndexRange: , fragments: , bufferEnd: , end: , levelDetails: ): source

Params:

Name	Type	Attribute	Description
start	*
fragPreviousLoad	*
fragmentIndexRange	*
fragments	*
bufferEnd	*
end	*
levelDetails	*

Return:

private _getAudioCodec(currentLevel: ): source

Params:

Name	Type	Attribute	Description
currentLevel	*

Return:

private _loadFragment(frag: , levelDetails: , pos: , bufferEnd: ) source

Params:

Name	Type	Attribute	Description
frag	*
levelDetails	*
pos	*
bufferEnd	*

private _loadKey(frag: , levelDetails: ) source

Params:

Name	Type	Attribute	Description
frag	*
levelDetails	*

private _reduceMaxBufferLength(minLength: *): boolean source

Params:

Name	Type	Attribute	Description
minLength	*

Return:

boolean

private _seekToStartPos() source

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

StreamController

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Public Members

public altAudio: boolean source

public appended: boolean source

public audioCodecSwap: boolean source

public audioCodecSwitch: * source

public audioOnly: boolean source

public bitrateTest: boolean source

public config: * source

public get currentLevel: * source

public demuxer: * source

Override:

public forceStartLoad: boolean source

public fragCurrent: * source

Override:

public fragLastKbps: * source

public fragLoadError: number source

public fragPlaying: * source

public fragPrevious: * source

Override:

public fragmentTracker: * source

Override:

public gapController: * source

public immediateSwitch: boolean source

public lastCurrentTime: * source

Override:

public level: * source

public levelLastLoaded: * source

public levels: * source

public get liveSyncPosition: * source

public set liveSyncPosition source

public loadedmetadata: boolean source

public media: * source

public mediaBuffer: * source

public get nextBufferedFrag: * source

public get nextLevel: * source

public nextLoadPosition: * source

Override:

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

Override:

public set state source

Override:

public get state: * source

Override:

public stats: * source

public videoBuffer: * source

Private Members

private _liveSyncPosition: * source

private _state: * source

Public Methods

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

public flushMainBuffer(startOffset: , endOffset: ) source

public followingBufferedFrag(frag: ): source

public getBufferedFrag(position: ): source

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

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

private _findFragment(start: , fragPreviousLoad: , fragmentIndexRange: , fragments: , bufferEnd: , end: , levelDetails: ): source

private _getAudioCodec(currentLevel: ): source

private _loadFragment(frag: , levelDetails: , pos: , bufferEnd: ) source

private _loadKey(frag: , levelDetails: ) source