L4T Multimedia API Reference

27.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Request.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_REQUEST_H
38 #define _ARGUS_REQUEST_H
39 
51 namespace Argus
52 {
53 
58 class Request : public InterfaceProvider, public Destructable
59 {
60 protected:
61  ~Request() {}
62 };
63 
69 DEFINE_UUID(InterfaceID, IID_REQUEST, eb9b3750,fc8d,455f,8e0f,91,b3,3b,d9,4e,c5);
70 
71 class IRequest : public Interface
72 {
73 public:
74  static const InterfaceID& id() { return IID_REQUEST; }
75 
80  virtual Status enableOutputStream(OutputStream* stream) = 0;
81 
85  virtual Status disableOutputStream(OutputStream* stream) = 0;
86 
90  virtual Status clearOutputStreams() = 0;
91 
98  virtual Status getOutputStreams(std::vector<OutputStream*>* streams) const = 0;
99 
106  virtual InterfaceProvider* getStreamSettings(const OutputStream* stream) = 0;
107 
116  virtual InterfaceProvider* getAutoControlSettings(const AutoControlId acId = 0) = 0;
117 
123  virtual InterfaceProvider* getSourceSettings() = 0;
124 
131  virtual Status setClientData(uint32_t data) = 0;
132 
136  virtual uint32_t getClientData() const = 0;
137 
138 protected:
140 };
141 
142 } // namespace Argus
144 #endif // _ARGUS_REQUEST_H
The base interface for a class that provides libargus Interfaces.
Definition: Types.h:361
Output streams are created and owned by CaptureSessions, and they maintain a connection with an EGLSt...
Definition: Stream.h:72
virtual InterfaceProvider * getAutoControlSettings(const AutoControlId acId=0)=0
Returns the capture control settings for a given AC.
virtual Status disableOutputStream(OutputStream *stream)=0
Disables the specified output stream.
Status
Status values returned by API function calls.
Definition: Types.h:228
The top-level interface class.
Definition: Types.h:330
A request defines the parameters to configure the capture.
Definition: Request.h:58
virtual Status enableOutputStream(OutputStream *stream)=0
Enables the specified output stream.
virtual Status clearOutputStreams()=0
Disables all output streams.
virtual uint32_t getClientData() const =0
Gets the client data for the request.
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 Status getOutputStreams(std::vector< OutputStream * > *streams) const =0
Returns all enabled output streams.
virtual InterfaceProvider * getSourceSettings()=0
Returns the source settings for the request.
virtual InterfaceProvider * getStreamSettings(const OutputStream *stream)=0
Returns the Stream settings for a particular stream in the request.
virtual Status setClientData(uint32_t data)=0
Sets the client data for the request.
Defines the interface to a capture Request.
Definition: Request.h:71
A unique identifier for an libargus Interface.
Definition: Types.h:340
A top level object class for libargus objects that are created and owned by the client.
Definition: Types.h:398
uint32_t AutoControlId
Definition: Types.h:903
static const InterfaceID & id()
Definition: Request.h:74