eSDK Pro Camera Parameter Classes

This topic describes the CameraParam class and the derived camera parameter classes in the eSDK Pro API:

• CameraParam class — Base class for all camera parameters.
• ‍BoolCameraParam class — Boolean on/off parameter.
• ‍CommandCameraParam class — Trigger-style parameter that executes an action.
• ‍EnumCameraParam class — Parameter that selects from a fixed set of named options.
• ‍FloatCameraParam class — Floating-point numeric parameter.
• ‍Int32CameraParam class — Signed 32-bit integer parameter.
• ‍StringCameraParam class — Text-based parameter.
• ‍UInt32CameraParam class — Unsigned 32-bit integer parameter.

‍

CameraParam Class

Namespace: eSdkPro  Header: eSdkPro/cameraparam.h

Base class for all camera parameters.

‍

GetName()

std::string eSdkPro::CameraParam::GetName() const

Returns: The name of the parameter.

‍

GetType()

CameraParamType eSdkPro::CameraParam::GetType() const

‍
Returns: The type of the parameter.

BoolCameraParam Class

Namespace: eSdkPro  Header: eSdkPro/cameraparam.h

Boolean camera parameter.

‍

SetValue()

void eSdkPro::BoolCameraParam::SetValue(bool value)

Parameter: value — The value to be set.

‍

GetValue()

bool eSdkPro::BoolCameraParam::GetValue() const

Returns: The current value of the parameter.

CommandCameraParam Class

Namespace: eSdkPro  Header: eSdkPro/cameraparam.h

Command parameter.

‍

Execute()

void eSdkPro::CommandCameraParam::Execute()

Executes the command.

EnumCameraParam Class

Namespace: eSdkPro  Header: eSdkPro/cameraparam.h

Enumeration-based camera parameter.

‍

SetValue()

void eSdkPro::EnumCameraParam::SetValue(const std::string& value)

Parameter: value — The value to be set.

‍

GetValue()

std::string eSdkPro::EnumCameraParam::GetValue() const

Returns: The current value of the parameter.

‍

GetRange()

std::vector<std::string> eSdkPro::EnumCameraParam::GetRange() const

Returns: The list of allowed values.

FloatCameraParam Class

Namespace: eSdkPro  Header: eSdkPro/cameraparam.h

Floating-point camera parameter.

‍

SetValue()

void eSdkPro::FloatCameraParam::SetValue(float value)

Parameter: value — The value to be set.

‍

GetValue()

float eSdkPro::FloatCameraParam::GetValue() const

Returns: The current value of the parameter.

‍

GetMin()

float eSdkPro::FloatCameraParam::GetMin() const

Returns: The minimum allowed value for this parameter.

‍

GetMax()

float eSdkPro::FloatCameraParam::GetMax() const

Returns: The maximum allowed value for this parameter.

Int32CameraParam Class

Namespace: eSdkPro  Header: eSdkPro/cameraparam.h

32-bit signed integer parameter.

‍

SetValue()

void eSdkPro::Int32CameraParam::SetValue(int32_t value)

Parameter: value — The value to be set.

‍

GetValue()

int32_t eSdkPro::Int32CameraParam::GetValue() const

Returns: The current value of the parameter.

‍

GetMin()

int32_t eSdkPro::Int32CameraParam::GetMin() const

Returns: The minimum allowed value for this parameter.

‍

GetMax()

int32_t eSdkPro::Int32CameraParam::GetMax() const

Returns: The maximum allowed value for this parameter.

‍

GetInc()

int32_t eSdkPro::Int32CameraParam::GetInc() const

Returns: The increment step between valid values.

StringCameraParam Class

Namespace: eSdkPro  Header: eSdkPro/cameraparam.h

String-based camera parameter.

‍

SetValue()

void eSdkPro::StringCameraParam::SetValue(const std::string& value)

Parameter: value — The value to be set.

‍

GetValue()

std::string eSdkPro::StringCameraParam::GetValue() const

‍
‍Returns: The current value of the parameter.

UInt32CameraParam Class

Namespace: eSdkPro  Header: eSdkPro/cameraparam.h

32-bit unsigned integer parameter.

‍

SetValue()

void eSdkPro::UInt32CameraParam::SetValue(uint32_t value)

Parameter: value — The value to be set.

‍

GetValue()

uint32_t eSdkPro::UInt32CameraParam::GetValue() const

Returns: The current value of the parameter.

‍

GetMin()

uint32_t eSdkPro::UInt32CameraParam::GetMin() const

Returns: The minimum allowed value for this parameter.

‍

GetMax()

uint32_t eSdkPro::UInt32CameraParam::GetMax() const

Returns: The maximum allowed value for this parameter.

‍

GetInc()

uint32_t eSdkPro::UInt32CameraParam::GetInc() const

Returns: The increment step between valid values.

‍

See Also

• Camera Class
• Server Class
• System Class

‍