Class Masks

Mask related utilities to be used in scripts

Hierarchy

Masks

Index

Constructors

Methods

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

Constructors

constructor

new Masks(): Masks
Returns Masks

Methods

getDefaultFileMasks

getDefaultFileMasks(): StringList
Gets default set of masks for track organization (incl. path and filename masks).

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

getDefaultWizardFileMasks

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

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

getDefaultWizardPathMasks

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

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

getDescription

getDescription(mask): string
Gets description of the mask
Parameters
- mask: string
  
  Mask
Returns string
- Defined in src/types/Native.ts:4900

getMaskPart

getMaskPart(mask): string
Gets only mask part of the mask
Parameters
- mask: string
  
  Mask
Returns string
- Defined in src/types/Native.ts:4922

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
- Defined in src/types/Native.ts:4929

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
- Defined in src/types/Native.ts:4879

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
- Defined in src/types/Native.ts:4868

getMaskResultForListAsync

getMaskResultForListAsync(SL, mask, forfilename, NotUseUnknown, concatPath, targetExt): Promise<any>
Undocumented
Parameters
- SL: Tracklist
- mask: string
- forfilename: boolean
- NotUseUnknown: boolean
- concatPath: boolean
- targetExt: string
Returns Promise<any>
- Defined in src/types/Native.ts:4856

getPathPart

getPathPart(mask): string
Gets path part of the mask
Parameters
- mask: string
  
  Mask
Returns string
- Defined in src/types/Native.ts:4915

getTrackPathParts

getTrackPathParts(SD, trackmask): StringList
Gets list of mask parts of the filename.
Parameters
- SD: Track
- trackmask: string
Returns StringList
- Defined in src/types/Native.ts:4937

getVisName

getVisName(...params): string
Gets name of the mask
Parameters
- Rest ...params: any[]
Returns string
- Defined in src/types/Native.ts:4908

mask2SongCol

mask2SongCol(mask): number
Undocumented
Parameters
- mask: string
Returns number
- Defined in src/types/Native.ts:4901

mask2VisMask

mask2VisMask(mask): string
Convert simple mask to visual mask (like %A to ).
Parameters
- mask: string
  
  Mask
Returns string
- Defined in src/types/Native.ts:4886

visMask2Mask

visMask2Mask(mask): string
Covert visual mask to simple mask (like to %A)
Parameters
- mask: string
  
  Mask
Returns string
- Defined in src/types/Native.ts:4893

Class Masks

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Masks

Methods

getDefaultFileMasks

Returns StringList

getDefaultWizardFileMasks

Returns StringList

getDefaultWizardPathMasks

Returns StringList

getDescription

Parameters

mask: string

Returns string

getMaskPart

Parameters

mask: string

Returns string

getMaskPathAndFileName

Parameters

mask: string

Returns StringList

getMaskResultForItem

Parameters

SD: Track

mask: string

forfilename: boolean

NotUseUnknown: boolean

concatPath: boolean

Returns string

getMaskResultForList

Parameters

SL: Tracklist

mask: string

forfilename: boolean

NotUseUnknown: boolean

concatPath: boolean

targetExt: string

Returns StringList

getMaskResultForListAsync

Undocumented

Parameters

SL: Tracklist

mask: string

forfilename: boolean

NotUseUnknown: boolean

concatPath: boolean

targetExt: string

Returns Promise<any>

getPathPart

Parameters

mask: string

Returns string

getTrackPathParts

Parameters

SD: Track

trackmask: string

Returns StringList

getVisName

Parameters

Rest ...params: any[]

Returns string

mask2SongCol

Undocumented

Parameters

mask: string

Returns number

mask2VisMask

Parameters

mask: string

Returns string

visMask2Mask

Parameters

mask: string

Returns string

`Rest` ...params: any[]