Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Public Types | Public Attributes | List of all members
iMS::ImagePlayer::PlayConfiguration Struct Reference

This struct sets the attributes for the ImagePlayer to use when initiating an Image Playback. More...

#include <include\ImageOps.h>

Public Types

using post_delay = std::chrono::duration< std::uint16_t, std::ratio< 1, 10000 > >
 This type is used internally to define the correct scaling between std::chrono classes and the hardware delay counter. Min Resolution is 0.1msec.
 

Public Member Functions

Constructors
 PlayConfiguration ()
 Empty Constructor. All attributes take on their default values.
 
 PlayConfiguration (PointClock c)
 Constructor with Clock Initialisation. Use this to set the Clock to be supplied from an External signal.
 
 PlayConfiguration (PointClock c, ImageTrigger t)
 Constructor with Clock & Trigger Initialisation. Use this to set the Clock, Trigger or both to be supplied from External signals.
 
 PlayConfiguration (PointClock c, std::chrono::duration< int > d)
 Constructor with Clock Initialisation and Post-Delay. Use this for a configurable delay between images.
 
 PlayConfiguration (PointClock c, std::chrono::duration< int > d, Repeats r, int n_rpts)
 Constructor with Clock Initialisation, Post-Delay and Image Repeats. Use this to configure the Clock source, Delay between Image repeats and the number of Repeats per Image.
 
 PlayConfiguration (Repeats r)
 Constructor with Indefinite Repeats. Use this to set the Image to Repeat Always until Stopped by User Command.
 
 PlayConfiguration (Repeats r, int n_rpts)
 Constructor with Programmable Repeats. Use this to set the Image to Repeat a programmable number of times.
 

Public Attributes

PointClock int_ext { PointClock::INTERNAL }
 Use Internal NCO or External Clock signal.
 
ImageTrigger trig { ImageTrigger::CONTINUOUS }
 Trigger Next Image Immediately, after programmable delay, External Trigger signal or software Trigger.
 
Repeats rpts { Repeats::NONE }
 Run Image Once, Always until stopped, or a Programmable number of times.
 
int n_rpts { 0 }
 If Repeats set to Repeats::PROGRAM, this field sets the number of repeats to trigger (not including first pass, i.e. n_rpts = 3 => 4 playbacks in total)
 
Polarity clk_pol { Polarity::NORMAL }
 Sets the active edge of the External Clock signal (Polarity::NORMAL = rising edge)
 
Polarity trig_pol { Polarity::NORMAL }
 Sets the active edge of the External Trigger signal (Polarity::NORMAL = rising edge)
 
post_delay del { 0 }
 When ImageTrigger is set to ImageTrigger::POST_DELAY, this field defines the length of time between the end of one image (or repeat) and the start of the next. Use SetPostDelay(std::chrono::milliseconds(...)) or an associated std::chrono class.
 

Detailed Description

This struct sets the attributes for the ImagePlayer to use when initiating an Image Playback.

Author
Dave Cowan
Date
2015-11-11
Since
1.0

The documentation for this struct was generated from the following file: