Sequence tag (advanced)

Modified on Mon, 8 Jan, 2018 at 9:41 AM

Definition

nisequence://path_to_folder

<!-- Copyright (c) 2018 The Interact Technology Group.
THE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
All rights reserved. -->

Usage

Embed an image sequence (animation) in the SmartPDF file. To customise the presentation with more advanced features (see below) add a file called "_sequence.plist" in the sequence folder.

Samples

nisequence://advancedsequence_folder

Sample of sequence configuration file “_sequence.plist”

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>repeat_count</key>
    <real>1</real>
    <key>frame_duration</key>
    <real>1</real>
    <key>transition_duration</key>
    <real>1</real>
    <key>transition</key>
    <string>stretch_bottom</string>
  </dict>
</plist>

<!-- Copyright (c) 2018 The Interact Technology Group.
THE CODE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
All rights reserved. -->

Keys and values for “_sequence.plist”

Key	Values	Description	Default value	Notes
frame_duration	<real>#</real>	Number of seconds each frame is displayed, not including the transition.	1
transition_duration	<real>#</real>	Number of seconds for the transition.	0.5
repeat_count	<real>#</real>	Number of times to repeat the sequence.	1	0 means to repeat forever
transition	slide_up slide_down slide_right slide_left stretch_bottom stretch_top stretch_left stretch_right fade retain	The transition keys control the transition effect.	fade	Transitions can be the same for the whole sequence, or can be configured per image. Transitions can also be different for the images appearing or disappearing.
transition_in, transition_out	Same as “transition”	Transition style as images appear/ disappear.	Defaults to "transition" value
transition_in_n, transition_out_n	Same as “transition”	Adding the image number to the key affects just that image.	Defaults to "transition" value	For example "transition_in_1" affects the second image (The image numbers

NOTES

The images are drawn in the place of the annotation box.
The background is transparent so it can appear as though its part of the PDF.
The images are loaded in alphabetical order, and the frames played in this order.
The “_sequence.plist” file contains a list of optional keys and values. Where a key does not exist, the default is used instead.