RtgvStartReceiveStream

RtgvStartReceiveStream starts a receive stream for receiving frames from a camera.

Syntax

Copy
BOOL RtgvStartReceiveStream(
    [in]    HANDLE cameraHandle, 
    [in]    PRTGV_STREAM_PARAMS pStreamParams
    [in]    HANDLE * streamErrorEvent
);

Parameters

[in] cameraHandle

A handle to the camera from which frames will be received.

[in] pStreamParams

A pointer to the stream parameters to be used for the receive stream. See RTGV_STREAM_PARAMS for more information.

[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 a stream is already started when the function is called.

This function cannot be called before calling RtgvInitialize.

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

Minimum supported version Header Library

wRTOS 1.0 SDK

RtgvApi.h

RtgvApi.lib

See Also: