Vision Functions

The following Vision functions can be used to discover, query, and retrieve frames from GigE Vision cameras. See the GigE Vision sample for an example of how to use Vision APIs to control and receive data from a GigE Vision Camera.

Function Name

Description

RtgvClose

Closes all GigE Vision resources.

RtgvCloseCameraControl

Closes the control channel on a camera.

RtgvCloseCameraStream

Stops a camera from sending images.

RtgvCloseReceiveStream

Closes the receive stream associated with the specified camera. The camera will no longer receive frames, even if it continues to send them.

RtgvCloseStream

Combines the functionality of both RtgvCloseCameraStream and RtgvCloseReceiveStream.

RtgvEnumerateCameras

Enumerates the discovered cameras on the network.

RtgvGetAcquisitionMode

Retrieves the currently configured acquisition mode of a camera.

RtgvGetCameraID

Retrieves the ID of a camera.

RtgvGetFrameHeight

Retrieves the currently configured frame height of a camera.

RtgvGetFrameMaxHeight

Retrieves the maximum frame height supported by a camera.

RtgvGetFrameMaxWidth

Retrieves the maximum frame width supported by a camera.

RtgvGetFrameNumberOfChannels

Retrieves the number of channels currently configured on a camera.

RtgvGetFrameOffsetX

Retrieves the frame X offset from the specified camera.

RtgvGetFrameOffsetY

Retrieves the frame Y offset from the specified camera.

RtgvGetFramePixelDepth

Retrieves the number of bits-per-pixel currently configured on a camera.

RtgvGetFramePixelFormat

Retrieves the currently configured pixel format on a camera.

RtgvGetFrameWidth

Retrieves the currently configured frame width of a camera.

RtgvGetManufacturerName

Retrieves the manufacturer name of a camera.

RtgvGetPayloadSize

Retrieves the currently configured pixel format on a camera.

RtgvGetLastStreamError

Retrieves the last error that occurred in the stream associated with the specified camera.

RtgvGrabFrame

Retrieves a frame from a camera.

RtgvInitCameraControl

Starts a control channel with a camera, which allows you to query and control the camera for such uses as retrieving the width of the image on the camera (using RtgvGetFrameWidth), or starting an image stream on the camera (using RtgvStartStream or RtgvStartCameraStream).

RtgvInitialize

Initializes GigE Vision resources.

RtgvIsGEVStatusCode

Determines whether the given error code is a GEV Status Code sent by a camera.

RtgvReadRegister

Reads a value from a register on the camera.

RtgvSendTrigger

Sends a trigger to a camera, causing it to send a frame.

RtgvSetCameraCameraAcquisitionMode

Sets the acquisition mode on the specified camera.

RtgvSetFrameHeight

Sets the frame height of a camera.

RtgvSetFramePixelFormat

Sets the pixel format on a specified camera.

RtgvSetFrameWidth

Sets the frame width of a specified camera.

RtgvSetFrameOffsetX

Sets the frame X offset on the specified camera.

RtgvSetFrameOffsetY

Sets the frame Y offset on the specified camera.

RtgvStartCameraStream

Starts a stream on a camera, sending frames to the specified IP Address.

RtgvStartReceiveStream

Starts a receive stream for receiving frames from a camera.

RtgvStartStream

Combines the functionality of both RtgvStartCameraStream and RtgvStartReceiveStream.

RtgvWaitForFrame

Waits for the first packet of a frame to be received.

RtgvWriteRegister

Writes a value to a register on the camera.