Defines component event types.
| Enumerator |
|---|
| NvSciStreamEventType_Connected | Indicates block has complete connection to producer and consumer endpoints.
The user may now proceed to perform other operations on the block.
Received by all blocks.
No event data fields are used.
|
| NvSciStreamEventType_Disconnected | Indicates portions of the stream have disconnected such that no more useful work can be done with the block.
Note that this event is not always triggered immediately when any disconnect occurs. For instance:
- If a consumer still has payloads waiting in its queue when a producer is destroyed, it will not be informed of the disconnection until all payloads are acquired.
- If one consumer in a multicast stream is destroyed, the producer will not be informed of the disconnection as long as other consumers are still able to receive payloads.
Received by all blocks.
No event data fields are used.
|
| NvSciStreamEventType_SyncAttr | Specifies sync object requirements.
Received by producer and consumer blocks.
The following event fields will be set: syncAttrList Provides an attribute list which the recipient can combine with its own requirements to create sync objects that will be used to signal the other endpoint. synchronousOnly If set, sync objects cannot be used by the other side. The recipient should not create sync objects, and should instead perform CPU waits before posting or returning payloads.
The values in the fields may not exactly match those sent from the other endpoint. The stream may transform them as they pass through. In particular, multi-cast components combine the requirements of all consumers before passing them to the producer, and IPC components may replace the requirements if they need to wait for the data to be ready before performing a copy step.
|
| NvSciStreamEventType_SyncCount | Specifies the number of sync objects sent from the opposite endpoint.
Received by producer and consumer blocks.
The following event fields will be set: count Indicates the number of sync objects that will be provided by the other side. The recipient can expect this many SyncDesc events to follow.
|
| NvSciStreamEventType_SyncDesc | Specifies a sync object sent from the opposite endpoint.
Received by producer and consumer blocks.
The following event fields will be set:
index
Specifies an index within the array of sync objects.
syncObj
Provides a handle to a sync object which the recipient should
map into the libraries which will operate on stream data.
|
| NvSciStreamEventType_PacketElementCountProducer | Specifies number of packets elements request from producer.
Received by pool block.
The following event fields will be set:
count
Indicates the number of packet element types that the producer
is capable of generating. The recipient can expect this many
PacketAttrProducer events.
|
| NvSciStreamEventType_PacketElementCountConsumer | Specifies number of packets elements request from consumer.
Received by pool block.
The following event fields will be set:
count
Indicates the number of packet element types that the consumer
wishes to receive. The recipient can expect this many
PacketAttrConsumer events.
|
| NvSciStreamEventType_PacketElementCount | Specifies the number of packet elements determined by pool.
Received by producer and consumer blocks.
The following event fields will be set:
count
Indicates the number of packet element buffers that the pool
will provide for each packet. The recipient can expect this
many PacketAttr events and this many PacketElement events for
each packet.
|
| NvSciStreamEventType_PacketAttrProducer | Specifies the packet capabilities from producer.
Received by pool block.
The following event fields will be set:
index
Index within the list of elements provided by the producer.
userData
A user-defined type which applications use to identify the
element and allow elements provided by the producer to be
matched with those desired by the consumer. At most one
element of any given type can be specified.
bufAttrList
Provides an attribute list which the recipient can combine
with its own requirements and those of the consumer to allocate
buffers which all parties can use.
syncMode
Indicates whether the buffer data will be available immediately
when the producer provides a payload or if the user must wait
for the producer's sync objects first.
The values in the fields may not exactly match those sent from the
producer. The stream may transform them as they pass through.
|
| NvSciStreamEventType_PacketAttrConsumer | Specifies the packet requests from consumer.
Received by pool block.
The following event fields will be set:
index
Index within the list of elements requested by the consumer.
userData
A user-defined type which applications use to identify the
element and allow elements provided by the producer to be
matched with those desired by the consumer. At most one
element of any given type can be specified.
bufAttrList
Provides an attribute list which the recipient can combine
with its own requirements and those of the producer to allocate
buffers which all parties can use.
syncMode
Indicates whether the consumer desires the buffer data to be
available immediately when the payload is acquired or if it can
wait until the producer's sync objects have triggered.
The values in the fields may not exactly match those sent from the
consumer. The stream may transform them as they pass through.
In particular, multi-cast components combine the requirements of
all consumers before passing them to the pool.
|
| NvSciStreamEventType_PacketAttr | Specifies the packet final settings from pool.
Received by producer and consumer blocks.
The following event fields will be set:
index
Index within the list of elements allocated by the pool.
userData
A user-defined type which applications use to identify the
element and allow elements provided by the producer to be
matched with those desired by the consumer. At most one
element of any given type can be specified.
bufAttrList
Provides the combined attribute list used by the pool to
allocate the element.
syncMode
Indicates the synchronization mode that the producer should use
and the consumer should expect.
The values in the fields may not exactly match those sent from the
pool. The stream may transform them as they pass through.
|
| NvSciStreamEventType_PacketCreate | Indicates new packet object has been introduced by pool.
Received by producer and consumer blocks.
The following event fields will be set: packetHandle Contains the handle for the new packet. This should be used whenever the component references the packet in the future.
|
| NvSciStreamEventType_PacketElement | Specifies new packet element.
Received by producer and consumer blocks.
The following event fields will be set: packetCookie Contains the cookie which the recipient provided to identify its data structure for the packet upon accepting it. index Index within the list of the packet's elements. bufObj Provides a handle to a buffer object which the recipient should map into the libraries which will operate on stream data.
|
| NvSciStreamEventType_PacketDelete | Specifies the discontinued packet object.
Received by producer and consumer blocks.
The following event fields will be set: packetCookie Contains the cookie which the recipient provided to identify its data structure for the packet upon accepting it.
|
| NvSciStreamEventType_PacketStatusProducer | Specifies the producer-side status of packet.
Received by pool block.
The following event fields will be set: packetCookie Contains the cookie which the pool provided to identify its data structure for the packet upon creating it. error An error code indicating whether the producer was able to add the new packet.
|
| NvSciStreamEventType_PacketStatusConsumer | Specifies the consumer-side status of packet.
Received by pool block.
The following event fields will be set: packetCookie Contains the cookie which the pool provided to identify its data structure for the packet upon creating it. error An error code indicating whether the consumer was able to add the new packet.
|
| NvSciStreamEventType_ElementStatusProducer | Specifies the producer-side status of packet element.
Received by pool block.
The following event fields will be set: packetCookie Contains the cookie which the pool provided to identify its data structure for the packet upon creating it. index Index of packet element for which status is provided. error An error code indicating whether the producer was able to map in the element buffer.
|
| NvSciStreamEventType_ElementStatusConsumer | Specifies the consumer-side status of packet element.
Received by pool block.
The following event fields will be set: packetCookie Contains the cookie which the pool provided to identify its data structure for the packet upon creating it. index Index of packet element for which status is provided. error An error code indicating whether the consumer was able to map in the element buffer.
|
| NvSciStreamEventType_PacketReady | Specifies a packet is available for reuse or acquire.
Received by producer and consumer block.
The following event fields will be set: None
|
| NvSciStreamEventType_Error | Indicates a failure not directly triggered by user action.
Received by any block.
The following event fields will be set: error An error code providing information about what went wrong.
|