Class Player

Class for working with player. Access via the global app.player.

Hierarchy

SharedObject
- Player

Index

Constructors

Methods

addTrackAtPos addTracksAsync analyzeWaveform clearPlaylistAsync clearUndoList doCut doOnLayoutModified getClassName getCountOfPlayedEntries getCurrentTrack getDSPModules getDefaultAction getFastCurrentTrack getIndexOfPlayingTrack getInputPlugins getNextTrack getOutputPluginFeatures getOutputPlugins getPersistentJSON getRedoList getSongList getTracklist getUndoList getVideoSettings getWaveform inputPluginConfig isMarked isPlayingTrack locked nextAsync outputPluginConfig pauseAsync playAsync playPauseAsync prepareAudioStreams prepareSubtitlesAsync prevAsync randomizePlaylistAsync redoAsync refreshStatus removeDuplicatesAsync removeNotAccessibleAsync removeSelectedTracksAsync repaintVideo reversePlaylistAsync seekMSAsync sendPlaybackCommand setAudioStream setDSPModules setMarked setOutputPlugin setPlaylistPosAsync setPlaylistPosByEntryAsync setVideoSettings stopAsync undoAsync updateSubtitlesLanguage updateSubtitlesSettings

Events

event_htmlPlaybackState event_layoutModified event_nowPlayingModified event_playbackEnd event_playbackState event_repeatChange event_seekChange event_shuffleChange event_stopAfterCurrentChange event_trackSkipped

Constructors

constructor

new Player(): Player
Returns Player

Inherited from SharedObject.constructor

Properties

asJSON

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

autoDJ

autoDJ: AutoDJSettings

Undocumented

autoResetStopAfterCurrent

autoResetStopAfterCurrent: boolean

If disabled, stop after current track flag persists for next tracks.

bitrate

bitrate: number

Returns bitrate of current track, in kbps.

channels

channels: number

Returns number of channels of current track

crossfade

crossfade: boolean

Gets/Sets whether crossfading is enabled.

entriesCount

entriesCount: number

Returns number of entries in nowplaying list.

htmlPlaybackState

htmlPlaybackState: HTMLPlaybackState

Undocumented

id

id: number

Gets integer id of the object

isPlaying

isPlaying: boolean

Returns true, if player is currently playing.

mute

mute: boolean

Mutes/unmutes volume, gets if volume is muted

normalize

normalize: boolean

Gets/Sets leveling of playback volume (normalization)

objectType

objectType: string

Gets the object type as string

panning

panning: number

Gets/Sets sound panning(balance), -1 = left, 0 - middle, 1 = right

paused

paused: boolean

Returns true, if player is currently paused

persistentID

persistentID: string

Gets persistent id of the object

playlistPos

playlistPos: number

Gets nowplaying list position, -1 = undefined, 0...n current track order. For setting use setPlaylistPosAsync or setPlaylistPosByEntryAsync.

repeatOne

repeatOne: boolean

Gets/Sets repeating current file in nowplaying list.

repeatPlaylist

repeatPlaylist: boolean

Gets/Sets repeating nowplaying list.

sampleRate

sampleRate: number

Returns sample rate of current track, in Hz.

shufflePlaylist

shufflePlaylist: boolean

Gets/Sets shuffling nowplaying list.

statusInfo

statusInfo: Promise<any>

Undocumented

stopAfterCurrentTrack

stopAfterCurrentTrack: boolean

Gets/Sets stop after current track flag.

title

title: string

Gets the object title

trackLengthMS

trackLengthMS: number

Gets current track length, in ms.

trackPositionMS

trackPositionMS: number

Gets current track playback position, in ms. For setting position use seekMSAsync.

visualization

visualization: Visualization

Gets object for managing visualization.

volume

volume: number

Gets/Sets volume, 0 = silent, 1 = maximum volume.

Methods

addTrackAtPos

addTrackAtPos(SD, position): void
Undocumented
Parameters
- SD: Track
- position: number
Returns void
- Defined in src/types/Native.ts:4331

addTracksAsync

addTracksAsync(tracks, params?): Promise<void>
Asynchronously adds given tracks to nowplaying list.

Promise is fulfilled when action is completed.
Parameters
- tracks: Track | Tracklist | StringList
- Optional params: {
      afterCurrent?: boolean;
      byAlbum?: boolean;
      focusedTrackIndex?: number;
      forcePreview?: boolean;
      mix?: boolean;
      position?: number;
      saveHistory?: boolean;
      shuffle?: boolean;
      startPlayback?: boolean;
      withClear?: boolean;
  }
  - Optional afterCurrent?: boolean
    
    if true, it places new tracks just after the currently playing track, default = false
  - Optional byAlbum?: boolean
    
    if true, it uses shuffle by album, relevant only if shuffle=true, default = false
  - Optional focusedTrackIndex?: number
    
    focused position in tracklist adding to the playing list, usable when adding whole list, but starting playback from the doubleclicked track, default = -1
  - Optional forcePreview?: boolean
    
    if true, it plays only preview of added tracks, default = false
  - Optional mix?: boolean
    
    if true, it merges randomly given tracks with tracks in playlist, default = false
  - Optional position?: number
    
    position in nowplaying list, where to place new tracks (0 = begin of the list, -1 = end of the list). Valid only if afterCurrent=false and withClear=false, default = -1
  - Optional saveHistory?: boolean
    
    if true, it adds this action to nowplaying history, default = true
  - Optional shuffle?: boolean
    
    if true, it shuffles given tracklist before it is added, default = false
  - Optional startPlayback?: boolean
    
    if true, it starts playback just after the tracks are added, default = false
  - Optional withClear?: boolean
    
    if true, it clears nowplaying list before adding tracks, default = false
Returns Promise<void>
- Defined in src/types/Native.ts:4307

analyzeWaveform

analyzeWaveform(tracks): void
Runs analyze waveform on specified tracks.
Parameters
- tracks: Tracklist
  
  Tracks to be analyzed
Returns void
- Defined in src/types/Native.ts:4534

clearPlaylistAsync

clearPlaylistAsync(saveHistory?): Promise<void>
Removes all tracks from nowplaying list
Parameters
- Optional saveHistory: boolean
  
  True, if this action should be saved to nowplaying history Promise is fulfilled when action is completed.
Returns Promise<void>
- Defined in src/types/Native.ts:4301

clearUndoList

clearUndoList(): void
Clears the playing history list.

Returns void
- Defined in src/types/Native.ts:4499

doCut

doCut(data): Promise<any>
Undocumented
Parameters
- data: Base
Returns Promise<any>
Inherited from SharedObject.doCut
- Defined in src/types/Native.ts:213

doOnLayoutModified

doOnLayoutModified(params): void
Undocumented
Parameters
- params: any
Returns void
- Defined in src/types/Native.ts:4535

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from SharedObject.getClassName
- Defined in src/types/Native.ts:198

getCountOfPlayedEntries

getCountOfPlayedEntries(): number
Gets number of nowplaying entries, which where already played.

Returns number
- Defined in src/types/Native.ts:4467

getCurrentTrack

getCurrentTrack(): Track
Gets current track

Returns Track
- Defined in src/types/Native.ts:4556

getDSPModules

getDSPModules(): PluginList
Undocumented

Returns PluginList
- Defined in src/types/Native.ts:4383

getDefaultAction

getDefaultAction(): string
Undocumented

Returns string
- Defined in src/types/Native.ts:4382

getFastCurrentTrack

getFastCurrentTrack(val): Track
Gets current track - fast version
Parameters
- val: any
  
  JS object, to be filled by current track
Returns Track
- Defined in src/types/Native.ts:4563

getIndexOfPlayingTrack

getIndexOfPlayingTrack(tracklist): number
Undocumented
Parameters
- tracklist: Tracklist
Returns number
- Defined in src/types/Native.ts:4461

getInputPlugins

getInputPlugins(): PluginList
Returns PluginList, with currently selected plugin checked.

Returns PluginList
List of input or decode BasePlugin
- Defined in src/types/Native.ts:4376

getNextTrack

getNextTrack(): Track
Gets track which would currently play next or nil, e.g. if shuffled playback

Returns Track
- Defined in src/types/Native.ts:4569

getOutputPluginFeatures

getOutputPluginFeatures(): any
Undocumented

Returns any
- Defined in src/types/Native.ts:4333

getOutputPlugins

getOutputPlugins(): PluginList
Returns PluginList, with currently active plugin checked.

Returns PluginList
List of output BasePlugin
- Defined in src/types/Native.ts:4359

getPersistentJSON

getPersistentJSON(): string
Undocumented

Returns string
Inherited from SharedObject.getPersistentJSON
- Defined in src/types/Native.ts:214

getRedoList

getRedoList(onlyFirst): StringList
Returns stringlist with short descriptions of possible redo actions.
Parameters
- onlyFirst: boolean
  
  Force to return only first redo action, if exists.
Returns StringList
List of strings - short descriptions of currently possible redo actions.
- Defined in src/types/Native.ts:4506

getSongList

getSongList(): PlaylistEntries
Gets current nowplaying list. Note that it returns PlaylistEntries class, to get Tracklist use getTracklist method instead

Returns PlaylistEntries
- Defined in src/types/Native.ts:4353

getTracklist

getTracklist(): Tracklist
Gets current playing list as Tracklist
Introduced in 5.0.4

Returns Tracklist
- Defined in src/types/Native.ts:4346

getUndoList

getUndoList(onlyFirst): StringList
Returns stringlist with short descriptions of possible undo actions.
Parameters
- onlyFirst: boolean
  
  Force to return only first undo action, if exists.
Returns StringList
List of strings - short descriptions of currently possible undo actions.
- Defined in src/types/Native.ts:4495

getVideoSettings

getVideoSettings(): any
Undocumented

Returns any
- Defined in src/types/Native.ts:4473

getWaveform

getWaveform(SD, forceUpdate): Promise<any>
Returns Waveform data for given SD
Parameters
- SD: Track
- forceUpdate: boolean
  
  If true, recomputes waveform
Returns Promise<any>
Promise is fulfilled with computed waveform data
- Defined in src/types/Native.ts:4528

inputPluginConfig

inputPluginConfig(): void
Asynchronously opens config dialog of active input plugin.

Returns void
- Defined in src/types/Native.ts:4381

isMarked

isMarked(id): boolean
Undocumented
Parameters
- id: number
Returns boolean
Inherited from SharedObject.isMarked
- Defined in src/types/Native.ts:212

isPlayingTrack

isPlayingTrack(SD): boolean
Returns true, if song SD is currently playing.
Parameters
- SD: Track
Returns boolean
- Defined in src/types/Native.ts:4460

locked

locked(func): void
Call defined method with locked data so user can access them.
Parameters
- func: (() => any)
  
  Method to call
  - - (): any
    - Returns any
Returns void
Inherited from SharedObject.locked
- Defined in src/types/Native.ts:192

nextAsync

nextAsync(checkSkip?, cannotPlayCurrent?): Promise<any>
Play next file in nowplaying list.
Parameters
- Optional checkSkip: boolean
  
  If true, then the track's last skipped and skip count will be updated.
- Optional cannotPlayCurrent: boolean
  
  Set true if there was an error playing the current track.
Returns Promise<any>
Promise is fulfilled when playback of the next track started
- Defined in src/types/Native.ts:4428

outputPluginConfig

outputPluginConfig(): void
Asynchronously opens config dialog of active output plugin.

Returns void
- Defined in src/types/Native.ts:4370

pauseAsync

pauseAsync(): Promise<any>
Pauses playback, asynchronously.

Returns Promise<any>
Promise is fulfilled when playback is paused
- Defined in src/types/Native.ts:4440

playAsync

playAsync(): Promise<any>
Starts playback, asynchronously.

Returns Promise<any>
Promise is fulfilled when playback started
- Defined in src/types/Native.ts:4414

playPauseAsync

playPauseAsync(): Promise<any>
Starts to play paused playback, or pause, if already playing, asynchronously.

Returns Promise<any>
Promise is fulfilled when playback state is changed
- Defined in src/types/Native.ts:4446

prepareAudioStreams

prepareAudioStreams(): StringList
Undocumented

Returns StringList
- Defined in src/types/Native.ts:4468

prepareSubtitlesAsync

prepareSubtitlesAsync(): Promise<any>
Undocumented

Returns Promise<any>
- Defined in src/types/Native.ts:4470

prevAsync

prevAsync(): Promise<any>
Play previous file in nowplaying list.

Returns Promise<any>
Promise is fulfilled when playback of the previous track started
- Defined in src/types/Native.ts:4434

randomizePlaylistAsync

randomizePlaylistAsync(...params): Promise<any>
Randomize nowplaying list, asynchronously. Currently playing track will be the first.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Promise is fulfilled when action is completed
- Defined in src/types/Native.ts:4396

redoAsync

redoAsync(count): Promise<any>
Redo last count actions with nowplaying list, asynchronously.
Parameters
- count: number
  
  Number of actions
Returns Promise<any>
Promise is fulfilled when undo is completed
- Defined in src/types/Native.ts:4488

refreshStatus

refreshStatus(): void
Undocumented

Returns void
- Defined in src/types/Native.ts:4332

removeDuplicatesAsync

removeDuplicatesAsync(): Promise<any>
Removes duplicate items from nowplaying list, asynchronously.

Returns Promise<any>
Promise is fulfilled when action is completed
- Defined in src/types/Native.ts:4408

removeNotAccessibleAsync

removeNotAccessibleAsync(): Promise<any>
Removes not accessible items from nowplaying list, asynchronously.

Returns Promise<any>
Promise is fulfilled when action is completed
- Defined in src/types/Native.ts:4402

removeSelectedTracksAsync

removeSelectedTracksAsync(): Promise<void>
Removes all selected tracks from nowplaying list, asynchronously.

Returns Promise<void>
Promise is fulfilled when operation is completed
- Defined in src/types/Native.ts:4339

repaintVideo

repaintVideo(): void
Undocumented

Returns void
- Defined in src/types/Native.ts:4536

reversePlaylistAsync

reversePlaylistAsync(): Promise<any>
Reverses nowplaying list, asynchronously.

Returns Promise<any>
Promise is fulfilled when action is completed
- Defined in src/types/Native.ts:4390

seekMSAsync

seekMSAsync(Value): Promise<any>
Seek to the given time, asynchronously.
Parameters
- Value: number
  
  Requested track time, in ms.
Returns Promise<any>
Promise is fulfilled when seek is completed
- Defined in src/types/Native.ts:4453

sendPlaybackCommand

sendPlaybackCommand(command, Args): void
Undocumented
Parameters
- command: number
- Args: any[]
Returns void
- Defined in src/types/Native.ts:4692

setAudioStream

setAudioStream(strIdx): void
Undocumented
Parameters
- strIdx: number
Returns void
- Defined in src/types/Native.ts:4469

setDSPModules

setDSPModules(mods): void
Undocumented
Parameters
- mods: PluginList
Returns void
- Defined in src/types/Native.ts:4384

setMarked

setMarked(id, value): void
Undocumented
Parameters
- id: number
- value: boolean
Returns void
Inherited from SharedObject.setMarked
- Defined in src/types/Native.ts:211

setOutputPlugin

setOutputPlugin(plugin): void
Sets given output plugin as active.
Parameters
- plugin: WAOutputPlugin
Returns void
- Defined in src/types/Native.ts:4365

setPlaylistPosAsync

setPlaylistPosAsync(idx): Promise<any>
Changes playlistPos in nowplaying list by index, asynchronously.
Parameters
- idx: number
  
  Index from 0.
Returns Promise<any>
Promise is fulfilled when operation is completed
- Defined in src/types/Native.ts:4513

setPlaylistPosByEntryAsync

setPlaylistPosByEntryAsync(pe): Promise<any>
Changes playlistPos in nowplaying list to entry pe, asynchronously.
Parameters
- pe: PlaylistEntry
Returns Promise<any>
Promise is fulfilled when operation is completed
- Defined in src/types/Native.ts:4520

setVideoSettings

setVideoSettings(val): void
Undocumented
Parameters
- val: any
Returns void
- Defined in src/types/Native.ts:4474

stopAsync

stopAsync(): Promise<any>
Stops playback, asynchronously.

Returns Promise<any>
Promise is fulfilled when playback is stopped
- Defined in src/types/Native.ts:4420

undoAsync

undoAsync(count): Promise<any>
Undo last count actions with nowplaying list, asynchronously.
Parameters
- count: number
  
  Number of actions
Returns Promise<any>
Promise is fulfilled when undo is completed
- Defined in src/types/Native.ts:4481

updateSubtitlesLanguage

updateSubtitlesLanguage(langIdx, fname): boolean
Undocumented
Parameters
- langIdx: number
- fname: string
Returns boolean
- Defined in src/types/Native.ts:4471

updateSubtitlesSettings

updateSubtitlesSettings(): boolean
Undocumented

Returns boolean
- Defined in src/types/Native.ts:4472

Events

event_htmlPlaybackState

event_htmlPlaybackState: ((newState, positionMS) => void)

Type declaration

- (newState, positionMS): void
- Event is called when state of the HTML player is changed ... like playback is started etc. Possible states are 'unpause', 'play', 'stop', 'pause', 'trackChanged', 'listReordered'.
  
  See App.listen
  Parameters
  - newState: string
    
    new playback state
  - positionMS: number
    
    position in miliseconds
  Returns void

event_layoutModified

event_layoutModified: (() => void)

Type declaration

- (): void
- Event is called when player layout is somehow modified.
  
  See App.listen
  
  Returns void

event_nowPlayingModified

event_nowPlayingModified: (() => void)

Type declaration

- (): void
- Event is called when now playing list is somehow modified.
  
  See App.listen
  
  Returns void

event_playbackEnd

event_playbackEnd: (() => void)

Type declaration

- (): void
- Event is called when playback ends.
  
  See App.listen
  
  Returns void

event_playbackState

event_playbackState: ((newState) => void)

Type declaration

- (newState): void
- Event is called when state of the player is changed ... like playback is started etc. Possible states are 'unpause', 'play', 'stop', 'pause', 'trackChanged', 'listReordered'.
  
  See App.listen
  Parameters
  - newState: "pause" | "play" | "stop" | "trackChanged" | "unpause" | "listReordered"
    
    new playback state
  Returns void

event_repeatChange

event_repeatChange: ((value) => void)

Type declaration

- (value): void
- Event is called when repeat is enabled/disabled.
  
  See App.listen
  Parameters
  - value: boolean
    
    new value for repeat
  Returns void

event_seekChange

event_seekChange: ((value) => void)

Type declaration

- (value): void
- Event is called when playback position changed by user interaction.
  
  See App.listen
  Parameters
  - value: number
    
    new position
  Returns void

event_shuffleChange

event_shuffleChange: ((value) => void)

Type declaration

- (value): void
- Event is called when shuffle is enabled/disabled.
  
  See App.listen
  Parameters
  - value: boolean
    
    new value for shuffle
  Returns void

event_stopAfterCurrentChange

event_stopAfterCurrentChange: ((value) => void)

Type declaration

- (value): void
- Event is called when stopAfterCurrentTrack is enabled/disabled.
  
  See App.listen
  Parameters
  - value: boolean
    
    new value for stopAfterCurrentTrack
  Returns void

event_trackSkipped

event_trackSkipped: (() => void)

Type declaration

- (): void
- Event is called when now user is manually skipped track.
  
  See App.listen
  
  Returns void

Class Player

Hierarchy

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Player

Properties

asJSON

autoDJ

Undocumented

autoResetStopAfterCurrent

bitrate

channels

crossfade

entriesCount

htmlPlaybackState

Undocumented

id

isPlaying

mute

normalize

objectType

panning

paused

persistentID

playlistPos

repeatOne

repeatPlaylist

sampleRate

shufflePlaylist

statusInfo

Undocumented

stopAfterCurrentTrack

title

trackLengthMS

trackPositionMS

visualization

volume

Methods

addTrackAtPos

Undocumented

Parameters

SD: Track

position: number

Returns void

addTracksAsync

Parameters

tracks: Track | Tracklist | StringList

Optional params: { afterCurrent?: boolean; byAlbum?: boolean; focusedTrackIndex?: number; forcePreview?: boolean; mix?: boolean; position?: number; saveHistory?: boolean; shuffle?: boolean; startPlayback?: boolean; withClear?: boolean; }

Optional afterCurrent?: boolean

Optional byAlbum?: boolean

Optional focusedTrackIndex?: number

Optional forcePreview?: boolean

Optional mix?: boolean

Optional position?: number

Optional saveHistory?: boolean

Optional shuffle?: boolean

Optional startPlayback?: boolean

Optional withClear?: boolean

Returns Promise<void>

analyzeWaveform

Parameters

tracks: Tracklist

Returns void

clearPlaylistAsync

Parameters

Optional saveHistory: boolean

Returns Promise<void>

clearUndoList

Returns void

doCut

Undocumented

Parameters

data: Base

Returns Promise<any>

doOnLayoutModified

`Optional` params: {
afterCurrent?: boolean;
byAlbum?: boolean;
focusedTrackIndex?: number;
forcePreview?: boolean;
mix?: boolean;
position?: number;
saveHistory?: boolean;
shuffle?: boolean;
startPlayback?: boolean;
withClear?: boolean;
}

`Optional` afterCurrent?: boolean

`Optional` byAlbum?: boolean

`Optional` focusedTrackIndex?: number

`Optional` forcePreview?: boolean

`Optional` mix?: boolean

`Optional` position?: number

`Optional` saveHistory?: boolean

`Optional` shuffle?: boolean

`Optional` startPlayback?: boolean

`Optional` withClear?: boolean

`Optional` saveHistory: boolean