Class MediaSync

Object for initiating media sync to/from a device or storage

MediaSync

Constructors

constructor

new MediaSync(device): MediaSync
Parameters
- device: Device
Returns MediaSync
- Defined in src/helpers/mediaSync.ts:3227

Properties

`Private` _ERR_TERMINATED

_ERR_TERMINATED: string

Undocumented

`Private` _fastTrackAccess

_fastTrackAccess: any

Undocumented

device

device: Device

Undocumented

files

files: StringList

Undocumented

isScheduled

isScheduled: boolean

Undocumented

process

process: any

Undocumented

queue

queue: any[]

Undocumented

queuedTracksCount

queuedTracksCount: number

Undocumented

queuedTracksUploadedCount

queuedTracksUploadedCount: number

Undocumented

taskProgress

taskProgress: BackgroundTask

Undocumented

taskType

taskType: string

Undocumented

Methods

__scanToLibrary

__scanToLibrary(syncHandler, last_content_signature?): Promise<unknown>
Parameters
- syncHandler: any
- Optional last_content_signature: any
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:4200

_acquireSyncLock

_acquireSyncLock(metadataStorage, sync): Promise<unknown>
Parameters
- metadataStorage: MetadataStorage
- sync: MediaSync
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:4105

_finishProcess

_finishProcess(success): void
Parameters
- success: boolean
Returns void
Undocumented
- Defined in src/helpers/mediaSync.ts:3930

_getFastTrack

_getFastTrack(info): any
Parameters
- info: any
Returns any
Undocumented
- Defined in src/helpers/mediaSync.ts:4349

_readContentFromMetaFiles

_readContentFromMetaFiles(device, info_file?, files?): Promise<unknown>
Parameters
- device: Device
- Optional info_file: any
- Optional files: any
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:3965

_releaseSyncLock

_releaseSyncLock(metadataStorage, sync): any
Parameters
- metadataStorage: MetadataStorage
- sync: MediaSync
Returns any
Undocumented
- Defined in src/helpers/mediaSync.ts:4115

_scanPlaylists

_scanPlaylists(syncHandler, parent_playlist?): Promise<void>
Parameters
- syncHandler: any
- Optional parent_playlist: any
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:4253

_updatePlaylist2Library

_updatePlaylist2Library(syncHandler, playlist): Promise<unknown>
Parameters
- syncHandler: any
- playlist: any
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:4242

_updateTracks2Lib

_updateTracks2Lib(tracks, replaceExisting, isFullScan?): Promise<void>
Parameters
- tracks: Tracklist
- replaceExisting: boolean
- Optional isFullScan: boolean
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:4290

_uploadPlaylists

_uploadPlaylists(playlists): Promise<void>
Parameters
- playlists: SharedList<Playlist>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3822

addPlaylist

addPlaylist(playlist, tracks): any
Parameters
- playlist: Playlist
- tracks: Tracklist
Returns any
Undocumented
- Defined in src/helpers/mediaSync.ts:3404

addTracks

addTracks(tracks): Promise<void>
Parameters
- tracks: Tracklist
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3394

checkFreeSpace

checkFreeSpace(): Promise<void>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3443

downloadTracks

downloadTracks(): Promise<void>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3606

downloadTracks2Library

downloadTracks2Library(): Promise<void>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:4326

exportMetaFiles

exportMetaFiles(sync): Promise<void>
Parameters
- sync: MediaSync
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:4069

finishProcess

finishProcess(success): void
Parameters
- success: boolean
Returns void
Undocumented
- Defined in src/helpers/mediaSync.ts:3937

getStorageInfo

getStorageInfo(): Promise<void>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3453

getStreamUrl

getStreamUrl(device, file): any
Parameters
- device: Device
- file: any
Returns any
Undocumented
- Defined in src/helpers/mediaSync.ts:3949

getStreamUrls

getStreamUrls(device, files): any
Parameters
- device: Device
- files: any
Returns any
Undocumented
- Defined in src/helpers/mediaSync.ts:3957

getSyncList

getSyncList(): Promise<void>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3409

linkTracks

linkTracks(): Promise<void>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3424

prepareTrackSource

prepareTrackSource(info): Promise<void>
Parameters
- info: any
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3654

readMetaFiles

readMetaFiles(device, sync?, retryNumber?): Promise<unknown>
Parameters
- device: Device
- Optional sync: MediaSync
- Optional retryNumber: number
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:3987

removeEmptySubfolders

removeEmptySubfolders(): Promise<void>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3876

removeFile

removeFile(target): any
Parameters
- target: any
Returns any
Undocumented
- Defined in src/helpers/mediaSync.ts:3471

removeFiles

removeFiles(filePaths, tracks): Promise<void>
Parameters
- filePaths: StringList
- tracks: Tracklist
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3486

removeFromDevice

removeFromDevice(tracklist): void
Removes tracks from the device
Parameters
- tracklist: Tracklist
Returns void
Method
removeFromDevice
- Defined in src/helpers/mediaSync.ts:3361

removeOldContent

removeOldContent(): Promise<unknown>
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:3554

runAutoSync

runAutoSync(runLibraryScan?): Promise<void>
Initiates auto sync with this device
Parameters
- Optional runLibraryScan: boolean
Returns Promise<void>
Method
runAutoSync
- Defined in src/helpers/mediaSync.ts:3298

runFileConversion

runFileConversion(): Promise<unknown>
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:3563

scanContent

scanContent(device): Promise<unknown>
Parameters
- device: Device
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:4120

scanToLibrary

scanToLibrary(): Promise<void>
Scans remote (cloud/device) content into library

Returns Promise<void>
Method
scanToLibrary
- Defined in src/helpers/mediaSync.ts:4148

sendToDevice

sendToDevice(tracks, playlist): Promise<void>
Sends tracks into device
Parameters
- tracks: Tracklist
  to send
- playlist: Playlist
Returns Promise<void>
Method
sendToDevice
- Defined in src/helpers/mediaSync.ts:3239

startProcess

startProcess(mode): Promise<void>
Parameters
- mode: string
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3916

updateDeletionText

updateDeletionText(files): void
Parameters
- files: StringList
Returns void
Undocumented
- Defined in src/helpers/mediaSync.ts:3387

uploadAdditionalFiles

uploadAdditionalFiles(files): Promise<void>
Parameters
- files: StringList
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3571

uploadFile

uploadFile(source, target): any
Parameters
- source: string
- target: string
Returns any
Undocumented
- Defined in src/helpers/mediaSync.ts:4060

uploadPlaylists

uploadPlaylists(): Promise<unknown>
Returns Promise<unknown>
Undocumented
- Defined in src/helpers/mediaSync.ts:3861

uploadTracks

uploadTracks(): Promise<void>
Returns Promise<void>
Undocumented
- Defined in src/helpers/mediaSync.ts:3690