class MAGES::Recorder::Container¶

Overview¶

A wrapper around an XREC file. More…

class Container: public UnityEngine.Object
{
public:
    // methods

    Container(string filePath, FileAccess access);

    IntervalTree BuildOffsetMap(
        out StartPacket start,
        out EndPacket end
    );

    void Reset();
    void Seek(long offset);
    void Close();
    void Write(Packet packet);
    bool Read(out Packet packet);
};

Detailed Documentation¶

A wrapper around an XREC file.

Used for streaming into and out of.

Methods¶

Container(string filePath, FileAccess access)

Initializes a new instance of the Container class.

Parameters:

filePath	The path of the file.
access	The access mode.
ArgumentException	Thrown when parameters are invalid.

IntervalTree BuildOffsetMap(
    out StartPacket start,
    out EndPacket end
)

Build a map of packet offsets in the stream.

Parameters:

start	The start packet.
end	The end packet.

Returns:

A mapping of time ranges into packet offsets.

void Reset()

Reset the stream to the beginning.

void Seek(long offset)

Seek to a specific offset in the stream.

Parameters:

offset	The offset (in bytes).

void Close()

Close the stream.

void Write(Packet packet)

Write a packet to the stream.

Parameters:

packet	The packet to write.
InvalidOperationException	Thrown when the stream is read-only.

bool Read(out Packet packet)

Read a packet from the stream.

Parameters:

packet	The packet.

Returns:

True if the packet was successfully read.