Class: shaka.msf.MSFTransport

Constructor

new MSFTransport(confignon-null)

Parameters:
Name Type Description
config shaka.extern.MsfManifestConfiguration
Implements:
Source:

Members

codec_ :shaka.extern.MsfCodec

Type:
Source:

config_ :shaka.extern.MsfManifestConfiguration

Type:
Source:

session_ :shaka.extern.MsfSession

Type:
Source:

sessionEnded_ :Promise.PromiseWithResolvers<string>

Resolves with the reason the MoQT session ended. A session the peer hangs up on -- one whose SETUP it rejects, say -- fails everything in flight with the same opaque WebTransport error, so the reason the session itself gives is the only useful one.
Type:
  • Promise.PromiseWithResolvers<string>
Source:

webTransport_ :WebTransport

Type:
  • WebTransport
Source:

Methods

configure(confignon-null)

Parameters:
Name Type Description
config shaka.extern.MsfManifestConfiguration
Source:

connect(uri, fingerprintnullable, authorizationTokenopt, nullable) → {Promise<!shaka.extern.MsfSession>}

Parameters:
Name Type Attributes Description
uri string
fingerprint Uint8Array <nullable>
authorizationToken string <optional>
<nullable>
Source:
Returns:
Type
Promise<!shaka.extern.MsfSession>

fetchTrack(namespace, trackName, callback) → {Promise}

Fetch a track (one-shot retrieval instead of ongoing subscription)
Parameters:
Name Type Description
namespace Array<string>
trackName string
callback shaka.msf.Utils.ObjectCallback
Source:
Returns:
Type
Promise

getCodec() → {shaka.extern.MsfCodec}

The primitive codec of the draft that was negotiated, or null before a connection has been made. Packagings need it to read the MoQT-encoded fields their objects carry.
Source:
Returns:
Type
shaka.extern.MsfCodec

getConfiguration() → {shaka.extern.MsfManifestConfiguration}

Source:
Returns:
Type
shaka.extern.MsfManifestConfiguration

open_(uri, optionsnon-null, protocolsnon-null) → {Promise<!WebTransport>}

Opens a WebTransport connection offering the given subprotocols, and resolves once it is ready.
Parameters:
Name Type Description
uri string
options Object The connection options, minus the subprotocols.
protocols Array<string>
Source:
Returns:
Type
Promise<!WebTransport>

registerPublishNamespaceCallback(callback) → {function()}

Register a callback to be notified when a PublishNamespace message is received.
Parameters:
Name Type Description
callback function(Array<string>)
Source:
Returns:
A function to unregister the callback
Type
function()

release()

Request that this object release all internal references.
Implements:
Source:

subscribeTrack(namespace, trackName, callback, startLocationopt, nullable) → {Promise<bigint>}

Subscribe to a track by namespace and track name
Parameters:
Name Type Attributes Description
namespace Array<string>
trackName string
callback shaka.msf.Utils.ObjectCallback
startLocation shaka.msf.Utils.Location <optional>
<nullable>
 Where delivery should begin, for a subscription that is not meant to start at the live edge.
Source:
Returns:
Type
Promise<bigint>

unsubscribeTrack(trackAlias) → {Promise}

Unsubscribe from a track by track alias
Parameters:
Name Type Description
trackAlias bigint
Source:
Returns:
Type
Promise

waitForSessionEnd() → {Promise<string>}

Resolves with the reason the MoQT session ended, and stays pending while it is alive.
Source:
Returns:
Type
Promise<string>

watchForSessionEnd_(webTransportnon-null)

Parameters:
Name Type Description
webTransport WebTransport
Source: