Base class for camera streaming. More...

Inheritance diagram for Flir.Atlas.Live.Device.Camera:

Public Member Functions
ImageBase	GetImage ()
	Gets the current received image. More...

override void	Dispose ()
	Dispose the camera instance. More...

virtual bool	StartGrabbing ()
	Starts grabbing of images from the connected camera device. More...

virtual void	StopGrabbing ()
	Stops grabbing images from the camera. More...

List< string >	EnumerateFrameRates ()
	Get supported frame rates More...

List< Size >	EnumerateResolutions ()
	List of supported resolutions. More...

Public Member Functions inherited from Flir.Atlas.Live.Device.CameraBase
	CameraBase ()
	Initializes a new instance of the Camera More...

virtual void	Connect (CameraDeviceInfo camera, SecurityParameters securityParameters=null)
	Asynchronous connects to a camera device. More...

virtual void	Disconnect ()
	Disconnect the camera device. More...

Protected Member Functions
	Camera (bool autoStartGrabbing)
	Initializes a new instance of the Camera More...

void	CameraAdapter_ImageReady (object sender, Interfaces.ImageReadyEventArgs e)

virtual bool	ImageReady (Interfaces.ImageReadyEventArgs e, bool fireImageReady=true)
	New image received, load to Atlas Image More...

override void	DisposeCamera ()
	Stop grabbing and dispose the camera instance. More...

override void	OnStatusChanged (ConnectionStatus status)
	Status changed. Check if grabbing shall be stopped or started. More...

virtual void	OnStreamError (StreamErrorEventArgs args)
	Fires StreamError More...

Protected Member Functions inherited from Flir.Atlas.Live.Device.CameraBase
virtual void	ProcessData ()
	Override if you need to process some custom data every cycle. More...

virtual bool	CheckDevice ()
	Check if device is still alive. More...

virtual bool	ConnectToCamera ()
	Connect camera More...

virtual void	OnDeviceError (DeviceErrorEventArgs args)
	Fires DeviceError. More...

Properties
bool	IsAutoStartGrabbingEnabled `[get, set]`
	Automatically start/stop grabbing if set to true. More...

ImageBase	Image `[get, set]`
	The current received camera frame, ImageBase for more information on how to access contained data. More...

uint	FrameCount `[get, set]`
	The received number of images. More...

uint	LostImages `[get, set]`
	The number of lost images More...

double	AveragePayload `[get]`
	Average data per second transmitted over the camera interface in MB. More...

bool	IsImageDisabled `[get, set]`
	Disable/Enable loading of the received image to Atlas Image. Set to true if the stream should be kept running but no updates are wanted. More...

VisualImageFormat	FormatVisualImage `[get, set]`
	The raw image format More...

GrabberState	IsGrabberReady `[get]`
	Check if the camera grabber is ready before a stream can be started. More...

double	Fps `[get, set]`
	Frames per second. More...

bool	IsGrabbing `[get]`
	Checks if grabbing is started. More...

Recorder.Recorder	Recorder `[get, protected set]`
	Camera recorder. Store sequence files (SEQ) or MP4 dependent on the connected streaming format. More...

int	FrameRateIndex `[get, set]`
	Select frame rate. EnumerateFrameRates() for a list of available frame rates. More...

int	SelectedResolutionIndex `[get, set]`
	Select resolution. EnumerateResolutions() for a list of available resolutions. More...

Properties inherited from Flir.Atlas.Live.Device.CameraBase
Diagnostics	Diagnostics `[get, protected set]`
	Diagnostic information can be useful when debugging an application. More...

int	TimelapseReconnect `[get, set]`
	Timelapse in milli seconds to wait before retrying to connect. More...

RemoteControl	RemoteControl `[get, protected set]`
	Remotely control a camera device. More...

bool	AutoReconnect `[get, set]`
	Automatically retries to connect to the camera if the connection is lost. More...

CameraDeviceInfo	CameraDeviceInfo `[get, set]`
	Connected camera device information. More...

SecurityParameters	SecurityParameters `[get, set]`
	Security parameters to use when connecting to the camera. More...

bool	IsConnected `[get]`
	Check if the camera is connected. More...

ConnectionStatus	ConnectionStatus `[get, protected set]`
	The camera connection status. More...

static string	Version `[get]`
	Gets the used Atlas version. More...

Events
EventHandler< ImageReceivedEventArgs >	ImageReceived
	Raw image received from camera. More...

EventHandler< EventArgs >	ImageInitialized
	Image initialized with received data More...

EventHandler< StreamErrorEventArgs >	StreamError
	This event is fired when a streaming error is detected. More...

Events inherited from Flir.Atlas.Live.Device.CameraBase
EventHandler< ConnectionStatusChangedEventArgs >	ConnectionStatusChanged
	This event is fired when the connection status has changed. More...

EventHandler< DeviceErrorEventArgs >	DeviceError
	This event is fired when an error is detected. More...

Additional Inherited Members
Protected Attributes inherited from Flir.Atlas.Live.Device.CameraBase
ICameraAdapter	Device
	CLI Camera device. More...

Object	LockDevice = new object()
	Sync. object for camera device. More...

Stopwatch	CheckHeartbeat = new Stopwatch()
	Keep camera connection alive More...

const int	TimeoutCheckForHeartbeat = 2000
	Interval when to check if camera is still present. More...

Detailed Description

Base class for camera streaming.

Constructor & Destructor Documentation

◆ Camera()

Flir.Atlas.Live.Device.Camera.Camera ( bool autoStartGrabbing )

inlineprotected

Initializes a new instance of the Camera

Parameters

autoStartGrabbing

Member Function Documentation

◆ CameraAdapter_ImageReady()

void Flir.Atlas.Live.Device.Camera.CameraAdapter_ImageReady	(	object	sender,
		Interfaces.ImageReadyEventArgs	e
	)

inlineprotected

Parameters

sender
e

◆ Dispose()

override void Flir.Atlas.Live.Device.Camera.Dispose ( )

inlinevirtual

Dispose the camera instance.

Reimplemented from Flir.Atlas.Live.Device.CameraBase.

Reimplemented in Flir.Atlas.Live.Device.DualStreamingThermalCamera, and Flir.Atlas.Live.Device.ThermalCamera.

◆ DisposeCamera()

override void Flir.Atlas.Live.Device.Camera.DisposeCamera ( )

inlineprotectedvirtual

Stop grabbing and dispose the camera instance.

Reimplemented from Flir.Atlas.Live.Device.CameraBase.

◆ EnumerateFrameRates()

List<string> Flir.Atlas.Live.Device.Camera.EnumerateFrameRates ( )

inline

Get supported frame rates

Returns: List of supported frame rates

◆ EnumerateResolutions()

List<Size> Flir.Atlas.Live.Device.Camera.EnumerateResolutions ( )

inline

List of supported resolutions.

Returns: List of resolutions.

◆ GetImage()

ImageBase Flir.Atlas.Live.Device.Camera.GetImage ( )

inline

Gets the current received image.

Returns: ImageBase

◆ ImageReady()

virtual bool Flir.Atlas.Live.Device.Camera.ImageReady	(	Interfaces.ImageReadyEventArgs	e,
		bool	fireImageReady = `true`
	)

inlineprotectedvirtual

New image received, load to Atlas Image

Parameters

e
fireImageReady

Returns

Reimplemented in Flir.Atlas.Live.Device.StreamingCamera, Flir.Atlas.Live.Device.DualStreamingThermalCamera, and Flir.Atlas.Live.Device.ThermalGigabitCamera.

◆ OnStatusChanged()

override void Flir.Atlas.Live.Device.Camera.OnStatusChanged ( ConnectionStatus status )

inlineprotectedvirtual

Status changed. Check if grabbing shall be stopped or started.

Parameters

status

Reimplemented from Flir.Atlas.Live.Device.CameraBase.

◆ OnStreamError()

virtual void Flir.Atlas.Live.Device.Camera.OnStreamError ( StreamErrorEventArgs args )

inlineprotectedvirtual

Fires StreamError

Parameters

args	Error message.

◆ StartGrabbing()

virtual bool Flir.Atlas.Live.Device.Camera.StartGrabbing ( )

inlinevirtual

Starts grabbing of images from the connected camera device.

Returns

◆ StopGrabbing()

virtual void Flir.Atlas.Live.Device.Camera.StopGrabbing ( )

inlinevirtual

Stops grabbing images from the camera.

Property Documentation

◆ AveragePayload

double Flir.Atlas.Live.Device.Camera.AveragePayload

get

Average data per second transmitted over the camera interface in MB.

◆ FormatVisualImage

VisualImageFormat Flir.Atlas.Live.Device.Camera.FormatVisualImage

getset

The raw image format

◆ Fps

double Flir.Atlas.Live.Device.Camera.Fps

getset

Frames per second.

◆ FrameCount

uint Flir.Atlas.Live.Device.Camera.FrameCount

getset

The received number of images.

◆ FrameRateIndex

int Flir.Atlas.Live.Device.Camera.FrameRateIndex

getset

Select frame rate. EnumerateFrameRates() for a list of available frame rates.

Exceptions

InvalidOperationException

◆ Image

ImageBase Flir.Atlas.Live.Device.Camera.Image

getsetprotected

The current received camera frame, ImageBase for more information on how to access contained data.

◆ IsAutoStartGrabbingEnabled

bool Flir.Atlas.Live.Device.Camera.IsAutoStartGrabbingEnabled

getset

Automatically start/stop grabbing if set to true.

◆ IsGrabberReady

GrabberState Flir.Atlas.Live.Device.Camera.IsGrabberReady

get

Check if the camera grabber is ready before a stream can be started.

◆ IsGrabbing

bool Flir.Atlas.Live.Device.Camera.IsGrabbing

get

Checks if grabbing is started.

Returns

◆ IsImageDisabled

bool Flir.Atlas.Live.Device.Camera.IsImageDisabled

getset

Disable/Enable loading of the received image to Atlas Image. Set to true if the stream should be kept running but no updates are wanted.

◆ LostImages

uint Flir.Atlas.Live.Device.Camera.LostImages

getset

The number of lost images

◆ Recorder

Recorder.Recorder Flir.Atlas.Live.Device.Camera.Recorder

getprotected set

Camera recorder. Store sequence files (SEQ) or MP4 dependent on the connected streaming format.

◆ SelectedResolutionIndex

int Flir.Atlas.Live.Device.Camera.SelectedResolutionIndex

getset

Select resolution. EnumerateResolutions() for a list of available resolutions.

Exceptions

InvalidOperationException

Event Documentation

◆ ImageInitialized

EventHandler<EventArgs> Flir.Atlas.Live.Device.Camera.ImageInitialized

Image initialized with received data

This occurs once after the first image is received.

◆ ImageReceived

EventHandler<ImageReceivedEventArgs> Flir.Atlas.Live.Device.Camera.ImageReceived

Raw image received from camera.

◆ StreamError

EventHandler<StreamErrorEventArgs> Flir.Atlas.Live.Device.Camera.StreamError

This event is fired when a streaming error is detected.

Public Member Functions

Protected Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Camera()

Member Function Documentation

◆ CameraAdapter_ImageReady()

◆ Dispose()

◆ DisposeCamera()

◆ EnumerateFrameRates()

◆ EnumerateResolutions()

◆ GetImage()

◆ ImageReady()

◆ OnStatusChanged()

◆ OnStreamError()

◆ StartGrabbing()

◆ StopGrabbing()

Property Documentation

◆ AveragePayload

◆ FormatVisualImage

◆ Fps

◆ FrameCount

◆ FrameRateIndex

◆ Image

◆ IsAutoStartGrabbingEnabled

◆ IsGrabberReady

◆ IsGrabbing

◆ IsImageDisabled

◆ LostImages

◆ Recorder

◆ SelectedResolutionIndex

Event Documentation

◆ ImageInitialized

◆ ImageReceived

◆ StreamError