Class Playlist

Playlist class

Playlist

Hierarchy (view full)

SharedMediaObject
- Playlist

Index

Events

event_change event_destroying event_playlistAdded event_playlistChanged event_playlistRemoved event_statuschange

Constructors

constructor

new Playlist(): Playlist
Returns Playlist
Inherited from SharedMediaObject.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)

childrenCount

childrenCount: number

Gets count of child playlists

deleted

deleted: boolean

Set to true after deletion so that 'change' event is called and item is removed from UI lists.

dontNotify

dontNotify: boolean

Undocumented

id

id: number

Gets playlist id

idColl

idColl: number

Undocumented

inEdit

inEdit: boolean

Undocumented

isAutoPlaylist

isAutoPlaylist: boolean

Gets/Sets whether the playlist is auto-playlist

isNew

isNew: boolean

Undocumented

isObservable

isObservable: boolean

Whether this object can be listened (e.g. for 'change' event)

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

itemImageType

itemImageType: string

Undocumented

name

name: string

Gets/Sets title of this playlist.

objectType

objectType: string

Gets the object type as string

parent

parent: Playlist

Gets playlist parent

parentID

parentID: number

Gets id of parent playlist

persistentID

persistentID: string

Gets persistent id of the object

queryData

queryData: string

Undocumented

statusInfo

statusInfo: Promise<any>

Undocumented

supportPin

supportPin: boolean

Whether object support pin to pinned list

title

title: string

Gets the object title

Methods

addLink

addLink(linkType, linkInfo, link): Promise<any>
Add new external list associated with object.
Parameters
- linkType: string
  Type of a link
- linkInfo: string
  Link information (like release or releaseGroup for musicbrainz link)
- link: string
  Link string
Returns Promise<any>
Inherited from SharedMediaObject.addLink
- Defined in src/types/Native.ts:980

addTrackAsync

addTrackAsync(Track): Promise<any>
Add track into playlist
Parameters
- Track: Track
  to add
Returns Promise<any>
- Defined in src/types/Native.ts:5314

addTrackByIdAsync

addTrackByIdAsync(Track): Promise<any>
Add track into playlist
Parameters
- Track: number
Returns Promise<any>
- Defined in src/types/Native.ts:5345

addTracksAsync

addTracksAsync(Tracks): Promise<any>
Add tracks into playlist
Parameters
- Tracks: Tracklist
  to add
Returns Promise<any>
- Defined in src/types/Native.ts:5320

beginUpdate

beginUpdate(): void
Lock object to update state. Events are not called when in update state.

Returns void
Inherited from SharedMediaObject.beginUpdate
- Defined in src/types/Native.ts:276

checkUpdate

checkUpdate(interval): void
Updates the object every X ms when called periodically. Useful e.g. when filling lists. Can be used only in the update lock! (i.e. between beginUpdate/endUpdate)
Parameters
- interval: number
Returns void
Inherited from SharedMediaObject.checkUpdate
- Defined in src/types/Native.ts:288

clearTracksAsync

clearTracksAsync(): Promise<any>
Clears this playlist's tracks

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

commitAsync

commitAsync(): Promise<any>
Commits this playlist

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

createCopyAsync

createCopyAsync(): Promise<any>
Creates copy (clone) of this playlist

Returns Promise<any>
as promise
- Defined in src/types/Native.ts:5420

deleteAsync

deleteAsync(): Promise<any>
Deletes this playlist

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

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
Overrides SharedMediaObject.doCut
- Defined in src/types/Native.ts:5368

endUpdate

endUpdate(): boolean
Unlock object from update state. beginUpdate and endUpdate must be in pair. When endUpdate is called, change event is called.

Returns boolean
Inherited from SharedMediaObject.endUpdate
- Defined in src/types/Native.ts:282

getAllLinksList

getAllLinksList(): ExternalLinksList
Get all external object links (acoustID, musicbrainz, wikipedia etc.)

Returns ExternalLinksList
Inherited from SharedMediaObject.getAllLinksList
- Defined in src/types/Native.ts:953

getCachedThumb

getCachedThumb(dimX, dimY): string
Parameters
- dimX: number
- dimY: number
Returns string
Undocumented
- Defined in src/types/Native.ts:5403

getChildren

getChildren(...params): PlaylistList
Gets children playlists (sub-playlists)
Parameters
- Rest ...params: any[]
Returns PlaylistList
- Defined in src/types/Native.ts:5400

getClassName

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

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

getLastModifiedAsync

getLastModifiedAsync(): Promise<any>
Gets playlist last modified timestamp

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

getLinksList

getLinksList(...params): ExternalLinksList
Get external link associated with the object. All link identifiers are (updated list is available in consts.js) : var LINK_MUSICBRAINZ = 'musicbrainz', LINK_ACOUSTID = 'acoustid', LINK_TVDB = 'tvdb', LINK_MAZE = 'maze', LINK_IMDB = 'imdb', LINK_WIKI = 'wiki', LINK_ECHOPRINT = 'echoprint', LINK_MOVIEDB = 'moviedb', LINK_DISCOGS = 'discogs';
Parameters
- Rest ...params: any[]
Returns ExternalLinksList
Inherited from SharedMediaObject.getLinksList
- Defined in src/types/Native.ts:971

getPersistentJSON

getPersistentJSON(): string
Returns string
Undocumented
Inherited from SharedMediaObject.getPersistentJSON
- Defined in src/types/Native.ts:214

getThumbAsync

getThumbAsync(...params): number
Parameters
- Rest ...params: any[]
Returns number
Undocumented
- Defined in src/types/Native.ts:5401

getTracklist

getTracklist(...params): Tracklist

Gets tracks of this playlist

Parameters

Rest ...params: any[]

Returns Tracklist

as promise

Example

var trcklist = Playlist.getTracklist(); <br>
trcklist.whenLoaded().then(function () {  <br>
    // all tracks are loaded here          <br>
});                                       <br>

insertTrackAsync

insertTrackAsync(Index, Track): Promise<any>
Inserts track into playlist
Parameters
- Index: number
- Track: Track
  Track to insert
Returns Promise<any>
- Defined in src/types/Native.ts:5333

insertTracksAsync

insertTracksAsync(Index, Tracks): Promise<any>
Inserts tracks into playlist
Parameters
- Index: number
- Tracks: Tracklist
  Tracks to insert
Returns Promise<any>
- Defined in src/types/Native.ts:5339

isMarked

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

isPinned

isPinned(): Promise<any>
Object is pinned in pinned list

Returns Promise<any>
Inherited from SharedMediaObject.isPinned
- Defined in src/types/Native.ts:940

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 SharedMediaObject.locked
- Defined in src/types/Native.ts:192

modifyAsync

modifyAsync(...params): Promise<any>
Call defined method with the item locked for modifications.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedMediaObject.modifyAsync
- Defined in src/types/Native.ts:262

moveTrackAsync

moveTrackAsync(Track, BeforeTrack): Promise<any>
Moves a track in the playlist
Parameters
- Track: Track
- BeforeTrack: Track
Returns Promise<any>
- Defined in src/types/Native.ts:5375

newPlaylist

newPlaylist(): Playlist
Creates new sub-playlist of this playlist

Returns Playlist
- Defined in src/types/Native.ts:5409

notifyChanged

notifyChanged(...params): void
Notifies that the object was changed (e.g. to force visual update etc.)
Parameters
- Rest ...params: any[]
Returns void
Inherited from SharedMediaObject.notifyChanged
- Defined in src/types/Native.ts:308

removeLink

removeLink(...params): Promise<any>
Remove external link from object.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedMediaObject.removeLink
- Defined in src/types/Native.ts:989

removeSelectedTracksAsync

removeSelectedTracksAsync(list): Promise<void>
Removes selected tracks from playlist
Parameters
- list: SharedList<any>
Returns Promise<void>
- Defined in src/types/Native.ts:5367

removeTrackAsync

removeTrackAsync(Track): Promise<any>
Removes track from playlist
Parameters
- Track: Track
  Track to remove
Returns Promise<any>
- Defined in src/types/Native.ts:5361

reorderAsync

reorderAsync(dataSource): Promise<any>
Saves re-ordered playlist's tracks into DB.

Does not function with Auto-Playlists. Auto-Playlists use QueryData for their sorting. See searchEditor.js and playlistHeader.js for an example on how to manipulate QueryData for sorting.
Parameters
- dataSource: Tracklist
Returns Promise<any>
- Defined in src/types/Native.ts:5384

saveThumbAsync

saveThumbAsync(imageLink): Promise<any>
Parameters
- imageLink: string
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:5402

setMarked

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

setPinned

setPinned(pinned, collID): void
Set object is pinned in pinned list.
Parameters
- pinned: boolean
  Object is pinned
- collID: number
  ID of collection where object is pinned
Returns void
Inherited from SharedMediaObject.setPinned
- Defined in src/types/Native.ts:947

setTracksAsync

setTracksAsync(Tracks): Promise<any>
Add tracks into playlist, but clears the existing tracks at first.
NOTE: Introduced in version 5.0.4
Parameters
- Tracks: Tracklist
  to add
Returns Promise<any>
- Defined in src/types/Native.ts:5327

toString

toString(): string
Returns string
Undocumented
Inherited from SharedMediaObject.toString
- Defined in src/types/Native.ts:264

toUriString

toUriString(): string
Returns string
Undocumented
Inherited from SharedMediaObject.toUriString
- Defined in src/types/Native.ts:263

updateStatus

updateStatus(): void
Returns void
Undocumented
Inherited from SharedMediaObject.updateStatus
- Defined in src/types/Native.ts:297

Events

event_change

event_change: ((changeType, ...additionalArgs) => void)

Event is called when object is somehow changed

See App.listen

Type declaration

- (changeType, ...additionalArgs): void
- Parameters
  - changeType: string
    additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)
  - Rest ...additionalArgs: any[]
  Returns void

Example

app.listen(object, 'change', (changeType) => {  });

event_destroying

event_destroying: (() => void)

Event is called when object is going to destroy

See App.listen

Type declaration

- (): void
- Returns void

event_playlistAdded

event_playlistAdded: ((playlistID, playlist) => void)

Event is called when a child playlist is created. Most useful with app.playlists.root.

See App.listen

Type declaration

- (playlistID, playlist): void
- Parameters
  - playlistID: number
    ID of created playlist. (pre version 5.0.4. use app.playlists.getByIDAsync(playlistID) to get the Playlist object).
  - playlist: Playlist
  Returns void

event_playlistChanged

event_playlistChanged: ((playlistID, playlist) => void)

Event is called when a child playlist is modified. Most useful with app.playlists.root.

See App.listen

Type declaration

- (playlistID, playlist): void
- Parameters
  - playlistID: number
    ID of changed playlist (pre version 5.0.4. use app.playlists.getByIDAsync(playlistID) to get the Playlist object).
  - playlist: Playlist
  Returns void

event_playlistRemoved

event_playlistRemoved: ((playlist) => void)

Event is called when a child playlist is removed. Most useful with app.playlists.root.

See App.listen

Type declaration

- (playlist): void
- Parameters
  - playlist: Playlist
    Object containing info of the playlist that was removed.
  Returns void

event_statuschange

event_statuschange: (() => void)

Event is called when status info of the object is changed

See App.listen

Type declaration

- (): void
- Returns void

Class Playlist

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Playlist

Properties

asJSON

childrenCount

deleted

dontNotify

Undocumented

id

idColl

Undocumented

inEdit

Undocumented

isAutoPlaylist

isNew

Undocumented

isObservable

isStatusBarSource

itemImageType

Undocumented

name

objectType

parent

parentID

persistentID

queryData

Undocumented

statusInfo

Undocumented

supportPin

title

Methods

addLink

Parameters

Returns Promise<any>

addTrackAsync

Parameters

Returns Promise<any>

addTrackByIdAsync

Parameters

Returns Promise<any>

addTracksAsync

Parameters

Returns Promise<any>

beginUpdate

Returns void

checkUpdate

Parameters

Returns void

clearTracksAsync

Returns Promise<any>

commitAsync

Returns Promise<any>

createCopyAsync

Returns Promise<any>

deleteAsync

Returns Promise<any>

doCut

Parameters

Returns Promise<any>

Undocumented

endUpdate

Returns boolean

getAllLinksList

Returns ExternalLinksList

getCachedThumb

Parameters

Returns string

Undocumented

getChildren

Parameters

Returns PlaylistList