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

Vicon Shogun banner


Sets the play range to include the frame range specified.

Use this command in the Script Editor to set the playRange of your scene to a subset of the current range.

playRange is very useful for trimming the working range of your animation file without losing any of the data. When you reset a playRange, the data that lies outside of the new range will still remain in the file if saved as a .vdf. Upon export to another format, only the playRange is exported.

The playRange command is not undoable.

SMPTE times must be surrounded by quotes

Functional area

Playback control

Command syntax


playRange inTime outTime[-r] [-start] [-end] [-save] [-restore]


yesStart frame integer , required unless -end option is specified
yesEnd frame integer, required unless the -start option is specified


NameFlag argumentsArgument typeExclusive toComments
r0Set range relative to start/end of current play range
start0endSets the playRange start to the current frame
end0startSets the playRange end to the current frame
save0restoreSave current play range before applying play range changes. Can be restored by next playRange -restore call.
restore0saveRestore the last saved play range before applying play range changes.

Return value



playRange -save;
playRange 340 345;
playRange -restore;
// This sequence of commands saves the current play range,
// then sets it to a new range; enabling you to restore
// the original range at any time.
// set start of play Range to 50
playRange -start 50;

// set end of play Range to 200
playRange -end 200;

Additional information

Related commands