Public Member Functions | List of all members
VideoDevice Class Reference

A device representing a video stream from the hard disk. More...

#include <cvb/driver/video_device.hpp>

Inherits Device.

Public Member Functions

Cvb::Driver::PlaybackMode PlaybackMode () const noexcept
 Gets how images are delivered by the stream. More...
 
void SetPlaybackMode (Cvb::Driver::PlaybackMode playbackMode)
 Sets how images are delivered by the stream. More...
 
- Public Member Functions inherited from Device
void * Handle () const noexcept
 Classic API device handle. More...
 
String ResourceLocator () const noexcept
 Gets the access token or path of the file name including its extension. More...
 
DeviceControlPtr DeviceControl () const
 Gets the DeviceControl interface if present. More...
 
DigitalIOPtr DigitalIO () const
 Gets the DigitalIO interface if present. More...
 
SoftwareTriggerPtr SoftwareTrigger () const
 Gets the SoftwareTrigger interface if present. More...
 
ImageRectPtr ImageRect () const
 Gets the ImageRect interface if present. More...
 
virtual StreamPtr Stream () const
 Get the stream for this device. More...
 
int StreamCount () const noexcept
 Get the number of streams. More...
 
template<class T >
std::shared_ptr< T > DeviceImage () const
 Gets, if available, the device image pointing to the last synchronized image. More...
 
DeviceImagePtr DeviceImage () const
 Gets, if available, the device image pointing to the latest synchronized image. More...
 
NodeMapPtr NodeMap (const String &name) const
 Gets the NodeMap with the given name. More...
 
std::map< String, NodeMapPtr > NodeMaps () const
 Gets the dictionary holding all available NodeMaps. More...
 
NotifyObservablePtr NotifyObservable (int id) const
 Get the observable for a given id. More...
 
Cvb::ConnectionState ConnectionState () const noexcept
 brief Gets the current Cvb::ConnectionState of this Device object.
 
EventCookie RegisterConnectionStateChangedEvent (std::function< void()> handler)
 Register a listener to the OnDisconnect event. More...
 
void UnregisterConnectionStateChangedEvent (EventCookie eventCookie) noexcept
 Manually unregister a listener to the OnDisconnect event. More...
 

Detailed Description

A device representing a video stream from the hard disk.

Member Function Documentation

◆ PlaybackMode()

PlaybackMode PlaybackMode ( ) const
inlinenoexcept

Gets how images are delivered by the stream.

Returns
The current playback mode.
Exceptions
Doesnot throw any exception.

◆ SetPlaybackMode()

void SetPlaybackMode ( Cvb::Driver::PlaybackMode  playbackMode)
inline

Sets how images are delivered by the stream.

Parameters
[in]playbackModeThe new playback mode.
Exceptions
Anyexception derived from std::exception including CvbException.