read


Description:

public uint read (uint64 sample, uint8[] data, out ClockTime timestamp)

Read data.length samples from the ringbuffer into the memory pointed to by data.

The first sample should be read from position sample in the ringbuffer.

data.length should not be a multiple of the segment size of the ringbuffer although it is recommended.

timestamp will return the timestamp associated with the data returned.

Parameters:

this

the RingBuffer to read from

sample

the sample position of the data

data

where the data should be read

timestamp

where the timestamp is returned

len

the number of samples in data to read

Returns: