onboardapi  9.10.0
by Rheinmetall
M_RecordingCtrl::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void CmdStartRecording (M_RecordingCtrl::VideoChannelListType const &VideoChannelList)
 
virtual void CmdCaptureVideoCutout (M_Common::StringListType const &VideoChannelIdList, M_Common::TimeType const &StartTime, M_Common::TimeType const &StopTime, std::string const &Description)
 
virtual void CmdStopRecording (M_Common::StringListType const &VideoChannelIdList)
 
virtual void CmdRemoveVideoCutout (std::string const &VideoChannelId, M_Common::TimeType const &StartTime, M_Common::TimeType const &StopTime)
 
virtual void CmdRemoveAllVideoCutouts ()
 Remove all stored previously captured video cutouts. More...
 
virtual void CmdCaptureImage (M_Common::StringListType const &VideoChannelIdList)
 

Detailed Description

Service interface. Contains operations that a client can command the Recording Control Service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_RecordingCtrl::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdCaptureImage()

void M_RecordingCtrl::IService::CmdCaptureImage ( M_Common::StringListType const &  VideoChannelIdList)
virtual

Capture still image. Note: Images can only be captured if a recording has been started for the specified channel(s).

Parameters
VideoChannelIdListList of Video Channel ids where still image should be captured.

◆ CmdCaptureVideoCutout()

void M_RecordingCtrl::IService::CmdCaptureVideoCutout ( M_Common::StringListType const &  VideoChannelIdList,
M_Common::TimeType const &  StartTime,
M_Common::TimeType const &  StopTime,
std::string const &  Description 
)
virtual

Capture video cutout. Note: Video cutouts can only be captured if a recording has been started for the specified channel(s). The lead time of the video cutout capture should be configured in the Service.

Parameters
VideoChannelIdListList of Video Channel ids where the video cutout should be captured.
StartTimeThe absolute time the video cutout should start from (seconds + nanoseconds since UTC epoch).
StopTimeThe absolute time the video cutout should end (seconds + nanoseconds since UTC epoch).
DescriptionTextual description for the cutout.

◆ CmdRemoveAllVideoCutouts()

void M_RecordingCtrl::IService::CmdRemoveAllVideoCutouts ( )
virtual

Remove all stored previously captured video cutouts.

◆ CmdRemoveVideoCutout()

void M_RecordingCtrl::IService::CmdRemoveVideoCutout ( std::string const &  VideoChannelId,
M_Common::TimeType const &  StartTime,
M_Common::TimeType const &  StopTime 
)
virtual

Remove a captured video cutout. Note: The VideoChannel, StartTime and StopTime parameters must all match an existing stored video cutout in order for the cutout to be removed.

Parameters
VideoChannelIdThe video channel identifying the video source of the cutout.
StartTimeThe absolute time the cutout was started. Note: This has to match the start time of a stored video cutout reported in ReportRecordingStatus.
StopTimeThe absolute time the cutout was stopped. Note: This has to match the stop time of a stored video cutout reported in ReportRecordingStatus.

◆ CmdStartRecording()

void M_RecordingCtrl::IService::CmdStartRecording ( M_RecordingCtrl::VideoChannelListType const &  VideoChannelList)
virtual

Start recording one or more Video Channels.

Parameters
VideoChannelListList of Video Channels which should be started.

◆ CmdStopRecording()

void M_RecordingCtrl::IService::CmdStopRecording ( M_Common::StringListType const &  VideoChannelIdList)
virtual

Stop recording.

Parameters
VideoChannelIdListList of Video Channel ids which should be stopped.