API Docs for: 0.0.1
Show:

Track Class

Module: Native

Media item class

Methods

addCoverAsync

(
  • filename
)

Adds new cover for this track

Parameters:

  • filename String

    full path to the image file

commit

()

Commits this track into database and tag

commitAsync

() Promise

Commits this track into database and tag

Returns:

Promise:

getCommentAsync

() Promise

Gets full comment field.

Returns:

Promise:

getLyricsAsync

() Promise

Gets full lyrics field.

Returns:

Promise:

getTemporaryCopy

() Track

Gets temporary copy of this track (track has same data, but isn't updated across UI or in DB etc.).

Returns:

getThumbAsync

(
  • DimX
  • DimY
  • callback
  • UNKNOWN
)

Returns link to cached image thumbnail of the nearest specified size

Parameters:

  • DimX Integer
    • required width
  • DimY Integer
    • required height
  • callback Callback
  • UNKNOWN Params

insertCoverAsync

(
  • filename
  • position
)

Adds new cover for this track

Parameters:

  • filename String

    full path to the image file

  • position Integer

loadCoverListAsync

()

Loads cover list for this track

setCommentAsync

(
  • value
)
Promise

Sets comment field.

Parameters:

  • value String

Returns:

Promise:

setLyricsAsync

(
  • value
)
Promise

Sets lyrics field.

Parameters:

  • value String

Returns:

Promise:

Properties

actors

String

gets/sets actors

album

String

gets/sets album

albumArtist

String

gets/sets albumArtist

artist

String

gets/sets artist

author

String

gets/sets author aka composer

bitrate

Integer

gets/sets bitrate

bmp

Integer

gets/sets bmp

conductor

String

gets/sets conductor

coverList

CoverList

Gets/sets cover list for this track Use loadCoverListAsync if you want to manipulate/save the covers

custom1

String

gets/sets custom1 field

custom2

String

gets/sets custom2 field

custom3

String

gets/sets custom3 field

custom4

String

gets/sets custom4 field

custom5

String

gets/sets custom5 field

day

Integer

gets/sets day

discNumber

String

gets/sets discNumber

episodeNumber

String

gets/sets episode number

fileLength

Integer

gets/sets fileLength in bytes

frequency

Integer

gets/sets frequency/Sample rate in hz

genre

String

gets/sets genre

groupDesc

String

gets/sets grouping

idsong

Integer

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

involvedPeople

String

gets/sets involvedPeople

isPlaying

Boolean

Gets whether this media is currently playing

isVideo

Boolean

Gets whether this media item is video

lyricist

String

gets/sets lyricist

month

Integer

gets/sets month

mood

String

gets/sets mood

occasion

String

gets/sets occasion

origArtist

String

gets/sets original artist

origTitle

String

gets/sets original title

path

String

gets/sets file path

playCounter

Integer

gets/sets played#

producer

String

gets/sets producer

publisher

String

gets/sets publisher

quality

String

gets/sets quality

seasonNumber

String

gets/sets season number

skipCount

Integer

gets/sets skipped#

songLength

Integer

gets/sets songLength in milliseconds

startTime

Integer

gets/sets startTime in milliseconds

stopTime

Integer

gets/sets stopTime in milliseconds

summary

String

gets/sets summary

tempo

String

gets/sets tempo

title

String

gets/sets title of this media item

trackNumber

String

gets/sets track number

year

Integer

gets/sets year