SourcePlayback
Defined in: core/source/iplayback.ts:276
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SourcePlayback():
SourcePlayback
Returns
Section titled “Returns”SourcePlayback
Methods
Section titled “Methods”getActionAfterPlayback()
Section titled “getActionAfterPlayback()”getActionAfterPlayback():
Promise<ActionAfterPlayback>
Defined in: core/source/iplayback.ts:482
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>
Implementation of
Section titled “Implementation of”ISourcePlayback.getActionAfterPlayback
getCuePoints()
Section titled “getCuePoints()”getCuePoints():
Promise<CuePoint[]>
Defined in: core/source/iplayback.ts:677
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[]>
Implementation of
Section titled “Implementation of”getPlaybackDuration()
Section titled “getPlaybackDuration()”getPlaybackDuration():
Promise<number>
Defined in: core/source/iplayback.ts:346
return: Promise
Gets the total playback duration of this source in seconds. Precision is up to 100ns units.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackDuration
getPlaybackEndPosition()
Section titled “getPlaybackEndPosition()”getPlaybackEndPosition():
Promise<number>
Defined in: core/source/iplayback.ts:443
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>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackEndPosition
getPlaybackPosition()
Section titled “getPlaybackPosition()”getPlaybackPosition():
Promise<number>
Defined in: core/source/iplayback.ts:307
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>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackPosition
getPlaybackStartPosition()
Section titled “getPlaybackStartPosition()”getPlaybackStartPosition():
Promise<number>
Defined in: core/source/iplayback.ts:404
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>
Implementation of
Section titled “Implementation of”ISourcePlayback.getPlaybackStartPosition
getValue()
Section titled “getValue()”getValue():
Promise<string>
Defined in: core/source/iplayback.ts:763
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>
Implementation of
Section titled “Implementation of”isAudio()
Section titled “isAudio()”isAudio():
Promise<boolean>
Defined in: core/source/iplayback.ts:725
return: Promise
Checks if this source’s file type is an audio file type.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isAutostartOnSceneLoad()
Section titled “isAutostartOnSceneLoad()”isAutostartOnSceneLoad():
Promise<boolean>
Defined in: core/source/iplayback.ts:521
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>
Implementation of
Section titled “Implementation of”ISourcePlayback.isAutostartOnSceneLoad
isForceDeinterlace()
Section titled “isForceDeinterlace()”isForceDeinterlace():
Promise<boolean>
Defined in: core/source/iplayback.ts:560
return: Promise
Checks whether Force Deinterlace is active.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isForceDeinterlace
isPlaying()
Section titled “isPlaying()”isPlaying():
Promise<boolean>
Defined in: core/source/iplayback.ts:365
return: Promise
Checks if current source is playing.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isRememberingPlaybackPosition()
Section titled “isRememberingPlaybackPosition()”isRememberingPlaybackPosition():
Promise<boolean>
Defined in: core/source/iplayback.ts:599
return: Promise
Check whether this source should retain its playback position when switching scenes.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isRememberingPlaybackPosition
isSeekable()
Section titled “isSeekable()”isSeekable():
Promise<boolean>
Defined in: core/source/iplayback.ts:288
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>
Implementation of
Section titled “Implementation of”isShowingPlaybackPosition()
Section titled “isShowingPlaybackPosition()”isShowingPlaybackPosition():
Promise<boolean>
Defined in: core/source/iplayback.ts:638
return: Promise
Checks if this source is set to display its playback position.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourcePlayback.isShowingPlaybackPosition
isVideo()
Section titled “isVideo()”isVideo():
Promise<boolean>
Defined in: core/source/iplayback.ts:744
return: Promise
Checks if this source’s file type is a video file type.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”setActionAfterPlayback()
Section titled “setActionAfterPlayback()”setActionAfterPlayback(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:501
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<SourcePlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.setActionAfterPlayback
setAutostartOnSceneLoad()
Section titled “setAutostartOnSceneLoad()”setAutostartOnSceneLoad(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:540
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<SourcePlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.setAutostartOnSceneLoad
setCuePoints()
Section titled “setCuePoints()”setCuePoints(
cuePoints):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:704
param: (value: CuePoint[])
Assign the specified array of Cue Points for this source.
Chainable.
See also: #core/CuePoint Core/CuePoint
Parameters
Section titled “Parameters”cuePoints
Section titled “cuePoints”CuePoint[]
Returns
Section titled “Returns”Promise<SourcePlayback>
Implementation of
Section titled “Implementation of”setForceDeinterlace()
Section titled “setForceDeinterlace()”setForceDeinterlace(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:579
param: (value: boolean)
Sets the Force Deinterlace setting.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<SourcePlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.setForceDeinterlace
setPlaybackEndPosition()
Section titled “setPlaybackEndPosition()”setPlaybackEndPosition(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:462
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<SourcePlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackEndPosition
setPlaybackPosition()
Section titled “setPlaybackPosition()”setPlaybackPosition(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:326
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<SourcePlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackPosition
setPlaybackStartPosition()
Section titled “setPlaybackStartPosition()”setPlaybackStartPosition(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:423
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<SourcePlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.setPlaybackStartPosition
setPlaying()
Section titled “setPlaying()”setPlaying(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:384
param: (value: boolean)
Plays (or pauses playback for) this source.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<SourcePlayback>
Implementation of
Section titled “Implementation of”setRememberingPlaybackPosition()
Section titled “setRememberingPlaybackPosition()”setRememberingPlaybackPosition(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:618
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<SourcePlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.setRememberingPlaybackPosition
setShowingPlaybackPosition()
Section titled “setShowingPlaybackPosition()”setShowingPlaybackPosition(
value):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:657
param: (value: boolean)
Sets whether this source should display its playback position.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<SourcePlayback>
Implementation of
Section titled “Implementation of”ISourcePlayback.setShowingPlaybackPosition
setValue()
Section titled “setValue()”setValue(
filename):Promise<SourcePlayback>
Defined in: core/source/iplayback.ts:783
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”filename
Section titled “filename”string
Returns
Section titled “Returns”Promise<SourcePlayback>