L4T Multimedia API Reference

27.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EventQueue.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of NVIDIA CORPORATION nor the names of its
13  * contributors may be used to endorse or promote products derived
14  * from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
37 #ifndef _ARGUS_EVENT_QUEUE_H
38 #define _ARGUS_EVENT_QUEUE_H
39 
50 namespace Argus
51 {
52 
57 {
58 protected:
60 };
61 
67 DEFINE_UUID(InterfaceID, IID_EVENT_QUEUE, 944b11f6,e512,49ad,8573,fc,82,3e,02,25,ed);
68 
69 class IEventQueue : public Interface
70 {
71 public:
72  static const InterfaceID& id() { return IID_EVENT_QUEUE; }
73 
81  virtual Status getEventTypes(std::vector<EventType>* types) const = 0;
82 
89  virtual const Event* getNextEvent() = 0;
90 
94  virtual uint32_t getSize() const = 0;
95 
101  virtual const Event* getEvent(uint32_t index) const = 0;
102 
103 protected:
105 };
106 
107 } // namespace Argus
109 #endif // _ARGUS_EVENT_QUEUE_H
The base interface for a class that provides libargus Interfaces.
Definition: Types.h:361
An Event represents an asynchronous result.
Definition: Event.h:60
static const InterfaceID & id()
Definition: EventQueue.h:72
Status
Status values returned by API function calls.
Definition: Types.h:228
The top-level interface class.
Definition: Types.h:330
An EventQueue object, as returned by IEventProvider::createEventQueue.
Definition: EventQueue.h:56
virtual Status getEventTypes(std::vector< EventType > *types) const =0
Returns the event types that this queue will receive.
virtual uint32_t getSize() const =0
Returns the number of events in the queue.
virtual const Event * getNextEvent()=0
Returns the next event in the queue (that is, the event at index 0).
DEFINE_UUID(ExtensionName, EXT_BAYER_SHARPNESS_MAP, 7d5e0470, 4ea6, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
The Ext::BayerSharpnessMap extension adds internally-generated sharpness metrics to CaptureMetadata r...
virtual const Event * getEvent(uint32_t index) const =0
Returns the event with the given index, where index 0 corresponds to the oldest event and [getSize() ...
A unique identifier for an libargus Interface.
Definition: Types.h:340
The interface available to an EventQueue.
Definition: EventQueue.h:69
A top level object class for libargus objects that are created and owned by the client.
Definition: Types.h:398