Libargus API Libargus Camera API

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
DebugCaptureSession.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
29 /**
30 * @file
31 * <b>Libargus Extension: Debug Capture Session API</b>
32 *
33 * @b Description: This file defines the DebugCaptureSession extension.
34 */
35
36 #ifndef _ARGUS_DEBUG_CAPTURE_SESSION_H
37 #define _ARGUS_DEBUG_CAPTURE_SESSION_H
38
39 namespace Argus
40 {
41
42 /**
43 * Adds a debug interface to dump internal libargus runtime information.
44 * It introduces one new interface:
45 * - Ext::IDebugCaptureSession: dumps session runtime information.
46 *
47 * @defgroup ArgusExtDebugCaptureSession Ext::DebugCaptureSession
48 * @ingroup ArgusExtensions
49 */
50 DEFINE_UUID(ExtensionName, EXT_DEBUG_CAPTURE_SESSION, 1fee5f03,2ea9,4558,8e92,c2,4b,0b,82,b9,af);
51
52 namespace Ext
53 {
54
55 /**
56 * @class IDebugCaptureSession
57 *
58 * Interface used to dump CaptureSession runtime information
59 *
60 * @ingroup ArgusCaptureSession ArgusExtDebugCaptureSession
61 */
62 DEFINE_UUID(InterfaceID, IID_DEBUG_CAPTURE_SESSION, beaa075b,dcf7,4e26,b255,3c,98,db,03,5b,99);
63 class IDebugCaptureSession : public Interface
64 {
65 public:
66 static const InterfaceID& id() { return IID_DEBUG_CAPTURE_SESSION; }
67
68 /**
69 * Returns session runtime information to the specified file descriptor.
70 */
71 virtual Status dump(int32_t fd) const = 0;
72
73 protected:
74 ~IDebugCaptureSession() {}
75 };
76
77 } // namespace Ext
78
79 } // namespace Argus
80
81 #endif
82