Add further help manual pages
[entangle:entangle.git] / help / C / plugin-shooter.page
1 <!-- -*- xml -*- -->
2 <page xmlns="http://projectmallard.org/1.0/"
3       type="topic"
4       id="plugin-shooter">
5   <info>
6     <link type="guide" xref="index#plugins"/>
7
8     <desc>Automated capture of image sequences</desc>
9   </info>
10
11   <title>Shooter Plugin</title>
12
13   <p>
14     The Shooter plugin provides a simple camera automation script that allows the
15     shutter to be triggered repeatedly in a loop. This can be used to timelapse
16     photography, night sky astrophotography and more.
17   </p>
18
19   <p>
20     The left hand control panel which contains the primary camera settings and histogram
21     has an further <gui>Automation</gui> section which will appear if any scripts are
22     registered. The shooter plugin will register a script to this section. When the
23     script is selected, two configurable parameters will be shown. The first determines
24     the total number of shots to capture and the second sets the delay between each shot,
25     in seconds.
26   </p>
27
28   <p>
29     To start the script, the regular <gui>Capture</gui> button on the toolbar should be
30     used. <app>Entangle</app> will proceed to run the script, capturing shots repeatedly
31     until the limit is reached. It is possible to terminate the script early by pressing
32     the <gui>Cancel</gui> button on the toolbar. The captured images will be downloaded
33     from the camera immediately after each one is captured. Downloading the images may
34     take a measurable amount of time. The script does not attempt to compensate for this,
35     so the delay interval time is in addition to the download time.
36   </p>
37
38 </page>