L4T Multimedia API Reference

31.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EventProvider.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2017, 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 
36 #ifndef _ARGUS_EVENT_PROVIDER_H
37 #define _ARGUS_EVENT_PROVIDER_H
38 
39 namespace Argus
40 {
41 
55 DEFINE_UUID(InterfaceID, IID_EVENT_PROVIDER, 523ed330,25dc,11e5,867f,08,00,20,0c,9a,66);
56 class IEventProvider : public Interface
57 {
58 public:
59  static const InterfaceID& id() { return IID_EVENT_PROVIDER; }
60 
67  virtual Status getAvailableEventTypes(std::vector<EventType>* types) const = 0;
68 
76  virtual EventQueue* createEventQueue(const std::vector<EventType>& eventTypes,
77  Status* status = NULL) = 0;
78 
107  virtual Status waitForEvents(const std::vector<EventQueue*>& queues,
108  uint64_t timeout = TIMEOUT_INFINITE) = 0;
109 
113  virtual Status waitForEvents(EventQueue* queue,
114  uint64_t timeout = TIMEOUT_INFINITE) = 0;
115 
116 protected:
118 };
119 
120 } // namespace Argus
121 
122 #endif // _ARGUS_EVENT_PROVIDER_H
virtual EventQueue * createEventQueue(const std::vector< EventType > &eventTypes, Status *status=NULL)=0
Creates an event queue for events of the given type(s)
DEFINE_UUID(ExtensionName, EXT_BAYER_AVERAGE_MAP, 12c3de20, 64c5, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
Status
Status values returned by API function calls.
Definition: Types.h:93
Interface for an object which generates Events (such as CaptureSession).
Definition: EventProvider.h:56
The top-level interface class.
Definition: Types.h:290
const uint64_t TIMEOUT_INFINITE
Constant used for infinite timeouts.
Definition: Types.h:88
A unique identifier for a libargus Interface.
Definition: Types.h:300
virtual Status waitForEvents(const std::vector< EventQueue * > &queues, uint64_t timeout=TIMEOUT_INFINITE)=0
Waits for and transfers any pending events from the provider to the provided queues.
static const InterfaceID & id()
Definition: EventProvider.h:59
virtual Status getAvailableEventTypes(std::vector< EventType > *types) const =0
Returns a list of event types that this provider can generate.