NVIDIA DRIVE OS Linux SDK API Reference

5.2.6 Release
For Test and Development only

Detailed Description

Describes an event triggered by the blocks.

Definition at line 502 of file nvscistream_types.h.

Data Fields

NvSciStreamEventType type
 Holds the type of event. More...
 
NvSciSyncAttrList syncAttrList
 Used with events that specify NvSciSyncObj waiter requirements: NvSciStreamEventType_SyncAttr. More...
 
NvSciBufAttrList bufAttrList
 Used with events that specify packet element information: NvSciStreamEventType_PacketAttr, NvSciStreamEventType_PacketAttrProducer, NvSciStreamEventType_PacketAttrConsumer. More...
 
NvSciSyncObj syncObj
 Used with events that provide a NvSciSyncObj: NvSciStreamEventType_SyncDesc. More...
 
NvSciBufObj bufObj
 Used with events that provide a NvSciBufObj: NvSciStreamEventType_PacketElement. More...
 
NvSciStreamPacket packetHandle
 Used with events that return a NvSciStreamPacket: NvSciStreamEventType_PacketCreate. More...
 
NvSciStreamCookie packetCookie
 Used with events that indicate a packet operation: NvSciStreamEventType_PacketDelete, NvSciStreamEventType_PacketElement, NvSciStreamEventType_PacketStatusProducer, NvSciStreamEventType_PacketStatusConsumer, NvSciStreamEventType_ElementStatusProducer, NvSciStreamEventType_ElementStatusConsumer. More...
 
uint32_t count
 Used with events that require a count: NvSciStreamEventType_SyncCount, NvSciStreamEventType_PacketElementCount, NvSciStreamEventType_PacketElementCountProducer, NvSciStreamEventType_PacketElementCountConsumer. More...
 
uint32_t index
 Used with events that require an index: NvSciStreamEventType_SyncDesc, NvSciStreamEventType_PacketAttr, NvSciStreamEventType_PacketElement, NvSciStreamEventType_ElementStatusProducer, NvSciStreamEventType_ElementStatusConsumer. More...
 
NvSciError error
 Used with events that return an error: NvSciStreamEventType_PacketStatusProducer, NvSciStreamEventType_PacketStatusConsumer, NvSciStreamEventType_ElementStatusProducer, NvSciStreamEventType_ElementStatusConsumer. More...
 
uint32_t userData
 Used with events that require a user-defined data field: NvSciStreamEventType_PacketAttr, NvSciStreamEventType_PacketAttrProducer, NvSciStreamEventType_PacketAttrConsumer. More...
 
bool synchronousOnly
 Used with events that specify NvSciSynObj waiter requirements: NvSciStreamEventType_SyncAttr. More...
 
NvSciStreamElementMode syncMode
 Used with events that specify a NvSciStreamElementMode: NvSciStreamEventType_PacketAttr, NvSciStreamEventType_PacketAttrProducer, NvSciStreamEventType_PacketAttrConsumer. More...
 

Field Documentation

◆ bufAttrList

NvSciBufAttrList NvSciStreamEvent::bufAttrList

Used with events that specify packet element information: NvSciStreamEventType_PacketAttr, NvSciStreamEventType_PacketAttrProducer, NvSciStreamEventType_PacketAttrConsumer.

For other events, will be set to NULL.

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

Definition at line 530 of file nvscistream_types.h.

◆ bufObj

NvSciBufObj NvSciStreamEvent::bufObj

Used with events that provide a NvSciBufObj: NvSciStreamEventType_PacketElement.

For other events, will be set to NULL.

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

Definition at line 554 of file nvscistream_types.h.

◆ count

uint32_t NvSciStreamEvent::count

Used with events that require a count: NvSciStreamEventType_SyncCount, NvSciStreamEventType_PacketElementCount, NvSciStreamEventType_PacketElementCountProducer, NvSciStreamEventType_PacketElementCountConsumer.

For other events, will be set to 0.

Indicates a number of items for this or subsequent events.

Definition at line 590 of file nvscistream_types.h.

◆ error

NvSciError NvSciStreamEvent::error

Used with events that return an error: NvSciStreamEventType_PacketStatusProducer, NvSciStreamEventType_PacketStatusConsumer, NvSciStreamEventType_ElementStatusProducer, NvSciStreamEventType_ElementStatusConsumer.

For other events, will be set to NvSciError_Success.

Indicates the status of an operation.

Definition at line 617 of file nvscistream_types.h.

◆ index

uint32_t NvSciStreamEvent::index

Used with events that require an index: NvSciStreamEventType_SyncDesc, NvSciStreamEventType_PacketAttr, NvSciStreamEventType_PacketElement, NvSciStreamEventType_ElementStatusProducer, NvSciStreamEventType_ElementStatusConsumer.

For other events, will be set to 0.

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

Definition at line 604 of file nvscistream_types.h.

◆ packetCookie

NvSciStreamCookie NvSciStreamEvent::packetCookie

Used with events that indicate a packet operation: NvSciStreamEventType_PacketDelete, NvSciStreamEventType_PacketElement, NvSciStreamEventType_PacketStatusProducer, NvSciStreamEventType_PacketStatusConsumer, NvSciStreamEventType_ElementStatusProducer, NvSciStreamEventType_ElementStatusConsumer.

For other events, will be set to NvSciStreamCookie_Invalid.

Provides the component's cookie identifying the packet.

Definition at line 577 of file nvscistream_types.h.

◆ packetHandle

NvSciStreamPacket NvSciStreamEvent::packetHandle

Used with events that return a NvSciStreamPacket: NvSciStreamEventType_PacketCreate.

For other events, will be set to NvSciStreamPacket_Invalid.

Definition at line 562 of file nvscistream_types.h.

◆ syncAttrList

NvSciSyncAttrList NvSciStreamEvent::syncAttrList

Used with events that specify NvSciSyncObj waiter requirements: NvSciStreamEventType_SyncAttr.

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

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

Definition at line 516 of file nvscistream_types.h.

◆ synchronousOnly

bool NvSciStreamEvent::synchronousOnly

Used with events that specify NvSciSynObj waiter requirements: NvSciStreamEventType_SyncAttr.

For other events, will be set to false.

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

Definition at line 641 of file nvscistream_types.h.

◆ syncMode

NvSciStreamElementMode NvSciStreamEvent::syncMode

Used with events that specify a NvSciStreamElementMode: NvSciStreamEventType_PacketAttr, NvSciStreamEventType_PacketAttrProducer, NvSciStreamEventType_PacketAttrConsumer.

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

Indicates whether data requires synchronization before using.

Definition at line 654 of file nvscistream_types.h.

◆ syncObj

NvSciSyncObj NvSciStreamEvent::syncObj

Used with events that provide a NvSciSyncObj: NvSciStreamEventType_SyncDesc.

For other events, will be set to NULL.

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

Definition at line 542 of file nvscistream_types.h.

◆ type

NvSciStreamEventType NvSciStreamEvent::type

Holds the type of event.

Definition at line 504 of file nvscistream_types.h.

◆ userData

uint32_t NvSciStreamEvent::userData

Used with events that require a user-defined data field: NvSciStreamEventType_PacketAttr, NvSciStreamEventType_PacketAttrProducer, NvSciStreamEventType_PacketAttrConsumer.

For other events, will be set to 0.

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

Definition at line 630 of file nvscistream_types.h.


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