dwSerializerParams Struct Reference

Detailed Description

Holds the parameters for sensor serializer creation.

Definition at line 90 of file SensorSerializerTypes.h.

Data Fields
const char8_t *	parameters
	Array for additional parameters provided to sensor serializer creation. More...
dwSensorSerializerOnDataFunc_t	onData
	Callback executed by the serializer on new data available. More...
void *	userData
	Context used by callback onData. More...

Field Documentation

onData

dwSensorSerializerOnDataFunc_t dwSerializerParams::onData

Callback executed by the serializer on new data available.

Definition at line 125 of file SensorSerializerTypes.h.

parameters

const char8_t* dwSerializerParams::parameters

Array for additional parameters provided to sensor serializer creation.

The parameters argument is an array in the form of key-value pairs separated by commas, i.e., key1=value1,key2=value2,key3=value3.

Supported 'keys' are:

• 'type' - Required. Specifies data-sink settings.
  • If the value of 'type' is 'disk', the serializer streams data to the file specified in the 'file' key. For an example, see dwSensorSerializer_initialize().
  • If the value of 'type' is 'user', the serializer uses the provided callback to stream data. When new data is available, the serializer calls the function provided in onData and puts the data in the buffer provided by userData.
    
• 'file' - See description for 'type'.
• 'file-buffer-size' - Size of output buffer to use for file operations.
• 'async-record' - Optional. Interpreted as uint16_t. Specify whether the serializer works in 'sync' mode (with a value of zero) or 'async' mode (with a non-zero value). The default mode is 'sync'.
  Following key-value pairs only applied for video data.
  
• 'format' - Optional. Specifies the video format. Supported values are 'h264', 'mp4' and 'raw'.
• 'bitrate' - Optional. Interpreted as uint32_t. Specify average frame bitrate. Default value is zero.
• 'framerate' - Optional. Interpreted as uint32_t. Specify frame proccessing rate. Default value is zero.
• 'quality' - Optional. String value. If non-empty, encoder qualitywill be set to max value.
• 'gop-length' - Optional. String value. If non-empty, set group of pictures's length to 16, default length is 1.
• 'image-type' - Optional. Interpreted as uint32_t. Specify image output type, see 'dwCameraOutputType', default output type is 'DW_CAMERA_OUTPUT_NATIVE_PROCESSED'.

For a code snippet, see dwSensorSerializer_initialize().

Definition at line 122 of file SensorSerializerTypes.h.

userData

void* dwSerializerParams::userData

Context used by callback onData.

Definition at line 128 of file SensorSerializerTypes.h.

---

The documentation for this struct was generated from the following file:

• SensorSerializerTypes.h