Class: shaka.util.ContentSteeringManager

Constructor

new ContentSteeringManager(playerInterface)

Parameters:
Name Type Description
playerInterface shaka.extern.ManifestParser.PlayerInterface
Implements:
Source:

Members

bannedLocations_ :Map<string, number>

Type:
  • Map<string, number>
Source:

baseUris_ :Array<string>

Type:
  • Array<string>
Source:

config_ :shaka.extern.ManifestConfiguration

Type:
Source:

defaultPathwayId_ :string

Type:
  • string
Source:

lastPathwayUsed_ :string

Type:
  • string
Source:

lastTTL_ :number

Default to 5 minutes. Value in seconds.
Type:
  • number
Source:

locations_ :Map<(string|number), !Map<string, string>>

Type:
  • Map<(string|number), !Map<string, string>>
Source:

manifestType_ :string

Type:
  • string
Source:

operationManager_ :shaka.util.OperationManager

Type:
Source:

pathwayClones_ :Array<shaka.util.ContentSteeringManager.PathwayClone>

Type:
Source:

pathwayPriority_ :Array<string>

Type:
  • Array<string>
Source:

playerInterface_ :shaka.extern.ManifestParser.PlayerInterface

Type:
Source:

updateTimer_ :shaka.util.Timer

Type:
Source:

Methods

addLocation(streamId, pathwayId, uri)

Parameters:
Name Type Description
streamId string | number
pathwayId string
uri string
Source:

addQueryParams_()

Source:

banLocation(uri)

Parameters:
Name Type Description
uri string
Source:

clearPreviousLocations()

Clear the previous locations added.
Source:

configure(config)

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

destroy() → {Promise}

Request that this object be destroyed, releasing all resources and shutting down all operations. Returns a Promise which is resolved when destruction is complete. This Promise should never be rejected.
Implements:
Source:
Returns:
Type
Promise

getLocations(streamId, ignoreBaseUrlsopt) → {Array<string>}

Get the base locations ordered according the priority.
Parameters:
Name Type Attributes Default Description
streamId string | number
ignoreBaseUrls boolean <optional>
 false
Source:
Returns:
Type
Array<string>

processManifest_(manifest, finalManifestUri)

Parameters:
Name Type Description
manifest shaka.util.ContentSteeringManager.SteeringManifest
finalManifestUri string
Source:

requestInfo(uri) → {Promise}

Request the Content Steering info.
Parameters:
Name Type Description
uri string
Source:
Returns:
Type
Promise

setBaseUris(baseUrisnon-null)

Parameters:
Name Type Description
baseUris Array<string>
Source:

setDefaultPathwayId(defaultPathwayIdnullable)

Parameters:
Name Type Attributes Description
defaultPathwayId string <nullable>
Source:

setManifestType(manifestType)

Parameters:
Name Type Description
manifestType string
Source:

Type Definitions

PathwayClone

Type:
Properties:
Name Type Description
BASE-ID string
ID string
URI-REPLACEMENT Array<shaka.util.ContentSteeringManager.UriReplacement>
Source:

SteeringManifest

Contains information about the Steering Manifest
Type:
Properties:
Name Type Description
VERSION string
TTL number
RELOAD-URI string
PATHWAY-PRIORITY Array<string>
PATHWAY-CLONES Array<shaka.util.ContentSteeringManager.PathwayClone>
Source:

UriReplacement

Type:
  • {HOST: string}
Properties:
Name Type Description
HOST string
Source: