If you want to discover how to archive programatically, you can type this in your shell:
/opt/Autodesk/io/bin/flame_archive --help
This will print out the following information:
Registered thread 'NetMtor' [ 140482508222464 ]
Output log to: '/opt/Autodesk/log/flame_archive.log'.
MP: Using 32 cpus (32 visible)
USAGE: flame_archive <operation> <modifiers> <options>
Examples:
flame_archive -f -F /tmp/archive1 # Format archive file
flame_archive -a -P pj1 -W wksp -L lib1 -E /clip1 -F /tmp/arch1 # Add clip1 to arch1
flame_archive -a -E /projects/TestProject/a38310ac_53a82f6b_0006a1c1/a38310ac_53a82f6b_0006a1c3/a38310ac_53a82f77_000079d7/a38310ac_53a82ff6_000d6100 -F /tmp/arch1 # Add Wiretap to arch1
flame_archive -a monday -P pj1 -F /tmp/arch1 # Archive project prj1 in arch1 under session "monday"
flame_archive -a -P pj1 -B cliplist.txt -F /tmp/arch1 # Batch archive a list of clip to arch1
flame_archive -r -F /tmp/arch1 -S '/Archive\ Session\ -\ 2014\\/03\\/12\ 23:43:40/prj1' # Restore project prj1 from arch1
flame_archive -r -F /tmp/arch -S @<UID> -P pj1 -W wksp -L lib1 -E /fld1/fld2 # Restore clip having <UID> to project prj1 in lib1/fld1/fld2
flame_archive -r -F /tmp/arch -B cliplist.txt -P pj1 -W wksp -L lib1 -E /fld1/fld2 # Batch restore clips found in cliplist.txt to project prj1 in lib1/fld1/fld2
flame_archive -l # List the contents of local host
flame_archive -l -F /tmp/arch1 -u # List arch1 (with UIDs)
flame_archive -l -F /tmp/arch1 -x # List arch1 (in XML)
flame_archive -l -F /tmp/arch1 -S @H_-1518333780_S_..._893796 # List an entry in arch1, given a UID
flame_archive -l -P project1 -E /wksp/Libraries/MyLib/MyFolder # List MyFolder from project1
flame_archive -e -P project1 # Provide Size Estimate for project1
flame_archive -c -F /tmp/archive1 # Convert file archive
Main operation mode:
-a, --archive [session_name]
archive clips to a file archive. The selected entries
are grouped under an archive session. The default
session name is "Archive Session - <date>". This can
be overridden by specifying 'session_name'.
-r, --restore restore clips from a file archive.
-l, --list list dump of archive file or clips.
-f, --format format an archive file.
-e, --estimate estimate space of clips when archiving and restoring.
-c, --convert convert file archive to current format.
Operation modifiers:
To identify an archive (and a specific entry within that archive):
-F, --file <ARCHIVE_FILE_PATH>
-S, --source <PATH_TO_ENTRY_IN_ARCHIVE>
To identify a project (and a specific entry within that project):
-P, --project <PROJECT_NAME>
-W, --workspace <WORKSPACE_NAME>
-L, --library <LIBRARY_NAME>
-E, --entry <ENTRY_PATH_IN_PROJECT> or <WIRETAP_PATH_IN_PROJET>
-B, --batch <PATH_TO_FILE >
When using the -S or -E path option, you can separate the entry names
of a hierarchy with a '/' character. If a name contains a '/', you can
escape the character by using a '\\' in front of the '/' so it does not
get confused with an entry separator. Similarly, if the name contains a space,
the space can be escaped with a single '\'
You can also use the '@' symbol to specify a UID for any entry.
An entry with a matching UID will be searched recursively from
the current path location. A UID may be used at the begining of
the path, for a global search, or after specifying a few entry levels
using the '/' separator, in order to refine the UID search.
Here are some examples of possibile modifiers used to locate an entry,
using a path within an archive or project:
-P pjr1 # project prj1
-P prj1 -W workspace -L mylib # clip library
-P prj1 -E /workspace/myLib # idem
-P prj1 -L mySharedlib # Shared library
-P pro1 -E @H_-15183_U_771516 # recursive search of UID in project
-P pro1 -E /workspace/Desktop/Reels@H_-15183_U_771516 # recursive search of UID in reels
-F /tmp/myArchive # archive
-F /tmp/myArchive -S @H_-15183_U_771516 # recursive search of UID in archive
-P prj1 -E '/Date\ :\ 2015\\/21\\/12/Folder2' # using the '\\' escape sequence
# in front of the date '/' characters and
# a single '\' in front of spaces, for a
When using -B, you must specify a file containing a list of UIDs starting by @. or a
Wiretap path. The entries must be provided one by line.
Options:
-A, --archiveLibrary <PATH>, use PATH as the directory path for the archive library where TOC files are stored
-u, --displayuid with -l, display the UID when listing
-n, --name <NAME> with -f, use NAME as the name of archive when formatting, default is 'Archive'
-t, --comment <TEXT> with -f, use TEXT as the comment when formatting, can be omitted
-i, --capacity <SIZE> with -f, use SIZE for the capacity when formatting an archive, default is 1GB
-N, --normal, active 'Normal' mode, default is 'Compact'
-k, --linked, do not copy uncached sources in archive, default is to copy
-O, --omit <LIST>
<LIST> is a comma-separated list of at least one of the following:
sources : do not include source caches in archive (only relevant with --linked)
renders : do not include TimelineFX renders in archive
maps : do not include maps and ML cache in archive
unused : like 'sources' but applied to unused versions only
-p, --preVerify, verify source data before archiving, if illegal, stop archiving
-y, --postVerify, verify archive data after archiving
-g, --ignore, ignore preVerify failure and continue archiving
-m, --mode <MODE> with -e, one of 'All', 'MetaData', 'Video', 'Audio', for estimation
-x, --xml with -l, list archive file in xml format
-v, --verbose
-T, --toc with -f, -a and -l, the operation will generate the HTML TOC
-b, --background, with -T generate thumbnails in parallel
-V, --volume <VOLUME> use a specific volume
-G, --group <GROUP> with -f, use GROUP as the group of archive when formatting
-h, --help
Stopping managed threads.