Command Line Reference

From Album Art Downloader

Jump to: navigation, search

Option names may be preceded by a / or a -

Common Options

 /artist      Artist to search for            (/artist "Artist Name")
              May be abbreviated to /ar       (/ar "Artist Name")
              Parameter name may be omitted
              if this is the first parameter  ("Artist Name")

 /album       Album to search for             (/album "Album Name")
              May be abbreviated to /al       (/al "Album Name")
              Parameter name may be omitted
              if this is the second parameter ("Artist Name" "Album Name")
 
 /path        Default path to save art as     (/path "\Art\Folder.jpg")
              May be abbreviated to /p        (/p "\Art\Folder.jpg")
              Parameter name may be omitted
              if this is the third parameter  ("Artist Name" "Album Name" "\Art\Folder.jpg")

              The following variables can be used in paths:
               %artist%     Artist searched for
               %album%      Album searched for
               %name%       Name of the image found
               %extension%  Default file extension for the image
               %source%     Name of the source where image was found
               %size%       Dimensions of the image
               %sequence%   (Only for command line interface)
                            A sequence number for the image, corresponding to
                             the number passed to /sequence, or "1" by default

 /sources     Searches only the specified     (/sources "Amazon,Coveralia")
              sources. Others are disabled.
              Separate sources with commas.
              May be abbreviated to /s

 /exclude     Does not search the specified   (/exclude "Local Files,Google")
              sources. Separate sources with
              commas.
              May be abbreviated to /es

 /minSize     Specifies the minimum size of   (/minSize 300)
              image, in pixels, to use.
              Both horizontal and vertical
              dimensions must conform.
              May be abbreviated to /mn       (/mn 300)
              
 /maxSize     Specifies the maximum size of   (/maxSize 1000)
              image, in pixels, to use.
              The smallest dimension of the
              image must conform.
              May be abbreviated to /mx       (/mx 1000)

Options only for full UI (AlbumArt.exe)

 /f           Provided for backwards          (/p "\Art" /f "Folder.jpg")
              compatibility only. When
              specified, the value is
              appended to the path.

 /localImagesPath
              Path to search for local image  (/localImagesPath "\Art\Unsorted\**\*.jpg")
              files in. If not specified, the
              path to save art in is used.
              
              The following variables can be used in paths:
               %artist%     Artist searched for
               %album%      Album searched for
               *            Wildcard, matches any characters
               \**\         Subfolder search. Any folders will match
                             at this point in the path. For example
                             "\Art\Unsorted\**\*.jpg" will match:
                              \Art\Unsorted\image.jpg
                              \Art\Unsorted\misc\image.jpg
                              \Art\Unsorted\misc\old\image.jpg
                             
                             "\Art\Unsorted\*\*.jpg" will match only:
                              \Art\Unsorted\misc\image.jpg

 /autoclose   Closes the search window after  (/autoclose)
              saving. To avoid closing, use
              Save As.
              May be abbreviated to /ac
              
              Append "off" to disable closing (/autoclose off)
              the search window after saving,
              if this option is on by default.
 
 /sort (name|size|source)[+|-]
              Sets the sorting to use for the (/sort size-)
              results.
              May be abbreviated to /o        (/o size-)
              
              The first character may be - to
              indicate descending search, or
              + to indicate ascending. If it
              is omitted, ascending is assumed.
              
              The field to sort by must be one
              of:
               name (may be abbreviated to n) (/o n+)
               size (may be abbreviated to s)
               source (may be abbreviated to o)

 
 /fileBrowser                                 (/fileBrowser "\Music")
              Opens a File Browser window. If
              a path is specified, starts
              searching that path immediately.
              If no path is specified, the
              browser window is just opened.  (/fileBrowser)
              
              If other parameters are not
              specified, then a search window
              will not be shown initially.

 /foobarBrowser [search]                      (/foobarBrowser search)
              Opens a Foobar Browser window. If
              the search parameter is present,
              starts searching the foobar media
              library immediately. If the search
              parameter is omitted, the browser
              window is just opened.          (/foobarBrowser)
              
              If other parameters are not
              specified, then a search window
              will not be shown initially.

 /separateInstance                            (/separateInstance)
              Starts a new instance as a new
              process, which will neither re-use
              nor be re-used by any other
              instance of the application.
              
              (not recommended)

Options only for command line interface (aad.exe)

 /minAspect   Specifies the minimum aspect ratio  (/minAspect 0.9)
              of the image to use. This is how
              square the image must be, where a
              value of 1 represents perfectly
              square (600 x 600, for example). An
              image of size 600 x 300 would only
              be allowed if /minAspect were 0.5
              or lower.
              May be abbreviated to /ma           (/ma 0.9)

 /sequence    Specifies which result to use, if   (/sequence 2)
              more than one are found. For
              example, passing 2 as the value
              here would ignore the first result
              found, and use the second.
              May be abbreviated to /seq          (/seq 2)
 
 /listSources Produces a list of all available    (/listSources)
              sources to search.
              May be abbreviated to /l            (/l)

Exit errorlevel codes:

 0            Success
 1            No image found
 -1           Error occured
Personal tools