SPI Functions

The Stream Programming Interface (SPI) contains functions exported by the Sync/Stream Manager to support applications that control real-time data streaming. These functions are used to create data streams, associate data objects, and for data streaming and synchronization. SPI functions also enable applications to query and install stream protocols and to query the current stream time.

The following table lists the SPI functions:

┌──────────────────────────┬──────────────────────────────────┐
│Function                  │Description                       │
├──────────────────────────┼──────────────────────────────────┤
│SpiAssociate              │Associates a data object with a   │
│                          │stream handler.                   │
├──────────────────────────┼──────────────────────────────────┤
│SpiCreateStream           │Creates a stream instance between │
│                          │a source and a target stream      │
│                          │handler.                          │
├──────────────────────────┼──────────────────────────────────┤
│SpiDestroyStream          │Removes a stream instance from the│
│                          │system.                           │
├──────────────────────────┼──────────────────────────────────┤
│SpiDetermineSyncMaster    │Determines best master stream to  │
│                          │be used in a sync group.          │
├──────────────────────────┼──────────────────────────────────┤
│SpiDisableEvent           │Disables event detection for a    │
│                          │particular event.                 │
├──────────────────────────┼──────────────────────────────────┤
│SpiDisableSync            │Removes a group of streams.       │
├──────────────────────────┼──────────────────────────────────┤
│SpiEnableEvent            │Enables event detection for a     │
│                          │particular event.                 │
├──────────────────────────┼──────────────────────────────────┤
│SpiEnableSync             │Establishes a group of streams to │
│                          │synchronize the streams.          │
├──────────────────────────┼──────────────────────────────────┤
│SpiEnumerateHandlers      │Returns a list of the stream      │
│                          │handler names installed in the    │
│                          │SPI.INI file.                     │
├──────────────────────────┼──────────────────────────────────┤
│SpiEnumerateProtocols     │Returns a list of stream protocol │
│                          │keys for the specified stream     │
│                          │handler.                          │
├──────────────────────────┼──────────────────────────────────┤
│SpiGetHandler             │Returns the handler ID for the    │
│                          │specified stream handler.         │
├──────────────────────────┼──────────────────────────────────┤
│SpiGetProtocol            │Queries a stream handler for a    │
│                          │specified stream protocol.        │
├──────────────────────────┼──────────────────────────────────┤
│SpiGetTime                │Queries the current stream time.  │
├──────────────────────────┼──────────────────────────────────┤
│SpiInstallProtocol        │Installs or removes a specified   │
│                          │stream protocol for a stream      │
│                          │handler.                          │
├──────────────────────────┼──────────────────────────────────┤
│SpiSeekStream             │Seeks to a specified point in the │
│                          │stream object or sets the current │
│                          │stream time.                      │
├──────────────────────────┼──────────────────────────────────┤
│SpiStartStream            │Starts data streaming for a single│
│                          │stream instance or a group of     │
│                          │streams.                          │
├──────────────────────────┼──────────────────────────────────┤
│SpiSendMsg                │Sends a message to a stream       │
│                          │handler.                          │
├──────────────────────────┼──────────────────────────────────┤
│SpiStopStream             │Stops data streaming for a single │
│                          │stream instance or a group of     │
│                          │streams.                          │
└──────────────────────────┴──────────────────────────────────┘


[Back: TimerSleep - Topics]
[Next: SpiAssociate]