| Xavia SDK c++ API 2.1.0 API description of the xavia library

Loading...
Searching...
No Matches
iCamera.h
1#pragma once
2
3#include <cstddef>
4#include <cstdint>
5#include <string>
6
7namespace xavia::sdk
8{
9 constexpr std::size_t DEFAULT_CAMERA_TIMEOUT_MS = 5000;
10
23 class ICamera
24 {
25 public:
26 virtual ~ICamera() = default;
27
39 virtual void Start(const std::size_t& timeoutMS = DEFAULT_CAMERA_TIMEOUT_MS) = 0;
40
51 virtual void Stop(const std::size_t& timeoutMS = DEFAULT_CAMERA_TIMEOUT_MS) = 0;
52
59 virtual void ResetConfiguration() = 0;
60
71 virtual void SetExposureTimeUs(const std::uint32_t exposureTimeUs) = 0;
72
80 virtual std::uint32_t GetExposureTimeUs() const = 0;
81
89 virtual std::string GetCameraId() const = 0;
90
98 virtual std::wstring GetCameraIdW() const = 0;
99
104 virtual bool IsStreaming() const = 0;
105
114 virtual bool HasWriteAccess() = 0;
115
116// /**
117// * \brief Attempts to get write access
118// * \brief returns true if we have write access, false if not
119// *
120// * This function tries to get write access through an application switchover.
121// * This will not always succeed. And even if it succeeds, another client could
122// * try the same technique to get the write access back.
123// */
124// virtual bool TryForceWriteAccess() = 0;
125
126// /**
127// * \brief Enable multicast streaming for the camera
128// */
129// virtual void EnableMultiCast() = 0;
130 };
131} // namespace xavia::sdk
xavia::sdk::ICamera
Camera object interface.
Definition iCamera.h:24
xavia::sdk::ICamera::ResetConfiguration
virtual void ResetConfiguration()=0
Reset camera configuration to default (factory) values.
xavia::sdk::ICamera::GetExposureTimeUs
virtual std::uint32_t GetExposureTimeUs() const =0
Get the current camera exposure time.
xavia::sdk::ICamera::SetExposureTimeUs
virtual void SetExposureTimeUs(const std::uint32_t exposureTimeUs)=0
Set the camera exposure time.
xavia::sdk::ICamera::GetCameraId
virtual std::string GetCameraId() const =0
Get the camera identifier.
xavia::sdk::ICamera::Start
virtual void Start(const std::size_t &timeoutMS=DEFAULT_CAMERA_TIMEOUT_MS)=0
Starts the camera streaming.
xavia::sdk::ICamera::HasWriteAccess
virtual bool HasWriteAccess()=0
Check if we have write access to the camera configuration.
xavia::sdk::ICamera::GetCameraIdW
virtual std::wstring GetCameraIdW() const =0
Get the camera identifier, wide format.
xavia::sdk::ICamera::Stop
virtual void Stop(const std::size_t &timeoutMS=DEFAULT_CAMERA_TIMEOUT_MS)=0
Stop the camera streaming.
xavia::sdk::ICamera::IsStreaming
virtual bool IsStreaming() const =0
Check if camera is currently streaming.