Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Classes | Namespaces | Typedefs | Enumerations
Image.h File Reference

Classes for storing sequences of synchronous multi-channel RF drive data. More...

#include "IMSTypeDefs.h"
#include "Containers.h"
#include <deque>
#include <list>
#include <array>
#include <chrono>
#include <ctime>
Include dependency graph for Image.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  iMS::ImagePoint
 Stores 4 FAP Triads containing frequency, amplitude and phase data for 4 RF channels. More...
 
class  iMS::Image
 A sequence of ImagePoints played out sequentially by the Controller and driven by the Synthesiser. More...
 
struct  iMS::ImageTableEntry
 An ImageTableEntry is created by the SDK on connecting to an iMS System, one for each Image that is stored in Controller memory and allocated in the Image Index Table. Further ImageTableEntries are added to the table each time an Image is downloaded to the Controller. More...
 
struct  iMS::ImageSequenceEntry
 An ImageSequenceEntry object can be created by application software to specify the parameters by which an Image is played back during an ImageSequence. More...
 
class  iMS::ImageSequence
 An ImageSequence object completely defines a sequence to be played back on an iMS Controller in terms by containing a list of ImageSequenceEntry 's plus a terminating action and optional value. More...
 
class  iMS::ImageGroup
 An ImageGroup collects together multiple associated images and a single ImageSequence for controlling Image playback order. More...
 

Namespaces

 iMS
 The entire API is encapsulated by the iMS namespace.
 

Typedefs

using iMS::ImageIndex = int
 Each ImageIndex is an offset into the Image Index Table that uniquely refers to an Image stored in Controller Memory.
 
typedef ImageGroup iMS::ImageFile
 For backwards compatibility with code written against SDK 1.2.6 or earlier.
 

Enumerations

enum  iMS::ImageRepeats { iMS::ImageRepeats::NONE, iMS::ImageRepeats::PROGRAM, iMS::ImageRepeats::FOREVER }
 Each Image can be repeated, either a programmable number of times, or indefinitely. More...
 
enum  iMS::SequenceTermAction : std::uint8_t {
  iMS::SequenceTermAction::DISCARD = 0, iMS::SequenceTermAction::RECYCLE = 1, iMS::SequenceTermAction::STOP_DISCARD = 2, iMS::SequenceTermAction::STOP_RECYCLE = 3,
  iMS::SequenceTermAction::REPEAT = 4, iMS::SequenceTermAction::REPEAT_FROM = 5
}
 Operation to perform on the completion of the last repeat of the last entry in a Sequence. More...
 

Detailed Description

Classes for storing sequences of synchronous multi-channel RF drive data.

Author
Dave Cowan
Date
2015-11-03
Since
1.0