docs.unity3d.com
    Show / Hide Table of Contents

    Class NtpTimecodeSource

    A component that gets timecode from an network time protocol (NTP) server.

    Inheritance
    Object
    NtpTimecodeSource
    Namespace: Unity.LiveCapture.Ntp
    Syntax
    public class NtpTimecodeSource : MonoBehaviour, ITimecodeSource, IRegistrable

    Properties

    FrameRate

    The rate at which timecodes are generated.

    Declaration
    public FrameRate FrameRate { get; }
    Property Value
    Type Description
    FrameRate
    Implements
    ITimecodeSource.FrameRate

    FriendlyName

    Get a human-readable name for the instance.

    Declaration
    public string FriendlyName { get; }
    Property Value
    Type Description
    String
    Implements
    IRegistrable.FriendlyName

    Id

    Get the unique identifier for this instance.

    Declaration
    public string Id { get; }
    Property Value
    Type Description
    String
    Implements
    IRegistrable.Id
    Remarks

    The ID should not be null or empty, and is expected to remain constant for the life of the instance.

    Now

    The latest timecode available at the source.

    Declaration
    public Timecode Now { get; }
    Property Value
    Type Description
    Timecode
    Implements
    ITimecodeSource.Now

    Methods

    ForceUpdate()

    Queries the NTP server to resynchronize the time with the server clock.

    Declaration
    public void ForceUpdate()
    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