visionx::RecordingImageProviderInterface

Overview

interface RecordingImageProviderInterface extends ImageProviderInterface

Derived Classes and Interfaces

CompressedImageProviderInterface

Operation Index

startImageRecording

@brief Starts a recording parametrized according to given config struct.

getImageRecordingStatus

@brief Checks if component is recording.

stopImageRecording

@brief Stops the recording.

getImageRecordingChannelPreferences

@brief Return channel preferences like names or whether lossless formats are required.

Operations

bool startImageRecording(imrec::Config recConfig)

@brief Starts a recording parametrized according to given config struct.

Parameters

config

Config struct.

imrec::Status getImageRecordingStatus()

@brief Checks if component is recording.

Return Value

true if component is recording, false otherwise.

bool stopImageRecording()

imrec::ChannelPreferencesList getImageRecordingChannelPreferences()

@brief Return channel preferences like names or whether lossless formats are required. The default implementation just returns indices for the channel names and that no lossless formats are required. This method should be overridden in image providers (e.g. to return {"left", false} and {"right", false} for stereo cameras or {"rgb", false}, {"depth", true} for RGB-D cameras).

Return Value

List of preferences corresponding to the channels.