Class Track

Media item class

Hierarchy

PinableObject
- Track

Index

Properties

actor actors album albumArtist allAddonsReaded artist artworkModified_UTC asJSON author autoTagState bitrate bpm bps cacheStatus commentShort composer conductor copyright coverList cuePath custom1 custom10 custom2 custom3 custom4 custom5 custom6 custom7 custom8 custom9 date dateAdded dateAdded_UTC day deleted dimensions director dirtyModified discNumber discNumberInt dontNotify encoder episodeNumber extendedTagsShort fileLength fileModified fileModified_UTC fileType filename frameRate frameRateStr frequency genre groupDesc height id idColl idMedia idPlaylistSong idalbum idsong initialKey involvedPeople isObservable isPlaying isStatusBarSource isVideo isYoutubeVideo isntInDB isrc language lastTimePlayed lastTimePlayed_UTC lastTimeSkipped lastTimeSkipped_UTC listsModif longTextLoaded lyricist lyricsSearched lyricsShort maxSample mediaLabel mediaSN mimeType modified month mood needsDBReload newlyScanned normalizeAlbum normalizeTrack objectType occasion organizedPath origArtist origDate origDay origLyricist origMonth origTitle origYear originalPath parentalRating path percentPlayed persistentID playCounter playLength playbackPos playlistSongOrder producer publisher quality rating seasonNumber seekable skipCount songLength startTime statusInfo stereo stopTime subtitle summary supportPin sync_id tempo temporaryOrder title trackModified trackModified_UTC trackNumber trackNumberInt trackType trackTypeStr trackTypeStringId vbr volumeLeveling webSource width year

Methods

addCoverAsync addData addLink appendCoversAsync assign beginUpdate checkUpdate commitAsync doCut endUpdate getAddonsAsync getAlbumAsync getAllLinksList getArtworkFileNameAsync getCachedThumb getCanSearchLyrics getClassName getCommentAsync getCommentSync getCoverList getExtendedTagsAsync getFirstCover getFirstCoverThumb getIsPlayable getLinksList getLyricsAsync getLyricsSync getPersistentJSON getPersonListAsync getPlaybackRule getTemporaryCopy getThumbAsync getTrackTypeAsync getVideoFormatAsync insertCoverAsync isAccessibleAsync isHighlighted isMarked isPinned isSame isWeakSame itemGrouper loadCoverList loadCoverListAsync locked modifyAsync notifyChanged notifyDeleted removeLink saveCoverList setCommentAsync setCoverList setExtendedTagsAsync setLyricsAsync setMarked setPinned toString toUriString updateAlbum updateArtist updateStatus

Constructors

constructor

new Track(): Track
Returns Track

Inherited from PinableObject.constructor

Properties

actor

actor: string

Undocumented

actors

actors: string

Gets/sets actors.

album

album: string

Gets/sets album.

albumArtist

albumArtist: string

Gets/sets albumArtist.

allAddonsReaded

allAddonsReaded: boolean

Undocumented

artist

artist: string

Gets/sets artist.

artworkModified_UTC

artworkModified_UTC: number

Undocumented

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)

author

author: string

Gets/sets author aka composer.

autoTagState

autoTagState: number

Undocumented

bitrate

bitrate: number

Gets/sets bitrate.

bpm

bpm: number

Gets/sets BPM (beats per minute).

bps

bps: number

Undocumented

cacheStatus

cacheStatus: number

Undocumented

commentShort

commentShort: string

Gets shortened version of the track comment, max 200 characters, shortened with ellipses. Read-only. To get/set the full comment, use getCommentAsync and setCommentAsync.

composer

composer: string

Gets/sets author aka composer.

conductor

conductor: string

Gets/sets conductor.

copyright

Undocumented

coverList

coverList: CoverList

Undocumented

cuePath

cuePath: string

Undocumented

custom1

custom1: string

Gets/sets custom1 field.

custom10

custom10: string

Gets/sets custom10 field.

custom2

custom2: string

Gets/sets custom2 field.

custom3

custom3: string

Gets/sets custom3 field.

custom4

custom4: string

Gets/sets custom4 field.

custom5

custom5: string

Gets/sets custom5 field.

custom6

custom6: string

Gets/sets custom6 field.

custom7

custom7: string

Gets/sets custom7 field.

custom8

custom8: string

Gets/sets custom8 field.

custom9

custom9: string

Gets/sets custom9 field.

date

date: number

Gets/sets date.

The first 4 digits are the year, the next 2 are the month, and the next 2 are the day. For example: 20110000 is the year 2011 without a month and day, and 20110410 is April 4, 2011.
-1 is considered an empty date. -2 is allowed as a special value for grouping tracks, but all other negative numbers are changed to -1.

Setting date automatically updates year, month, and day.

dateAdded

dateAdded: number

Gets/sets dateAdded DateTime property (when the file has been added to library).

Use e.g.

track.dateAdded = app.utils.timestamp2DateTime( 'YYYY-MM-DD HH:MM:SS' );

track.dateAdded = app.utils.timestamp2DateTime( new Date().toISOString());

track.dateAdded = new Date();

dateAdded_UTC

dateAdded_UTC: number

Gets/sets dateAdded DateTime property (when the file has been added to library).

Use e.g.

track.dateAdded_UTC = app.utils.timestamp2DateTime( 'YYYY-MM-DD HH:MM:SS' );

track.dateAdded_UTC = app.utils.timestamp2DateTime( new Date().toISOString());

track.dateAdded_UTC = new Date();

day

day: number

Gets/sets day. Automatically updated by date.

deleted

deleted: boolean

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

dimensions

dimensions: string

Undocumented

director

director: string

Undocumented

dirtyModified

dirtyModified: boolean

Undocumented

discNumber

discNumber: string

Gets/sets discNumber.

discNumberInt

discNumberInt: number

Undocumented

dontNotify

dontNotify: boolean

Undocumented

encoder

encoder: string

Undocumented

episodeNumber

episodeNumber: string

Gets/sets episode number.

extendedTagsShort

extendedTagsShort: string

Read-only shortened version of extendedTags, as JSON. To get the full tags, use getExtendedTagsAsync()

fileLength

fileLength: number

Gets/sets fileLength in bytes.

fileModified

fileModified: number

Gets/sets fileModified DateTime property.

Use e.g.

track.fileModified = app.utils.timestamp2DateTime( 'YYYY-MM-DD HH:MM:SS' );

track.fileModified_UTC = app.utils.timestamp2DateTime( new Date().toISOString());

fileModified_UTC

fileModified_UTC: number

Gets/sets fileModified DateTime property.

Use e.g.

track.fileModified = app.utils.timestamp2DateTime( 'YYYY-MM-DD HH:MM:SS' );

track.fileModified_UTC = app.utils.timestamp2DateTime( new Date().toISOString());

fileType

fileType: string

Undocumented

filename

filename: string

Undocumented

frameRate

frameRate: number

Undocumented

frameRateStr

frameRateStr: string

Undocumented

frequency

frequency: number

Gets/sets frequency/Sample rate in hz.

genre

genre: string

Gets/sets genre.

groupDesc

groupDesc: string

Gets/sets grouping.

height

height: number

Undocumented

id

id: number

Gets integer id of the object

idColl

idColl: number

Undocumented

idMedia

idMedia: number

Undocumented

idPlaylistSong

idPlaylistSong: number

Undocumented

idalbum

idalbum: number

Undocumented

idsong

idsong: number

Gets/sets ID as is in database (Songs.ID).

initialKey

initialKey: string

Undocumented

involvedPeople

involvedPeople: string

Gets/sets involvedPeople.

isObservable

isObservable: boolean

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

isPlaying

isPlaying: boolean

Gets whether this media is currently playing

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

isVideo

isVideo: boolean

Gets whether this media item is video

isYoutubeVideo

isYoutubeVideo: boolean

Undocumented

isntInDB

isntInDB: boolean

Undocumented

isrc

isrc: string

Undocumented

language

language: string

Undocumented

lastTimePlayed

lastTimePlayed: number

Gets/sets lastTimePlayed DateTime property (when the file has been last time played).

Use e.g.

track.lastTimePlayed = app.utils.timestamp2DateTime( 'YYYY-MM-DD HH:MM:SS' );

track.lastTimePlayed_UTC = app.utils.timestamp2DateTime( new Date().toISOString());

lastTimePlayed_UTC

lastTimePlayed_UTC: number

Gets/sets lastTimePlayed DateTime property (when the file has been last time played).

Use e.g.

track.lastTimePlayed = app.utils.timestamp2DateTime( 'YYYY-MM-DD HH:MM:SS' );

track.lastTimePlayed_UTC = app.utils.timestamp2DateTime( new Date().toISOString());

lastTimeSkipped

lastTimeSkipped: number

Gets/sets lastTimeSkipped DateTime property (when the file has been last time skipped).

Use e.g.

track.lastTimeSkipped = app.utils.timestamp2DateTime( 'YYYY-MM-DD HH:MM:SS' );

track.lastTimeSkipped_UTC = app.utils.timestamp2DateTime( new Date().toISOString());

lastTimeSkipped_UTC

lastTimeSkipped_UTC: number

Gets/sets lastTimePlayed DateTime property (when the file has been last time played).

Use e.g.

track.lastTimeSkipped = app.utils.timestamp2DateTime( 'YYYY-MM-DD HH:MM:SS' );

track.lastTimeSkipped_UTC = app.utils.timestamp2DateTime( new Date().toISOString());

listsModif

listsModif: boolean

Undocumented

longTextLoaded

longTextLoaded: boolean

Undocumented

lyricist

lyricist: string

Gets/sets lyricist.

lyricsSearched

lyricsSearched: boolean

Undocumented

lyricsShort

lyricsShort: string

Undocumented

maxSample

maxSample: number

Undocumented

mediaLabel

mediaLabel: string

Undocumented

mediaSN

mediaSN: number

Undocumented

mimeType

mimeType: string

Undocumented

modified

modified: boolean

Undocumented

month

month: number

Gets/sets month. Automatically updated by date.

mood

mood: string

Gets/sets mood.

needsDBReload

needsDBReload: boolean

Set to true once some changes in DB were made externally (to refresh the data)

newlyScanned

newlyScanned: boolean

Undocumented

normalizeAlbum

normalizeAlbum: number

Undocumented

normalizeTrack

normalizeTrack: number

Undocumented

objectType

objectType: string

Gets the object type as string

occasion

occasion: string

Gets/sets occasion.

organizedPath

organizedPath: string

Undocumented

origArtist

origArtist: string

Gets/sets original artist.

origDate

origDate: number

Gets/sets original date.

When read, the first 4 digits are the year, the next 2 are the month, and the next 2 are the day. For example: 20110000 is the year 2011 without a month and day, and 20110410 is April 4, 2011.
-1 is considered an empty date. -2 is allowed as a special value for grouping tracks, but all other negative numbers are changed to -1.

Setting origDate automatically updates origYear, origMonth, and origDay.

origDay

origDay: number

Gets/sets original day. Automatically updated by origDate.

origLyricist

origLyricist: string

Undocumented

origMonth

origMonth: number

Gets/sets original month. Automatically updated by origDate.

origTitle

origTitle: string

Gets/sets original title.

origYear

origYear: number

Gets/sets original year. Automatically updated by origDate.

originalPath

originalPath: string

Undocumented

parentalRating

parentalRating: string

Undocumented

path

path: string

Gets/sets file path.

percentPlayed

percentPlayed: number

Undocumented

persistentID

persistentID: string

Gets persistent id of the object

playCounter

playCounter: number

Gets/sets played #.

playLength

playLength: number

gets true playLength in milliseconds (startTime / stopTime taken into account)

playbackPos

playbackPos: number

Undocumented

playlistSongOrder

playlistSongOrder: number

Undocumented

producer

producer: string

Gets/sets producer.

publisher

publisher: string

Gets/sets publisher.

quality

quality: string

Gets/sets quality.

rating

rating: number

Gets/sets rating.

Any integer is allowed, but only -1 to 100 have significance.
The number of stars is equal to the rating divided by 20. -1 is an empty/unknown rating, 0 is 0 stars (or a "bomb"), 50 is 2.5 stars, and 100 is 5 stars.

seasonNumber

seasonNumber: string

Gets/sets season number.

seekable

seekable: boolean

Undocumented

skipCount

skipCount: number

Gets/sets skipped #.

songLength

songLength: number

Gets/sets songLength in milliseconds.

startTime

startTime: number

Gets/sets startTime in milliseconds.

statusInfo

statusInfo: Promise<any>

Undocumented

stereo

stereo: number

Undocumented

stopTime

stopTime: number

Gets/sets stopTime in milliseconds.

subtitle

subtitle: string

Undocumented

summary

summary: string

Gets/sets summary.

supportPin

supportPin: boolean

Whether object support pin to pinned list

sync_id

sync_id: string

Undocumented

tempo

tempo: string

Gets/sets tempo.

temporaryOrder

temporaryOrder: number

Undocumented

title

title: string

Gets/sets title of this media item.

trackModified

trackModified: number

Undocumented

trackModified_UTC

trackModified_UTC: number

Undocumented

trackNumber

trackNumber: string

Gets/sets track number.

trackNumberInt

trackNumberInt: number

Undocumented

trackType

trackType: TrackType

Undocumented

trackTypeStr

trackTypeStr: string

Undocumented

trackTypeStringId

trackTypeStringId: string

Undocumented

vbr

vbr: boolean

Undocumented

volumeLeveling

volumeLeveling: number

Undocumented

webSource

webSource: string

Undocumented

width

width: number

Undocumented

year

year: number

Gets/sets year. Automatically updated by date.

Methods

addCoverAsync

addCoverAsync(filename): Promise<any>
Adds new cover for this track
Parameters
- filename: string
  
  full path to the image file
Returns Promise<any>
- Defined in src/types/Native.ts:1320

addData

addData(o): void
Adds metadata from another track. Does not override values, i.e. assigns only fields that are currently empty
Parameters
- o: Track
Returns void
- Defined in src/types/Native.ts:1084

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 PinableObject.addLink
- Defined in src/types/Native.ts:980

appendCoversAsync

appendCoversAsync(list, pars): Promise<any>
Undocumented
Parameters
- list: CoverList
- pars: any
Returns Promise<any>
- Defined in src/types/Native.ts:1313

assign

assign(assignFromSD): void
Assigns metadata from another track
Parameters
- assignFromSD: Track
Returns void
- Defined in src/types/Native.ts:1075

beginUpdate

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

Returns void
Inherited from PinableObject.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 PinableObject.checkUpdate
- Defined in src/types/Native.ts:288

commitAsync

commitAsync(params?): Promise<void>
Saves this track into database (and tag -- based on user's settings)

Promise is fulfilled when action is completed.
Parameters
- Optional params: {
  forceSaveToDB?: boolean;
  tagModified?: boolean;
  }
  - Optional forceSaveToDB?: boolean
    
    if true, then also the new files (not in db yet) are saved, default = false
  - Optional tagModified?: boolean
    
    if false, the metadata is not written to the file tag, default = true
Returns Promise<void>
- Defined in src/types/Native.ts:1046

doCut

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

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 PinableObject.endUpdate
- Defined in src/types/Native.ts:282

getAddonsAsync

getAddonsAsync(): Promise<any>
Get track additional informations (like webArtist, webCopyright etc)

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

getAlbumAsync

getAlbumAsync(): Promise<any>
Returns album class

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

getAllLinksList

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

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

getArtworkFileNameAsync

getArtworkFileNameAsync(...params): Promise<any>
Undocumented
Parameters
- Rest ...params: any[]
Returns Promise<any>
- Defined in src/types/Native.ts:1007

getCachedThumb

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

getCanSearchLyrics

getCanSearchLyrics(): boolean
Undocumented

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

getClassName

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

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

getCommentAsync

getCommentAsync(): Promise<string>
Gets full comment field.

Returns Promise<string>
- Defined in src/types/Native.ts:1092

getCommentSync

getCommentSync(): string
Undocumented

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

getCoverList

getCoverList(): CoverList
Undocumented

Returns CoverList
- Defined in src/types/Native.ts:1330

getExtendedTagsAsync

getExtendedTagsAsync(): Promise<string>
Gets full ExtendedTags field.

Returns Promise<string>
- Defined in src/types/Native.ts:1121

getFirstCover

getFirstCover(): Cover
Undocumented

Returns Cover
- Defined in src/types/Native.ts:1329

getFirstCoverThumb

getFirstCoverThumb(DimX, DimY): string
Undocumented
Parameters
- DimX: number
- DimY: number
Returns string
- Defined in src/types/Native.ts:1328

getIsPlayable

getIsPlayable(): boolean
Undocumented

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

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 PinableObject.getLinksList
- Defined in src/types/Native.ts:971

getLyricsAsync

getLyricsAsync(): Promise<string>
Gets full lyrics field.

Returns Promise<string>
- Defined in src/types/Native.ts:1098

getLyricsSync

getLyricsSync(): string
Undocumented

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

getPersistentJSON

getPersistentJSON(): string
Undocumented

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

getPersonListAsync

getPersonListAsync(personType): SharedList<SharedObject>
Returns list of person by specified type
Parameters
- personType: string
Returns SharedList<SharedObject>
- Defined in src/types/Native.ts:1029

getPlaybackRule

getPlaybackRule(ruleType): boolean
Undocumented
Parameters
- ruleType: string
Returns boolean
- Defined in src/types/Native.ts:1569

getTemporaryCopy

getTemporaryCopy(...params): Track
Gets temporary copy of this track (track has same data, but isn't updated across UI or in DB etc.).
Parameters
- Rest ...params: any[]
Returns Track
- Defined in src/types/Native.ts:1068

getThumbAsync

getThumbAsync(...params): number
Returns link to cached image thumbnail of the nearest specified size
Parameters
- Rest ...params: any[]
Returns number
- Defined in src/types/Native.ts:1061

getTrackTypeAsync

getTrackTypeAsync(...params): Promise<any>
Undocumented
Parameters
- Rest ...params: any[]
Returns Promise<any>
- Defined in src/types/Native.ts:1115

getVideoFormatAsync

getVideoFormatAsync(): Promise<any>
Undocumented

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

insertCoverAsync

insertCoverAsync(filename, position): Promise<any>
Adds new cover for this track
Parameters
- filename: string
  
  full path to the image file
- position: number
Returns Promise<any>
- Defined in src/types/Native.ts:1327

isAccessibleAsync

isAccessibleAsync(): Promise<any>
To check whether the file is accessible

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

isHighlighted

isHighlighted(column): boolean
Undocumented
Parameters
- column: string
Returns boolean
- Defined in src/types/Native.ts:1005

isMarked

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

isPinned

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

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

isSame

isSame(obj): boolean
Undocumented
Parameters
- obj: Base
Returns boolean
- Defined in src/types/Native.ts:1076

isWeakSame

isWeakSame(obj): number
Undocumented
Parameters
- obj: Base
Returns number
- Defined in src/types/Native.ts:1077

itemGrouper

itemGrouper(groupName): string
Undocumented
Parameters
- groupName: string
Returns string
- Defined in src/types/Native.ts:1006

loadCoverList

loadCoverList(keepPictureDataLoaded, useDatabaseOnly): CoverList
Undocumented
Parameters
- keepPictureDataLoaded: boolean
- useDatabaseOnly: boolean
Returns CoverList
- Defined in src/types/Native.ts:1308

loadCoverListAsync

loadCoverListAsync(...params): CoverList
Loads cover list for this track
Parameters
- Rest ...params: any[]
Returns CoverList
- Defined in src/types/Native.ts:1312

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

modifyAsync

modifyAsync(...params): number
Undocumented
Parameters
- Rest ...params: any[]
Returns number
Overrides PinableObject.modifyAsync
- Defined in src/types/Native.ts:1009

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 PinableObject.notifyChanged
- Defined in src/types/Native.ts:308

notifyDeleted

notifyDeleted(): void
Undocumented

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

removeLink

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

saveCoverList

saveCoverList(): void
Undocumented

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

setCommentAsync

setCommentAsync(value): Promise<void>
Sets comment field.
Parameters
- value: string
Returns Promise<void>
- Defined in src/types/Native.ts:1105

setCoverList

setCoverList(Value): void
Undocumented
Parameters
- Value: CoverList
Returns void
- Defined in src/types/Native.ts:1331

setExtendedTagsAsync

setExtendedTagsAsync(value): Promise<void>
Sets ExtendedTags field, must be in a JSON-formatted string.
Parameters
- value: string
Returns Promise<void>
- Defined in src/types/Native.ts:1128

setLyricsAsync

setLyricsAsync(...params): Promise<void>
Sets lyrics field.
Parameters
- Rest ...params: any[]
Returns Promise<void>
- Defined in src/types/Native.ts:1112

setMarked

setMarked(id, value): void
Undocumented
Parameters
- id: number
- value: boolean
Returns void
Inherited from PinableObject.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 PinableObject.setPinned
- Defined in src/types/Native.ts:947

toString

toString(): string
Undocumented

Returns string
Overrides PinableObject.toString
- Defined in src/types/Native.ts:1085

toUriString

toUriString(): string
Undocumented

Returns string
Overrides PinableObject.toUriString
- Defined in src/types/Native.ts:1086

updateAlbum

updateAlbum(): void
Undocumented

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

updateArtist

updateArtist(): void
Undocumented

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

updateStatus

updateStatus(): void
Undocumented

Returns void
Inherited from PinableObject.updateStatus
- Defined in src/types/Native.ts:297

Events

event_change

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

Type declaration

- (changeType, ...additionalArgs): void
- Event is called when object is somehow changed
  
  See App.listen
  
  Example
```
app.listen(object, 'change', (changeType) => {  });
```
  Parameters
  - changeType: string
    
    additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)
  - Rest ...additionalArgs: any[]
  Returns void

event_destroying

event_destroying: (() => void)

Type declaration

- (): void
- Event is called when object is going to destroy
  
  See App.listen
  
  Returns void

event_statuschange

event_statuschange: (() => void)

Type declaration

- (): void
- Event is called when status info of the object is changed
  
  See App.listen
  
  Returns void

Class Track

Hierarchy

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Track

Properties

actor

Undocumented

actors

album

albumArtist

allAddonsReaded

Undocumented

artist

artworkModified_UTC

Undocumented

asJSON

author

autoTagState

Undocumented

bitrate

bpm

bps

Undocumented

cacheStatus

Undocumented

commentShort

composer

conductor

copyright

Undocumented

coverList

Undocumented

cuePath

Undocumented

custom1

custom10

custom2

custom3

custom4

custom5

custom6

custom7

custom8

custom9

date

dateAdded

dateAdded_UTC

day

deleted

dimensions

Undocumented

director

Undocumented

dirtyModified

Undocumented

discNumber

discNumberInt

Undocumented

dontNotify

Undocumented

encoder

Undocumented

episodeNumber

extendedTagsShort

fileLength

fileModified

fileModified_UTC

fileType

Undocumented

filename

Undocumented

frameRate

Undocumented

frameRateStr