Gocator_GrabSurface_WithTimeout


Captures Surface from Gocator device with timeout; returns Nil if no data comes in the specified time.

Syntax

C++
Python
 
def Gocator_GrabSurface_WithTimeout(
	state: Gocator_State,
	inInputQueueSize: int,
	inTimeout: int,
	/,
	*,
	inAddress: str | None = None
)
-> (
	outResult: bool,
	outSurface: Surface | None,
	outSurfaceIntensity: Image | None,
	outFrameInfo: GocatorFrameInfo | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState Gocator_State
Input value inAddress str | None None Gocator Device identifying IP address (e.g. "127.0.0.1") or serial number (e.g. "SN:17335")
Input value inInputQueueSize int 1 - 50000 Number of incoming frames that can be buffered before the application is able to process them
Input value inTimeout int 10 - Maximum time to wait for data in milliseconds
Output value outSurface Surface | None
Output value outSurfaceIntensity Image | None
Output value outFrameInfo GocatorFrameInfo | None