L4T Multimedia API Reference

27.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

Namespaces

 Ext
 

Data Structures

class  AcRegion
 Defines an autocontrol region of interest (in pixel space). More...
 
class  Array2D
 A template class to hold a 2-dimensional array of data. More...
 
class  BayerTuple
 BayerTuple template class. More...
 
class  CameraDevice
 Contains an object representing a single camera device. More...
 
class  CameraProvider
 A CameraProvider instance provides the entry point to the Argus runtime. More...
 
class  CaptureMetadata
 A container for metadata from a single capture. More...
 
class  CaptureMetadataContainer
 An object that holds a CaptureMetadata instance and is used to read the capture metadata from a consumer thread directly from the embedded EGLStream metadata. More...
 
class  CaptureSession
 The object that controls all operations on a single sensor. More...
 
class  Destructable
 A top level object class for libargus objects that are created and owned by the client. More...
 
class  Event
 An Event represents an asynchronous result. More...
 
class  EventQueue
 An EventQueue object, as returned by IEventProvider::createEventQueue. More...
 
class  EventType
 A unique identifier for a particular type of Event. More...
 
class  ExtensionName
 Extension name UUID. More...
 
class  IAutoControlSettings
 This class is exposed by the InterfaceProvider returned by IRequest::getAutocontrolSettings(). More...
 
class  IBayerHistogram
 An interface to a set of histograms created from Bayer pixel data, one per Bayer channel. More...
 
class  ICameraProperties
 An interface to retrieve the properties of a CameraDevice. More...
 
class  ICameraProvider
 The core interface provided by a CameraProvider. More...
 
class  ICaptureMetadata
 An interface that reports metadata for a single capture. More...
 
class  ICaptureSession
 Describes the core interface available to CaptureSessions. More...
 
class  IDenoiseMetadata
 
class  IDenoiseSettings
 
class  IEdgeEnhanceMetadata
 
class  IEdgeEnhanceSettings
 
class  IEvent
 The interface common to all event types. More...
 
class  IEventCaptureComplete
 The interface that exposes the properties for a CAPTURE_COMPLETE event. More...
 
class  IEventError
 The interface that exposes the properties for an ERROR event. More...
 
class  IEventProvider
 The interface for an object which generates Events (such as CaptureSession). More...
 
class  IEventQueue
 The interface available to an EventQueue. More...
 
class  InputStream
 Input streams are created and owned by CaptureSessions, and they maintain a connection with an EGLStream in order to acquire frames as an EGLStream consumer. More...
 
class  Interface
 The top-level interface class. More...
 
class  InterfaceID
 A unique identifier for an libargus Interface. More...
 
class  InterfaceProvider
 The base interface for a class that provides libargus Interfaces. More...
 
class  IOutputStreamSettings
 Interface that exposes the settings used for OutputStream creation. More...
 
class  IRequest
 Defines the interface to a capture Request. More...
 
class  IRGBHistogram
 An interface to a set of histograms created from RGB pixel data, one per RGB channel. More...
 
class  ISensorMode
 An interface to retrieve the properties of a SensorMode. More...
 
class  ISourceSettings
 This class is exposed by the InterfaceProvider returned by IRequest::getSourceSettings(). More...
 
class  IStream
 Interface that exposes the properties common to all Stream objects. More...
 
class  IStreamCaptureMetadata
 An interface that reports metadata for a single stream in a single capture. More...
 
class  IStreamSettings
 
class  IVideoStabilizationMetadata
 
class  IVideoStabilizationSettings
 
class  NamedUUID
 A unique identifier with a name (primarily for debugging purposes). More...
 
class  NonCopyable
 Utility class for libargus interfaces. More...
 
class  OutputStream
 Output streams are created and owned by CaptureSessions, and they maintain a connection with an EGLStream in order to present frames as an EGLStream producer. More...
 
class  OutputStreamSettings
 Settings for OutputStream creation are exposed by the OutputStreamSettings class. More...
 
class  PixelFormat
 Pixel formats. More...
 
class  Point2D
 Point2D template class. More...
 
class  Range
 Range template class. More...
 
class  Rectangle
 Rectangle template class. More...
 
struct  remove_const
 Movable smart pointer mimicking std::unique_ptr. More...
 
struct  remove_const< const T & >
 
struct  remove_const< const T * >
 
struct  remove_const< const T >
 
class  Request
 A request defines the parameters to configure the capture. More...
 
class  RGBTuple
 RGBTuple template class. More...
 
class  rv
 Template helper emulating C++11 rvalue semantics. More...
 
class  SensorMode
 An object representing the sensor mode of a CameraDevice. More...
 
class  Size2D
 Size2D template class. More...
 
class  Tuple
 Tuple template class. More...
 
class  UniqueObj
 
struct  UUID
 UUID. More...
 

Typedefs

typedef uint32_t AutoControlId
 

Enumerations

enum  AeAntibandingMode {
  AE_ANTIBANDING_MODE_OFF,
  AE_ANTIBANDING_MODE_AUTO,
  AE_ANTIBANDING_MODE_50HZ,
  AE_ANTIBANDING_MODE_60HZ,
  AE_ANTIBANDING_MODE_COUNT
}
 
enum  AeState {
  AE_STATE_INACTIVE,
  AE_STATE_SEARCHING,
  AE_STATE_CONVERGED,
  AE_STATE_FLASH_REQUIRED,
  AE_STATE_LOCKED,
  AE_STATE_COUNT
}
 
enum  AwbState {
  AWB_STATE_INACTIVE,
  AWB_STATE_SEARCHING,
  AWB_STATE_CONVERGED,
  AWB_STATE_LOCKED,
  AWB_STATE_COUNT
}
 
enum  BayerChannel {
  BAYER_CHANNEL_R,
  BAYER_CHANNEL_G_EVEN,
  BAYER_CHANNEL_G_ODD,
  BAYER_CHANNEL_B,
  BAYER_CHANNEL_COUNT
}
 
enum  Status {
  STATUS_OK,
  STATUS_INVALID_PARAMS,
  STATUS_INVALID_SETTINGS,
  STATUS_UNAVAILABLE,
  STATUS_OUT_OF_MEMORY,
  STATUS_UNIMPLEMENTED,
  STATUS_TIMEOUT,
  STATUS_CANCELLED,
  STATUS_DISCONNECTED,
  STATUS_COUNT
}
 Status values returned by API function calls. More...
 
enum  RGBChannel {
  RGB_CHANNEL_R,
  RGB_CHANNEL_G,
  RGB_CHANNEL_B,
  RGB_CHANNEL_COUNT
}
 
enum  Coordinate {
  COORDINATE_X,
  COORDINATE_Y,
  COORDINATE_Z,
  COORDINATE_2D_COUNT = 2,
  COORDINATE_3D_COUNT = 3
}
 

Functions

 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 results in order to help determine the correct position of the lens to achieve the best focus. More...
 
 DEFINE_UUID (ExtensionName, EXT_DEBUG_CAPTURE_METADATA, 37afdbd9, 0020, 4f91, 957b, 46, ea, eb, 79, 80, c7)
 The Ext::DebugCaptureMetadata extension adds internal capture metadata to the libargus driver. More...
 
 DEFINE_UUID (ExtensionName, EXT_DEBUG_CAPTURE_SESSION, 1fee5f03, 2ea9, 4558, 8e92, c2, 4b, 0b, 82, b9, af)
 The Ext::DebugCaptureSession extension adds internal method to the libargus driver. More...
 
 DEFINE_UUID (ExtensionName, EXT_DE_FOG, 9cf05bd0, 1d99, 4be8, 8732, 75, 99, 55, 7f, ed, 3a)
 The Ext::DeFog extension adds an internal de-fog algorithm to the libargus driver. More...
 
 DEFINE_UUID (ExtensionName, EXT_FACE_DETECT, 40412bb0, ba24, 11e5, a837, 08, 00, 20, 0c, 9a, 66)
 The Ext::FaceDetect extension adds internal face-detection algorithms to the libargus driver. More...
 
 DEFINE_UUID (ExtensionName, EXT_SENSOR_PRIVATE_METADATA, 7acf4352, 3a75, 46e7, 9af1, 8d, 71, da, 83, 15, 23)
 The Ext::SensorPrivateMetadata extension adds sensor embedded metadata to libargus. More...
 
 DEFINE_UUID (InterfaceID, IID_CAMERA_PROPERTIES, 436d2a73, c85b, 4a29, bce5, 15, 60, 6e, 35, 86, 91)
 
 DEFINE_UUID (InterfaceID, IID_SENSOR_MODE, e69015e0, db2a, 11e5, a837, 18, 00, 20, 0c, 9a, 66)
 
 DEFINE_UUID (InterfaceID, IID_CAMERA_PROVIDER, a00f33d7, 8564, 4226, 955c, 2d, 1b, cd, af, a3, 5f)
 
 DEFINE_UUID (InterfaceID, IID_BAYER_HISTOGRAM, 50bc4f1c, 6424, beb7, baae, b0, 90, c9, c3, 25, 9e)
 
 DEFINE_UUID (InterfaceID, IID_RGB_HISTOGRAM, 50bc4f1d, 6424, beb7, baae, b0, 90, c9, c3, 25, 9e)
 
 DEFINE_UUID (InterfaceID, IID_STREAM_CAPTURE_METADATA, 61cbe0a8, 0ee1, 4c67, baae, 02, 02, 1a, b8, d9, 47)
 
 DEFINE_UUID (InterfaceID, IID_CAPTURE_METADATA, 5f6ac5d4, 59e8, 45d0, 8bac, 38, 09, 1f, f8, 74, a9)
 
 DEFINE_UUID (InterfaceID, IID_DENOISE_METADATA, 7A461D23, 6AE1, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_UUID (InterfaceID, IID_EDGE_ENHANCE_METADATA, 7A461D24, 6AE1, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_UUID (InterfaceID, IID_VIDEO_STABILIZATION_METADATA, 7A461D25, 6AE1, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_UUID (InterfaceID, IID_CAPTURE_SESSION, 813644f5, bc21, 4013, af44, dd, da, b5, 7a, 9d, 13)
 
 DEFINE_UUID (EventType, EVENT_TYPE_ERROR, 2c80d8b0, 2bfd, 11e5, a2cb, 08, 00, 20, 0c, 9a, 66)
 Event Type used to report an error. More...
 
 DEFINE_UUID (EventType, EVENT_TYPE_CAPTURE_STARTED, 2c80d8b1, 2bfd, 11e5, a2cb, 08, 00, 20, 0c, 9a, 66)
 Event Type used to report when a capture starts. More...
 
 DEFINE_UUID (EventType, EVENT_TYPE_CAPTURE_COMPLETE, 2c80d8b2, 2bfd, 11e5, a2cb, 08, 00, 20, 0c, 9a, 66)
 Event Type used to report when all capture processing has completed. More...
 
 DEFINE_UUID (InterfaceID, IID_EVENT, 98bcb49e, fd7d, 11e4, a322, 16, 97, f9, 25, ec, 7b)
 
 DEFINE_UUID (InterfaceID, IID_EVENT_ERROR, 13e0fc70, 1ab6, 11e5, b939, 08, 00, 20, 0c, 9a, 66)
 
 DEFINE_UUID (InterfaceID, IID_EVENT_CAPTURE_COMPLETE, 8b2b40b5, f1e4, 4c4d, ae1c, f3, 93, f6, 54, 06, d5)
 
 DEFINE_UUID (InterfaceID, IID_EVENT_PROVIDER, 523ed330, 25dc, 11e5, 867f, 08, 00, 20, 0c, 9a, 66)
 
 DEFINE_UUID (InterfaceID, IID_EVENT_QUEUE, 944b11f6, e512, 49ad, 8573, fc, 82, 3e, 02, 25, ed)
 
 DEFINE_UUID (InterfaceID, IID_REQUEST, eb9b3750, fc8d, 455f, 8e0f, 91, b3, 3b, d9, 4e, c5)
 
 DEFINE_UUID (InterfaceID, IID_SOURCE_SETTINGS, eb7ae38c, 3c62, 4161, a92a, a6, 4f, ba, c6, 38, 83)
 
 DEFINE_UUID (InterfaceID, IID_AUTO_CONTROL_SETTINGS, 1f2ad1c6, cb13, 440b, bc95, 3f, fd, 0d, 19, 91, db)
 
 DEFINE_UUID (InterfaceID, IID_STREAM_SETTINGS, c477aeaf, 9cc8, 4467, a834, c7, 07, d7, b6, 9f, a4)
 
 DEFINE_UUID (InterfaceID, IID_DENOISE_SETTINGS, 7A461D20, 6AE1, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_UUID (InterfaceID, IID_EDGE_ENHANCE_SETTINGS, 7A461D21, 6AE1, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_UUID (InterfaceID, IID_VIDEO_STABILIZATION_SETTINGS, 7A461D22, 6AE1, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_NAMED_UUID_CLASS (StreamMode)
 
 DEFINE_UUID (StreamMode, STREAM_MODE_MAILBOX, 33661d40, 3ee2, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
 
 DEFINE_UUID (StreamMode, STREAM_MODE_FIFO, 33661d41, 3ee2, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
 
 DEFINE_UUID (InterfaceID, IID_STREAM, 8f50dade, cc26, 4ec6, 9d2e, d9, d0, 19, 2a, ef, 06)
 
 DEFINE_UUID (InterfaceID, IID_OUTPUT_STREAM_SETTINGS, 52f2b830, 3d52, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
 
 DEFINE_NAMED_UUID_CLASS (AwbMode)
 
 DEFINE_NAMED_UUID_CLASS (CaptureIntent)
 
 DEFINE_NAMED_UUID_CLASS (DenoiseMode)
 
 DEFINE_NAMED_UUID_CLASS (EdgeEnhanceMode)
 
 DEFINE_NAMED_UUID_CLASS (SensorModeType)
 
 DEFINE_NAMED_UUID_CLASS (VideoStabilizationMode)
 
 DEFINE_UUID (AwbMode, AWB_MODE_OFF, FB3F365A, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_AUTO, FB3F365B, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_INCANDESCENT, FB3F365C, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_FLUORESCENT, FB3F365D, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_WARM_FLUORESCENT, FB3F365E, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_DAYLIGHT, FB3F365F, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_CLOUDY_DAYLIGHT, FB3F3660, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_TWILIGHT, FB3F3661, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_SHADE, FB3F3662, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (AwbMode, AWB_MODE_MANUAL, 20FB45DA, C49F, 4293, AB02, 13, 3F, 8C, CA, DD, 69)
 
 DEFINE_UUID (CaptureIntent, CAPTURE_INTENT_MANUAL, FB3F3663, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (CaptureIntent, CAPTURE_INTENT_PREVIEW, FB3F3664, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (CaptureIntent, CAPTURE_INTENT_STILL_CAPTURE, FB3F3665, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (CaptureIntent, CAPTURE_INTENT_VIDEO_RECORD, FB3F3666, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (CaptureIntent, CAPTURE_INTENT_VIDEO_SNAPSHOT, FB3F3667, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (DenoiseMode, DENOISE_MODE_OFF, FB3F3668, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (DenoiseMode, DENOISE_MODE_FAST, FB3F3669, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (DenoiseMode, DENOISE_MODE_HIGH_QUALITY, FB3F366A, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (EdgeEnhanceMode, EDGE_ENHANCE_MODE_OFF, F7100B40, 6A5F, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_UUID (EdgeEnhanceMode, EDGE_ENHANCE_MODE_FAST, F7100B41, 6A5F, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_UUID (EdgeEnhanceMode, EDGE_ENHANCE_MODE_HIGH_QUALITY, F7100B42, 6A5F, 11E6, BDF4, 08, 00, 20, 0C, 9A, 66)
 
 DEFINE_UUID (SensorModeType, SENSOR_MODE_TYPE_DEPTH, 64483464, 4b91, 11e6, bbbd, 40, 16, 7e, ab, 86, 92)
 
 DEFINE_UUID (SensorModeType, SENSOR_MODE_TYPE_YUV, 6453e00c, 4b91, 11e6, 871d, 40, 16, 7e, ab, 86, 92)
 
 DEFINE_UUID (SensorModeType, SENSOR_MODE_TYPE_RGB, 6463d4c6, 4b91, 11e6, 88a3, 40, 16, 7e, ab, 86, 92)
 
 DEFINE_UUID (SensorModeType, SENSOR_MODE_TYPE_BAYER, 646f04ea, 4b91, 11e6, 9c06, 40, 16, 7e, ab, 86, 92)
 
 DEFINE_UUID (VideoStabilizationMode, VIDEO_STABILIZATION_MODE_OFF, FB3F366E, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (VideoStabilizationMode, VIDEO_STABILIZATION_MODE_ON, FB3F366F, CC62, 11E5, 9956, 62, 56, 62, 87, 07, 61)
 
 DEFINE_UUID (PixelFormat, PIXEL_FMT_UNKNOWN, 00000000, 93d5, 11e5, 0000, 1c, b7, 2c, ef, d4, 1e)
 
 DEFINE_UUID (PixelFormat, PIXEL_FMT_Y8, 569be14a, 93d5, 11e5, 91bc, 1c, b7, 2c, ef, d4, 1e)
 
 DEFINE_UUID (PixelFormat, PIXEL_FMT_Y16, 56ddb19c, 93d5, 11e5, 8e2c, 1c, b7, 2c, ef, d4, 1e)
 
 DEFINE_UUID (PixelFormat, PIXEL_FMT_YCbCr_420_888, 570c10e6, 93d5, 11e5, 8ff3, 1c, b7, 2c, ef, d4, 1e)
 
 DEFINE_UUID (PixelFormat, PIXEL_FMT_YCbCr_422_888, 573a7940, 93d5, 11e5, 99c2, 1c, b7, 2c, ef, d4, 1e)
 
 DEFINE_UUID (PixelFormat, PIXEL_FMT_YCbCr_444_888, 576043dc, 93d5, 11e5, 8983, 1c, b7, 2c, ef, d4, 1e)
 
 DEFINE_UUID (PixelFormat, PIXEL_FMT_JPEG_BLOB, 578b08c4, 93d5, 11e5, 9686, 1c, b7, 2c, ef, d4, 1e)
 
 DEFINE_UUID (PixelFormat, PIXEL_FMT_RAW16, 57b484d8, 93d5, 11e5, aeb6, 1c, b7, 2c, ef, d4, 1e)
 
template<typename TheInterface >
TheInterface * interface_cast (InterfaceProvider *obj)
 Interface-casting helper similar to dynamic_cast. More...
 
template<typename TheInterface >
TheInterface * interface_cast (const InterfaceProvider *obj)
 
template<typename T >
rv< T > & move (T &self)
 
template<typename TheInterface , typename TObject >
TheInterface * interface_cast (const UniqueObj< TObject > &obj)
 
bool operator== (const UUID &l, const UUID &r)
 
bool operator< (const UUID &l, const UUID &r)
 

Variables

const uint64_t TIMEOUT_INFINITE = 0xFFFFFFFFFFFFFFFF
 Constant used for infinite timeouts. More...
 
const uint32_t MAX_UUID_NAME_SIZE = 32
 

Typedef Documentation

typedef uint32_t Argus::AutoControlId

Definition at line 903 of file Types.h.

Enumeration Type Documentation

Enumerator
AE_ANTIBANDING_MODE_OFF 
AE_ANTIBANDING_MODE_AUTO 
AE_ANTIBANDING_MODE_50HZ 
AE_ANTIBANDING_MODE_60HZ 
AE_ANTIBANDING_MODE_COUNT 

Definition at line 184 of file Types.h.

Enumerator
AE_STATE_INACTIVE 
AE_STATE_SEARCHING 
AE_STATE_CONVERGED 
AE_STATE_FLASH_REQUIRED 
AE_STATE_LOCKED 
AE_STATE_COUNT 

Definition at line 194 of file Types.h.

Enumerator
AWB_STATE_INACTIVE 
AWB_STATE_SEARCHING 
AWB_STATE_CONVERGED 
AWB_STATE_LOCKED 
AWB_STATE_COUNT 

Definition at line 205 of file Types.h.

Enumerator
BAYER_CHANNEL_R 
BAYER_CHANNEL_G_EVEN 
BAYER_CHANNEL_G_ODD 
BAYER_CHANNEL_B 
BAYER_CHANNEL_COUNT 

Definition at line 215 of file Types.h.

Enumerator
COORDINATE_X 
COORDINATE_Y 
COORDINATE_Z 
COORDINATE_2D_COUNT 
COORDINATE_3D_COUNT 

Definition at line 270 of file Types.h.

Enumerator
RGB_CHANNEL_R 
RGB_CHANNEL_G 
RGB_CHANNEL_B 
RGB_CHANNEL_COUNT 

Definition at line 261 of file Types.h.

Status values returned by API function calls.

Enumerator
STATUS_OK 

Function succeeded.

STATUS_INVALID_PARAMS 

The set of parameters passed was invalid.

STATUS_INVALID_SETTINGS 

The requested settings are invalid.

STATUS_UNAVAILABLE 

The requested device is unavailable.

STATUS_OUT_OF_MEMORY 

An operation failed because of insufficient mavailable memory.

STATUS_UNIMPLEMENTED 

This method has not been implemented.

STATUS_TIMEOUT 

An operation timed out.

STATUS_CANCELLED 

The capture was aborted.

See also
ICaptureSession::cancelRequests()
STATUS_DISCONNECTED 

The stream or other resource has been disconnected.

STATUS_COUNT 

Definition at line 228 of file Types.h.

Function Documentation

Argus::DEFINE_NAMED_UUID_CLASS ( StreamMode  )
Argus::DEFINE_NAMED_UUID_CLASS ( AwbMode  )
Argus::DEFINE_NAMED_UUID_CLASS ( CaptureIntent  )
Argus::DEFINE_NAMED_UUID_CLASS ( DenoiseMode  )
Argus::DEFINE_NAMED_UUID_CLASS ( EdgeEnhanceMode  )
Argus::DEFINE_NAMED_UUID_CLASS ( SensorModeType  )
Argus::DEFINE_NAMED_UUID_CLASS ( VideoStabilizationMode  )
Argus::DEFINE_UUID ( ExtensionName  ,
EXT_SENSOR_PRIVATE_METADATA  ,
7acf4352  ,
3a75  ,
46e7  ,
9af1  ,
8d  ,
71  ,
da  ,
83  ,
15  ,
23   
)

The Ext::SensorPrivateMetadata extension adds sensor embedded metadata to libargus.

This data is metadata that the sensor embeds inside the frame, the type and formating of embedding depends on the sensor. It is up to the user to correctly parse the data based on the specifics of the sensor used.

  • ISensorPrivateMetadataCaps: Used to check if a device is capable of private metadata output.
  • ISensorPrivateMetadataRequest: Used to enable private metadata output from a capture request.
  • ISensorPrivateMetadata: Used to access the sensor private metadata.
Argus::DEFINE_UUID ( StreamMode  ,
STREAM_MODE_MAILBOX  ,
33661d40  ,
3ee2  ,
11e6  ,
bdf4  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)
Argus::DEFINE_UUID ( StreamMode  ,
STREAM_MODE_FIFO  ,
33661d41  ,
3ee2  ,
11e6  ,
bdf4  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)
Argus::DEFINE_UUID ( ExtensionName  ,
EXT_DE_FOG  ,
9cf05bd0  ,
1d99  ,
4be8  ,
8732  ,
75  ,
99  ,
55  ,
7f  ,
ed  ,
3a   
)

The Ext::DeFog extension adds an internal de-fog algorithm to the libargus driver.

It introduces one new interface:

  • IDeFogSettings; used to enable de-fog for a Request.
Argus::DEFINE_UUID ( ExtensionName  ,
EXT_DEBUG_CAPTURE_METADATA  ,
37afdbd9  ,
0020  ,
4f91  ,
957b  ,
46  ,
ea  ,
eb  ,
79  ,
80  ,
c7   
)

The Ext::DebugCaptureMetadata extension adds internal capture metadata to the libargus driver.

It introduces one new interface:

  • IDebugCaptureMetadata: used to get hardware capture count for a Request.
Argus::DEFINE_UUID ( ExtensionName  ,
EXT_DEBUG_CAPTURE_SESSION  ,
1fee5f03  ,
2ea9  ,
4558  ,
8e92  ,
c2  ,
4b  ,
0b  ,
82  ,
b9  ,
af   
)

The Ext::DebugCaptureSession extension adds internal method to the libargus driver.

It introduces one new interface:

  • IDebugCaptureSession: used to dump session runtime information
Argus::DEFINE_UUID ( InterfaceID  ,
IID_SOURCE_SETTINGS  ,
eb7ae38c  ,
3c62  ,
4161  ,
a92a  ,
a6  ,
4f  ,
ba  ,
c6  ,
38  ,
83   
)
Argus::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 results in order to help determine the correct position of the lens to achieve the best focus.

It introduces two new interfaces:

  • IBayerSharpnessMapSettings; used to enable sharness map generation in a capture Request.
  • IBayerSharpnessMapMetadata; exposes the sharpness map metrics from the CaptureMetadata.
Argus::DEFINE_UUID ( ExtensionName  ,
EXT_FACE_DETECT  ,
40412bb0  ,
ba24  ,
11e5  ,
a837  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)

The Ext::FaceDetect extension adds internal face-detection algorithms to the libargus driver.

It introduces four new interfaces:

  • IFaceDetectCaps; exposes the face detection capabilities of a CaptureSession.
  • IFaceDetectSettings; used to enable face detection for a Request.
  • IFaceDetectMetadata; returns a list of FaceDetectResult objects from a completed capture's CaptureMetadata.
  • IFaceDetectResult; exposes the image rect and confidence level of a result object returned by getFaceDetectResults.
Argus::DEFINE_UUID ( InterfaceID  ,
IID_EVENT_PROVIDER  ,
523ed330  ,
25dc  ,
11e5  ,
867f  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_EVENT_QUEUE  ,
944b11f6  ,
e512  ,
49ad  ,
8573  ,
fc  ,
82  ,
3e  ,
02  ,
25  ,
ed   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_CAPTURE_SESSION  ,
813644f5  ,
bc21  ,
4013  ,
af44  ,
dd  ,
da  ,
b5  ,
7a  ,
9d  ,
13   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_REQUEST  ,
eb9b3750  ,
fc8d  ,
455f  ,
8e0f  ,
91  ,
b3  ,
3b  ,
d9  ,
4e  ,
c5   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_CAMERA_PROPERTIES  ,
436d2a73  ,
c85b  ,
4a29  ,
bce5  ,
15  ,
60  ,
6e  ,
35  ,
86  ,
91   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_CAMERA_PROVIDER  ,
a00f33d7  ,
8564  ,
4226  ,
955c  ,
2d  ,
1b  ,
cd  ,
af  ,
a3  ,
5f   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_BAYER_HISTOGRAM  ,
50bc4f1c  ,
6424  ,
beb7  ,
baae  ,
b0  ,
90  ,
c9  ,
c3  ,
25  ,
9e   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_STREAM  ,
8f50dade  ,
cc26  ,
4ec6  ,
9d2e  ,
d9  ,
d0  ,
19  ,
2a  ,
ef  ,
06   
)
Argus::DEFINE_UUID ( EventType  ,
EVENT_TYPE_ERROR  ,
2c80d8b0  ,
2bfd  ,
11e5  ,
a2cb  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)

Event Type used to report an error.

Additional interface: IEventError.

Argus::DEFINE_UUID ( EventType  ,
EVENT_TYPE_CAPTURE_STARTED  ,
2c80d8b1  ,
2bfd  ,
11e5  ,
a2cb  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)

Event Type used to report when a capture starts.

Argus::DEFINE_UUID ( EventType  ,
EVENT_TYPE_CAPTURE_COMPLETE  ,
2c80d8b2  ,
2bfd  ,
11e5  ,
a2cb  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)

Event Type used to report when all capture processing has completed.

Argus::DEFINE_UUID ( InterfaceID  ,
IID_EVENT  ,
98bcb49e  ,
fd7d  ,
11e4  ,
a322  ,
16  ,
97  ,
f9  ,
25  ,
ec  ,
7b   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_RGB_HISTOGRAM  ,
50bc4f1d  ,
6424  ,
beb7  ,
baae  ,
b0  ,
90  ,
c9  ,
c3  ,
25  ,
9e   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_OFF  ,
FB3F365A  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_AUTO  ,
FB3F365B  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_INCANDESCENT  ,
FB3F365C  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_EVENT_ERROR  ,
13e0fc70  ,
1ab6  ,
11e5  ,
b939  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_FLUORESCENT  ,
FB3F365D  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_WARM_FLUORESCENT  ,
FB3F365E  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_DAYLIGHT  ,
FB3F365F  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_CLOUDY_DAYLIGHT  ,
FB3F3660  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_OUTPUT_STREAM_SETTINGS  ,
52f2b830  ,
3d52  ,
11e6  ,
bdf4  ,
08  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_TWILIGHT  ,
FB3F3661  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_SHADE  ,
FB3F3662  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( AwbMode  ,
AWB_MODE_MANUAL  ,
20FB45DA  ,
C49F  ,
4293  ,
AB02  ,
13  ,
3F  ,
8C  ,
CA  ,
DD  ,
69   
)
Argus::DEFINE_UUID ( CaptureIntent  ,
CAPTURE_INTENT_MANUAL  ,
FB3F3663  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( CaptureIntent  ,
CAPTURE_INTENT_PREVIEW  ,
FB3F3664  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_STREAM_CAPTURE_METADATA  ,
61cbe0a8  ,
0ee1  ,
4c67  ,
baae  ,
02  ,
02  ,
1a  ,
b8  ,
d9  ,
47   
)
Argus::DEFINE_UUID ( CaptureIntent  ,
CAPTURE_INTENT_STILL_CAPTURE  ,
FB3F3665  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( CaptureIntent  ,
CAPTURE_INTENT_VIDEO_RECORD  ,
FB3F3666  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_AUTO_CONTROL_SETTINGS  ,
1f2ad1c6  ,
cb13  ,
440b  ,
bc95  ,
3f  ,
fd  ,
0d  ,
19  ,
91  ,
db   
)
Argus::DEFINE_UUID ( CaptureIntent  ,
CAPTURE_INTENT_VIDEO_SNAPSHOT  ,
FB3F3667  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( DenoiseMode  ,
DENOISE_MODE_OFF  ,
FB3F3668  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( DenoiseMode  ,
DENOISE_MODE_FAST  ,
FB3F3669  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_EVENT_CAPTURE_COMPLETE  ,
8b2b40b5  ,
f1e4  ,
4c4d  ,
ae1c  ,
f3  ,
93  ,
f6  ,
54  ,
06  ,
d5   
)
Argus::DEFINE_UUID ( DenoiseMode  ,
DENOISE_MODE_HIGH_QUALITY  ,
FB3F366A  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( EdgeEnhanceMode  ,
EDGE_ENHANCE_MODE_OFF  ,
F7100B40  ,
6A5F  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
Argus::DEFINE_UUID ( EdgeEnhanceMode  ,
EDGE_ENHANCE_MODE_FAST  ,
F7100B41  ,
6A5F  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
Argus::DEFINE_UUID ( EdgeEnhanceMode  ,
EDGE_ENHANCE_MODE_HIGH_QUALITY  ,
F7100B42  ,
6A5F  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_SENSOR_MODE  ,
e69015e0  ,
db2a  ,
11e5  ,
a837  ,
18  ,
00  ,
20  ,
0c  ,
9a  ,
66   
)
Argus::DEFINE_UUID ( SensorModeType  ,
SENSOR_MODE_TYPE_DEPTH  ,
64483464  ,
4b91  ,
11e6  ,
bbbd  ,
40  ,
16  ,
7e  ,
ab  ,
86  ,
92   
)
Argus::DEFINE_UUID ( SensorModeType  ,
SENSOR_MODE_TYPE_YUV  ,
6453e00c  ,
4b91  ,
11e6  ,
871d  ,
40  ,
16  ,
7e  ,
ab  ,
86  ,
92   
)
Argus::DEFINE_UUID ( SensorModeType  ,
SENSOR_MODE_TYPE_RGB  ,
6463d4c6  ,
4b91  ,
11e6  ,
88a3  ,
40  ,
16  ,
7e  ,
ab  ,
86  ,
92   
)
Argus::DEFINE_UUID ( SensorModeType  ,
SENSOR_MODE_TYPE_BAYER  ,
646f04ea  ,
4b91  ,
11e6  ,
9c06  ,
40  ,
16  ,
7e  ,
ab  ,
86  ,
92   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_CAPTURE_METADATA  ,
5f6ac5d4  ,
59e8  ,
45d0  ,
8bac  ,
38  ,
09  ,
1f  ,
f8  ,
74  ,
a9   
)
Argus::DEFINE_UUID ( VideoStabilizationMode  ,
VIDEO_STABILIZATION_MODE_OFF  ,
FB3F366E  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( VideoStabilizationMode  ,
VIDEO_STABILIZATION_MODE_ON  ,
FB3F366F  ,
CC62  ,
11E5  ,
9956  ,
62  ,
56  ,
62  ,
87  ,
07  ,
61   
)
Argus::DEFINE_UUID ( PixelFormat  ,
PIXEL_FMT_UNKNOWN  ,
00000000  ,
93d5  ,
11e5  ,
0000  ,
1c  ,
b7  ,
2c  ,
ef  ,
d4  ,
1e   
)
Argus::DEFINE_UUID ( PixelFormat  ,
PIXEL_FMT_Y8  ,
569be14a  ,
93d5  ,
11e5  ,
91bc  ,
1c  ,
b7  ,
2c  ,
ef  ,
d4  ,
1e   
)
Argus::DEFINE_UUID ( PixelFormat  ,
PIXEL_FMT_Y16  ,
56ddb19c  ,
93d5  ,
11e5  ,
8e2c  ,
1c  ,
b7  ,
2c  ,
ef  ,
d4  ,
1e   
)
Argus::DEFINE_UUID ( PixelFormat  ,
PIXEL_FMT_YCbCr_420_888  ,
570c10e6  ,
93d5  ,
11e5  ,
8ff3  ,
1c  ,
b7  ,
2c  ,
ef  ,
d4  ,
1e   
)
Argus::DEFINE_UUID ( PixelFormat  ,
PIXEL_FMT_YCbCr_422_888  ,
573a7940  ,
93d5  ,
11e5  ,
99c2  ,
1c  ,
b7  ,
2c  ,
ef  ,
d4  ,
1e   
)
Argus::DEFINE_UUID ( PixelFormat  ,
PIXEL_FMT_YCbCr_444_888  ,
576043dc  ,
93d5  ,
11e5  ,
8983  ,
1c  ,
b7  ,
2c  ,
ef  ,
d4  ,
1e   
)
Argus::DEFINE_UUID ( PixelFormat  ,
PIXEL_FMT_JPEG_BLOB  ,
578b08c4  ,
93d5  ,
11e5  ,
9686  ,
1c  ,
b7  ,
2c  ,
ef  ,
d4  ,
1e   
)
Argus::DEFINE_UUID ( PixelFormat  ,
PIXEL_FMT_RAW16  ,
57b484d8  ,
93d5  ,
11e5  ,
aeb6  ,
1c  ,
b7  ,
2c  ,
ef  ,
d4  ,
1e   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_DENOISE_METADATA  ,
7A461D23  ,
6AE1  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_EDGE_ENHANCE_METADATA  ,
7A461D24  ,
6AE1  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_VIDEO_STABILIZATION_METADATA  ,
7A461D25  ,
6AE1  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_STREAM_SETTINGS  ,
c477aeaf  ,
9cc8  ,
4467  ,
a834  ,
c7  ,
07  ,
d7  ,
b6  ,
9f  ,
a4   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_DENOISE_SETTINGS  ,
7A461D20  ,
6AE1  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_EDGE_ENHANCE_SETTINGS  ,
7A461D21  ,
6AE1  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
Argus::DEFINE_UUID ( InterfaceID  ,
IID_VIDEO_STABILIZATION_SETTINGS  ,
7A461D22  ,
6AE1  ,
11E6  ,
BDF4  ,
08  ,
00  ,
20  ,
0C  ,
9A  ,
66   
)
template<typename TheInterface >
TheInterface* Argus::interface_cast ( InterfaceProvider *  obj)
inline

Interface-casting helper similar to dynamic_cast.

Definition at line 381 of file Types.h.

References Argus::InterfaceProvider::getInterface().

Referenced by interface_cast().

template<typename TheInterface >
TheInterface* Argus::interface_cast ( const InterfaceProvider *  obj)
inline

Definition at line 387 of file Types.h.

template<typename TheInterface , typename TObject >
TheInterface* Argus::interface_cast ( const UniqueObj< TObject > &  obj)
inline

Definition at line 471 of file Types.h.

References Argus::UniqueObj< T >::get(), and interface_cast().

template<typename T >
rv<T>& Argus::move ( T &  self)

Definition at line 425 of file Types.h.

bool Argus::operator< ( const UUID &  l,
const UUID &  r 
)
bool Argus::operator== ( const UUID &  l,
const UUID &  r 
)

Variable Documentation

const uint32_t Argus::MAX_UUID_NAME_SIZE = 32

Definition at line 55 of file UUID.h.

const uint64_t Argus::TIMEOUT_INFINITE = 0xFFFFFFFFFFFFFFFF

Constant used for infinite timeouts.

Definition at line 98 of file Types.h.