docs.unity3d.com
    Show / Hide Table of Contents

    Class Server

    The base class for servers that can be managed in the Live Capture window.

    Inheritance
    Object
    Server
    Namespace: Unity.LiveCapture
    Syntax
    public abstract class Server : ScriptableObject
    Remarks

    Servers are instantiated using the ServerManager, which will serializes servers to the Library folder.

    Methods

    GetName()

    Gets the display name for this server.

    Declaration
    public abstract string GetName()
    Returns
    Type Description
    String

    A string containing the name of the server.

    OnDisable()

    Called when the server is being destroyed.

    Declaration
    protected virtual void OnDisable()

    OnEnable()

    Called when the server is created.

    Declaration
    protected virtual void OnEnable()

    OnServerChanged(Boolean)

    Call this when the server's state or serialized data has been modified.

    Declaration
    protected void OnServerChanged(bool save)
    Parameters
    Type Name Description
    Boolean save

    Should the server's serialized data be re-written to disk.

    Remarks

    This triggers a refresh of the server GUI.

    OnUpdate()

    The method which is called regularly to update the server.

    Declaration
    public virtual void OnUpdate()

    OnValidate()

    Called when the server's serialized fields have been changed from the inspector.

    Declaration
    protected virtual void OnValidate()
    Back to top
    Terms of use
    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