AXIS_GrabImage


Captures a frame using AXIS.

Syntax

C++
Python
 
def AXIS_GrabImage(
	state: AXIS_State,
	inAddress: str,
	outImage: Image,
	/,
	*,
	inCameraID: int = 1,
	inOutputQueueSize: int = 5,
	inLogin: str | None = None,
	inPassword: str | None = None,
	inStreamProfile: str | None = None,
	inResolution: AXISResolution | None = None,
	inRotation: AXISRotation | None = None,
	inCompression: int | None = None,
	inTextString: str | None = None,
	inUseSquarePixel: bool | None = None
)
-> outResult: bool

Parameters

Name Type Range Default Description
Input will be modified ioState AXIS_State
Input value inAddress str Source device host or ip address
Input value inCameraID int 1 - 4 1 ID of camera
Input value inOutputQueueSize int 5 - 200 5 Capacity of output frames queue
Input value inLogin str | None None Login for Basic authorization
Input value inPassword str | None None Login for Basic authorization
Input value inStreamProfile str | None None Profile configuration name.
Input value inResolution AXISResolution | None None Resolution of the returned image
Input value inRotation AXISRotation | None None Rotates the image clockwise
Input value inCompression int | None 0 - 100 None Compression level of the image
Input value inTextString str | None None
Input value inUseSquarePixel bool | None None Square pixel (aspect ratio) correction
Output value outImage Image Output image