Working with the AviExport utility from command line

You can work with the AviExport utility from the command line using the AviExport.run file located in the <Axxon PSIM installation folder>\Modules folder for 32-bit Windows OS or <Axxon PSIM installation folder>\Modules64 for 64-bit Windows OS.

You can use the following parameters when working with the AviExport utility from the command line:

-format:format—output container format. This is an optional parameter, the default is avi.

Available values:

• fs—Axxon PSIM file system;
• avi—avi container;
• mkv—mkv container;
• asf—asf container;
• flv—flv container;
• mp4—mp4 container.

-extr:path—the path to the portable version of the player (Axxon_player_portable.exe for x32 or Axxon_player_portable64.exe for x64), it also includes the exe file mapping mode. This is an optional parameter. It is disabled by default.

-period:[start time;end time]—general export period. Time is set in the YYYY-MM-DDThh:mm:ss format, for example, 2015-09-29T12:10:50. This is a mandatory parameter if you don't set a period for each camera.

-periods:[start time:end time]—specific export periods. You can set periods in the timestamp (UTC_UNIX) format. This is a mandatory parameter if you don't set a general period. The character ":" is the separator in one period. The character ";" is the separator between periods.
Example of specific periods:
from 2024-01-31T12:00:00.000 to 2024-01-31T12:30:00.000 and from 2024-01-31T13:00:00.000 to 2024-01-31T13:30:00.000 are set this way:
periods:[1706691600000:1706693400000;1706695200000:1706697000000].

If a camera doesn't have its own period, use the -period:[start time;end time] parameter of the general period.
If each camera has its own period, it isn't necessary to use the -period:[start time;end time] parameter of the general period.
If a camera doesn't have its own period and you don't set the general export period, then the export fails.
The example of the command line where the first camera has its own period while the second and the third cameras have one general period:
-period:[2024-01-31T15:00:00.000;2024-01-31T16:00:00.000] 
-src:[127.0.0.1:900;id=1];audio:[auto];vcodec:[fourcc=x264;r=0;k=0;q=0];periods:[1706691600000:1706693400000;1706695200000:1706697000000];titles:[off]
-src:[127.0.0.1:900;id=2];audio:[auto];vcodec:[fourcc=x264;r=0;k=0;q=0];titles:[off]
-src:[127.0.0.1:900;id=3];audio:[auto];vcodec:[fourcc=x264;r=0;k=0;q=0];titles:[off].
-dst:path—path to the file or folder. If the path ends with the ‘\’ character, then it is identified as a path to the folder, and file names are generated automatically. The path is always identified as the path to the folder when exporting to Axxon PSIM file system. If the path doesn't exist, then the utility tries to create it automatically. This is a mandatory parameter.

-src:[path to source]—data source (audio and video) and its parameters. You must specify at least one or more data sources. There are the following ways to specify a path:

1. [ip address:port;id=camera ID]. Example -src:[127.0.0.1:900;id=5]
2. [ip address:port;id=camera ID;ipstorage_id=Edge storage ID]. This is for Edge storage archive export. Example -src:[127.0.0.1:900;id=500;ipstorage_id=500]

After you specify the data source via the ";" separator, you can add optional parameters:

• vcodec:value—video codec settings. It isn't used when packing to the Axxon PSIM file system is performed. Available values:
• vcodec:auto—bin packing with no conversion (used by default).
• vcodec:axxn—bin packing with no conversion (AXXN codec is specified).
• vcodec:[codec parameters]—for example, vcodec:[fourcc=DIVX;r=-1;k=-1:q=6]
• audio:value—audio source settings. Available values:
• audio:auto—audio is exported automatically if it is configured and present in the archive (used by default).
• audio:off—audio isn't exported for this camera.
• audio:[path]—path to the audio source in the [ip address:port;id= microphone ID] or ["path to Axxon PSIM archive";id=microphone ID] format.
• titles:[parameters]—titles settings. It isn't used when packing to the Axxon PSIM file system is performed. Parameters:
• int—titles are exported in the bin body.
• ext—titles are exported to an external .srt file.
  By default, titles aren't exported.

-options:[parameters]—additional export parameters. All parameters are optional. It isn't used when packing to the Axxon PSIM file system is performed. Possible parameters:

• holesplit=[number]—time (in milliseconds) allowed between archive intervals during which intervals are merged in one file. If the time between intervals exceeds the specified value, then there is no merging. The following data is recorded to a new file. By default, all intervals are merged. When multiple channels are exported into the .avi file, the parameter isn't used.
• maxsize=[number]—maximum size of a file (in MB). If the size is exceeded, then the following data is recorded to a new file. The maximum allowed value as well as the default value is 4096.
• duration=[number]—maximum duration of one file (in seconds). If the duration is exceeded, then the following data is recorded to a new file. By default, there is no duration limit.

Export examples with different codecs:

• DIVX: 
  -dst:"E:\test\export1\" -format:avi -extr:"E:\test\export1\Axxon_player_portable.exe" -src:[127.0.0.1:900;id=5];vcodec:[fourcc=DIVX;r=-1;k=-1:q=6];audio:[127.0.0.1:910;id=2];titles:[ext;int] -period:[2015-09-29T12:10:50;2015-09-29T12:40:50]
• xvid mpeg-4: 
  -dst:"C:\Users\AxxonSoft\Documents\Axxon PSIM\export\" -tmp:"C:\Users\AxxonSoft\Documents\Axxon PSIM\export\132CCBFA-18F3-E811-AA66-1C1B0DE52EED\" -format:avi -period:[2018-11-28T17:20:00.000;2018-11-28T17:21:00.000] -options:[maxsize=670] -src:[127.0.0.1:900;id=1];vcodec:[fourcc=xvid;r=0;k=0;q=0];titles:[ext;int]
• x264vfw: 
  -dst:"C:\Users\AxxonSoft\Documents\Axxon PSIM\export\" -tmp:"C:\Users\AxxonSoft\Documents\Axxon PSIM\export\F533AE2C-19F3-E811-AA66-1C1B0DE52EED\" -format:avi -period:[2018-11-28T17:20:00.000;2018-11-28T17:21:00.000] -options:[maxsize=670] -src:[127.0.0.1:900;id=1];vcodec:[fourcc=x264;r=0;k=0;q=0];titles:[ext;int].