eSDK Pro Camera Class

This topic describes the Camera class in the eSDK Pro API.
‍

Camera Class

Namespace: eSdkPro  Header: eSdkPro/camera.h

Represents a camera.

‍

GetDiscoveryInfo()

CameraDiscoveryInfo eSdkPro::Camera::GetDiscoveryInfo() const

‍
Returns: The discovery info of the camera.

Camera Discovery Information Struct

‍Struct: eSdkPro::CameraDiscoveryInfo

Camera device information used for identification and setup.

Members

• m_serialNumber — A unique identifier for each camera.
• m_modelName — The model of the camera, e.g. HR-12000SC.
• m_ip — A unique identifier for the camera on the network.
• m_subnetMask — The subnet mask for the camera on the network.
• m_interfaceName — The network adapter name where the camera is connected.
• m_macAddress — The permanent unique hardware identifier.

‍

Open()

void eSdkPro::Camera::Open(const CameraOpenConfig& config)

Opens a camera and initializes the camera stream.‍

Parameter: config — The configuration parameters to open the camera with.

Camera Open Configuration Struct

‍Struct: eSdkPro::CameraOpenConfig

Configuration for opening a camera.

Members

• m_streamCpuCore — The CPU core for the streaming thread. −1 for automatic thread-affinity selection.
• m_gpuDeviceId — The GPU device ID (index) to use for streaming. −1 for no GPU streaming.
• m_gpuDirectEnabled — Enables GPU Direct for streaming directly into GPU memory using GPUDirect.
• m_autoNumStreamBuffers — Enables automatic stream-buffer allocation; otherwise numStreamBuffers is used.
• m_numStreamBuffers — The number of stream buffers to allocate.

‍

Close()

void eSdkPro::Camera::Close()

Closes a camera and deinitializes the camera stream.

‍

StartStreaming()

void eSdkPro::Camera::StartStreaming()

Starts frame acquisition.

‍

StopStreaming()

void eSdkPro::Camera::StopStreaming()

Stops frame acquisition.

‍

StartImagePreview()

void eSdkPro::Camera::StartImagePreview(PreviewFrameFunc onFrameReceive)

Starts image preview, downsampled frames received are in RGBA format. Image quality may be controlled using System::SetPreviewQuality().‍

Parameter: onFrameReceive — The callback function to be executed when a frame is received.

‍

StopImagePreview()

void eSdkPro::Camera::StopImagePreview()

Stops image preview.

‍

GetParameter()

template <typename T, typename = ValidCameraParam<T>>
T eSdkPro::Camera::GetParameter(const std::string& name) const

Gets a camera parameter of type T.

Template parameter: T — The type of the camera parameter. T must derive from CameraParam.‍

Parameter: name — The parameter name.‍

Returns: The camera parameter of type T.

‍

See Also

• Server Class
• Camera Parameter Classes
• Frame Class

‍