Class Filesystem

Filesystem operations. Access via the global app.filesystem.

Filesystem

Constructors

constructor

Methods

addNetworkResourceAsync copyFileAsync copyFilesAsync copyFolderAsync correctFilename createFolderAsync deleteFile deleteFileAsync deleteFolder deleteFolderAsync deleteNetworkResourceAsync dirExists dirExistsAsync fileExistsAsync fileNamesToSongList getApplicationPath getAudioExtensions getAudioExtensionsAsync getAudioFileTypes getCurrentLessMD5Async getDBFolderListAsync getDataFolder getDiskSpaceAsync getDriveList getFileContentAsync getFileFromString getFileInfoAsync getFileSizeAsync getFileType getFolderFromString getFolderOfPathAsync getFoldersList getIconsFolder getInsertedMediaList getLastScannedFolders getMonitoredFolders getNetworkResourceList getPathSeparator getPlaylistExtensions getPlaylistExtensionsAsync getPlaylistFileTypes getPluginsFolder getScanExtensions getScriptsPath getSystemFolderMyMusic getSystemFolderMyVideo getUserFolder getVideoExtensions getVideoExtensionsAsync getVideoFileTypes isKnownFiletype loadSkinFile loadTextFromFileAsync networkResourceFromPath processLocatedFiles renameFile renameFileAsync renameFiles renameFilesAsync saveTextToFileAsync scanForMedia scanForMovedFiles setFileContentAsync setFileInfoAsync setLastScannedFolders setScanExtensions showScanLog simpleScanForMedia startAutoScanner toShortPath

Constructors

constructor

Methods

addNetworkResourceAsync

  • addNetworkResourceAsync(path): Promise<any>

  • Adds network resource

    Parameters

    • path: string

      Path of the resource to add

    Returns Promise<any>

copyFileAsync

  • copyFileAsync(src, dst): Promise<any>

  • Copy file.

    Parameters

    • src: string

      Source filename

    • dst: string

      New filename

    Returns Promise<any>

    Promise is fulfilled when action is completed.

copyFilesAsync

  • copyFilesAsync(srcList, destFolder, addToDB?, dontShowOverwritePrompt?, dontShowErrors?): Promise<any>

  • Copy files.
    NOTE: Starting from version 5.0.4 accepts also StringList as first param

    Parameters

    • srcList: Tracklist | StringList

      Source file list

    • destFolder: string

      Destination folder

    • Optional addToDB: boolean

      Tracks will be added to database

    • Optional dontShowOverwritePrompt: boolean

      Prompt to overwrite won't be shown

    • Optional dontShowErrors: boolean

      Error log won't be shown

    Returns Promise<any>

    Promise is fulfilled when action is completed.

copyFolderAsync

  • copyFolderAsync(path, destination, params?): Promise<any>

  • Copy/Move folder.

    Parameters

    • path: string

      Folder to copy/move

    • destination: string

      Target folder where to copy/move

    • Optional params: {
          all?: boolean;
          db?: boolean;
          move?: boolean;
          recursive?: boolean;
      }

      Copy/Move parameters

      • Optional all?: boolean

        Undocumented

      • Optional db?: boolean

        Undocumented

      • Optional move?: boolean

        Undocumented

      • Optional recursive?: boolean

        Undocumented

    Returns Promise<any>

correctFilename

  • correctFilename(filename): string

  • Modifies string so that can be used as filename. i.e. Removes illegal filename chars.

    Parameters

    • filename: string

      Path to convert

    Returns string

    corrected path version

createFolderAsync

  • createFolderAsync(path): Promise<any>

  • Creates folder and returns as SharedFolder in Promise fullfillment

    Parameters

    • path: string

      Path of the folder to create

    Returns Promise<any>

deleteFile

  • deleteFile(src): boolean

  • Deletes a file. It's LEGACY, use deleteFileAsync instead!

    Parameters

    • src: string

    Returns boolean

deleteFileAsync

  • deleteFileAsync(fileName): Promise<any>

  • Delete file.

    Parameters

    • fileName: string

      Path of file to delete

    Returns Promise<any>

deleteFolder

  • deleteFolder(path): void

  • Parameters

    • path: string

    Returns void

    Undocumented

deleteFolderAsync

  • deleteFolderAsync(path, recycle, onlyEmpty?, dontDeleteFromDB?): Promise<any>

  • Delete folder.

    Parameters

    • path: string | StringList

      Folder to delete

    • recycle: boolean

      To recycle bin

    • Optional onlyEmpty: boolean

      Only if the folder has no other non-media content

    • Optional dontDeleteFromDB: boolean

      Deletes the content, but not from the MM database (leaving deadlinks there) -- Aadded in 5.0.4

    Returns Promise<any>

deleteNetworkResourceAsync

  • deleteNetworkResourceAsync(res): Promise<any>

  • Removes network resource

    Parameters

    Returns Promise<any>

dirExists

  • dirExists(path): boolean

  • Returns true, if directory exists. Note: It's LEGACY, was replaced by dirExistsAsync

    Parameters

    • path: string

      Path to the directory.

    Returns boolean

dirExistsAsync

  • dirExistsAsync(path): Promise<boolean>

  • Returns true as first promise param (if directory exists).

    Parameters

    • path: string

      Path to the directory.

    Returns Promise<boolean>

fileExistsAsync

  • fileExistsAsync(path): Promise<any>

  • Returns true as first promise param (if directory exists).

    Parameters

    • path: string

      Path to the file.

    Returns Promise<any>

fileNamesToSongList

  • fileNamesToSongList(list): Tracklist

  • Gets tracklist from filenames list

    Parameters

    Returns Tracklist

getApplicationPath

  • getApplicationPath(): string

  • Gets application path to executable

    Returns string

getAudioExtensions

  • getAudioExtensions(): StringList

  • Gets list of all supported audio extensions.

    Returns StringList

getAudioExtensionsAsync

getAudioFileTypes

  • getAudioFileTypes(...params): StringList

  • Parameters

    • Rest ...params: any[]

    Returns StringList

    Undocumented

getCurrentLessMD5Async

  • getCurrentLessMD5Async(): Promise<any>

  • Returns Promise<any>

    Undocumented

getDBFolderListAsync

  • getDBFolderListAsync(parentID, collectionID): DBFolderList

  • Gets list of track's folders.

    Parameters

    • parentID: number

      Parent Folder ID

    • collectionID: number

      Collection ID

    Returns DBFolderList

getDataFolder

  • getDataFolder(): string

  • Gets MediaMonkey data folder

    Returns string

getDiskSpaceAsync

  • getDiskSpaceAsync(path): Promise<{
        spaceFree: number;
        spaceTotal: number;
    }>

  • Returns free/total space in bytes

    Parameters

    • path: string

      Path to the directory.

    Returns Promise<{
        spaceFree: number;
        spaceTotal: number;
    }>

getDriveList

getFileContentAsync

  • getFileContentAsync(fileName, from?, to?): Promise<FileBuffer>

  • Gets file content or a specified portion

    Parameters

    • fileName: string

      File path of the file

    • Optional from: number

      from position in bytes

    • Optional to: number

      to position in bytes

    Returns Promise<FileBuffer>

getFileFromString

  • getFileFromString(fullname): string

  • Parameters

    • fullname: string

    Returns string

    Undocumented

getFileInfoAsync

  • getFileInfoAsync(fileName): Promise<any>

  • Gets file info like dateCreated, dateModified, dateAccessed, size as JSON
    date values are in the ISO format, see app.filesystem.timestamp2DateTime and app.utils.dateTime2Timestamp for the conversion

    Parameters

    • fileName: string

      File path of the file

    Returns Promise<any>

    promise with param fileInfo (JSON format)

    Example

    var jsonInfo = await app.filesystem.getFileInfoAsync(track.path);
    var info = JSON.parse( jsonInfo);
    console.log( info.dateModified);

getFileSizeAsync

  • getFileSizeAsync(fileName): Promise<number>

  • Gets file size in bytes

    Parameters

    • fileName: string

      File path of the file

    Returns Promise<number>

getFileType

  • getFileType(path): string

  • Parameters

    • path: string

    Returns string

    Undocumented

getFolderFromString

  • getFolderFromString(path, isTemporary?): SharedFolder

  • Returns the folder as SharedFolder object

    Parameters

    • path: string

      Path of the folder to get

    • Optional isTemporary: boolean

    Returns SharedFolder

getFolderOfPathAsync

  • getFolderOfPathAsync(path): Promise<any>

  • Gets folder of path

    Parameters

    • path: string

    Returns Promise<any>

    with folder object

getFoldersList

  • getFoldersList(path): Promise<any>

  • Gets list folders for given path as StringList

    Parameters

    • path: string

    Returns Promise<any>

getIconsFolder

  • getIconsFolder(): string

  • Gets folder containing icons

    Returns string

getInsertedMediaList

getLastScannedFolders

  • getLastScannedFolders(): StringList

  • Gets last scanned folders

    Returns StringList

getMonitoredFolders

getNetworkResourceList

getPathSeparator

  • getPathSeparator(): string

  • Returns path separator for the current OS

    Returns string

getPlaylistExtensions

  • getPlaylistExtensions(): StringList

  • Gets list of all supported playlist extensions.

    Returns StringList

getPlaylistExtensionsAsync

getPlaylistFileTypes

  • getPlaylistFileTypes(...params): StringList

  • Parameters

    • Rest ...params: any[]

    Returns StringList

    Undocumented

getPluginsFolder

  • getPluginsFolder(global): string

  • Parameters

    • global: boolean

    Returns string

    Undocumented

getScanExtensions

getScriptsPath

  • getScriptsPath(): string

  • Returns string

    Undocumented

getSystemFolderMyMusic

  • getSystemFolderMyMusic(): string

  • Gets system folder for music

    Returns string

getSystemFolderMyVideo

  • getSystemFolderMyVideo(): string

  • Gets system folder for video

    Returns string

getUserFolder

  • getUserFolder(): string

  • Gets user personal folder

    Returns string

getVideoExtensions

  • getVideoExtensions(): StringList

  • Gets list of all supported video extensions.

    Returns StringList

getVideoExtensionsAsync

getVideoFileTypes

  • getVideoFileTypes(...params): StringList

  • Parameters

    • Rest ...params: any[]

    Returns StringList

    Undocumented

isKnownFiletype

  • isKnownFiletype(ext): boolean

  • Returns whether this file type (extensions) is associated with MediaMonkey

    Parameters

    • ext: string

    Returns boolean

loadSkinFile

  • loadSkinFile(params): SharedResponse

  • Parameters

    • params: {
          callback?: (() => void);
          file: string;
      }
      • Optional callback?: (() => void)

        Undocumented

          • (): void

          • Returns void

      • file: string

        Undocumented

    Returns SharedResponse

    Undocumented

loadTextFromFileAsync

  • loadTextFromFileAsync(fileName, params?): Promise<string>

  • Load text from file.

    Parameters

    • fileName: string

      full path to the file to load

    • Optional params: {
          encoding?: TextEncoding;
      }

      Object containing additional parameters.

    Returns Promise<string>

networkResourceFromPath

processLocatedFiles

  • processLocatedFiles(list): Promise<any>

  • Process located files and update them in database.

    Parameters

    Returns Promise<any>

renameFile

  • renameFile(src, dst): boolean

  • Renames file. It's LEGACY, use renameFileAsync instead!

    Parameters

    • src: string
    • dst: string

    Returns boolean

renameFileAsync

  • renameFileAsync(src, dst, OverwritePrompt): Promise<any>

  • Rename file.

    Parameters

    • src: string

      Source filename

    • dst: string

      New filename

    • OverwritePrompt: boolean

      Overwrites with prompting

    Returns Promise<any>

    Promise is fulfilled when action is completed.

renameFiles

  • renameFiles(...params): Promise<any>

  • Alias of renameFilesAsync.

    Parameters

    • Rest ...params: any[]

    Returns Promise<any>

renameFilesAsync

  • renameFilesAsync(srcList, destFolder, params?): Promise<any>

  • Move or copy list of files.
    Starting from version 5.0.4 moves also non-media files and accepts also StringList as first param
    Prior to version 5.0.4 the function was named just renameFiles

    Parameters

    • srcList: Tracklist | StringList

      Source file list

    • destFolder: string

      Destination folder or dest. filename

    • Optional params: {
          addDB?: boolean;
          canRemoveEmptyFolders?: boolean;
          changeFileName?: boolean;
          move?: boolean;
      }

      Object containing additional parameters. Possible properties are:

      • Optional addDB?: boolean

        Undocumented

      • Optional canRemoveEmptyFolders?: boolean

        Undocumented

      • Optional changeFileName?: boolean

        Undocumented

      • Optional move?: boolean

        Undocumented

    Returns Promise<any>

saveTextToFileAsync

  • saveTextToFileAsync(fileName, text, params?): Promise<void>

  • Save text to file.

    Parameters

    • fileName: string

      full path to the file to save

    • text: string

      text to save

    • Optional params: {
          append?: boolean;
          encoding?: string;
      }

      Object containing additional parameters. Possible properties are:

      • Optional append?: boolean

        Undocumented

      • Optional encoding?: string

        Undocumented

    Returns Promise<void>

scanForMedia

  • scanForMedia(pathsToScan, containers, exts, params): Promise<any>

  • Scan selected path for media files.

    Parameters

    • pathsToScan: StringList

      Paths to scan

    • containers: SharedList<ServerContainer>

      Server containers to scan

    • exts: string

      Extensions to scan (comma separated).

    • params: any

      Additional parameters

    Returns Promise<any>

scanForMovedFiles

  • scanForMovedFiles(sl, paths): Promise<any>

  • Scan selected tracks for their new location.

    Parameters

    Returns Promise<any>

setFileContentAsync

  • setFileContentAsync(content, fileName, from?): Promise<Promise<void>>

  • Sets file content for a specified portion of data

    Parameters

    • content: FileBuffer

      buffer data to write

    • fileName: string

      File path of the file

    • Optional from: number

      from position in bytes (0 by default)

    Returns Promise<Promise<void>>

setFileInfoAsync

  • setFileInfoAsync(fileName, params): Promise<any>

  • Sets file info like dateModified, readOnly date values are in the ISO format, see app.filesystem.timestamp2DateTime and app.utils.dateTime2Timestamp for the conversion
    NOTE: Introduced in 5.0.4

    Parameters

    • fileName: string

      File path of the file

    • params: string

      Params to be set in JSON format

    Returns Promise<any>

    result

    Example

    app.filesystem.setFileInfoAsync( 'C:\\Temp\\file.txt', '{"dateModified":"2020-02-02 22:22:22", "readOnly":"true"}');

setLastScannedFolders

  • setLastScannedFolders(paths): void

  • Sets last scanned folders

    Parameters

    Returns void

setScanExtensions

  • setScanExtensions(list): void

  • Parameters

    Returns void

    Undocumented

showScanLog

  • showScanLog(ImportedFiles, FailedFiles, UpdatedFiles, SkippedFiles): void

  • Parameters

    Returns void

    Undocumented

simpleScanForMedia

  • simpleScanForMedia(path): Promise<any>

  • Scan selected path for media files.

    Parameters

    • path: string

      Path to scan

    Returns Promise<any>

startAutoScanner

  • startAutoScanner(): void

  • Starts auto scanner

    Returns void

toShortPath

  • toShortPath(filename): string

  • On Windows returns the short path version used by programs that require the earlier 8.3 file naming convention
    NOTE: Introduced in 5.0.4

    Parameters

    • filename: string

    Returns string

    short path version

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc