L4T Multimedia API Reference

32.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CaptureSession.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_CAPTURE_SESSION_H
37 #define _ARGUS_CAPTURE_SESSION_H
38 
39 namespace Argus
40 {
41 
52 {
53 protected:
55 };
56 
64 DEFINE_UUID(InterfaceID, IID_CAPTURE_SESSION, 813644f5,bc21,4013,af44,dd,da,b5,7a,9d,13);
65 class ICaptureSession : public Interface
66 {
67 public:
68  static const InterfaceID& id() { return IID_CAPTURE_SESSION; }
69 
78  virtual Status cancelRequests() = 0;
79 
97  virtual uint32_t capture(const Request* request,
98  uint64_t timeout = TIMEOUT_INFINITE,
99  Status* status = NULL) = 0;
100 
120  virtual uint32_t captureBurst(const std::vector<const Request*>& requestList,
121  uint64_t timeout = TIMEOUT_INFINITE,
122  Status* status = NULL) = 0;
123 
127  virtual uint32_t maxBurstRequests() const = 0;
128 
139  virtual Request* createRequest(const CaptureIntent& intent = CAPTURE_INTENT_PREVIEW,
140  Status* status = NULL) = 0;
141 
152  virtual OutputStreamSettings* createOutputStreamSettings(const StreamType& type,
153  Status* status = NULL) = 0;
154 
164  virtual OutputStream* createOutputStream(const OutputStreamSettings* settings,
165  Status* status = NULL) = 0;
166 
170  virtual bool isRepeating() const = 0;
171 
183  virtual Status repeat(const Request* request) = 0;
184 
196  virtual Status repeatBurst(const std::vector<const Request*>& requestList) = 0;
197 
207  virtual Range<uint32_t> stopRepeat() = 0;
208 
216  virtual Status waitForIdle(uint64_t timeout = TIMEOUT_INFINITE) const = 0;
217 
218 protected:
220 };
221 
222 } // namespace Argus
223 
224 #endif // _ARGUS_CAPTURE_SESSION_H
virtual Range< uint32_t > stopRepeat()=0
Shuts down any repeating capture.
The base interface for a class that provides libargus Interfaces.
Definition: Types.h:321
DEFINE_UUID(ExtensionName, EXT_BAYER_AVERAGE_MAP, 12c3de20, 64c5, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
virtual Status repeat(const Request *request)=0
Sets up a repeating request.
Status
Status values returned by API function calls.
Definition: Types.h:93
The top-level interface class.
Definition: Types.h:290
virtual Status waitForIdle(uint64_t timeout=TIMEOUT_INFINITE) const =0
Waits until all pending captures are complete.
virtual Status cancelRequests()=0
Removes all previously submitted requests from the queue.
Interface to the core CaptureSession methods.
static const InterfaceID & id()
virtual OutputStream * createOutputStream(const OutputStreamSettings *settings, Status *status=NULL)=0
Creates an OutputStream object using the settings configured by an OutputStreamSettings object (see c...
virtual bool isRepeating() const =0
Returns true if there is a streaming request in place.
virtual OutputStreamSettings * createOutputStreamSettings(const StreamType &type, Status *status=NULL)=0
Creates an OutputStreamSettings object that is used to configure the creation of an OutputStream (see...
virtual uint32_t maxBurstRequests() const =0
Returns the maximum number of capture requests that can be included in a burst capture.
const uint64_t TIMEOUT_INFINITE
Constant used for infinite timeouts.
Definition: Types.h:88
Range template class.
Definition: Types.h:710
A unique identifier for a libargus Interface.
Definition: Types.h:300
virtual Status repeatBurst(const std::vector< const Request * > &requestList)=0
Sets up a repeating burst request.
virtual Request * createRequest(const CaptureIntent &intent=CAPTURE_INTENT_PREVIEW, Status *status=NULL)=0
Creates a request object that can be later used with this CaptureSession.
A top level object class for libargus objects that are created and owned by the client.
Definition: Types.h:358
virtual uint32_t capture(const Request *request, uint64_t timeout=TIMEOUT_INFINITE, Status *status=NULL)=0
Submits a single capture request to the request queue.
virtual uint32_t captureBurst(const std::vector< const Request * > &requestList, uint64_t timeout=TIMEOUT_INFINITE, Status *status=NULL)=0
Submits a burst to the request queue.