Sync/Stream Subsystem Events

Sync/stream subsystem events identify a specific change of state for either a master or slave stream handler. Some of these events do not have any effect on synchronization and merely indicate status of the data stream.

Two classes of events are defined: implicit and explicit. Implicit events are those events which all stream handlers must always support (such as end of stream or preroll complete). Explicit events are events which are supported only by some handlers (such as a custom event unique to a particular type of data). The application automatically receives notification of implicit events; however, the application must enable explicit events by using the SpiEnableEvent function if it wants to receive notification of any other events. Events remain enabled until they are disabled. The SSM and stream handlers are the only components that generate events.

The following table lists the events that are currently defined for the sync/stream subsystem. Stream handlers can also define new events for use as a communication mechanism between the stream handler and the application. Refer to the ulType and ulSubType fields in the EVCB data structure in the OS/2 Multimedia Programming Reference.

кФФФФФФФФФФФФФФФФФФФФФФФФТФФФФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФП
ГEvent                   ГData      ГDescription                             Г
Г                        ГStructure Г                                        Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_CUE_DATA          ГDATA_EVCB ГA cuepoint in terms of some specific    Г
Г(Explicit)              Г          Гpiece of data in a stream. This event   Г
Г                        Г          Гcan be enabled as a single event or as aГ
Г                        Г          Гrecurring event.                        Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_CUE_TIME          ГTIME_EVCB ГA cuepoint in terms of stream time from Г
Г(Explicit)              Г          Гthe start of the stream. This event can Г
Г                        Г          Гbe enabled as a single event or as a    Г
Г                        Г          Гrecurring event. Recurring events are   Г
Г                        Г          Гevents that are defined as a time       Г
Г                        Г          Гinterval. An event is generated an each Г
Г                        Г          Гoccurrence of this time interval. SingleГ
Г                        Г          Гevents remain enabled, even after they  Г
Г                        Г          Гare reported. In case the stream is     Г
Г                        Г          Гseeked backwards in time to a position  Г
Г                        Г          Гbefore a cuepoint and play is resumed,  Г
Г                        Г          Гthe cuepoint will be reported again.    Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_CUE_TIME_PAUSE    ГTIME_EVCB ГA cuepoint in terms of stream time from Г
Г(Explicit)              Г          Гthe start of the stream. This event willГ
Г                        Г          Гcause the stream to be paused when the  Г
Г                        Г          Гcuepoint is reached. This event can be  Г
Г                        Г          Гenabled as a single event.              Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_DATAOVERRUN       ГEVCB      ГA stream handler detected a data        Г
Г(Explicit)              Г          Гoverrun. Data could be lost in a        Г
Г                        Г          Гrecording situation.                    Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_DATAUNDERRUN      ГEVCB      ГA target stream handler detected a data Г
Г(Explicit)              Г          Гunderrun condition. There was no data   Г
Г                        Г          Гavailable to output to the output       Г
Г                        Г          Гdevice. Usually in this situation, the  Г
Г                        Г          Гtarget stream handler will attempt to   Г
Г                        Г          Гget another buffer and then pause it's  Г
Г                        Г          Гdevice. The target stream handler will  Г
Г                        Г          Гbe re-started when more data is         Г
Г                        Г          Гavailable to be output. This condition  Г
Г                        Г          Гresults in a break in the output data   Г
Г                        Г          Гstream. Interleaved data format can     Г
Г                        Г          Гcause underruns to occur when the end ofГ
Г                        Г          Гthe data is reached, but the end of fileГ
Г                        Г          Гhas not been reached.                   Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_EOS (Implicit)    ГIMPL_EVCB ГEnd of stream event.  This event is     Г
Г                        Г          Гgenerated after the target stream       Г
Г                        Г          Гhandler has consumed the last buffer in Г
Г                        Г          Гthe stream. This signals to the         Г
Г                        Г          Гapplication that the stream has         Г
Г                        Г          Гcompleted processing.                   Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_ERROR (Implicit)  ГIMPL_EVCB ГAn error has occurred while streaming.  Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_PLAYLISTCUEPOINT  ГPLAYL_EVCBГA memory stream handler playlist        Г
Г(Implicit)              Г          Гcuepoint event.                         Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_PLAYLISTMESSAGE   ГPLAYL_EVCBГA memory stream handler playlist        Г
Г(Implicit)              Г          Гmessage.                                Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_QUEUE_OVERFLOW    ГIMPL_EVCB ГEvent queue overflow. Indicates that an Г
Г(Implicit)              Г          Гevent has been lost due to too many     Г
Г                        Г          Гevents being generated. The application Г
Г                        Г          Г(MCD) should use this event to clear anyГ
Г                        Г          Гwaiting conditions.                     Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_STREAM_STOPPED    ГIMPL_EVCB ГThe stream has been emptied or          Г
Г(Implicit)              Г          Гdiscarded. (See the SpiStopStream       Г
Г                        Г          Гfunction in the OS/2 Multimedia         Г
Г                        Г          ГProgramming Reference.)                 Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_SYNC_PREROLLED    ГIMPL_EVCB ГAll synchronized streams are prerolled. Г
Г(Implicit)              Г          Г(See the SpiStartStream function in the Г
Г                        Г          ГOS/2 Multimedia Programming Reference.) Г
УФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГEVENT_SYNCOVERRUN       ГOVRU_EVCB ГA sync overrun has been detected in the Г
Г(Explicit)              Г          Гstream.                                 Г
РФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

The Sync/Stream Manager propagates events to the application through the media driver by doing a call-back to an event routine that the application registered with the SSM on an SpiCreateStream call. Use the event routine as if it were a second-level interrupt routine and do not attempt to do a lot of processing. The event routine is on a per-process basis; it receives only one process at a time. Therefore, when an event is sent to be processed, it must wait until the current event has completed processing.

Because there is only one EVCB for implicit events, it is a good idea to copy any needed information from the EVCB into local variables for processing by the event routine. The event routine has the following interface:

Event_Entry(PEVCB pEVCB, rc)

[Back] [Next]