Show / Hide Table of Contents

Interface IRecording

Outline of what data get's serialized when put into RAP format. Each recording can contain multiple sub-recordings, equating to a tree-like structure.

Namespace: Recolude.Core
Assembly: Recolude.Core.dll
Syntax
public interface IRecording

Properties

Binaries

Binaries associated with the recording.

Declaration
IBinary[] Binaries { get; }
Property Value
Type Description
IBinary[]

Binaries associated with the recording.

BinaryReferences

References to different binaries associated with the recording.

Declaration
BinaryReference[] BinaryReferences { get; }
Property Value
Type Description
BinaryReference[]

References to different binaries associated with the recording.

CaptureCollections

All capture data for this specific recording. It does not include sub-recording capture data.

Declaration
ICaptureCollection<ICapture>[] CaptureCollections { get; }
Property Value
Type Description
ICaptureCollection<ICapture>[]

All capture data for this specific recording.

Duration

Helper method short hand for EndTime - StartTime; If there are no captures within the recording or sub recordings, the duration is 0.

Declaration
float Duration { get; }
Property Value
Type Description
System.Single

Duration of the recording.

EndTime

The time of the latest capture found within all capture collections within this recording and all sub recordings. If there is no capture data within the recording and all sub recordings, the value should be NaN.

Declaration
float EndTime { get; }
Property Value
Type Description
System.Single

End time of the recording.

ID

ID of the recording. Developers should strive to ensuring this value remains unique and not-null

Declaration
string ID { get; }
Property Value
Type Description
System.String

ID of the recording.

Metadata

Metadata associated with the recording.

Declaration
Metadata Metadata { get; }
Property Value
Type Description
Metadata

Metadata associated with the recording.

Name

Name of the recording. Developers shuold strive to ensure this value is never null;

Declaration
string Name { get; }
Property Value
Type Description
System.String

Name of the recording.

Recordings

All immediate child recordings.

Declaration
IRecording[] Recordings { get; }
Property Value
Type Description
IRecording[]

All immediate child recordings.

StartTime

The time of the earliest capture found within all capture collections within this recording and all sub recordings. If there is no capture data within the recording and all sub recordings, the value should be NaN.

Declaration
float StartTime { get; }
Property Value
Type Description
System.Single

Start time of the recording.

Extension Methods

IRecordingExtensions.GetCollection<T>(IRecording)
IRecordingExtensions.GetCollection<T>(IRecording, String)
IRecordingExtensions.PositionCollection(IRecording)
IRecordingExtensions.RotationCollection(IRecording)
IRecordingExtensions.CustomEventCollection(IRecording)
IRecordingExtensions.LifeCycleCollection(IRecording)
RecordingCollectionExtensions.ToCSV(IRecording)
Back to top Generated by DocFX