Class: ProgramService

ProgramService


new ProgramService(player [, options])

Program Service Plugin

Parameters:
Name Type Argument Description
player Player

The Player that this class should be attached to.

options Object <optional>

The key/value store of player options.

Extends

  • videojs.Plugin

Members


currentChannelAsset

Get Current Channel Asset


currentProgram

Get Current Program


currentVOD

Get Current VOD Asset


exposure

get exposure


isProgramEvent

Is current program an event

Methods


dispose()

dispose


entitlement(value)

set or get entitlement

Parameters:
Name Type Description
value Entitlement
Returns:

Entitlement

Type
Entitlement

extractAssetMetadata(assetMetadata)

Extract title, subtitle and images from assetMetadata

Parameters:
Name Type Description
assetMetadata Object
Returns:

title, subtitle and images

Type
Object

getAssetMetadata(assetId [, callback])

get AssetMetadata

Parameters:
Name Type Argument Description
assetId string
callback function <optional>

with asset metadata


getLocalizedAssetMetadata(assetMetadata)

Get Localized Asset Metadata

Parameters:
Name Type Description
assetMetadata Object

Asset Metadata

Returns:

Localized Asset Metadata

Type
Object

getNextProgram( [callback])

Get Next Program

Parameters:
Name Type Argument Description
callback function <optional>

with next program


getPreviousProgram( [callback])

Get Previous Program

Parameters:
Name Type Argument Description
callback function <optional>

with previous program


getProgram(dateTime [, callback])

get Program

Parameters:
Name Type Argument Description
dateTime Date
callback function <optional>

with program


options(obj)

Set/Get The program service options

Parameters:
Name Type Description
obj Object
Returns:

options

Type
Object

reset()

reset


running()

Check if ProgramService is running

Returns:

ProgramService is running

Type
boolean

start()

start program service


stop()

stop program service


verifyEntitlement(program)

verifyEntitlement

Parameters:
Name Type Description
program Object

Class: ProgramService

ProgramService


new ProgramService(player [, options])

Create the ProgramService

Parameters:
Name Type Argument Description
player Player

The Player that this class should be attached to.

options Object <optional>

The key/value store of player options.

Members


currentChannelAsset

Get Current Channel Asset


currentProgram

Get Current Program


currentVOD

Get Current VOD Asset


exposure

get exposure


isProgramEvent

Is current program an event

Methods


dispose()

dispose


entitlement(value)

set or get entitlement

Parameters:
Name Type Description
value Entitlement
Returns:

Entitlement

Type
Entitlement

extractAssetMetadata(assetMetadata)

Extract title, subtitle and images from assetMetadata

Parameters:
Name Type Description
assetMetadata Object
Returns:

title, subtitle and images

Type
Object

getAssetMetadata(assetId [, callback])

get AssetMetadata

Parameters:
Name Type Argument Description
assetId string
callback function <optional>

with asset metadata


getLocalizedAssetMetadata(assetMetadata)

Get Localized Asset Metadata

Parameters:
Name Type Description
assetMetadata Object

Asset Metadata

Returns:

Localized Asset Metadata

Type
Object

getNextProgram( [callback])

Get Next Program

Parameters:
Name Type Argument Description
callback function <optional>

with next program


getPreviousProgram( [callback])

Get Previous Program

Parameters:
Name Type Argument Description
callback function <optional>

with previous program


getProgram(dateTime [, callback])

get Program

Parameters:
Name Type Argument Description
dateTime Date
callback function <optional>

with program


options(obj)

Set/Get The program service options

Parameters:
Name Type Description
obj Object
Returns:

options

Type
Object

reset()

reset


running()

Check if ProgramService is running

Returns:

ProgramService is running

Type
boolean

start()

start program service


stop()

stop program service


verifyEntitlement(program)

verifyEntitlement

Parameters:
Name Type Description
program Object