Function rs2_pipeline_start_with_config

Function Documentation

rs2_pipeline_profile *rs2_pipeline_start_with_config(rs2_pipeline *pipe, rs2_config *config, rs2_error **error)

Start the pipeline streaming according to the configuraion. 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. The pipeline selects and activates the device upon start, according to configuration or a default configuration. When the rs2::config is provided to the method, the pipeline tries to activate the config resolve() result. If the application requests are conflicting with pipeline computer vision modules or no matching device is available on the platform, the method fails. Available configurations and devices may change between config resolve() call and pipeline start, in case devices are connected or disconnected, or another application acquires ownership of a device.

Parameters:

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

  • config – [in] A rs2::config with requested filters on the pipeline configuration. By default no filters are applied.

  • 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.