Kstars

Ekos DBus Interface - Capture Module

Public Slots

Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::abort ()
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::pause ()
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::restartCamera (const QString &name)
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::start ()
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::stop (CaptureState targetState=CAPTURE_IDLE)
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::suspend ()
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::toggleSequence ()
 
Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::toggleVideo (bool enabled)
 

Detailed Description

Ekos::Capture interface provides advanced scripting capabilities to capture image sequences.

Public Slots

◆ abort

Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::abort ( )
inlineslot

DBUS interface function.

Aborts all jobs and mark current state as ABORTED. It simply calls stop(CAPTURE_ABORTED)

Definition at line 482 of file capture.h.

◆ pause

void Ekos::Capture::pause ( )
slot

DBUS interface function.

pause Pauses the Sequence Queue progress AFTER the current capture is complete.

Definition at line 693 of file capture.cpp.

◆ restartCamera

void Ekos::Capture::restartCamera ( const QString name)
slot

DBus interface function.

restartCamera Restarts the INDI driver associated with a camera. Remote and Local drivers are supported.

Parameters
nameName of camera to restart. If a driver defined multiple cameras, they would be removed and added again after driver restart.
Note
Restarting camera should only be used as a last resort when it comes completely unresponsive. Due the complex nature of driver interactions with Ekos, restarting cameras can lead to unexpected behavior.

Definition at line 7340 of file capture.cpp.

◆ start

void Ekos::Capture::start ( )
slot

DBUS interface function.

Start the execution of the Capture::SequenceJob list #jobs.

Starts the sequence queue capture procedure sequentially by starting all jobs that are either Idle or Aborted in order.

Starting the execution of the Capture::SequenceJob list selects the first job from the ist that may be executed and starts to prepare the job (

See also
prepareJob()).

Several factors determine, which of the jobs will be selected:

  • First, the list is searched to find the first job that is marked as idle or aborted.
  • If none is found, it is checked whether ignoring job progress is set. If yes, all jobs are are reset (
    See also
    reset()) and the first one from the list is selected. If no, the user is asked whether the jobs should be reset. If the user declines, starting is aborted.

Definition at line 769 of file capture.cpp.

◆ stop

void Ekos::Capture::stop ( CaptureState  targetState = CAPTURE_IDLE)
slot

DBUS interface function.

Stop, suspend or abort the currently active job.

Stop all jobs and set current job status to aborted if abort is set to true, otherwise status is idle until sequence is resumed or restarted.

Parameters
targetStatestatus of the job after abortion
targetState

Definition at line 882 of file capture.cpp.

◆ suspend

Q_SCRIPTABLE Q_NOREPLY void Ekos::Capture::suspend ( )
inlineslot

DBUS interface function.

Aborts all jobs and mark current state as SUSPENDED. It simply calls stop(CAPTURE_SUSPENDED) The only difference between SUSPENDED and ABORTED it that capture module can automatically resume a suspended state on its own without external trigger once the right conditions are met. When whatever reason caused the module to go into suspended state ceases to exist, the capture module automatically resumes. On the other hand, ABORTED state must be started via an external programmatic or user trigger (e.g. click the start button again).

Definition at line 494 of file capture.h.

◆ toggleSequence

void Ekos::Capture::toggleSequence ( )
slot

DBUS interface function.

toggleSequence Toggle sequence state depending on its current state.

  1. If paused, then resume sequence.
  2. If idle or completed, then start sequence.
  3. Otherwise, abort current sequence.

Definition at line 714 of file capture.cpp.

◆ toggleVideo

void Ekos::Capture::toggleVideo ( bool  enabled)
slot

DBUS interface function.

Toggle video streaming if supported by the device.

Parameters
enabledSet to true to start video streaming, false to stop it if active.

Definition at line 6360 of file capture.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Mon Sep 26 2022 04:14:07 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.