Class Cover

Cover item (artwork item) Accessible e.g. via Track.coverList, Track.loadCoverListAsync() etc.

Cover

Hierarchy (view full)

SharedObservable
- Cover

Constructors

constructor

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

coverStorage

coverStorage: CoverStorage

Gets storage type (0 - tag, 1 - file, 2 - not saved "auto-looked" up image)

coverTagIndex

coverTagIndex: number

Undocumented

coverType

coverType: any

Undocumented

coverTypeDesc

coverTypeDesc: string

Gets cover type (e.g. 'Cover (front)')

deleted

deleted: boolean

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

description

description: string

Gets description

dontNotify

dontNotify: boolean

Undocumented

id

id: number

Gets integer id of the object

isObservable

isObservable: boolean

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

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

loaded

loaded: boolean

Gets loaded state (whether picture data are loaded in memory / available)

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

pictureDataHash

pictureDataHash: string

Undocumented

picturePath

picturePath: string

Gets path to the image (if not stored in the file tag)

pictureType

pictureType: string

Gets picture type (e.g. 'image/jpeg')

statusInfo

statusInfo: Promise<any>

Undocumented

title

title: string

Gets the object title

Methods

beginUpdate

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

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

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
Inherited from SharedObservable.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 SharedObservable.endUpdate
- Defined in src/types/Native.ts:282

findNearestCacheSize

findNearestCacheSize(dimX, dimY): number
Parameters
- dimX: number
- dimY: number
Returns number
Undocumented
- Defined in src/types/Native.ts:2948

getCachedThumb

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

getClassName

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

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

getCopy

getCopy(): Cover
Gets copy of this item

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

getCoverStorageInfo

getCoverStorageInfo(): string
Returns string
Undocumented
- Defined in src/types/Native.ts:2937

getFullPicturePath

getFullPicturePath(parentPath): string
Parameters
- parentPath: string
Returns string
Undocumented
- Defined in src/types/Native.ts:2933

getInfoAsync

getInfoAsync(): Promise<any>
Gets info about this cover item (resolution, storage etc.)

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

getPersistentJSON

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

getSizeInfoAsync

getSizeInfoAsync(): Promise<any>
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:2970

getThumb

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

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:2946

getThumbPath

getThumbPath(size): string
Parameters
- size: number
Returns string
Undocumented
- Defined in src/types/Native.ts:2947

isMarked

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

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 SharedObservable.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 SharedObservable.modifyAsync
- Defined in src/types/Native.ts:262

move2TagAsync

move2TagAsync(): Promise<any>
Moves the image file to file tag (if supported by the file format)

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

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

saveToFile

saveToFile(fname): void
Saves picture data to a file
Parameters
- fname: string
Returns void
- Defined in src/types/Native.ts:2932

saveToFileFolder

saveToFileFolder(trackPath, useFilename, checkExistence): Promise<any>
Saves picture data to file folder
Parameters
- trackPath: string
- useFilename: string
- checkExistence: boolean
Returns Promise<any>
- Defined in src/types/Native.ts:2957

setMarked

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

toString

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

toUriString

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

updateStatus

updateStatus(): void
Returns void
Undocumented
Inherited from SharedObservable.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_statuschange

event_statuschange: (() => void)

Event is called when status info of the object is changed

See App.listen

Type declaration

- (): void
- Returns void

Class Cover

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Cover

Properties

asJSON

coverStorage

coverTagIndex

Undocumented

coverType

Undocumented

coverTypeDesc

deleted

description

dontNotify

Undocumented

id

isObservable

isStatusBarSource

loaded

objectType

persistentID

pictureDataHash

Undocumented

picturePath

pictureType

statusInfo

Undocumented

title

Methods

beginUpdate

Returns void

checkUpdate

Parameters

Returns void

doCut

Parameters

Returns Promise<any>

Undocumented

endUpdate

Returns boolean

findNearestCacheSize

Parameters

Returns number

Undocumented

getCachedThumb

Parameters

Returns string

Undocumented

getClassName

Returns string

getCopy

Returns Cover

getCoverStorageInfo

Returns string

Undocumented

getFullPicturePath

Parameters

Returns string

Undocumented

getInfoAsync

Returns Promise<any>

getPersistentJSON

Returns string

Undocumented

getSizeInfoAsync

Returns Promise<any>

Undocumented

getThumb

Parameters

Returns string

Undocumented

getThumbAsync

Parameters