FMIceLinkDataBuffer Class Reference

Inherits from	NSObject
Declared in	FMIceLinkDataBuffer.h FMIceLinkDataBuffer.m

`+ allocateWithCount:`

Allocates a new [data](#//api/name/data) buffer with a given size (in bytes) in big-endian format.

+ (FMIceLinkDataBuffer *)allocateWithCount:(int)count

Parameters

`count`	Pre-allocated data buffer size (in bytes).

Discussion

Allocates a new [data](#//api/name/data) buffer with a given size (in bytes) in big-endian format.

Declared In

FMIceLinkDataBuffer.h

`+ allocateWithCount:littleEndian:`

Allocates a new [data](#//api/name/data) buffer with a given size (in bytes).

+ (FMIceLinkDataBuffer *)allocateWithCount:(int)count littleEndian:(bool)littleEndian

Parameters

`count`	Pre-allocated data buffer size (in bytes).
`littleEndian`	Whether the data is little-endian.

Discussion

Allocates a new [data](#//api/name/data) buffer with a given size (in bytes).

Declared In

FMIceLinkDataBuffer.h

`+ allocateWithCount:littleEndian:pooled:`

Allocates a new [data](#//api/name/data) buffer with a given size (in bytes).

+ (FMIceLinkDataBuffer *)allocateWithCount:(int)count littleEndian:(bool)littleEndian pooled:(bool)pooled

Parameters

`count`	Pre-allocated data buffer size (in bytes).
`littleEndian`	Whether the data is little-endian.
`pooled`	Is part of a data pool.

Discussion

Allocates a new [data](#//api/name/data) buffer with a given size (in bytes).

Declared In

FMIceLinkDataBuffer.h

`– and:offset:`

Performs a bitwise "and" operation on a value.

- (bool)and:(int)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Performs a bitwise "and" operation on a value.

Declared In

FMIceLinkDataBuffer.h

`– appendWithBuffer:`

Appends a buffer.

- (FMIceLinkDataBuffer *)appendWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

`buffer`	The buffer.

Discussion

Appends a buffer.

Declared In

FMIceLinkDataBuffer.h

`– appendWithBuffers:`

Appends some buffers.

- (FMIceLinkDataBuffer *)appendWithBuffers:(NSMutableArray *)buffers

Parameters

`buffers`	The buffers.

Discussion

Appends some buffers.

Declared In

FMIceLinkDataBuffer.h

`+ areEqualWithBuffer1:buffer2:`

Tests if the two buffers have equal contents.

+ (bool)areEqualWithBuffer1:(FMIceLinkDataBuffer *)buffer1 buffer2:(FMIceLinkDataBuffer *)buffer2

Parameters

`buffer1`	First buffer to test.
`buffer2`	Second buffer to test.

Discussion

Tests if the two buffers have equal contents.

Declared In

FMIceLinkDataBuffer.h

`– clone`

Clones this instance.

- (FMIceLinkDataBuffer *)clone

Discussion

Clones this instance.

Declared In

FMIceLinkDataBuffer.h

`– cloneWithLittleEndian:`

Clones this instance.

- (FMIceLinkDataBuffer *)cloneWithLittleEndian:(bool)littleEndian

Parameters

`littleEndian`	Whether to clone into a little endian buffer.

Discussion

Clones this instance.

Declared In

FMIceLinkDataBuffer.h

`– data`

Gets the data.

- (NSMutableData *)data

Discussion

Gets the data.

Declared In

FMIceLinkDataBuffer.h

`+ empty`

Gets an empty [data](#//api/name/data) buffer.

+ (FMIceLinkDataBuffer *)empty

Discussion

Gets an empty [data](#//api/name/data) buffer.

Declared In

FMIceLinkDataBuffer.h

`– free`

Decrements the retain count by one and returns the Buffer to the pool if zero.

- (void)free

Discussion

Decrements the retain count by one and returns the Buffer to the pool if zero.

Declared In

FMIceLinkDataBuffer.h

`+ fromJsonArrayWithDataBuffersJson:`

Deserializes an array of instances from JSON.

+ (NSMutableArray *)fromJsonArrayWithDataBuffersJson:(NSString *)dataBuffersJson

Parameters

`dataBuffersJson`	The data buffers JSON. @return

Discussion

Deserializes an array of instances from JSON.

Declared In

FMIceLinkDataBuffer.h

`+ fromJsonWithDataBufferJson:`

Deserializes an instance from JSON.

+ (FMIceLinkDataBuffer *)fromJsonWithDataBufferJson:(NSString *)dataBufferJson

Parameters

`dataBufferJson`	The data buffer JSON. @return

Discussion

Deserializes an instance from JSON.

Declared In

FMIceLinkDataBuffer.h

`– index`

Gets the index.

- (int)index

Discussion

Gets the index.

Declared In

FMIceLinkDataBuffer.h

`– innerData`

Gets backing [data](#//api/name/data) buffer.

- (NSMutableData *)innerData

Discussion

Gets backing [data](#//api/name/data) buffer.

Declared In

FMIceLinkDataBuffer.h

`– isPooled`

Gets whether this DataBuffer is from a pool.

- (bool)isPooled

Discussion

Gets whether this DataBuffer is from a pool.

Declared In

FMIceLinkDataBuffer.h

`– isSubset`

Gets whether this DataBuffer is a subset.

- (bool)isSubset

Discussion

Gets whether this DataBuffer is a subset.

Declared In

FMIceLinkDataBuffer.h

`– keep`

Increment the retain count by one.

- (FMIceLinkDataBuffer *)keep

Discussion

Increment the retain count by one.

Declared In

FMIceLinkDataBuffer.h

`– length`

Gets the length.

- (int)length

Discussion

Gets the length.

Declared In

FMIceLinkDataBuffer.h

`– littleEndian`

Gets whether FMIceLinkDataBuffer#[data](#//api/name/data) is little-endian.

- (bool)littleEndian

Discussion

Gets whether FMIceLinkDataBuffer#[data](#//api/name/data) is little-endian.

Declared In

FMIceLinkDataBuffer.h

`– or:offset:`

Performs a bitwise "or" operation on a value.

- (bool)or:(int)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Performs a bitwise "or" operation on a value.

Declared In

FMIceLinkDataBuffer.h

`– prependWithBuffer:`

Prepends a buffer.

- (FMIceLinkDataBuffer *)prependWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

`buffer`	The buffer.

Discussion

Prepends a buffer.

Declared In

FMIceLinkDataBuffer.h

`– prependWithBuffers:`

Prepends some buffers.

- (void)prependWithBuffers:(NSMutableArray *)buffers

Parameters

`buffers`	The buffers.

Discussion

Prepends some buffers.

Declared In

FMIceLinkDataBuffer.h

`– read12WithOffset:bitOffset:`

Reads a 12-bit value.

- (int)read12WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bitoffset.

Discussion

Reads a 12-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read13SignedWithOffset:bitOffset:`

Reads a 13-bit signed value.

- (int)read13SignedWithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 13-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read13WithOffset:bitOffset:`

Reads a 13-bit value.

- (int)read13WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bitoffset.

Discussion

Reads a 13-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read15WithOffset:bitOffset:`

Reads a 15-bit value.

- (int)read15WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 15-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read16SignedWithOffset:`

Reads a 16-bit signed value.

- (int)read16SignedWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 16-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read16SignedWithOffset:offsetPlus:`

Reads a 16-bit signed value.

- (int)read16SignedWithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 16-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read16WithOffset:`

Reads a 16-bit value.

- (int)read16WithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 16-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read16WithOffset:offsetPlus:`

Reads a 16-bit value.

- (int)read16WithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 16-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read18WithOffset:bitOffset:`

Reads an 18-bit value.

- (int)read18WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads an 18-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read1WithOffset:bitOffset:`

Reads a 1-bit value.

- (bool)read1WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 1-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read24SignedWithOffset:`

Reads a 24-bit signed value.

- (int)read24SignedWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 24-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read24SignedWithOffset:offsetPlus:`

Reads a 24-bit signed value.

- (int)read24SignedWithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 24-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read24WithOffset:`

Reads a 24-bit value.

- (int)read24WithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 24-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read24WithOffset:offsetPlus:`

Reads a 24-bit value.

- (int)read24WithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 24-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read2SignedWithOffset:bitOffset:`

Reads a 2-bit signed value.

- (int)read2SignedWithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 2-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read2WithOffset:bitOffset:`

Reads a 2-bit value.

- (int)read2WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 2-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read32SignedWithOffset:`

Reads a 32-bit signed value.

- (long long)read32SignedWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 32-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read32SignedWithOffset:offsetPlus:`

Reads a 32-bit signed value.

- (long long)read32SignedWithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 32-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read32WithOffset:`

Reads a 32-bit value.

- (long long)read32WithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 32-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read32WithOffset:offsetPlus:`

Reads a 32-bit value.

- (long long)read32WithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 32-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read3SignedWithOffset:bitOffset:`

Reads a 3-bit signed value.

- (int)read3SignedWithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 3-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read3WithOffset:bitOffset:`

Reads a 3-bit value.

- (int)read3WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 3-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read40SignedWithOffset:`

Reads a 40-bit signed value.

- (long long)read40SignedWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 40-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read40SignedWithOffset:offsetPlus:`

Reads a 40-bit signed value.

- (long long)read40SignedWithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 40-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read40WithOffset:`

Reads a 40-bit value.

- (long long)read40WithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 40-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read40WithOffset:offsetPlus:`

Reads a 40-bit value.

- (long long)read40WithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 40-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read48SignedWithOffset:`

Reads a 48-bit signed value.

- (long long)read48SignedWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 48-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read48SignedWithOffset:offsetPlus:`

Reads a 48-bit signed value.

- (long long)read48SignedWithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 48-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read48WithOffset:`

Reads a 48-bit value.

- (long long)read48WithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 48-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read48WithOffset:offsetPlus:`

Reads a 48-bit value.

- (long long)read48WithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 48-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read4SignedWithOffset:bitOffset:`

Reads a 4-bit signed value.

- (int)read4SignedWithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 4-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read4WithOffset:bitOffset:`

Reads a 4-bit value.

- (int)read4WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 4-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read56SignedWithOffset:`

Reads a 56-bit signed value.

- (long long)read56SignedWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 56-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read56SignedWithOffset:offsetPlus:`

Reads a 56-bit signed value.

- (long long)read56SignedWithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 56-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read56WithOffset:`

Reads a 56-bit value.

- (long long)read56WithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 56-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read56WithOffset:offsetPlus:`

Reads a 56-bit value.

- (long long)read56WithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 56-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read5SignedWithOffset:bitOffset:`

Reads a 5-bit signed value.

- (int)read5SignedWithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 5-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read5WithOffset:bitOffset:`

Reads a 5-bit value.

- (int)read5WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 5-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read64SignedWithOffset:`

Reads a 64-bit signed value.

- (long long)read64SignedWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 64-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read64SignedWithOffset:offsetPlus:`

Reads a 64-bit signed value.

- (long long)read64SignedWithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 64-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read64WithOffset:`

Reads a 64-bit value.

- (long long)read64WithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads a 64-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read64WithOffset:offsetPlus:`

Reads a 64-bit value.

- (long long)read64WithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads a 64-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read6SignedWithOffset:bitOffset:`

Reads a 6-bit signed value.

- (int)read6SignedWithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 6-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read6WithOffset:bitOffset:`

Reads a 6-bit value.

- (int)read6WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 6-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read7SignedWithOffset:bitOffset:`

Reads a 7-bit signed value.

- (int)read7SignedWithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 7-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read7WithOffset:bitOffset:`

Reads a 7-bit value.

- (int)read7WithOffset:(int)offset bitOffset:(int)bitOffset

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Reads a 7-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read8SignedWithOffset:`

Reads an 8-bit signed value.

- (int)read8SignedWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads an 8-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read8SignedWithOffset:offsetPlus:`

Reads an 8-bit signed value.

- (int)read8SignedWithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads an 8-bit signed value.

Declared In

FMIceLinkDataBuffer.h

`– read8WithOffset:`

Reads an 8-bit value.

- (int)read8WithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Reads an 8-bit value.

Declared In

FMIceLinkDataBuffer.h

`– read8WithOffset:offsetPlus:`

Reads an 8-bit value.

- (int)read8WithOffset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Reads an 8-bit value.

Declared In

FMIceLinkDataBuffer.h

`– readUtf8StringWithOffset:`

Read a UTF-8 string.

- (NSString *)readUtf8StringWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Read a UTF-8 string.

Declared In

FMIceLinkDataBuffer.h

`– readUtf8StringWithOffset:length:`

Reads a UTF-8 string.

- (NSString *)readUtf8StringWithOffset:(int)offset length:(int)length

Parameters

`offset`	The offset.
`length`	The length.

Discussion

Reads a UTF-8 string.

Declared In

FMIceLinkDataBuffer.h

`– resizeWithNewLength:`

Resizes this buffer to a new [length](#//api/name/length) with new [data](#//api/name/data) being inserted at the end.

- (void)resizeWithNewLength:(int)newLength

Parameters

`newLength`	The new length.

Discussion

Resizes this buffer to a new [length](#//api/name/length) with new [data](#//api/name/data) being inserted at the end.

Declared In

FMIceLinkDataBuffer.h

`– resizeWithNewLength:offset:`

Resizes this buffer to a new [length](#//api/name/length) with new [data](#//api/name/data) being inserted at a given offset.

- (void)resizeWithNewLength:(int)newLength offset:(int)offset

Parameters

`newLength`	The new length.
`offset`	The offset.

Discussion

Resizes this buffer to a new [length](#//api/name/length) with new [data](#//api/name/data) being inserted at a given offset.

Declared In

FMIceLinkDataBuffer.h

`– resizeWithNewLength:offset:setZero:`

Resizes this buffer to a new [length](#//api/name/length) with new [data](#//api/name/data) being inserted at a given offset.

- (void)resizeWithNewLength:(int)newLength offset:(int)offset setZero:(bool)setZero

Parameters

`newLength`	The new length.
`offset`	The offset.
`setZero`	Sets empty space to zero.

Discussion

Resizes this buffer to a new [length](#//api/name/length) with new [data](#//api/name/data) being inserted at a given offset.

Declared In

FMIceLinkDataBuffer.h

`– sequenceEqualsConstantTimeWithBuffer:`

Compares a [data](#//api/name/data) buffer for equality in constant time.

- (bool)sequenceEqualsConstantTimeWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

`buffer`	The buffer.

Return Value

true if the sequences are equal; otherwise, false.

Discussion

Compares a [data](#//api/name/data) buffer for equality in constant time.

Declared In

FMIceLinkDataBuffer.h

`– sequenceEqualsWithBuffer:`

Compares a [data](#//api/name/data) buffer for equality.

- (bool)sequenceEqualsWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

`buffer`	The data buffer.

Return Value

true if the sequences are equal; otherwise, false.

Discussion

Compares a [data](#//api/name/data) buffer for equality.

Declared In

FMIceLinkDataBuffer.h

`– set:`

Sets the [data](#//api/name/data) buffer to the specified value.

- (void)set:(uint8_t)value

Parameters

`value`	The value.

Discussion

Sets the [data](#//api/name/data) buffer to the specified value.

Declared In

FMIceLinkDataBuffer.h

`– set:offset:`

Sets a subset of the [data](#//api/name/data) buffer to the specified value.

- (void)set:(uint8_t)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Sets a subset of the [data](#//api/name/data) buffer to the specified value.

Declared In

FMIceLinkDataBuffer.h

`– set:offset:length:`

Sets a subset of the [data](#//api/name/data) buffer to the specified value.

- (void)set:(uint8_t)value offset:(int)offset length:(int)length

Parameters

`value`	The value.
`offset`	The offset.
`length`	The length.

Discussion

Sets a subset of the [data](#//api/name/data) buffer to the specified value.

Declared In

FMIceLinkDataBuffer.h

`– setIndex:`

Sets the [index](#//api/name/index).

- (void)setIndex:(int)value

Discussion

Sets the [index](#//api/name/index).

Declared In

FMIceLinkDataBuffer.h

`– setInnerData:`

Sets backing [data](#//api/name/data) buffer.

- (void)setInnerData:(NSMutableData *)value

Discussion

Sets backing [data](#//api/name/data) buffer.

Declared In

FMIceLinkDataBuffer.h

`– setLength:`

Sets the [length](#//api/name/length).

- (void)setLength:(int)value

Discussion

Sets the [length](#//api/name/length).

Declared In

FMIceLinkDataBuffer.h

`– setLittleEndian:`

Sets whether FMIceLinkDataBuffer#[data](#//api/name/data) is little-endian.

- (void)setLittleEndian:(bool)value

Discussion

Sets whether FMIceLinkDataBuffer#[data](#//api/name/data) is little-endian.

Declared In

FMIceLinkDataBuffer.h

`– subsetWithOffset:`

Gets a subset of this instance.

- (FMIceLinkDataBuffer *)subsetWithOffset:(int)offset

Parameters

`offset`	The offset.

Discussion

Gets a subset of this instance.

Declared In

FMIceLinkDataBuffer.h

`– subsetWithOffset:length:`

Gets a subset of this instance.

- (FMIceLinkDataBuffer *)subsetWithOffset:(int)offset length:(int)length

Parameters

`offset`	The offset.
`length`	The length.

Discussion

Gets a subset of this instance.

Declared In

FMIceLinkDataBuffer.h

`– toArray`

Converts this instance to an array of bytes.

- (NSMutableData *)toArray

Discussion

Converts this instance to an array of bytes.

Declared In

FMIceLinkDataBuffer.h

`– toHexString`

Converts this instance to a hexadecimal string.

- (NSString *)toHexString

Discussion

Converts this instance to a hexadecimal string.

Declared In

FMIceLinkDataBuffer.h

`– toJson`

Serializes this instance to JSON.

@return

- (NSString *)toJson

Discussion

Serializes this instance to JSON.

@return

Declared In

FMIceLinkDataBuffer.h

`+ toJsonArrayWithDataBuffers:`

Serializes an array of instances to JSON.

+ (NSString *)toJsonArrayWithDataBuffers:(NSMutableArray *)dataBuffers

Parameters

`dataBuffers`	The data buffers. @return

Discussion

Serializes an array of instances to JSON.

Declared In

FMIceLinkDataBuffer.h

`+ toJsonWithDataBuffer:`

Serializes an instance to JSON.

+ (NSString *)toJsonWithDataBuffer:(FMIceLinkDataBuffer *)dataBuffer

Parameters

`dataBuffer`	The data buffer. @return

Discussion

Serializes an instance to JSON.

Declared In

FMIceLinkDataBuffer.h

`– tryRead13WithOffset:bitOffset:value:`

Tries to read a 13-bit value;

- (bool)tryRead13WithOffset:(int)offset bitOffset:(int)bitOffset value:(int *)value

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.
`value`	The value.

Discussion

Tries to read a 13-bit value;

Declared In

FMIceLinkDataBuffer.h

`– tryRead16WithOffset:value:`

Tries to read a 16-bit value.

- (bool)tryRead16WithOffset:(int)offset value:(int *)value

Parameters

`offset`	The offset.
`value`	The value.

Discussion

Tries to read a 16-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead1WithOffset:bitOffset:value:`

Tries to read a 1-bit value.

- (bool)tryRead1WithOffset:(int)offset bitOffset:(int)bitOffset value:(bool *)value

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.
`value`	if set to true [value].

Discussion

Tries to read a 1-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead24WithOffset:value:`

Tries to read a 24-bit value.

- (bool)tryRead24WithOffset:(int)offset value:(int *)value

Parameters

`offset`	The offset.
`value`	The value.

Discussion

Tries to read a 24-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead2WithOffset:bitOffset:value:`

Tries to read a 2-bit value.

- (bool)tryRead2WithOffset:(int)offset bitOffset:(int)bitOffset value:(int *)value

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.
`value`	The value.

Discussion

Tries to read a 2-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead32WithOffset:value:`

Tries to read a 32-bit value.

- (bool)tryRead32WithOffset:(int)offset value:(long long *)value

Parameters

`offset`	The offset.
`value`	The value.

Discussion

Tries to read a 32-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead3WithOffset:bitOffset:value:`

Tries to read a 3-bit value.

- (bool)tryRead3WithOffset:(int)offset bitOffset:(int)bitOffset value:(int *)value

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.
`value`	The value.

Discussion

Tries to read a 3-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead40WithOffset:value:`

Tries to read a 40-bit value.

- (bool)tryRead40WithOffset:(int)offset value:(long long *)value

Parameters

`offset`	The offset.
`value`	The value.

Discussion

Tries to read a 40-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead48WithOffset:value:`

Tries to read a 48-bit value.

- (bool)tryRead48WithOffset:(int)offset value:(long long *)value

Parameters

`offset`	The offset.
`value`	The value.

Discussion

Tries to read a 48-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead4WithOffset:bitOffset:value:`

Tries to read a 4-bit value.

- (bool)tryRead4WithOffset:(int)offset bitOffset:(int)bitOffset value:(int *)value

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.
`value`	The value.

Discussion

Tries to read a 4-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead56WithOffset:value:`

Tries to read a 56-bit value.

- (bool)tryRead56WithOffset:(int)offset value:(long long *)value

Parameters

`offset`	The offset.
`value`	The value.

Discussion

Tries to read a 56-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead5WithOffset:bitOffset:value:`

Tries to read a 5-bit value.

- (bool)tryRead5WithOffset:(int)offset bitOffset:(int)bitOffset value:(int *)value

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.
`value`	The value.

Discussion

Tries to read a 5-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead64WithOffset:value:`

Tries to read a 64-bit value.

- (bool)tryRead64WithOffset:(int)offset value:(long long *)value

Parameters

`offset`	The offset.
`value`	The value.

Discussion

Tries to read a 64-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead6WithOffset:bitOffset:value:`

Tries to read a 6-bit value.

- (bool)tryRead6WithOffset:(int)offset bitOffset:(int)bitOffset value:(int *)value

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.
`value`	The value.

Discussion

Tries to read a 6-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead7WithOffset:bitOffset:value:`

Tries to read a 7-bit value.

- (bool)tryRead7WithOffset:(int)offset bitOffset:(int)bitOffset value:(int *)value

Parameters

`offset`	The offset.
`bitOffset`	The bit offset.
`value`	The value.

Discussion

Tries to read a 7-bit value.

Declared In

FMIceLinkDataBuffer.h

`– tryRead8WithOffset:value:`

Tries to read an 8-bit value.

- (bool)tryRead8WithOffset:(int)offset value:(int *)value

Parameters

`offset`	The offset.
`value`	The value.

Discussion

Tries to read an 8-bit value.

Declared In

FMIceLinkDataBuffer.h

`+ wrapWithData:`

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data) in big-endian format.

+ (FMIceLinkDataBuffer *)wrapWithData:(NSMutableData *)data

Parameters

`data`	The data.

Discussion

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data) in big-endian format.

Declared In

FMIceLinkDataBuffer.h

`+ wrapWithData:index:`

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data) in big-endian format.

+ (FMIceLinkDataBuffer *)wrapWithData:(NSMutableData *)data index:(int)index

Parameters

`data`	The data.
`index`	The index.

Discussion

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data) in big-endian format.

Declared In

FMIceLinkDataBuffer.h

`+ wrapWithData:index:length:`

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data) in big-endian format.

+ (FMIceLinkDataBuffer *)wrapWithData:(NSMutableData *)data index:(int)index length:(int)length

Parameters

`data`	The data.
`index`	The index.
`length`	The length.

Discussion

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data) in big-endian format.

Declared In

FMIceLinkDataBuffer.h

`+ wrapWithData:index:length:littleEndian:`

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data).

+ (FMIceLinkDataBuffer *)wrapWithData:(NSMutableData *)data index:(int)index length:(int)length littleEndian:(bool)littleEndian

Parameters

`data`	The data.
`index`	The index.
`length`	The length.
`littleEndian`	Whether the data is little-endian.

Discussion

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data).

Declared In

FMIceLinkDataBuffer.h

`+ wrapWithData:index:littleEndian:`

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data).

+ (FMIceLinkDataBuffer *)wrapWithData:(NSMutableData *)data index:(int)index littleEndian:(bool)littleEndian

Parameters

`data`	The data.
`index`	The index.
`littleEndian`	Whether the data is little-endian.

Discussion

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data).

Declared In

FMIceLinkDataBuffer.h

`+ wrapWithData:littleEndian:`

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data).

+ (FMIceLinkDataBuffer *)wrapWithData:(NSMutableData *)data littleEndian:(bool)littleEndian

Parameters

`data`	The data.
`littleEndian`	Whether the data is little-endian.

Discussion

Produces a new [data](#//api/name/data) buffer containing supplied [data](#//api/name/data).

Declared In

FMIceLinkDataBuffer.h

`– write1:offset:bitOffset:`

Writes a 1-bit value.

- (bool)write1:(bool)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes a 1-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write13:offset:bitOffset:`

Writes a 13-bit value.

- (bool)write13:(int)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes a 13-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write16:offset:`

Writes a 16-bit value.

- (bool)write16:(int)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Writes a 16-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write16:offset:offsetPlus:`

Writes a 16-bit value.

- (bool)write16:(int)value offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`value`	The value.
`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Writes a 16-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write18:offset:bitOffset:`

Writes an 18-bit value.

- (bool)write18:(int)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes an 18-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write2:offset:bitOffset:`

Writes a 2-bit value.

- (bool)write2:(int)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes a 2-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write24:offset:`

Writes a 24-bit value.

- (bool)write24:(int)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Writes a 24-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write24:offset:offsetPlus:`

Writes a 24-bit value.

- (bool)write24:(int)value offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`value`	The value.
`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Writes a 24-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write3:offset:bitOffset:`

Writes a 3-bit value.

- (bool)write3:(int)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes a 3-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write32:offset:`

Writes a 32-bit value.

- (bool)write32:(long long)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Writes a 32-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write32:offset:offsetPlus:`

Writes a 32-bit value.

- (bool)write32:(long long)value offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`value`	The value.
`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Writes a 32-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write4:offset:bitOffset:`

Writes a 4-bit value.

- (bool)write4:(int)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes a 4-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write40:offset:`

Writes a 40-bit value.

- (bool)write40:(long long)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Writes a 40-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write40:offset:offsetPlus:`

Writes a 40-bit value.

- (bool)write40:(long long)value offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`value`	The value.
`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Writes a 40-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write48:offset:`

Writes a 48-bit value.

- (bool)write48:(long long)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Writes a 48-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write48:offset:offsetPlus:`

Writes a 48-bit value.

- (bool)write48:(long long)value offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`value`	The value.
`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Writes a 48-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write5:offset:bitOffset:`

Writes a 5-bit value.

- (bool)write5:(int)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes a 5-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write56:offset:`

Writes a 56-bit value.

- (bool)write56:(long long)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Writes a 56-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write56:offset:offsetPlus:`

Writes a 56-bit value.

- (bool)write56:(long long)value offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`value`	The value.
`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Writes a 56-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write6:offset:bitOffset:`

Writes a 6-bit value.

- (bool)write6:(int)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes a 6-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write64:offset:`

Writes a 64-bit value.

- (bool)write64:(long long)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Writes a 64-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write64:offset:offsetPlus:`

Writes a 64-bit value.

- (bool)write64:(long long)value offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`value`	The value.
`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Writes a 64-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write7:offset:bitOffset:`

Writes a 7-bit value.

- (bool)write7:(int)value offset:(int)offset bitOffset:(int)bitOffset

Parameters

`value`	The value.
`offset`	The offset.
`bitOffset`	The bit offset.

Discussion

Writes a 7-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write8:offset:`

Writes an 8-bit value.

- (bool)write8:(int)value offset:(int)offset

Parameters

`value`	The value.
`offset`	The offset.

Discussion

Writes an 8-bit value.

Declared In

FMIceLinkDataBuffer.h

`– write8:offset:offsetPlus:`

Writes an 8-bit value.

- (bool)write8:(int)value offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

`value`	The value.
`offset`	The offset.
`offsetPlus`	The offset plus the value length.

Discussion

Writes an 8-bit value.