FMIceLinkMatroskaElement Class Reference

Inherits from NSObject
Declared in FMIceLinkMatroskaElement.h
FMIceLinkMatroskaElement.m

Overview

A Matroska element.

+ compareWithBytes1:bytes2:

Compares two byte arrays for equality.
+ (bool)compareWithBytes1:(NSMutableData *)bytes1 bytes2:(NSMutableData *)bytes2

Parameters

bytes1

The first byte array.

bytes2

The second byte array.

Discussion

Compares two byte arrays for equality.

Declared In

FMIceLinkMatroskaElement.h

– getBytes

Serializes to a byte array.
- (NSMutableData *)getBytes

Discussion

Serializes to a byte array.

Declared In

FMIceLinkMatroskaElement.h

– getInnerBytes

Gets the inner bytes.
- (NSMutableData *)getInnerBytes

Discussion

Gets the inner bytes.

Declared In

FMIceLinkMatroskaElement.h

– id

Gets the EBML ID.
- (NSMutableData *)id

Discussion

Gets the EBML ID.

Declared In

FMIceLinkMatroskaElement.h

– length

Gets the total length of the element (including ID/[size](#//api/name/size) field), set after calling FMIceLinkMatroskaElement#[getBytes](#//api/name/getBytes).
- (int)length

Discussion

Gets the total length of the element (including ID/[size](#//api/name/size) field), set after calling FMIceLinkMatroskaElement#[getBytes](#//api/name/getBytes).

Declared In

FMIceLinkMatroskaElement.h

+ readBool:

Reads a boolean element from the stream.
+ (bool)readBool:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads a boolean element from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readDate:

Reads a date string element from the stream.
+ (NSDate *)readDate:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads a date string element from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readDouble:

Reads a double element from the stream.
+ (double)readDouble:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads a double element from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readFloat:

Reads a float element from the stream.
+ (float)readFloat:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads a float element from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readGuid:

Reads a GUID element from the stream.
+ (FMIceLinkGuid *)readGuid:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads a GUID element from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readIdWithBytes:offset:offsetPlus:

Reads a binary ID from the stream.
+ (NSMutableData *)readIdWithBytes:(NSMutableData *)bytes offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

bytes

The byte array.

offset

The offset into the byte array.

offsetPlus

The offset plus the amount read.

Discussion

Reads a binary ID from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readSignedInteger:

Reads a signed integer element from the byte array.
+ (long long)readSignedInteger:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads a signed integer element from the byte array.

Declared In

FMIceLinkMatroskaElement.h

+ readString:

Reads an ASCII string element from the stream.
+ (NSString *)readString:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads an ASCII string element from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readUnsignedInteger:

Reads an unsigned integer element from the byte array.
+ (long long)readUnsignedInteger:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads an unsigned integer element from the byte array.

Declared In

FMIceLinkMatroskaElement.h

+ readUtf8:

Reads a UTF-8 string element from the stream.
+ (NSString *)readUtf8:(NSMutableData *)value

Parameters

value

The value.

Discussion

Reads a UTF-8 string element from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readValueWithBytes:offset:offsetPlus:

Reads a binary value from the stream.
+ (NSMutableData *)readValueWithBytes:(NSMutableData *)bytes offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

bytes

The byte array.

offset

The offset into the byte array.

offsetPlus

The offset plus the amount read.

Discussion

Reads a binary value from the stream.

Declared In

FMIceLinkMatroskaElement.h

+ readVariableIntegerWithBytes:offset:offsetPlus:

Reads a variable integer ("vint") from the byte array.
+ (long long)readVariableIntegerWithBytes:(NSMutableData *)bytes offset:(int)offset offsetPlus:(int *)offsetPlus

Parameters

bytes

The byte array.

offset

The offset into the byte array.

offsetPlus

The offset plus the amount read.

Discussion

Reads a variable integer ("vint") from the byte array.

Declared In

FMIceLinkMatroskaElement.h

+ serializeVariableInteger:

Serializes a variable integer.
+ (NSMutableData *)serializeVariableInteger:(long long)value

Parameters

value

The value.

Discussion

Serializes a variable integer.

Declared In

FMIceLinkMatroskaElement.h

+ serializeVariableInteger:length:

Serializes a variable integer using a fixed [length](#//api/name/length).
+ (NSMutableData *)serializeVariableInteger:(long long)value length:(int)length

Parameters

value

The value.

length

The length to use.

Discussion

Serializes a variable integer using a fixed [length](#//api/name/length).

Declared In

FMIceLinkMatroskaElement.h

– setSizeLength:

Sets the [length](#//api/name/length) of the [size](#//api/name/size) field, in bytes. Defaults to zero (variable [size](#//api/name/size)).
- (void)setSizeLength:(int)value

Discussion

Sets the [length](#//api/name/length) of the [size](#//api/name/size) field, in bytes. Defaults to zero (variable [size](#//api/name/size)).

Declared In

FMIceLinkMatroskaElement.h

– setWriteDefaultValues:

Sets whether to include default values when serializing.
- (void)setWriteDefaultValues:(bool)value

Discussion

Sets whether to include default values when serializing.

Declared In

FMIceLinkMatroskaElement.h

– size

Gets the size of the element (excluding ID/size field), set after calling FMIceLinkMatroskaElement#[getBytes](#//api/name/getBytes).
- (int)size

Discussion

Gets the size of the element (excluding ID/size field), set after calling FMIceLinkMatroskaElement#[getBytes](#//api/name/getBytes).

Declared In

FMIceLinkMatroskaElement.h

– sizeLength

Gets the [length](#//api/name/length) of the [size](#//api/name/size) field, in bytes. Defaults to zero (variable [size](#//api/name/size)).
- (int)sizeLength

Discussion

Gets the [length](#//api/name/length) of the [size](#//api/name/size) field, in bytes. Defaults to zero (variable [size](#//api/name/size)).

Declared In

FMIceLinkMatroskaElement.h

– write:id:stream:

Writes a binary element to the stream.
- (void)write:(NSMutableData *)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes a binary element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeBool:id:stream:

Writes a boolean element to the stream.
- (void)writeBool:(bool)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes a boolean element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeDate:id:stream:

Writes a date element to the stream.
- (void)writeDate:(NSDate *)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes a date element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeDefaultValues

Gets whether to include default values when serializing.
- (bool)writeDefaultValues

Discussion

Gets whether to include default values when serializing.

Declared In

FMIceLinkMatroskaElement.h

– writeDouble:id:stream:

Writes a double element to the stream.
- (void)writeDouble:(double)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes a double element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeFloat:id:stream:

Writes a float element to the stream.
- (void)writeFloat:(float)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes a float element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeGuid:id:stream:

Writes a GUID element to the stream.
- (void)writeGuid:(FMIceLinkGuid *)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes a GUID element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeSignedInteger:id:stream:

Writes an signed integer element to the stream.
- (void)writeSignedInteger:(long long)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes an signed integer element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeString:id:stream:

Writes an ASCII string element to the stream.
- (void)writeString:(NSString *)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes an ASCII string element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeUnsignedInteger:id:stream:

Writes an unsigned integer element to the stream.
- (void)writeUnsignedInteger:(long long)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes an unsigned integer element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeUtf8:id:stream:

Writes a UTF-8 string element to the stream.
- (void)writeUtf8:(NSString *)value id:(NSMutableData *)idValue stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

idValue

The ID of the value.

stream

The stream to write.

Discussion

Writes a UTF-8 string element to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeVariableInteger:stream:

Writes a variable integer ("vint") to the stream.
- (void)writeVariableInteger:(long long)value stream:(FMIceLinkByteOutputStream *)stream

Parameters

value

The value to write.

stream

The stream to write.

Discussion

Writes a variable integer ("vint") to the stream.

Declared In

FMIceLinkMatroskaElement.h

– writeVariableInteger:stream:length:

Writes a variable integer ("vint") to the stream using a fixed [length](#//api/name/length).
- (void)writeVariableInteger:(long long)value stream:(FMIceLinkByteOutputStream *)stream length:(int)length

Parameters

value

The value to write.

stream

The stream to write.

length

The length to use.

Discussion

Writes a variable integer ("vint") to the stream using a fixed [length](#//api/name/length).

Declared In

FMIceLinkMatroskaElement.h