RtgvGetFrameNumberOfChannels

RtgvGetFrameNumberOfChannels gets the number of channels currently configured on a camera.

Syntax

Copy
BOOL RtgvGetFrameNumberOfChannels(
    [in]    HANDLE cameraHandle, 
    [out]   PUINT32 pNumChannels
);

Parameters

[in] cameraHandle

The handle of the camera being queried.

[out] pNumChannels

A pointer to an unsigned integer that receives the number of channels per pixel of the camera.  This is dependent on the currently configured pixel format on the camera (i.e. mono means 1 channel, whereas RGB means 3 channels).

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

Minimum supported version Header Library

wRTOS 1.0 SDK

RtgvApi.h

RtgvApi.lib

See Also: