duvc-ctl 2.0.0
USB Video Class Camera Control Library
Loading...
Searching...
No Matches
Quick API

Functions

bool duvc::get (const Device &dev, CamProp prop, PropSetting &out)
 Get a camera control property value.
 
bool duvc::set (const Device &dev, CamProp prop, const PropSetting &in)
 Set a camera control property value.
 
bool duvc::get_range (const Device &dev, CamProp prop, PropRange &out)
 Get the valid range for a camera control property.
 
bool duvc::get (const Device &dev, VidProp prop, PropSetting &out)
 Get a video processing property value.
 
bool duvc::set (const Device &dev, VidProp prop, const PropSetting &in)
 Set a video processing property value.
 
bool duvc::get_range (const Device &dev, VidProp prop, PropRange &out)
 Get the valid range for a video processing property.
 

Detailed Description

Simplified one-call camera control functions.

These wrappers provide easy access for CLI tools and casual use cases. They internally use the Camera RAII API but expose a simple bool interface. For detailed error handling, use the full Camera API.

Function Documentation

◆ get() [1/2]

bool duvc::get ( const Device & dev,
CamProp prop,
PropSetting & out )
inline

Get a camera control property value.

Parameters
devDevice to query
propCamera property
outOutput property setting
Returns
true if successful

Definition at line 63 of file duvc.hpp.

References duvc::Result< T >::is_ok(), and duvc::Result< T >::value().

Referenced by duvc_cam_get(), and duvc_vid_get().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get() [2/2]

bool duvc::get ( const Device & dev,
VidProp prop,
PropSetting & out )
inline

Get a video processing property value.

Parameters
devDevice to query
propVideo property
outOutput property setting
Returns
true if successful

Definition at line 113 of file duvc.hpp.

References duvc::Result< T >::is_ok(), and duvc::Result< T >::value().

Here is the call graph for this function:

◆ get_range() [1/2]

bool duvc::get_range ( const Device & dev,
CamProp prop,
PropRange & out )
inline

Get the valid range for a camera control property.

Parameters
devDevice to query
propCamera property
outOutput property range
Returns
true if successful

Definition at line 95 of file duvc.hpp.

References duvc::Result< T >::is_ok(), and duvc::Result< T >::value().

Referenced by duvc_cam_get_range(), and duvc_vid_get_range().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_range() [2/2]

bool duvc::get_range ( const Device & dev,
VidProp prop,
PropRange & out )
inline

Get the valid range for a video processing property.

Parameters
devDevice to query
propVideo property
outOutput property range
Returns
true if successful

Definition at line 145 of file duvc.hpp.

References duvc::Result< T >::is_ok(), and duvc::Result< T >::value().

Here is the call graph for this function:

◆ set() [1/2]

bool duvc::set ( const Device & dev,
CamProp prop,
const PropSetting & in )
inline

Set a camera control property value.

Parameters
devDevice to modify
propCamera property
inNew property setting
Returns
true if successful

Definition at line 81 of file duvc.hpp.

References duvc::Result< T >::is_ok().

Referenced by duvc_cam_set(), and duvc_vid_set().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set() [2/2]

bool duvc::set ( const Device & dev,
VidProp prop,
const PropSetting & in )
inline

Set a video processing property value.

Parameters
devDevice to modify
propVideo property
inNew property setting
Returns
true if successful

Definition at line 131 of file duvc.hpp.

References duvc::Result< T >::is_ok().

Here is the call graph for this function: