ISourcePlayback
Defined in: core/source/iplayback.ts:22
Methods
Section titled “Methods”getActionAfterPlayback()
Section titled “getActionAfterPlayback()”getActionAfterPlayback():
Promise<ActionAfterPlayback>
Defined in: core/source/iplayback.ts:123
return: Promise
Gets the specified action after playback for this source is done (either playback reaches the end of the video, or the specified playback end position.)
See also: #core/ActionAfterPlayback Core/ActionAfterPlayback
Returns
Section titled “Returns”Promise<ActionAfterPlayback>
getCuePoints()
Section titled “getCuePoints()”getCuePoints():
Promise<CuePoint[]>
Defined in: core/source/iplayback.ts:213
return: Promise<CuePoint[]>
Gets the set of Cue Points created for this source.
See also: #core/CuePoint Core/CuePoint
Returns
Section titled “Returns”Promise<CuePoint[]>
getPlaybackDuration()
Section titled “getPlaybackDuration()”getPlaybackDuration():
Promise<number>
Defined in: core/source/iplayback.ts:56
return: Promise
Gets the total playback duration of this source in seconds. Precision is up to 100ns units.
Returns
Section titled “Returns”Promise<number>
getPlaybackEndPosition()
Section titled “getPlaybackEndPosition()”getPlaybackEndPosition():
Promise<number>
Defined in: core/source/iplayback.ts:101
return: Promise
Gets the specified end position in seconds for this source, with precision up to 100ns. If playback reaches the end position, this source will then execute the specified action after playback (rewind, loop, etc.)
Returns
Section titled “Returns”Promise<number>
getPlaybackPosition()
Section titled “getPlaybackPosition()”getPlaybackPosition():
Promise<number>
Defined in: core/source/iplayback.ts:38
return: Promise
Gets the playback position of this source in seconds. The system can store precision up to 100ns.
Returns
Section titled “Returns”Promise<number>
getPlaybackStartPosition()
Section titled “getPlaybackStartPosition()”getPlaybackStartPosition():
Promise<number>
Defined in: core/source/iplayback.ts:81
return: Promise
Gets the specified start position in seconds for this source, with precision up to 100ns. If this source loops or is set to rewind, the playback position will return to the start position.
Returns
Section titled “Returns”Promise<number>
getValue()
Section titled “getValue()”getValue():
Promise<string|XML>
Defined in: core/source/iplayback.ts:240
return: Promise
Gets the URL path of the media file used as a source
source.getValue().then(function(value) { // Do something with the value});Returns
Section titled “Returns”Promise<string | XML>
isAudio()
Section titled “isAudio()”isAudio():
Promise<boolean>
Defined in: core/source/iplayback.ts:266
return: Promise
Checks if this source’s file type is an audio file type.
Returns
Section titled “Returns”Promise<boolean>
isAutostartOnSceneLoad()
Section titled “isAutostartOnSceneLoad()”isAutostartOnSceneLoad():
Promise<boolean>
Defined in: core/source/iplayback.ts:144
return: Promise
Checks whether this source is set to start playback when the application switches to this source’s scene.
Returns
Section titled “Returns”Promise<boolean>
isForceDeinterlace()
Section titled “isForceDeinterlace()”isForceDeinterlace():
Promise<boolean>
Defined in: core/source/iplayback.ts:161
return: Promise
Checks whether Force Deinterlace is active.
Returns
Section titled “Returns”Promise<boolean>
isPlaying()
Section titled “isPlaying()”isPlaying():
Promise<boolean>
Defined in: core/source/iplayback.ts:63
return: Promise
Checks if current source is playing.
Returns
Section titled “Returns”Promise<boolean>
isRememberingPlaybackPosition()
Section titled “isRememberingPlaybackPosition()”isRememberingPlaybackPosition():
Promise<boolean>
Defined in: core/source/iplayback.ts:178
return: Promise
Check whether this source should retain its playback position when switching scenes.
Returns
Section titled “Returns”Promise<boolean>
isSeekable()
Section titled “isSeekable()”isSeekable():
Promise<boolean>
Defined in: core/source/iplayback.ts:30
return: Promise
Determines if it is possible to move the playback position of this media source. It is possible for some video formats to not allow seeking of the playback position.
Returns
Section titled “Returns”Promise<boolean>
isShowingPlaybackPosition()
Section titled “isShowingPlaybackPosition()”isShowingPlaybackPosition():
Promise<boolean>
Defined in: core/source/iplayback.ts:195
return: Promise
Checks if this source is set to display its playback position.
Returns
Section titled “Returns”Promise<boolean>
isVideo()
Section titled “isVideo()”isVideo():
Promise<boolean>
Defined in: core/source/iplayback.ts:273
return: Promise
Checks if this source’s file type is a video file type.
Returns
Section titled “Returns”Promise<boolean>
setActionAfterPlayback()
Section titled “setActionAfterPlayback()”setActionAfterPlayback(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:136
param: (value: ActionAfterPlayback)
Sets the action to be executed on this source once playback is done (either playback reaches the end of the video, or the specified playback end position.)
Chainable.
See also: #core/ActionAfterPlayback Core/ActionAfterPlayback
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ISourcePlayback>
setAutostartOnSceneLoad()
Section titled “setAutostartOnSceneLoad()”setAutostartOnSceneLoad(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:154
param: (value: boolean)
Specifies whether this source is set to start playback when the application switches to this source’s scene.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourcePlayback>
setCuePoints()
Section titled “setCuePoints()”setCuePoints(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:224
param: (value: CuePoint[])
Assign the specified array of Cue Points for this source.
Chainable.
See also: #core/CuePoint Core/CuePoint
Parameters
Section titled “Parameters”CuePoint[]
Returns
Section titled “Returns”Promise<ISourcePlayback>
setForceDeinterlace()
Section titled “setForceDeinterlace()”setForceDeinterlace(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:170
param: (value: boolean)
Sets the Force Deinterlace setting.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourcePlayback>
setPlaybackEndPosition()
Section titled “setPlaybackEndPosition()”setPlaybackEndPosition(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:112
return: Promise
Sets the specified end position in seconds for this source, with precision up to 100ns. If playback reaches the end position, this source will then execute the specified action after playback (rewind, loop, etc.)
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ISourcePlayback>
setPlaybackPosition()
Section titled “setPlaybackPosition()”setPlaybackPosition(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:48
param: (value: number)
Sets the playback position of this source. Parameter is in seconds, up to a precision level of 100ns.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ISourcePlayback>
setPlaybackStartPosition()
Section titled “setPlaybackStartPosition()”setPlaybackStartPosition(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:92
return: Promise
Sets the specified start position in seconds for this source, with precision up to 100ns. If this source loops or is set to rewind, the playback position will return to the start position.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ISourcePlayback>
setPlaying()
Section titled “setPlaying()”setPlaying(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:72
param: (value: boolean)
Plays (or pauses playback for) this source.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourcePlayback>
setRememberingPlaybackPosition()
Section titled “setRememberingPlaybackPosition()”setRememberingPlaybackPosition(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:188
param: (value: boolean)
Sets whether this source should retain its playback position when switching scenes.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourcePlayback>
setShowingPlaybackPosition()
Section titled “setShowingPlaybackPosition()”setShowingPlaybackPosition(
value):Promise<ISourcePlayback>
Defined in: core/source/iplayback.ts:204
param: (value: boolean)
Sets whether this source should display its playback position.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourcePlayback>
setValue()
Section titled “setValue()”setValue(
value):Promise<any>
Defined in: core/source/iplayback.ts:259
param: (value: string)
return: Promise<ISourcePlayback>Set the media file to be used as source
source.setValue('C:\\SomeFolder\\SomeFile.mp4') .then(function(source) { // Promise resolves with same Source instance});Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<any>