Utilities to be used in scripts. Access via the global app.utils.

Utils

Constructors

Properties

Methods

addCachedThumbPath addToPlayedAsync assignGroupData2ListAsync bitRateToStr boolToYesNo burnAudioCDTracksAsync canFileStoreImages checkFormatAvailability clearThumbPathsCache convertProcessorsCount copyToClipboard createAlbumlist createArtistlist createEmptyAlbum createEmptyArtist createEmptyGenre createEmptyList createEmptyTrack createSharedList createTrackGroupData createTracklist createUUID dateTime2Timestamp dateTimeToStr dialogOpenFile dialogSaveFile droppingFolder ejectDriveAsync fixFilenames formatNormalization formatTimestamp freqToStr getApplicationVersion getAudioCDInfoAsync getAudioCDTracksAsync getBurnDriveListAsync getConst getCoverTypes getDataFromClipboard getDate getDateNow getDateNowInt getDateNow_UTC getDirectory getDragFileMIME getDroppedFiles getDuplicates getFilename getGoldInfo getJustInstalled getLingBase getMainMonitorInfo getMaxPathLength getMetadataInfoFromTracksAsync getMonitorInfoFromCoords getNormalizeText getNumberOfTracksUsingCoverAsync getPortableMode getRegistryValue getSampleTrack getSampleTrackAsync getTaskbarColor getTaskbarPosition getTempFilePathAsync getTypeStringId getTypeText getUNCPath getUsedLanguage getUserName getValueLink getWindowsVersionMajor isAbsolutePath isAccessibleMediaAsync isRegistered language2shortcut lingCompare logStackTrace md5HexaHash modifyFilenamesExtAsync multiString2VisualString myDecodeDate myEncodeDate myFormatDateTime normalizationDiff normalizeAlbumName normalizeMultipleString now openExplorerFolder prepareImage registerApp registerLink registeredName removeCoversIfLast removeFilenameExtension resolveDropFiles resolveDropFolders resolveDropImage saveImageAsync shellExecute showCursor showTaskBar showTrialExpiredDialog showVirtualKeyboard songTimeToStr songTimeToStrEx stereoToStr strToSongTimeEx string2BPM stringSimilarity system text2TrackType timestamp2DateTime visualString2MultiString

Constructors

Properties

web: Web

Returns web utils class

Methods

  • Parameters

    Returns void

    Undocumented

  • Parameters

    Returns Promise<any>

    Undocumented

  • Parameters

    • groupData: Track
    • alist: Tracklist
    • withSave: boolean
    • tagModified: boolean
    • applyArtworkToAlbum: boolean

    Returns Promise<any>

    Undocumented

  • Parameters

    • BR: number

    Returns string

    Undocumented

  • Parameters

    • i: boolean

    Returns string

    Undocumented

  • Parameters

    Returns Promise<any>

    Undocumented

  • Parameters

    • fname: string

    Returns boolean

    Undocumented

  • Parameters

    Returns Promise<any>

    Undocumented

  • Returns void

    Undocumented

  • Parameters

    • count: number

    Returns number

    Undocumented

  • Copy objects to clipboard.

    Parameters

    • data: SharedObject

      Objects to copy, typically SongList.

    • Optional params: {
          cut?: boolean;
          srcObject?: any;
      }

      Object with additional static (serializable) data

      • Optional cut?: boolean

        Undocumented

      • Optional srcObject?: any

        Undocumented

    Returns Promise<any>

  • Creates new AlbumList interface to be used as list of albums.

    Parameters

    • Optional loaded: boolean

      set as loaded

    Returns AlbumList

  • Creates new ArtistList interface to be used as list of albums.

    Parameters

    • Optional loaded: boolean

    Returns ArtistList

  • Creates empty album data, useful for storing temporary data etc.

    Returns Album

    album

  • Creates empty artist data, useful for storing temporary data etc.

    Returns Artist

    artist

  • Creates empty genre data, useful for storing temporary data etc.

    Returns Genre

    genre

  • Creates empty object list. Unlike createSharedList it supports searching/filtering. isLoaded needs to be properly set to true (once the list is filled) so that searching/filtering works!

    Returns SharedUIList<SharedObservable>

  • Creates empty track data, useful for storing temporary data etc.

    Returns Track

    track

  • Creates empty shared object list, is similar to createEmptyList, but does not support auto-update and searching/filtering

    Returns SharedList<SharedObject>

  • Returns Track

    Undocumented

  • Creates new Tracklist interface to be used as list of tracks.

    Parameters

    • Optional loaded: boolean

      set as loaded

    Returns Tracklist

  • Returns string

    Undocumented

  • Converts dateTime to timestamp format 'YYYY-MM-DD HH:MM:SS'

    Parameters

    • val: number

    Returns string

  • Parameters

    • dt: number

    Returns string

    Undocumented

  • Opens system's open file dialog

    Parameters

    • initialDir: string
    • defaultExt: string
    • filter: string
    • title: string
    • Optional allowMultiSelect: boolean

    Returns Promise<any>

  • Opens system's save file dialog

    Parameters

    • initialDir: string
    • defaultExt: string
    • filter: string
    • title: string
    • Optional defaultFilename: string

    Returns Promise<any>

  • Returns boolean

    Undocumented

  • Ejects media of the removable drive
    Introduced in version 5.0.4

    Parameters

    • Letter: string

      drive letter of the drive to eject media

    Returns Promise<any>

  • This function auto-resolves duplicate and overly long filenames, adds numbered suffix for dups and shortened long paths

    Parameters

    • namesToFix: StringList

      List of finenames to fix

    • checkedState: SharedList<Base>

      List with check states (only checked item will be taken into account)

    • cutLongPath: boolean

      Whether the paths should be shortened to 260 chars

    Returns void

  • Parameters

    • NormalizeValue: number

    Returns string

    Undocumented

  • Returns pretty print local date time

    Parameters

    • timestamp: string

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

    Returns string

  • Parameters

    • i: number

    Returns string

    Undocumented

  • Get the application version, with the specified level of detail.

    Parameters

    • levels: number

      Level of detail, i.e. return major.minor, major.minor.release, etc. Accepts integers 1 through 4.

    Returns string

    Version number with the requested level of detail.

    Example

    app.utils.getApplicationVersion(1); // returns "5"
    app.utils.getApplicationVersion(2); // returns "5.0"
    app.utils.getApplicationVersion(3); // returns "5.0.2"
    app.utils.getApplicationVersion(4); // returns "5.0.2.2532"
  • Gets audio CD album/tracks information from Freedb

    Parameters

    • Letter: string

      drive letter of the CD drive (use empty string to search all audio CD/DVD/BD drives)

    Returns Promise<any>

  • Gets tracks from audio CD

    Parameters

    • Letter: string

      Drive letter of the CD drive (use empty string to search all audio CD/DVD/BD drives)

    Returns Promise<any>

  • Returns Promise<any>

    Undocumented

  • Parameters

    • id: string

    Returns string

    Undocumented

  • Returns object with data from clipboard.

    Parameters

    • Optional justTest: boolean

      Since bitmaps take a long time to retrieve from the clipboard, if true, the data will just be "bitmap" in the case where an image was copied to the clipboard.

    Returns ClipboardDataReturn

  • Parameters

    • val: number

    Returns any

    Undocumented

  • Returns number

    Undocumented

  • Returns number

    Undocumented

  • Returns number

    Undocumented

  • Parameters

    • path: string

    Returns string

    Undocumented

  • Parameters

    • index: number

    Returns string

    Undocumented

  • This function compares strings in list and return new list with duplicated strings (each duplicate is represented once in returned list).

    Parameters

    Returns StringList

  • Parameters

    • path: string

    Returns string

    Undocumented

  • Returns string

    Undocumented

  • Returns boolean

    Undocumented

  • Get lingual base of the string field (useful when comparing/matching song metadata) Examples: 'I am Believer - 2006 Remaster' ==> 'I am Believer' 'More of The Monkees (Deluxe Edition)' ==> 'More of The Monkees' 'A New Machine (Pt. 1) - 2019' ==> 'New Machine' 'I Want You Back - Radio Edit') ==> 'I Want You Back' 'Rock with You - Single Version' ==> 'Rock with You'

    Parameters

    • str: string

      text string to process

    Returns string

  • Returns any

    Undocumented

  • Returns number

    Undocumented

  • Parameters

    Returns Promise<any>

    Undocumented

  • Parameters

    • Rest ...params: any[]

    Returns any

    Undocumented

  • Parameters

    • NormalizeTrack: number
    • NormalizeAlbum: number

    Returns string

    Undocumented

  • Parameters

    • imagepath: string

    Returns Promise<any>

    Undocumented

  • Retrieve true when app is in portable mode.

    Returns boolean

  • Gets Windows registry value for given key and value

    Parameters

    • key: string

      Registry path

    • value: string

      value to get under given path

    Returns string

    Example

    let value = app.utils.getRegistryValue( 'HKEY_CURRENT_USER\\Control Panel\\Colors', 'ButtonFace');
    
  • Parameters

    • trackType: string

    Returns Track

    Undocumented

  • Gets a random track fullfilling the given type

    Parameters

    • trackType: string

      (can be: music, video, musicvideo, classical, audiobook, podcast, videopodcast, tv)

    Returns Promise<any>

    track

  • Returns any

    Undocumented

  • Returns any

    Undocumented

  • Gets temporary file path in the temp directory and returns as param of the promise's resolve func

    Returns Promise<any>

  • Parameters

    • i: number

    Returns string

    Undocumented

  • Parameters

    • i: number

    Returns string

    Undocumented

  • Parameters

    • path: string

    Returns Promise<any>

    Undocumented

  • Returns string

    Undocumented

  • Returns string

    Undocumented

  • Returns number

    Undocumented

  • Checks whether path is absolute (e.g. C:\...)

    Parameters

    • path: string

    Returns boolean

  • Parameters

    • idMedia: number

    Returns Promise<any>

    Undocumented

  • Return true if app is licensed.

    Returns boolean

  • Parameters

    • lang: string

    Returns string

    Undocumented

  • Linguist compare of two strings e.g. 'a-ha' matches ' aha' 'Vague / E La Nave Va' matches 'Vàgue/E la Nave Va'

    Parameters

    • str1: string

      string 1 to compare

    • str2: string

      string 2 to compare

    • ignoreBrackets: boolean

      if TRUE then ignores the appendixes in brackets -- like ...(remastered)

    Returns boolean

  • Returns string

    Undocumented

  • Returns 32-character hexadecimal md5 hash of given string. String is converted to UTF8 before hashing

    Parameters

    • s: string

      string to hash

    • Optional secretId: string

      secret key id, which is appended before hash

    Returns string

  • Parameters

    Returns Promise<any>

    Undocumented

  • Parameters

    • s: string

    Returns string

    Undocumented

  • Converts text date representation to integer.

    Parameters

    • text: string

      String date value

    Returns number

  • Converts integer date representation to string.

    Parameters

    • val: number

      Integer date value

    Returns string

  • Parameters

    • val: number

    Returns string

    Undocumented

  • Returns difference between the default target level (89 db) and configured target level

    Returns number

  • Parameters

    • name: string

    Returns string

    Undocumented

  • Parameters

    • s: string

    Returns string

    Undocumented

  • Gets DateTime value corresponding to now() -- used e.g. for track.lastTimePlayed

    Returns number

  • Opens folder in file explorer (e.g. Windows explorer on Windows)

    Parameters

    • path: string

      Path to open

    Returns Promise<any>

  • Parameters

    • url: string
    • maxWidth: number
    • maxHeight: number
    • callback: any

    Returns void

    Undocumented

  • Parameters

    • username: string
    • licenseKey: string

    Returns Promise<any>

    Undocumented

  • Returns string

    Undocumented

  • Returns string

    Undocumented

  • Parameters

    • arr: any

    Returns void

    Undocumented

  • Parameters

    • path: string

    Returns string

    Undocumented

  • Returns Promise<any>

    Undocumented

  • Returns Promise<any>

    Undocumented

  • Parameters

    • Rest ...params: any[]

    Returns Promise<any>

    Undocumented

  • Parameters

    • imageLink: string

    Returns Promise<any>

    Undocumented

  • Parameters

    • show: boolean

    Returns void

    Undocumented

  • Show/hide system taskbar (Windows only). Used mainly for fullscreen video.

    Parameters

    • showIt: boolean

      Boolean value to show (true) or hide (false) system taskbar.

    Returns void

  • Parameters

    • plugTitle: string
    • missingCodecConst: string

    Returns Promise<any>

    Undocumented

  • Returns void

    Undocumented

  • Parameters

    • time: number

    Returns string

    Undocumented

  • Parameters

    • time: number

    Returns string

    Undocumented

  • Parameters

    • i: number

    Returns string

    Undocumented

  • Parameters

    • str: string

    Returns number

    Undocumented

  • Parameters

    • ws: string

    Returns number

    Undocumented

  • Parameters

    • s1: string
    • s2: string
    • caseSensitive: boolean

    Returns number

    Undocumented

  • Returns string

    Undocumented

  • Parameters

    • Text: string

    Returns number

    Undocumented

  • Converts timestamp format 'YYYY-MM-DD HH:MM:SS' to dateTime accepts also ISO 8601 form YYYY-MM-DDTHH:mm:ss.sssZ

    Parameters

    • val: string

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

    Returns number

  • Parameters

    • s: string

    Returns string

    Undocumented