MEMBERS

autoplay :boolean

IncisorAPI.js, line 8493

Boolean determining if the PlaybackController automatically starts playing when included in a newly instantiated Construct.

Default Value:

• true

readonly duration :number

IncisorAPI.js, line 8449

The read-only length of this PlaybackController in seconds. To change the duration, adjust the 'startTime' or 'endTime' properties.

inheritedTypes :object

IncisorAPI.js, line 8435

Dictionary object listing all of the types this object is compatible with.

lazyStop :boolean

IncisorAPI.js, line 8442

Boolean flag determining if the PlaybackController will hault the next time the time reachs the endTime (or startTime if playback is a negative value). If this flag is false, the PlaybackController loops and continues playing indefinitely.

Default Value:

• false

readonly netPlaybackRate :number

IncisorAPI.js, line 8471

Read-only value denoting the net playbackRate, including the effects of this PlaybackController's SpeedControls.

pauseImmunity :PauseEvent|Array.<PauseEvent>

IncisorAPI.js, line 8479

The PauseEvent or Array of PauseEvents that this PlaybackController will be immune to. Set this parameter to [] for this PlaybackController to have no pause immunity.

Default Value:

• nc.defaultPauseImmunity

playbackRate :number

IncisorAPI.js, line 8464

Value multiplying the progression of the 'time' value. To play twice as fast use 2, for items that can play backwards, use negative values.

Default Value:

• 1

readonly playbackState :string

IncisorAPI.js, line 8457

Read-only string denoting the current playback state: 'stopped', 'paused', or 'playing'. State values are available in 'nc.constants.playbackStates'.

Default Value:

• nc.constants.playbackStates.stopped

speedControl :SpeedControl|Array.<SpeedControl>

IncisorAPI.js, line 8486

The SpeedControl or Array of SpeedControls that this PlaybackController is affected by.

Default Value:

• nc.defaultSpeedControl

type :string

IncisorAPI.js, line 8429

Type identifier.

METHODS

addLazyStopCallback(callbackOwner, callbackName, callbackArgs (opt))

IncisorAPI.js, line 8546

Adds a callback that occurs upon the next 'lazyStop', which occurs any time the time reaches the startTime or endTime while the 'lazyStop' flag is true. It should be noted that all lazyStop callbacks are consumed upon encountering a lazyStop, and would need to be-added to be triggered upon subsequent lazyStops.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the optional callback function that is triggered when a lazy stop occurs.
callbackName	string			The name of the optional callback function that is triggered when a lazy stop occurs.
callbackArgs	Array | any	<optional>		Parameters for the optional callback function that is triggered when a lazy stop occurs.

addStateChangeCallback(callbackOwner, callbackName, callbackArgs (opt))

IncisorAPI.js, line 8563

Adds a callback that occurs if/when any component of this PlaybackController has changed. This can be used to manage processes that run entirely outside of the Incisor® system by providing a callback to update said processes upon any change. A string denoting the triggering change will be passed in as the callback function's first parameter, and user-defined parameters will follow.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the optional callback function that is triggered when any component of this PlaybackController has changed.
callbackName	string			The name of the optional callback function that is triggered when any component of this PlaybackController has changed.
callbackArgs	Array | any	<optional>		Parameters for the optional callback function that is triggered when any component of this PlaybackController has changed.

addTimeUpdateCallback(callbackOwner, callbackName, callbackArgs (opt))

IncisorAPI.js, line 8529

Adds a callback that occurs any time the 'time' property is updated, which happens while this PlaybackController is playing, but also when time is set directly. The time value will be sent to this callback as its first parameter, with any user-defined args following.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function that is triggered when time is updated.
callbackName	string			The name of the callback function that is triggered when time is updated.
callbackArgs	Array | any	<optional>		Args for the callback function that is triggered when time is updated.

dispose()

IncisorAPI.js, line 8575

Removes internal Incisor® references to this PlaybackController in order to aid memory management.

pause()

IncisorAPI.js, line 8514

Changes the playbackState to "paused", and pauses the progression of the 'time' value.

play()

IncisorAPI.js, line 8500

Changes the playbackState to "playing", and begins the progression of the 'time' value. While playing, the PlaybackController automatically updates the 'time' value once every fixedUpdate.

playOnce(lazyStopCallbackOwner (opt), lazyStopCallbackName (opt), lazyStopCallbackArgs (opt))

IncisorAPI.js, line 8509

Starts playing with 'time=startTime' (or if playbackRate is negative, 'time=endTime') and sets the 'lazyStop' value to true. An optional callback function can be provided for when playbackController stops - this callback is consumed upon stopping.

Parameters:

Name	Type	Attributes	Default	Description
lazyStopCallbackOwner	object	<optional>		The object owning the optional callback function that is triggered when a lazy stop occurs.
lazyStopCallbackName	string	<optional>		The name of the optional callback function that is triggered when a lazy stop occurs.
lazyStopCallbackArgs	Array | any	<optional>		Parameters for the optional callback function that is triggered when a lazy stop occurs.

removeLazyStopCallback(callbackOwner, callbackName)

IncisorAPI.js, line 8553

Removes the given lazyStop callback.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback to be removed.
callbackName	string			The name of the callback to be removed.

removeStateChangeCallback(callbackOwner, callbackName)

IncisorAPI.js, line 8570

Removes the given stateChange callback.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback to be removed.
callbackName	string			The name of the callback to be removed.

removeTimeUpdateCallback(callbackOwner, callbackName)

IncisorAPI.js, line 8536

Removes the given timeUpdate callback.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback to be removed.
callbackName	string			The name of the callback to be removed.

stop()

IncisorAPI.js, line 8519

Changes the playbackState to "stopped" and sets the 'time' value to 'startTime'.