EnableStream[s]

Top  Previous  Next

Namespace Hierarchy

C++

PXCSenseManager::EnableStream[s]

C#

PXCMSenseManager.EnableStream[s]

Java

PXCMSenseManager.EnableStream[s]

Syntax

C++

pxcStatus  EnableStreams(DataDesc *ddesc);

pxcStatus  EnableStream(StreamType stream, pxcI32 width, pxcI32 height, pxcF32 fps);

pxcStatus  EnableStream(StreamType stream, pxcI32 width, pxcI32 height);

 

C#

pxcmStatus EnableStreams(DataDesc ddesc);

pxcmStatus EnableStream(StreamType stream, Int32 width, Int32 height, Single fps);

pxcmStatus EnableStream(StreamType stream, Int32 width, Int32 height);

 

Java

pxcmStatus EnableStreams(DataDesc ddesc);

pxcmStatus EnableStream(StreamType stream, int width, int height, float fps);

pxcmStatus EnableStream(StreamType stream, int width, int height);

 

Parameters

 

ddesc

The video stream descriptor as detailed in the DataDesc structure.

 

stream

The stream type. See the StreamType enumerator for definitions.

 

width

The specified image width, or zero for any image width.

 

height

The specified image height, or zero for any image height.

 

fps

The specified frame rate, or zero for any frame rate.

Description


The EnableStream[s] function requests that the specified stream(s) be part of the pipeline streaming. The application can call this function multiple times for different streams.

If the application specifies more than 1 stream in the stream descriptor, the PXC[M]SenseManager interface delivers all streams synchronized when invoking the OnImageSamples callback function.

Use this function to explicitly request a stream for rendering or processing. There is no need to call this function for any modality processing. When the application uses the EnableModule function (or any algorithm specific helper functions) to enable algorithm modalities, the SDK enables the corresponding streams implicitly.

Return Status

 

PXC[M]_STATUS_NO_ERROR

The function completes successfully.