Function rs2_pipeline_start_with_config_and_callback

Function Documentation

rs2_pipeline_profile *rs2_pipeline_start_with_config_and_callback(rs2_pipeline *pipe, rs2_config *config, rs2_frame_callback_ptr on_frame, void *user, rs2_error **error)

Start the pipeline streaming according to the configuraion. The pipeline captures samples from the device, and delivers them to the through the provided frame callback. Starting the pipeline is possible only when it is not started. If the pipeline was started, an exception is raised. When starting the pipeline with a callback both wait_for_frames() or poll_for_frames() will throw exception. 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.

  • on_frame – [in] function pointer to register as per-frame callback

  • user – [in] auxiliary data the user wishes to receive together with every frame callback

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