This information is for Vicon Shogun 1.7. For up-to-date help, see the latest Shogun documentation.

Vicon Shogun banner


Load a native file (*.vdf or *.hdf). You are prompted for a filename.

Use loadFile when you need to open an existing *.vdf file. This action will close the open scene, prompting you first to save it.

You can also use this command to import or merge non-native motion capture files into your existing scene.

Functional area

File handling

Command syntax


loadFile ["filename1" "filename2" ...][-startTime integer] [-type string] [-i] [-importType string] [-range integer integer] [-createBackupClip] [-currentSubject] 


String path name of file to be loaded (can be specified by the File Open or File Import dialog boxes or explicitly by name)


NameFlag argumentsArgument typeExclusive toComments
startTime1integerForce the incoming animation to start at the specified time.
type1stringOpen the dialog with filter set to given extension (e.g. "asf" sets extension filter to .asf)
i0Import from a non-native file. Importer is chosen by matching the file extension.
importType1stringArguments for this option are:
"ImportSelectedCreateNew" - the default and does as indicated
"ImportOnlySelected" - ignores any modules being imported that are not selected
"AlwaysCreateNew" - forces importers to always create new modules
createBackupClip0Automatically creates a backup clip for each clip created upon import.

Use to ensure VSR, VSS, VST, or VSK files merge into the current subject when loaded, regardless of whether the subject name of the current subject matches the file, for example, you can use this flag to import an updated VSS into an existing VSS.

Return value



loadFile -i -importType "mergeSelected"; 
// This command prompts you to select a non-native file.
// The selected file is merged into your existing scene.

loadFile "C:/temp/myFile.vdf";
// Loads a native VDF file

Additional information

Related commands