OrbbecSDK 2.0.18
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
Loading...
Searching...
No Matches
ob::DevicePresetList Class Reference

Class representing a list of device presets. More...

#include <Device.hpp>

Public Member Functions

 DevicePresetList (ob_device_preset_list_t *impl)
 
 ~DevicePresetList () noexcept
 
uint32_t getCount ()
 Get the number of device presets in the list.
 
const char * getName (uint32_t index)
 Get the name of the device preset at the specified index.
 
bool hasPreset (const char *name)
 check if the preset list contains the special name preset.
 
uint32_t count ()
 

Detailed Description

Class representing a list of device presets.

A device preset is a set of parameters or configurations that can be applied to the device to achieve a specific effect or function.

Definition at line 1260 of file Device.hpp.

Constructor & Destructor Documentation

◆ DevicePresetList()

ob::DevicePresetList::DevicePresetList ( ob_device_preset_list_t * impl)
inlineexplicit

Definition at line 1265 of file Device.hpp.

◆ ~DevicePresetList()

ob::DevicePresetList::~DevicePresetList ( )
inlinenoexcept

Definition at line 1266 of file Device.hpp.

Member Function Documentation

◆ getCount()

uint32_t ob::DevicePresetList::getCount ( )
inline

Get the number of device presets in the list.

Returns
uint32_t the number of device presets in the list

Definition at line 1277 of file Device.hpp.

Referenced by count().

◆ getName()

const char * ob::DevicePresetList::getName ( uint32_t index)
inline

Get the name of the device preset at the specified index.

Parameters
indexthe index of the device preset
Returns
const char* the name of the device preset

Definition at line 1290 of file Device.hpp.

◆ hasPreset()

bool ob::DevicePresetList::hasPreset ( const char * name)
inline

check if the preset list contains the special name preset.

Parameters
nameThe name of the preset
Returns
bool Returns true if the special name is found in the preset list, otherwise returns false.

Definition at line 1302 of file Device.hpp.

◆ count()

uint32_t ob::DevicePresetList::count ( )
inline

Definition at line 1311 of file Device.hpp.

Referenced by getCount().


The documentation for this class was generated from the following file: