new PlaylistTrack(viewer, config)
A FORGE.PlaylistTrack is an object that manages the sound atached to a playlist track.
Parameters:
| Name | Type | Description |
|---|---|---|
viewer |
FORGE.Viewer | The FORGE.Viewer reference. |
config |
AudioTrackConfig | The track config object. |
- Source:
Extends
Members
(readonly) alive :boolean
Get the alive flag value of the object.
Type:
- boolean
- Inherited From:
- Source:
(readonly) className :string
Get the class name of the object.
Type:
- string
- Inherited From:
- Source:
currentTime :number
Get and set the current time of the track.
Type:
- number
- Source:
data :*
Get and set any custom data you want to associate to this object.
Type:
- *
- Inherited From:
- Source:
debug :boolean
Get and set the debug flag.
Type:
- boolean
- Inherited From:
- Source:
(readonly) decoded :boolean
Get the decoded status of the track.
Type:
- boolean
- Source:
loop :boolean
Get ans set the loop state of the track.
Type:
- boolean
- Source:
(readonly) onDestroy :FORGE.EventDispatcher
Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
- Inherited From:
- Source:
(readonly) onEnded :FORGE.EventDispatcher
Get the "onEnded" event FORGE.EventDispatcher of the track.
Type:
- Source:
(readonly) onPause :FORGE.EventDispatcher
Get the "onPause" event FORGE.EventDispatcher of the track.
Type:
- Source:
(readonly) onPlay :FORGE.EventDispatcher
Get the "onPlay" event FORGE.EventDispatcher of the track.
Type:
- Source:
(readonly) onResume :FORGE.EventDispatcher
Get the "onResume" event FORGE.EventDispatcher of the track.
Type:
- Source:
(readonly) onStop :FORGE.EventDispatcher
Get the "onStop" event FORGE.EventDispatcher of the track.
Type:
- Source:
(readonly) paused :boolean
Get the paused status of the track.
Type:
- boolean
- Source:
(readonly) playing :boolean
Get the playing status of the track.
Type:
- boolean
- Source:
(readonly) ready :boolean
Get the ready status of the track.
Type:
- boolean
- Source:
(readonly) tags :Array
Get the tags associated to this object.
Type:
- Array
- Inherited From:
- Source:
(readonly) uid :string
Get the uid of the object.
Type:
- string
- Inherited From:
- Source:
volume :number
Get and set the volume of the track.
Type:
- number
- Source:
warning :boolean
Get and set the warning flag.
Type:
- boolean
- Inherited From:
- Source:
Methods
destroy()
Destroy sequence
- Overrides:
- Source:
log(value)
Basic log method, log a string in the console if debug is enabled.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
* | The value you want to log in the console. |
- Inherited From:
- Source:
pause()
Pause the track.
- Source:
play()
Play the track.
- Source:
resume()
Resume the track.
- Source:
stop()
Stop the track.
- Source:
warn(valuenullable)
Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
string | Object |
<nullable> |
The value you want to warn in the console. |
- Inherited From:
- Source: