NVIDIA DRIVE OS Linux SDK API Reference

5.1.9.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NvSciStreamEvent Struct Reference

Detailed Description

Describes a component event.

Definition at line 414 of file nvscistream.h.

Data Fields

NvSciStreamEventType type
 Holds the type of event. More...
 
NvSciSyncAttrList syncAttrList
 Used with events that specify sync object attributes: SyncAttr. More...
 
NvSciBufAttrList bufAttrList
 Used with events that specify buffer object attributes: PacketAttr PacketAttrProducer PacketAttrConsumer. More...
 
NvSciSyncObj syncObj
 Used with events that provide a sync object: SyncDesc. More...
 
NvSciBufObj bufObj
 Used with events that provide a buffer object: PacketElement. More...
 
NvSciStreamPacket packetHandle
 Used with events that return a packet handle: PacketCreate. More...
 
NvSciStreamCookie packetCookie
 Used with events that indicate a packet operation: PacketDelete PacketElement PacketStatusProducer PacketStatusConsumer ElementStatusProducer ElementStatusConsumer. More...
 
uint32_t count
 Used with events that require a count: SyncCount PacketElementCount PacketElementCountProducer PacketElementCountConsumer. More...
 
uint32_t index
 Used with events that require an index: SyncDesc PacketAttr PacketElement ElementStatusProducer ElementStatusConsumer. More...
 
NvSciError error
 Used with events that return an error: PacketStatus ElementStatus. More...
 
uint32_t userData
 Used with events that require a user-defined data field: PacketAttr PacketAttrProducer PacketAttrConsumer. More...
 
bool synchronousOnly
 Used with events that specify sync object attributes: SyncAttr. More...
 
NvSciStreamElementMode syncMode
 Used with events that specify a synchronization mode: PacketAttr PacketAttrProducer PacketAttrConsumer. More...
 

Field Documentation

NvSciBufAttrList NvSciStreamEvent::bufAttrList

Used with events that specify buffer object attributes: PacketAttr PacketAttrProducer PacketAttrConsumer.

For other events, will be set to NULL.

If set, provides an attribute list handle of which the recipient becomes the owner. It should free the handle when it is no longer required.

Definition at line 442 of file nvscistream.h.

NvSciBufObj NvSciStreamEvent::bufObj

Used with events that provide a buffer object: PacketElement.

For other events, will be set to NULL.

If set, provides a buffer object handle of which the recipient becomes the owner. It should free the handle when it is no longer required.

Definition at line 466 of file nvscistream.h.

uint32_t NvSciStreamEvent::count

Used with events that require a count: SyncCount PacketElementCount PacketElementCountProducer PacketElementCountConsumer.

For other events, will be set to 0.

Indicates a number of items for this or subsequent events.

Definition at line 502 of file nvscistream.h.

NvSciError NvSciStreamEvent::error

Used with events that return an error: PacketStatus ElementStatus.

For other events, will be set to NvSciError_Success.

Indicates the status of an operation.

Definition at line 527 of file nvscistream.h.

uint32_t NvSciStreamEvent::index

Used with events that require an index: SyncDesc PacketAttr PacketElement ElementStatusProducer ElementStatusConsumer.

For other events, will be set to 0.

Indicates position of item to which the event applies within a list.

Definition at line 516 of file nvscistream.h.

NvSciStreamCookie NvSciStreamEvent::packetCookie

Used with events that indicate a packet operation: PacketDelete PacketElement PacketStatusProducer PacketStatusConsumer ElementStatusProducer ElementStatusConsumer.

For other events, will be set to NvSciStreamCookie_Invalid.

Provides the component's cookie identifying the packet.

Definition at line 489 of file nvscistream.h.

NvSciStreamPacket NvSciStreamEvent::packetHandle

Used with events that return a packet handle: PacketCreate.

For other events, will be set to NvSciStreamPacket_Invalid.

Definition at line 474 of file nvscistream.h.

NvSciSyncAttrList NvSciStreamEvent::syncAttrList

Used with events that specify sync object attributes: SyncAttr.

For other events, or if not needed, will be set to NULL.

If set, provides an attribute list handle of which the recipient becomes the owner. It should free the handle when it is no longer required.

Definition at line 428 of file nvscistream.h.

bool NvSciStreamEvent::synchronousOnly

Used with events that specify sync object attributes: SyncAttr.

For other events, will be set to false.

Indicates endpoint cannot process sync objects of any kind and data must be published synchronously. (This case is not common.)

Definition at line 551 of file nvscistream.h.

NvSciStreamElementMode NvSciStreamEvent::syncMode

Used with events that specify a synchronization mode: PacketAttr PacketAttrProducer PacketAttrConsumer.

For other events, defaults to NvSciStreamElementMode_Asynchronous, and can be ignored.

Indicates whether data requires synchronization before using.

Definition at line 564 of file nvscistream.h.

NvSciSyncObj NvSciStreamEvent::syncObj

Used with events that provide a sync object: SyncDesc.

For other events, will be set to NULL.

If set, provides a sync object handle of which the recipient becomes the owner. It should free the handle when it is no longer required.

Definition at line 454 of file nvscistream.h.

NvSciStreamEventType NvSciStreamEvent::type

Holds the type of event.

Definition at line 416 of file nvscistream.h.

uint32_t NvSciStreamEvent::userData

Used with events that require a user-defined data field: PacketAttr PacketAttrProducer PacketAttrConsumer.

For other events, will be set to 0.

A value provided by application and passed through the stream without interpretation.

Definition at line 540 of file nvscistream.h.


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