Command Line Parameters

AnimPlayer supports command line parameters when starting the application (AnimPlayer.exe).
This is quite useful if you want to include AnimPlayer in an existing workflow or pipline.

  • To launch AnimPlayer from Autodesk 3d Studio Max please click here.
  • To launch AnimPlayer from Autodesk Maya please click here.

To load a sequence pass a single file name or folder name including the full path e.g.:

  • AnimPlayer "c:\data\media\test\test_01.0001.tga"
  • AnimPlayer "c:\data\media\test\"

You can also add a settings file name (.animplayer_set) to load a specific configuration, e.g.:

  • AnimPlayer "c:\data\test_01.0001.tga" "c:\data\ntsc.animplayer_set"

together with a sound file name (.wav) to load a sound file, e.g.:

  • AnimPlayer "c:\data\test.0001.tga" "c:\data\ntsc.animplayer_set" "c:\media\speech.wav"

Specifying a project file name (.animplayer_prj) to load an existing project is also valid, e.g.:

  • AnimPlayer "c:\data\media\current_project.animplayer_prj"

File Names, Numbers and Wildcards

It is highly recommended to put all file names in "double quotes".

AnimPlayer always expects an image file name in the following format:

pathnamenumberextension
c:\data\media\ test_01. 0001 .tga
  • The path can be either a drive path (c:\data\media\) or an UNC path (\\Server1\media\).
  • AnimPlayer supports any digit length of ordinal frame numbers but all files of an sequence must have the same amount of digits . The frame number have to be the last part of the file name, but in front of the extension.
  • An image extension starting with a . is always required.

List of valid wild cards

  • @ or ? substitute a single char in the name or number.
  • # or * substitute the entire frame number.
  • wildcards in path or extension may work but are currently not officially supported.

Valid examples:

\\Server1\media\test_??.#.tga loads all frames of all tests (same as next line)
\\Server1\media\test_??.####.tga loads all frames of all tests
C:\media\test_01.00??.tga loads frames 0-99 of test 01

Unix Style File Names

AnimPlayer supports unix style file names. All unix filenames will be mapped to drive C:\, e.g:

/tmp/previews/render_01234.tga -> C:\tmp\previews\render_01234.tga

Better suggestions are welcome!

Complete Command Line Reference

  • AnimPlayer imagefile|path [-singleframe]
  • AnimPlayer imagefile|path [settingsfile] [soundfile]
  • AnimPlayer imagemask [startframe[-endframe] [step]] [settingsfile] [soundfile]
  • AnimPlayer projectfile
SymbolDescriptionExample
imagefile full qualified image filename without wildcards  
path full qualified path to a folder  
imagemask image file name with path where the number is replaced by wildcard(s)  
settingsfile filename of a AnimPlayer settings file with extension *.animplayer_set  
soundfile filename of a uncompressed wave sound file with extension *.wav  
projectfile filename of a AnimPlayer project file with extension
*.animplayer_prj
 
     
startframe number of start frame 123
-endframe number of end frame, works only together with startframe 123-244
step load only every step frame, works only together with start/endframe 2
     
-singleframe loads only the very first frame, operates AnimPlayer like an image viewer  
     
| means or  
[] for optional parameter(s)  

Examples

AnimPlayer \\server1\media\layer_#.tga 120-340 2 d:\speech.wav d:\ntsc.animplayer_set

Loads every 2nd frame of sequence layer_#.tga from frame 120 to frame 340,
also loads a sound and settings file.

AnimPlayer c:\media\zbuffer_0123.tga -singleframe

Loads only c:\media\zbuffer_0123.tga and supress automatic sequence detection

 

Updates

feedfeed