Class: PipelineProfile

PipelineProfile()

The pipeline profile includes a device and a selection of active streams, with specific profile. The profile is a selection of the above under filters and conditions defined by the pipeline. Streams may belong to more than one sensor of the device.

Constructor

new PipelineProfile()

Source:

Members

isValid

Check if the object is valid
Source:

Methods

destroy() → {undefined}

Destroy the resource associated with this object
Source:
Returns:
Type
undefined

getDevice() → {Device}

Retrieve the device used by the pipeline. The device class provides the application access to control camera additional settings - get device information, sensor options information, options value query and set, sensor specific extensions. Since the pipeline controls the device streams configuration, activation state and frames reading, calling the device API functions, which execute those operations, results in unexpected behavior. The pipeline streaming device is selected during Pipeline.start. Devices of profiles, which are not returned by Pipeline.start or Pipeline.getActiveProfile, are not guaranteed to be used by the pipeline.
Source:
Returns:
the pipeline selected device
Type
Device

getStream(streamType, streamIndex) → {StreamProfile}

Return the selected stream profile, which are enabled in this profile.
Parameters:
Name Type Description
streamType Integer | String the stream type of the desired profile, see stream for avaiable values
streamIndex Integer stream index of the desired profile, -1 for any matching
Source:
Returns:
the first matching stream profile
Type
StreamProfile

getStreams() → {Array.<StreamProfile>}

Return the selected streams profiles, which are enabled in this profile.
Source:
Returns:
an array of StreamProfile
Type
Array.<StreamProfile>