SOURCE
ssiioput.dll

SUMMARY
SocketWriter SocketWriter
SocketReader SocketReader
SocketEventWriter SocketEventWriter
SocketEventReader SocketEventReader
NotifySender NotifySender
NotifyReceiver NotifyReceiver
MemoryWriter MemoryWriter
FileWriter FileWriter
FileSampleWriter FileSampleWriter
FileReader FileReader
FileEventWriter FileEventWriter
FileAnnotationWriter FileAnnotationWriter
FakeSignal FakeSignal

DETAILS
SocketWriter
  SocketWriter  CONSUMER
 
           Forwards streams to external applications through a socket connection.
 
             +  url   CHAR   1024   ''   LOCK   url of the form 'scheme://host:port' (e.g. upd://*:-1, tcp://172.0.0.1:1234) 
             +  format   INT   1   '0'   LOCK   streaming format: 0=BINARY, 1=ASCII, 2=OSC, 3=IMAGE 
             +  delim   CHAR   1024   ','   LOCK   delim chars if streaming in ascii format 
             +  id   CHAR   1024   ''   LOCK   id if streaming in osc format 
             +  compression   INT   1   '1'   LOCK   compression if streaming images (0=NONE,1=JPG) 
             +  packet_delay   UINT   1   '3'   LOCK   delay between sending packets in milliseconds to give receiver some time to pick them up (IMAGE only) 
             +  reltime   BOOL   1   'false'   LOCK   send relative time stamps (OSC only) 
             +  host   CHAR   1024   'localhost'   LOCK   host name (empty for any) [deprecated use 'url'] 
             +  port   INT   1   '1234'   LOCK   port number (-1 for any) [deprecated use 'url'] 
             +  type   UCHAR   1   '0'   LOCK   protocol type (0=UDP, 1=TCP) [deprecated use 'url'] 
             +  osc   BOOL   1   'false'   LOCK   use osc format [deprecated, use 'format'] 
 
SocketReader
  SocketReader  SENSOR
 
           Receives a signal through a UDP or TCP socket connection either as a raw stream or in osc format.
 
             +  url   CHAR   1024   ''   LOCK   url of the form 'scheme://host:port' (e.g. udp://172.0.0.1:1234) 
             +  format   INT   1   '0'   LOCK   streaming format: 0=BINARY, 1=ASCII, 2=OSC, 3=IMAGE 
             +  delim   CHAR   1024   ','   LOCK   delim chars if streaming in ascii format 
             +  ssr   DOUBLE   1   '0.00000'   LOCK   sample rate in Hz 
             +  sdim   UINT   1   '0'   LOCK   sample dimension (if format is set to BINARY, ASCII or OSC) 
             +  sbyte   UINT   1   '0'   LOCK   sample bytes (if format is set to BINARY, ASCII or OSC) 
             +  stype   UCHAR   1   '0'   LOCK   sample type (0=UNDEF, 1=CHAR, 2=UCHAR, 3=SHORT 4=USHORT, 5=INT, 6=UINT, 7=LONG, 8=ULONG, 9=FLOAT, 10=DOUBLE, 11=LDOUBLE, 12=STRUCT, 13=IMAGE, 14=BOOL) 
             +  swidth   INT   1   '640'   LOCK   image width in pixels (if format is set to IMAGE) 
             +  sheight   INT   1   '480'   LOCK   image height in pixels (if format is set to IMAGE) 
             +  sdepth   INT   1   '8'   LOCK   number of bits per pixel (if format is set to IMAGE) 
             +  schannels   INT   1   '3'   LOCK   number of channels per pixel (if format is set to IMAGE) 
             +  timeout   UINT   1   '1000'   LOCK   time out in milliseconds 
             +  host   CHAR   1024   'localhost'   LOCK   host name (empty for any) [deprecated use 'url'] 
             +  port   INT   1   '1234'   LOCK   port number (-1 for any) [deprecated use 'url'] 
             +  type   UCHAR   1   '0'   LOCK   protocol type (0=UDP, 1=TCP) [deprecated use 'url'] 
             +  osc   BOOL   1   'false'   LOCK   use osc format [deprecated, use 'format'] 
 
           Available channels:
 
             +  socket   Properties are determined from the options. 
 
SocketEventWriter
  SocketEventWriter  OBJECT
 
           Forwards events to external applications through a socket connection.
 
             +  url   CHAR   1024   ''   LOCK   url of the form 'scheme://host:port' (e.g. udp://172.0.0.1:1234) 
             +  osc   BOOL   1   'false'   LOCK   use osc format 
             +  xml   BOOL   1   'true'   LOCK   output in xml format (not for osc) 
             +  cdata   BOOL   1   'false'   LOCK   wrap xml strings in cdata 
             +  reltime   BOOL   1   'false'   LOCK   send relative time stamps (osc or xml) 
             +  host   CHAR   1024   'localhost'   LOCK   host name (empty for any) [deprecated use 'url'] 
             +  port   INT   1   '1234'   LOCK   port number (-1 for any) [deprecated use 'url'] 
             +  type   UCHAR   1   '0'   LOCK   protocol type (0=UDP, 1=TCP) [deprecated use 'url'] 
 
SocketEventReader
  SocketEventReader  OBJECT
 
           Receives events through a UDP or TCP socket connection.
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  url   CHAR   1024   ''   LOCK   url of the form 'scheme://host:port' (e.g. udp://172.0.0.1:1234) 
             +  size   UINT   1   '1472'   LOCK   size of buffer 
             +  timeout   UINT   1   '1000'   LOCK   time out in milliseconds 
             +  osc   BOOL   1   'false'   LOCK   use osc format 
             +  reltime   BOOL   1   'false'   LOCK   send relative time stamps (osc or xml) 
             +  host   CHAR   1024   'localhost'   LOCK   host name (empty for any) [deprecated use 'url'] 
             +  port   INT   1   '1234'   LOCK   port number (-1 for any) [deprecated use 'url'] 
             +  type   UCHAR   1   '0'   LOCK   protocol type (0=UDP, 1=TCP) [deprecated use 'url'] 
             +  sname   CHAR   1024   'event'   LOCK   sender name [deprecated use address] 
             +  ename   CHAR   1024   'socket'   LOCK   event name [deprecated use address] 
 
NotifySender
  NotifySender  OBJECT
 
           Forwards notifictions through a socket connection.
 
             +  url   CHAR   1024   'udp://172.0.0.1:1234'   LOCK   url of the form 'scheme://host:port' (e.g. udp://:-1, tcp://172.0.0.1:1234) 
 
NotifyReceiver
  NotifyReceiver  OBJECT
 
           Receives events through a UDP or TCP socket connection.
 
             +  url   CHAR   1024   'upd://172.0.0.1:1234'   LOCK   url of the form 'scheme://host:port' (e.g. upd://:-1, tcp://172.0.0.1:1234) 
             +  id   CHAR   1024   ''   LOCK   object id(s) (if several separate by comma) 
             +  size   UINT   1   '1472'   LOCK   size of buffer 
             +  timeout   UINT   1   '1000'   LOCK   time out in milliseconds 
 
MemoryWriter
  MemoryWriter  CONSUMER
 
           Stores a stream to memory.
 
             +  size   CHAR   1024   '10.0s'   LOCK   buffer size (add s/ms if seconds/milliseconds, otherwise number of samples) 
 
FileWriter
  FileWriter  CONSUMER
 
           Stores streams to a file on disk.
 
             +  path   CHAR   1024   ''   LOCK   file path (empty for stdout) 
             +  overwrite   BOOL   1   'false'   LOCK   overwrite file if it already exists (otherwise a unique path will be created) 
             +  keepEmpty   BOOL   1   'true'   LOCK   store stream even if it is empty 
             +  type   UCHAR   1   '0'   LOCK   file type (0=binary, 1=text, 2=lz4) 
             +  mode   UCHAR   1   '1'   LOCK   file access mode (1=w, 2=a, 3=r+, 4=w+, 5=a+) 
             +  stream   BOOL   1   'true'   LOCK   continuous stream mode 
             +  delim   CHAR   1024   ' '   LOCK   delimiter string (text only) 
             +  meta   CHAR   1024   ''   LOCK   list of 'key=value' pairs separated by ; to add as meta information 
 
FileSampleWriter
  FileSampleWriter  CONSUMER
 
           Stores samples to a file on disk.
 
             +  path   CHAR   1024   ''   LOCK   file path (empty for stdout) 
             +  type   UCHAR   1   '0'   LOCK   file type (0=binary, 1=ascii) 
             +  classes   CHAR   1024   ''   LOCK   class names (separated by ;) 
             +  defaultClassIndex   INT   1   '-1'   LOCK   default class index (applied if >= 0) 
             +  streamClassIndex   INT   1   '-1'   LOCK   index of input stream holding class indices (applied if >= 0) 
             +  user   CHAR   1024   ''   LOCK   user name 
 
FileReader
  FileReader  SENSOR
 
           Reads in a SSI signal file and streams it through a single channel.
 
             +  path   CHAR   1024   ''   LOCK   filepath of input file or of a list with input files 
             +  block   DOUBLE   1   '1.00000'   LOCK   block size in seconds 
             +  blockInSamples   UINT   1   '0'   LOCK   block size in samples (overwrites 'block' if > 0) 
             +  offset   DOUBLE   1   '0.00000'   LOCK   offset in seconds 
             +  offsetInSamples   UINT   1   '0'   LOCK   offset in samples (overwrites 'offset' if > 0) 
             +  cutoff   DOUBLE   1   '0.00000'   LOCK   cutoff in seconds (if > 0) 
             +  cutoffInSamples   UINT   1   '0'   LOCK   cutoff in samples (overwrites 'cutoff' if > 0) 
             +  loop   BOOL   1   'true'   LOCK   loop file 
 
           Available channels:
 
             +  file   Type and size of the stream is determined from the file. 
 
FileEventWriter
  FileEventWriter  OBJECT
 
           Stores events to a file on disk.
 
             +  path   CHAR   1024   'events'   LOCK   path of output file 
 
FileAnnotationWriter
  FileAnnotationWriter  CONSUMER
 
           Converts events to labels and stores them to an annotation file.
 
             +  path   CHAR   1024   ''   LOCK   path of annotation file (will be created) 
             +  annotationPath   CHAR   1024   ''   LOCK   path of annotation file (will be created) [deprecated use path] 
             +  overwrite   BOOL   1   'false'   LOCK   overwrite file if it already exists (otherwise a unique path will be created) 
             +  keepEmpty   BOOL   1   'true'   LOCK   store annotation even if it is empty 
             +  schemePath   CHAR   1024   ''   LOCK   path of scheme file (labels that do not fit the scheme will be ignored) 
             +  defaultSchemeName   CHAR   1024   'noname'   LOCK   default scheme name if not scheme was loaded 
             +  defaultLabel   CHAR   1024   ''   LOCK   default label e.g. to label empty events (applies to discrete annotations only) 
             +  forceDefaultLabel   BOOL   1   'false'   LOCK   force use of default label (applies to discrete annotations only) 
             +  addUnkownLabel   BOOL   1   'false'   LOCK   automatically add unkown labels to annotation scheme 
             +  eventNameAsLabel   BOOL   1   'false'   LOCK   use the event name as label (applies to discrete annotations only) 
             +  senderNameAsLabel   BOOL   1   'false'   LOCK   use the sender name as label (applies to discrete annotations only) 
             +  mapKeyIndex   UINT   1   '0'   LOCK   index of the key that will be selected from map events (applies to discrete annotations only) 
             +  mapKeySelectMax   BOOL   1   'false'   LOCK   select the key with the maximum value (applies to discrete annotations only) 
             +  streamScoreIndex   UINT   1   '0'   LOCK   stream dimension of score value (applies to continuous annotations only) 
             +  streamConfidenceIndex   UINT   1   '1'   LOCK   stream dimension of confidence value (applies to continuous annotations only) 
             +  defaultMinScore   FLOAT   1   '0.00000'   LOCK   default min score 
             +  defaultMaxScore   FLOAT   1   '1.00000'   LOCK   default max score 
             +  defaultConfidence   FLOAT   1   '1.00000'   LOCK   default confidence 
             +  forceDefaultConfidence   BOOL   1   'false'   LOCK   force use of default confidence 
             +  meta   CHAR   1024   ''   LOCK   list of 'key=value' pairs separated by ; to add as meta information 
 
FakeSignal
  FakeSignal  SENSOR
 
           signal generator
 
             +  sr   DOUBLE   1   '50.00000'   LOCK   sample rate of signal 
             +  sr_bad   DOUBLE   1   '0.00000'   LOCK   bad sample rate (if != 0 will be used to initialize the channel and allows to simulate the situation where a sensor does not stick to its sample rate) 
             +  signal   INT   1   '0'   LOCK   signal (0=sine, 1=random, 2=image(ssi), 3=image(random gray), 4=image(random rgb)) 
 
           Available channels:
 
             +  signal   signal (sine wave | random | image) 
 


Built with Social Signal Interpretation (SSI) [v1.0.5]
(c) University of Augsburg
http://openssi.net