RtgvStartStream

RtgvStartStream combines the functionality of both RtgvStartReceiveStream and RtgvStartCameraStream.

Syntax

BOOL RtgvStartStream(
    [in]    HANDLE cameraHandle,       
    [in]    UINT32 localIP, 
    [in]    UINT32 localPort, 
    [in]    UINT32 imageRingBufferNumElements,
    [in]    HANDLE * StreamErrorEvent
);

Parameters

[in] cameraHandle

A handle to the camera for which a stream will be started.

[in] localIPAddress

The IP Address of the wRTOS Network Interface Card (NIC) to which the camera should send images.

[in] localPort

The local port to which the camera should send images.

[in] imageRingBufferNumElements

The number of elements to be allocated for the image ring buffer, which holds images that are received and ready to be grabbed using RtgvGrabFrame. When in trigger mode, only 1 element is needed. In continuous mode, a larger ring buffer is recommended. A ring buffer size of 10 has been tested and is known to work.

[in] streamErrorEvent

A pointer to an event handle that will be signaled if an error occurs in the stream.

Return Values

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Remarks

This function will fail if it is called before RtgvInitialize and RtgvInitCameraControl.

To find the camera to query, call RtgvInitialize and then call RtgvEnumerateCameras to get an RTGV_CAMERA_INFO array describing each camera found on the network, along with its handles.

Requirements