VideoPlaylist

Defined in: system/videoplaylist.ts:26

Special class for adding a video playlist to the stage.

Basic Usage

var XJS = require('xjs');
var VideoPlaylist = XJS.VideoPlaylist;

var vids = new VideoPlaylist(['C:\\Users\\Public\\Music\\video1.mp4',
     'C:\\Users\\Public\\Music\\video2.mp4']).addToScene();

Implements

• Addable

Constructors

Constructor

new VideoPlaylist(items): VideoPlaylist

Defined in: system/videoplaylist.ts:37

param: (files: string[])

Creates a VideoPlaylist object for several video files.

Parameters

items

string[]

Returns

VideoPlaylist

Methods

addToScene()

addToScene(value?): Promise<any>

Defined in: system/videoplaylist.ts:145

param: (value?: number | Scene)

 return: Promise<any>

Adds the prepared video playlist to the current scene by default. Accepts an optional parameter value, which when supplied, points to the scene where item will be added instead. If ready config {listenToItemAdd: true} it returns item id, else returns boolean. This function is not available to sources.

Note: There is yet no way to detect error responses for this action.

Parameters

value?

number | Scene

Returns

Promise<any>

Implementation of

Addable.addToScene

---

toXML()

toXML(): Promise<XML>

Defined in: system/videoplaylist.ts:48

return: XML

Creates an XML object with the playlist properties. This method is used internally for the addToScene method.

Returns

Promise<XML>