Class Masks

Mask related utilities to be used in scripts

Masks

Constructors

constructor

Methods

getDefaultFileMasks getDefaultWizardFileMasks getDefaultWizardPathMasks getDescription getMaskPart getMaskPathAndFileName getMaskResultForItem getMaskResultForList getMaskResultForListAsync getPathPart getTrackPathParts getVisName mask2SongCol mask2VisMask visMask2Mask

Constructors

constructor

Methods

getDefaultFileMasks

  • getDefaultFileMasks(): StringList

  • Gets default set of masks for track organization (incl. path and filename masks).

    Returns StringList

getDefaultWizardFileMasks

  • getDefaultWizardFileMasks(): StringList

  • Gets list of default masks combinations for filename (used by mask edity wizard).

    Returns StringList

getDefaultWizardPathMasks

  • getDefaultWizardPathMasks(): StringList

  • Gets list of default masks conbinations for path definition (used by mask edit wizard).

    Returns StringList

getDescription

  • getDescription(mask): string

  • Gets description of the mask

    Parameters

    • mask: string

      Mask

    Returns string

getMaskPart

  • getMaskPart(mask): string

  • Gets only mask part of the mask

    Parameters

    • mask: string

      Mask

    Returns string

getMaskPathAndFileName

  • getMaskPathAndFileName(mask): StringList

  • Gets list of mask folder by folder. Last item in list is file name mask.

    Parameters

    • mask: string

      Mask

    Returns StringList

getMaskResultForItem

  • getMaskResultForItem(SD, mask, forfilename, NotUseUnknown, concatPath): string

  • Get new title/path of the track based on mask. See wiki for available masks.

    Parameters

    • SD: Track
    • mask: string

      Mask to be used

    • forfilename: boolean
    • NotUseUnknown: boolean
    • concatPath: boolean

      Guess complete path when relative mask is used

    Returns string

getMaskResultForList

  • getMaskResultForList(SL, mask, forfilename, NotUseUnknown, concatPath, targetExt): StringList

  • Get new title/path of the track based on mask. See wiki for available masks.

    Parameters

    • SL: Tracklist
    • mask: string

      Mask to be used

    • forfilename: boolean
    • NotUseUnknown: boolean
    • concatPath: boolean

      Guess complete path when relative mask is used

    • targetExt: string

      Target extension, for use for mask

    Returns StringList

getMaskResultForListAsync

  • getMaskResultForListAsync(SL, mask, forfilename, NotUseUnknown, concatPath, targetExt): Promise<any>

  • Parameters

    • SL: Tracklist
    • mask: string
    • forfilename: boolean
    • NotUseUnknown: boolean
    • concatPath: boolean
    • targetExt: string

    Returns Promise<any>

    Undocumented

getPathPart

  • getPathPart(mask): string

  • Gets path part of the mask

    Parameters

    • mask: string

      Mask

    Returns string

getTrackPathParts

  • getTrackPathParts(SD, trackmask): StringList

  • Gets list of mask parts of the filename.

    Parameters

    • SD: Track
    • trackmask: string

    Returns StringList

getVisName

  • getVisName(...params): string

  • Gets name of the mask

    Parameters

    • Rest ...params: any[]

    Returns string

mask2SongCol

  • mask2SongCol(mask): number

  • Parameters

    • mask: string

    Returns number

    Undocumented

mask2VisMask

  • mask2VisMask(mask): string

  • Convert simple mask to visual mask (like %A to ).

    Parameters

    • mask: string

      Mask

    Returns string

visMask2Mask

  • visMask2Mask(mask): string

  • Covert visual mask to simple mask (like to %A)

    Parameters

    • mask: string

      Mask

    Returns string

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc