docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class InputRemoting

    Makes the activity and data of an InputManager observable in message form.

    Inheritance
    object
    InputRemoting
    Implements
    IObservable<InputRemoting.Message>
    IObserver<InputRemoting.Message>
    Namespace: UnityEngine.InputSystem
    Assembly: Unity.InputSystem.dll
    Syntax
    public sealed class InputRemoting : IObservable<InputRemoting.Message>, IObserver<InputRemoting.Message>
    Remarks

    Can act as both the sender and receiver of these message so the flow is fully bidirectional, i.e. the InputManager on either end can mirror its layouts, devices, and events over to the other end. This permits streaming input not just from the player to the editor but also feeding input from the editor back into the player.

    Remoting sits entirely on top of the input system as an optional piece of functionality. In development players and the editor, we enable it automatically but in non-development players it has to be explicitly requested by the user.

    To see devices and input from players in the editor, open the Input Debugger through "Windows >> Input Debugger".

    Properties

    sending

    Declaration
    public bool sending { get; }
    Property Value
    Type Description
    bool
    See Also
    remoting

    Methods

    RemoveRemoteDevices(int)

    Declaration
    public void RemoveRemoteDevices(int participantId)
    Parameters
    Type Name Description
    int participantId
    See Also
    remoting

    StartSending()

    Start sending messages for data and activity in the local input system to observers.

    Declaration
    public void StartSending()
    See Also
    sending
    StopSending()

    StopSending()

    Declaration
    public void StopSending()
    See Also
    remoting

    Subscribe(IObserver<Message>)

    Declaration
    public IDisposable Subscribe(IObserver<InputRemoting.Message> observer)
    Parameters
    Type Name Description
    IObserver<InputRemoting.Message> observer
    Returns
    Type Description
    IDisposable
    See Also
    remoting

    Implements

    IObservable<T>
    IObserver<T>

    Extension Methods

    Observable.CallOnce<TValue>(IObservable<TValue>, Action<TValue>)
    Observable.CallOnce<TValue>(IObservable<TValue>, Action<TValue>)
    Observable.Call<TValue>(IObservable<TValue>, Action<TValue>)
    Observable.Call<TValue>(IObservable<TValue>, Action<TValue>)
    Observable.SelectMany<TSource, TResult>(IObservable<TSource>, Func<TSource, IEnumerable<TResult>>)
    Observable.SelectMany<TSource, TResult>(IObservable<TSource>, Func<TSource, IEnumerable<TResult>>)
    Observable.Select<TSource, TResult>(IObservable<TSource>, Func<TSource, TResult>)
    Observable.Select<TSource, TResult>(IObservable<TSource>, Func<TSource, TResult>)
    Observable.Take<TValue>(IObservable<TValue>, int)
    Observable.Take<TValue>(IObservable<TValue>, int)
    Observable.Where<TValue>(IObservable<TValue>, Func<TValue, bool>)
    Observable.Where<TValue>(IObservable<TValue>, Func<TValue, bool>)

    See Also

    remoting

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Properties
      • sending
    • Methods
      • RemoveRemoteDevices(int)
      • StartSending()
      • StopSending()
      • Subscribe(IObserver<Message>)
    • Implements
    • Extension Methods
    • See Also
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)