You are here: Start » Function Reference » Camera Support » AXIS » AXIS_GrabImage_WithTimeout

AXIS_GrabImage_WithTimeout

Header:	ThirdPartySdk.h
Namespace:	fil
Module:	ThirdParty

Captures with timeout a frame using AXIS.

Syntax

bool fil::AXIS_GrabImage_WithTimeout
(
	AXIS_State& ioState,
	const ftl::String& inAddress,
	int inCameraID,
	int inOutputQueueSize,
	int inTimeout,
	ftl::Optional<const ftl::String&> inLogin,
	ftl::Optional<const ftl::String&> inPassword,
	ftl::Optional<const ftl::String&> inStreamProfile,
	ftl::Optional<fil::AXISResolution::Type> inResolution,
	ftl::Optional<fil::AXISRotation::Type> inRotation,
	ftl::Optional<int> inCompression,
	ftl::Optional<const ftl::String&> inTextString,
	ftl::Optional<bool> inUseSquarePixel,
	ftl::Conditional<fil::Image>& outImage
)

Parameters

Name	Type	Range	Default	Description
ioState	AXIS_State&			Object used to maintain state of the function.
inAddress	const String&			Source device host or ip address
inCameraID	int	1 - 4		ID of camera
inOutputQueueSize	int	5 - 200		Capacity of output frames queue
inTimeout	int	1 -	100	Maximum time to wait for frame in milliseconds
inLogin	Optional<const String&>		NIL	Login for Basic authorization
inPassword	Optional<const String&>		NIL	Login for Basic authorization
inStreamProfile	Optional<const String&>		NIL	Profile configuration name.
inResolution	Optional<AXISResolution::Type>		NIL	Resolution of the returned image
inRotation	Optional<AXISRotation::Type>		NIL	Rotates the image clockwise
inCompression	Optional<int>	0 - 100	NIL	Compression level of the image
inTextString	Optional<const String&>		NIL
inUseSquarePixel	Optional<bool>		NIL	Square pixel (aspect ratio) correction
outImage	Conditional<Image>&			Output image

Remarks

Camera identification

Camera is identified by two inputs:

inAddress - server name or IP address of camera. It is not a http address using to view image by website. For example:
```
http://my.camera.com/folder/view/viewer_index.shtml?id=217
```
inAddress is
```
http://my.camera.com
```
inCameraID - camera source. Applies only to video servers with more than one video input.

Changing parameters

AXIS Camera support is based on MJPEG streaming, and after changing any parameter the connection must be reset.

The simplest way to reset connection is to stop and restart the program.

FabImage Studio support only basic authentication, please check your device setting.
In order to change authentication method you need to right-click device on the list in AXIS Device Manager and go to Configure Device. There you need to change "Authentication Policy" parameter to "Basic"

HTTPS is not supported.

Configuring the settings in the manufacturer's application may take priority.

New camera models use a global rotation setting.

Errors

List of possible exceptions:

Error type	Description
DomainError	Empty inAddress in AXIS_GrabImage_WithTimeout.