Class: shaka.msf.JoinGate

Constructor

new JoinGate(callback, description)

Parameters:
Name Type Description
callback shaka.msf.Utils.ObjectCallback
description string Used in log messages.
Source:

Members

callback_ :shaka.msf.Utils.ObjectCallback

Type:
Source:

description_ :string

Type:
  • string
Source:

fillEnd_ :shaka.msf.Utils.Location

The last Object the fill delivered.
Type:
Source:

held_ :Array<shaka.msf.Utils.MOQObject>

The subscription's Objects, while the fill is still running; null once it is over.
Type:
Source:

largestObject_ :shaka.msf.Utils.Location

Where the fill ends, once the SUBSCRIBE_OK has said.
Type:
Source:

progressTimeout_ :number

How long the fill may go without delivering an Object, once the timer is waiting on its progress; null before that.
Type:
  • number
Source:

started_ :boolean

Whether the fill's stream has shown up.
Type:
  • boolean
Source:

timeoutOnStart_ :number

How long to wait for the fill once its stream shows up, while the timer is still waiting for that; null otherwise.
Type:
  • number
Source:

timer_ :shaka.util.Timer

Type:
Source:

Methods

compare_(a, b) → {number}

Parameters:
Name Type Description
a shaka.msf.Utils.Location
b shaka.msf.Utils.Location
Source:
Returns:
Type
number

expect(largestObject, timeoutSeconds, startTimeoutSecondsopt)

Says what the SUBSCRIBE_OK reported as the Largest Object, which is where the fill ends, and starts waiting for it.
Parameters:
Name Type Attributes Description
largestObject shaka.msf.Utils.Location | undefined Null when nothing has been published on the track, so there is nothing to fill; undefined when the SUBSCRIBE_OK could not tell, so the fill ends only when its stream does.
timeoutSeconds number How long the fill may go without delivering an Object.
startTimeoutSeconds number <optional>
 How long to wait for the fill's stream to show up, when fillStarted() will say so; until then the timeout above does not start.
Source:

fillStarted()

Says that the fill's stream has shown up, so that the wait for it to start gives way to the wait for it to finish.
Source:

fromFill(obj)

Hands on an Object of the fill.
Parameters:
Name Type Description
obj shaka.msf.Utils.MOQObject
Source:

fromSubscription(obj)

Hands on an Object of the subscription, or holds it until the fill is over.
Parameters:
Name Type Description
obj shaka.msf.Utils.MOQObject
Source:

isFilled_(obj) → {boolean}

Parameters:
Name Type Description
obj shaka.msf.Utils.MOQObject
Source:
Returns:
Whether the fill already delivered this Object.
Type
boolean

open()

Ends the fill and hands on what the subscription delivered meanwhile.
Source:

release()

Stops handing anything on.
Source: