Class Device

Device class representing media sync profile

Device

Hierarchy (view full)

SharedObservable
- Device

Index

Constructors

Methods

addTrack2Library addTracks2Library beginUpdate canBiDiSynch canEject checkUpdate commitAsync createSyncProcess deleteFoldersAsync doCut ejectAsync endUpdate getCachedThumb getCheckStates getClassName getCollectionSettings getFolderList getFolderStringList getHasFolderSupport getHasPlaylistSupport getIsDummy getIsOnSyncList getPersistentJSON getPlaylistSettingsJSON getPlaylists getSupportedPlaylistFormats getSyncedObjects getTargetMask getThumbAsync getTrackByPath getTracklist getTracksToDownload getWriteAccessRoot isMarked is_iPodType loadFromProfileAsync locked mergeTracklists modifyAsync notifyChanged removeAsync removeTracksFromLibrary resetProfileAsync resetTargetMasks saveToProfileAsync scanContent scanContentAsync setCapacityAsync setContentAsync setDriveLetter setFolderList setMarked setPlaylistSettingsJSON setSyncedObjects setTargetMask toString toUriString updateDriveLabelAsync updatePlaylist2Library updateStatus usbType

Events

event_change event_destroying event_statuschange

Constructors

constructor

new Device(): Device
Returns Device
Inherited from SharedObservable.constructor

Properties

allowWifiSync

allowWifiSync: boolean

Indicates whether remote sync is granted for this device sync profile

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)

autoConvertConfig

autoConvertConfig: AutoConvertSettings

Auto-convert rules config

autoUnmount

autoUnmount: boolean

Undocumented

biDirConfirm

biDirConfirm: boolean

Indicates whether files to be copied from the device to the PC needs user confirmation during sync

biDirSync

biDirSync: boolean

Indicates whether content should by synced bidirectionally, i.e. also from the device to the PC

biDirSyncMetadata

biDirSyncMetadata: boolean

Indicates whether file metadata changes should be synced from the device to the PC

calculator

calculator: DeviceCalculator

Undocumented

connected

connected: boolean

Indicates whether this device is USB connected

convertArtwork

convertArtwork: boolean

Whether artwork should be converted

convertArtworkType

convertArtworkType: string

Type to which the artwork should be converted

copyToPCFolder

copyToPCFolder: string

Local folder representing where should be copied files from the device

customJSON

customJSON: string

Optional, sync handlers stores custom service data here

deleteConfirm

deleteConfirm: boolean

Indicates whether files deletion should be confirmed by user during auto sync

deleteConfirmUnknown

deleteConfirmUnknown: boolean

Undocumented

deleteUnknown

deleteUnknown: boolean

Indicates whether all device files that are no longer on the sync list should be deleted during auto sync

deleteUnsync

deleteUnsync: boolean

Indicates whether library files that are no longer on the sync list should be deleted during auto sync

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

enabled

enabled: boolean

Undocumented

handlerID

handlerID: string

Gets/Sets sync handler used for media sync, e.g. 'cloud', 'usb' etc.
See mediaSyncHandlers in mediaSync.js

hasFolderSupport

hasFolderSupport: boolean

Undocumented

hasPlaylistSupport

hasPlaylistSupport: boolean

Undocumented

id

id: number

Gets integer id of the object

imagePath

imagePath: string

Path to the image representing this device profile

isAutoSyncRunning

isAutoSyncRunning: boolean

Indicates whether auto-sync process is currently running

isFolderBased

isFolderBased: boolean

Indicates whether this profile is folder based, default is TRUE, but e.g. 'Google Play Music' utilizes this to FALSE

isNewlyCreated

isNewlyCreated: boolean

Indicates whether this device profiles is newly created (on first connect or first registration)

isObservable

isObservable: boolean

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

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

lastSyncTime

lastSyncTime: string

Returns last sync time

Returns

timestamp in UTC form 'YYYY-MM-DD HH:MM:SS'

name

name: string

Gets/Sets name of this device sync profile

objectType

objectType: string

Gets the object type as string

persistentID

persistentID: string

Gets persistent id of the object

preferStars

preferStars: boolean

Undocumented

profile_id

profile_id: string

Undocumented

randomSelection

randomSelection: boolean

Undocumented

removeAAByteRate

removeAAByteRate: number

Treshold (in bytes) for removeAAFromTag

removeAAFromTag

removeAAFromTag: boolean

Indicates whether artwork should by removed from file tags when it is larger than removeAAByteRate treshold

resizeArtwork

resizeArtwork: boolean

Whether artwork should be resized

resizeArtworkMaxRes

resizeArtworkMaxRes: number

Max. resultion to which the artwork should be resized

resyncOnMaskChange

resyncOnMaskChange: boolean

Indicates whether files should be re-uploaded to new locations once their target locations are changed by sync mask config
If false then MediaMonkey leave them in its original locations

saveAAToFolder

saveAAToFolder: boolean

Indicates whether artwork should by copied to the file folders on the device

saveAAToTag

saveAAToTag: boolean

Indicates whether artwork should by copied to the file tags on the device

scanOnConnect

scanOnConnect: boolean

Indicates whether device content should be scanned ASAP or once needed

scanning

scanning: boolean

Indicates whether content of this device is being scanned

statusInfo

statusInfo: Promise<any>

Undocumented

syncAAMask

syncAAMask: string

Mask representing target filename for artwork files

syncOnConnect

syncOnConnect: boolean

Undocumented

syncOnlyFirstArtist

syncOnlyFirstArtist: boolean

Indicates whether only first artist should be synced when multiple artists exists

syncOnlyFirstGenre

syncOnlyFirstGenre: boolean

Indicates whether only first genre should be synced when multiple genres exists

syncPlaylists

syncPlaylists: boolean

Indicates whether playlists should be synced to the device

title

title: string

Gets the object title

Methods

addTrack2Library

addTrack2Library(track, updateMetadata, checkDownloadStatus): Promise<any>
Adds device/cloud track into library (currently used for cloud content scanning into user library)
Parameters
- track: Track
  to be added
- updateMetadata: boolean
  Overwrite existing library metadata (if exists)
- checkDownloadStatus: boolean
  Checks whether the track is downloaded and returns as second parameter in the promise
Returns Promise<any>
- Defined in src/types/Native.ts:3514

addTracks2Library

addTracks2Library(tracks, updateMetadata, downloadMissing, taskProgress, isFullScan): Promise<any>
Adds device/cloud tracks into library (currently used for cloud content scanning into user library)
Parameters
- tracks: Tracklist
  to be added
- updateMetadata: boolean
  Overwrite existing library metadata (if exists)
- downloadMissing: boolean
  Indicates whether the unpaired tracks should be downloaded locally
- taskProgress: BackgroundTask
- isFullScan: boolean
  Indicates whether the tracks is full scan (to auto-remove no longer existing tracks from library)
Returns Promise<any>
- Defined in src/types/Native.ts:3525

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

canBiDiSynch

canBiDiSynch(): boolean
Returns boolean
Undocumented
- Defined in src/types/Native.ts:3413

canEject

canEject(): boolean
Returns boolean
Undocumented
- Defined in src/types/Native.ts:3414

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

commitAsync

commitAsync(): Promise<any>
Commits device profile modifications into database

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

createSyncProcess

createSyncProcess(mode): SharedObject
Creates sync process for manipulating media sync
see MediaSync class implementation in helpers/mediaSync.js for examples
Parameters
- mode: string
  can be either 'send' (manual sync) or 'auto' (auto sync)
Returns SharedObject
- Defined in src/types/Native.ts:3479

deleteFoldersAsync

deleteFoldersAsync(list): Promise<any>
Parameters
- list: StringList
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:3567

doCut

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

ejectAsync

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

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

getCachedThumb

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

getCheckStates

getCheckStates(list, onlyPartlyChecked): Promise<any>
Parameters
- list: SharedNodeList
- onlyPartlyChecked: boolean
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:3410

getClassName

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

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

getCollectionSettings

getCollectionSettings(idCollection): DeviceCollection
Gets collection settings object
see /controls/deviceConfig/syncToDevice.js for examples
Parameters
- idCollection: number
Returns DeviceCollection
- Defined in src/types/Native.ts:3427

getFolderList

getFolderList(aFolderType): SharedList<SharedFolder>
Gets folder list
folderType param can be either 'content' (for actual content listing)
or 'scanFromDevice' and 'syncFromDevice' for device folder configs (see /controls/deviceConfig/syncFromDevice.js for examples)
Parameters
- aFolderType: string
Returns SharedList<SharedFolder>
- Defined in src/types/Native.ts:3398

getFolderStringList

getFolderStringList(aFolderType): StringList
Parameters
- aFolderType: string
Returns StringList
Undocumented
- Defined in src/types/Native.ts:3399

getHasFolderSupport

getHasFolderSupport(): boolean
Folders are supported

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

getHasPlaylistSupport

getHasPlaylistSupport(): boolean
Playlists are supported

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

getIsDummy

getIsDummy(): boolean
Returns boolean
Undocumented
- Defined in src/types/Native.ts:3415

getIsOnSyncList

getIsOnSyncList(objectType, objId): Promise<any>
Parameters
- objectType: string
- objId: number
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:3411

getPersistentJSON

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

getPlaylistSettingsJSON

getPlaylistSettingsJSON(): string
Gets JSON representing playlist sync config, see /controls/deviceConfig/options/pnl_Playlists.js for possible values

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

getPlaylists

getPlaylists(): SharedList<DevicePlaylist>
Gets device playlists

Returns SharedList<DevicePlaylist>
as promise
- Defined in src/types/Native.ts:3455

getSupportedPlaylistFormats

getSupportedPlaylistFormats(): StringList
Gets list of supported playlist formats

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

getSyncedObjects

getSyncedObjects(): SharedList<SharedMediaObject>
Returns SharedList<SharedMediaObject>
Undocumented
- Defined in src/types/Native.ts:3408

getTargetMask

getTargetMask(maskType): string
Gets destination target mask for desired content type
Parameters
- maskType: string
Returns string
- Defined in src/types/Native.ts:3342

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

getTrackByPath

getTrackByPath(DevicePath): Track
Gets device track by its path
Parameters
- DevicePath: string
Returns Track
- Defined in src/types/Native.ts:3449

getTracklist

getTracklist(...params): Tracklist

Gets device content

Parameters

Rest ...params: any[]

Returns Tracklist

as promise

Example

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

getTracksToDownload

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

getWriteAccessRoot

getWriteAccessRoot(): string
Returns string
Undocumented
- Defined in src/types/Native.ts:3412

isMarked

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

is_iPodType

is_iPodType(): boolean
Returns boolean
Undocumented
- Defined in src/types/Native.ts:3417

loadFromProfileAsync

loadFromProfileAsync(path): Promise<any>
Loads all profile values from MMDC (MediaMonkey device configuration) file
Parameters
- path: string
  to the MMDC file
Returns Promise<any>
- Defined in src/types/Native.ts:3377

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

mergeTracklists

mergeTracklists(mergeTo, mergeFrom, byField): Promise<any>
Parameters
- mergeTo: Tracklist
- mergeFrom: Tracklist
- byField: string
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:3442

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

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

removeAsync

removeAsync(): Promise<any>
Removes this device profile

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

removeTracksFromLibrary

removeTracksFromLibrary(...params): Promise<any>
Removes device/cloud tracks from library (currently used for cloud content scanning into user library)
Parameters
- Rest ...params: any[]
Returns Promise<any>
- Defined in src/types/Native.ts:3548

resetProfileAsync

resetProfileAsync(): Promise<any>
Restores all profile values to the defaults

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

resetTargetMasks

resetTargetMasks(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:3350

saveToProfileAsync

saveToProfileAsync(path): Promise<any>
Saves all profile values to MMDC (MediaMonkey device configuration) file
Parameters
- path: string
  to the MMDC file
Returns Promise<any>
- Defined in src/types/Native.ts:3384

scanContent

scanContent(rescan): void
Inititates scanning of device content, is done automatically when getTracklist() is called and the content hasn't been scanned yet
Parameters
- rescan: boolean
  whether content should be rescanned for already scanned content
Returns void
- Defined in src/types/Native.ts:3504

scanContentAsync

scanContentAsync(rescan): Promise<any>
Re-scans device content, is done automatically when getTracklist() is called and the content hasn't been scanned yet
Parameters
- rescan: boolean
  whether content should be rescanned for already scanned content
Returns Promise<any>
- Defined in src/types/Native.ts:3498

setCapacityAsync

setCapacityAsync(capacity, spaceUsed): Promise<any>
Parameters
- capacity: number
- spaceUsed: number
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:3352

setContentAsync

setContentAsync(tracks): Promise<any>
Parameters
- tracks: Tracklist
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:3505

setDriveLetter

setDriveLetter(letter): void
Parameters
- letter: string
Returns void
Undocumented
- Defined in src/types/Native.ts:3351

setFolderList

setFolderList(folderType, list): void
Sets folder list as configured, see /controls/deviceConfig/syncFromDevice.js for examples
folderType param can be either 'scanFromDevice' or 'syncFromDevice'
Parameters
- folderType: string
- list: StringList
Returns void
- Defined in src/types/Native.ts:3407

setMarked

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

setPlaylistSettingsJSON

setPlaylistSettingsJSON(JSON): void
Sets JSON representing playlist sync config, see /controls/deviceConfig/options/pnl_Playlists.js for possible values
Parameters
- JSON: string
Returns void
- Defined in src/types/Native.ts:3364

setSyncedObjects

setSyncedObjects(list): void
Parameters
- list: SharedList<SharedObject>
Returns void
Undocumented
- Defined in src/types/Native.ts:3409

setTargetMask

setTargetMask(maskType, value): void
Sets destination target mask for desired content type
Parameters
- maskType: string
- value: string
Returns void
- Defined in src/types/Native.ts:3349

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

updateDriveLabelAsync

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

updatePlaylist2Library

updatePlaylist2Library(aTitle, guid, parent_guid, last_modified, criteria, aTracks, canUsePartialPlaylists): Promise<any>
Adds or updates device playlist into local user library (currently used for cloud content scanning into user library)
Parameters
- aTitle: string
- guid: string
  playlist guid (use empty string to created new one)
- parent_guid: string
  parent playlist guid (use empty string to insert under root)
- last_modified: string
  last modified timestamp
- criteria: string
  auto-playlist's criteria JSON
- aTracks: Tracklist
- canUsePartialPlaylists: boolean
  if TRUE then creates playlist even if not all tracks are matched/found
Returns Promise<any>
- Defined in src/types/Native.ts:3538

updateStatus

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

usbType

usbType(): string
Returns string
Undocumented
- Defined in src/types/Native.ts:3418

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 Device

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Device

Properties

allowWifiSync

asJSON

autoConvertConfig

autoUnmount

Undocumented

biDirConfirm

biDirSync

biDirSyncMetadata

calculator

Undocumented

connected

convertArtwork

convertArtworkType

copyToPCFolder

customJSON

deleteConfirm

deleteConfirmUnknown

Undocumented

deleteUnknown

deleteUnsync

deleted

dontNotify

Undocumented

enabled

Undocumented

handlerID

hasFolderSupport

Undocumented

hasPlaylistSupport

Undocumented

id

imagePath

isAutoSyncRunning

isFolderBased

isNewlyCreated

isObservable

isStatusBarSource

lastSyncTime

Returns

name

objectType

persistentID

preferStars

Undocumented

profile_id

Undocumented

randomSelection

Undocumented

removeAAByteRate

removeAAFromTag

resizeArtwork

resizeArtworkMaxRes

resyncOnMaskChange

saveAAToFolder

saveAAToTag

scanOnConnect

scanning

statusInfo

Undocumented

syncAAMask

syncOnConnect

Undocumented

syncOnlyFirstArtist

syncOnlyFirstGenre

syncPlaylists

title

Methods

addTrack2Library

Parameters