docs.unity3d.com
    Show / Hide Table of Contents

    Class SessionRecordingModule

    Module responsible for recording provider data during an MR session

    Inheritance
    Object
    SessionRecordingModule
    Namespace: Unity.MARS.Data.Recorded
    Syntax
    [MovedFrom("Unity.MARS")]
    public class SessionRecordingModule : IModule, IUsesFunctionalityInjection, IFunctionalitySubscriber<IProvidesFunctionalityInjection>, IFunctionalitySubscriber

    Properties

    IsRecording

    Declaration
    public bool IsRecording { get; }
    Property Value
    Type Description
    Boolean

    Methods

    CancelRecording()

    If recording, stops recording and discards recorded data

    Declaration
    public void CancelRecording()

    CreateDataRecordings(TimelineAsset, List<DataRecording>, List<Object>)

    Declaration
    public void CreateDataRecordings(TimelineAsset timeline, List<DataRecording> dataRecordings, List<Object> newAssets)
    Parameters
    Type Name Description
    TimelineAsset timeline
    List<DataRecording> dataRecordings
    List<Object> newAssets

    RegisterRecorderType<T>()

    Registers a type of data recorder to include in the next recording

    Declaration
    public void RegisterRecorderType<T>()
        where T : DataRecorder, new()
    Type Parameters
    Name Description
    T

    Type of data recorder to register

    ToggleRecording()

    If not recording, starts recording data based on registered recorder types. If recording, records any last data if needed and then stops recording data.

    Declaration
    public void ToggleRecording()

    Explicit Interface Implementations

    IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider

    Declaration
    IProvidesFunctionalityInjection IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider { get; set; }
    Returns
    Type Description
    IProvidesFunctionalityInjection
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IModule.LoadModule()

    Declaration
    void IModule.LoadModule()
    Implements
    IModule.LoadModule()

    IModule.UnloadModule()

    Declaration
    void IModule.UnloadModule()
    Implements
    IModule.UnloadModule()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023