Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » Binary Data » WriteBufferArrayToBuffer

WriteBufferArrayToBuffer


Module: FoundationLite

Writes connected content of all source buffer array items into other byte buffer.

Name Type Range Description
inBuffer ByteBuffer Initial buffer to be expanded
inOffset Integer* 0 - Write destination position
inSourceBuffers ByteBufferArray Buffers with source data to be copied
outBuffer ByteBuffer Resulting data

Description

This filter is intended for assembling an array of byte buffers into a single continuous stream of data. Resulting data is stored into the output buffer.

Source data is produced by connecting data of every buffer item from the source array on the inSourceBuffers input, preserving their order. Length of data in array buffers is not restricted by any means (buffers in array can have different lengths).

Resulting ByteBuffer data on the outBuffer output is created by expanding data from buffer on the inBuffer input. Data is written starting at the position specified by the inOffset input (in bytes). When written data spans beyond the end of the input buffer the resulting buffer length is expanded (event when inOffset points beyond the end of the input buffer). When the inOffset input is set to Auto data is written at the end of the input buffer.

This filter can be used when writing an array of information to the byte buffer. Usually this filter will finalize an array execution of other buffer writing filters.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
IoError Resulting buffer size is too large.
RuntimeError Invalid buffers aliasing.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of WriteToBuffer filter group.

See Also