Function rs2_pipeline_start

Function Documentation

rs2_pipeline_profile *rs2_pipeline_start(rs2_pipeline *pipe, rs2_error **error)

Start the pipeline streaming with its default configuration. The pipeline streaming loop captures samples from the device, and delivers them to the attached computer vision modules and processing blocks, according to each module requirements and threading model. During the loop execution, the application can access the camera streams by calling wait_for_frames() or poll_for_frames(). The streaming loop runs until the pipeline is stopped. Starting the pipeline is possible only when it is not started. If the pipeline was started, an exception is raised.

Parameters:
  • pipe[in] a pointer to an instance of the pipeline

  • error[out] if non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns:

The actual pipeline device and streams profile, which was successfully configured to the streaming device.