Class InputReceiver

Represents a separate player in the game complete with a set of actions exclusive to the player and a set of paired device. It is the simple version of UnityEngine.InputSystem.PlayerInput that removing dependency of InputControlScheme.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
DataChannelBase
InputChannelReceiverBase
InputReceiver
Inherited Members
UnityEngine.Component.GetComponentInParent(System.Type, System.Boolean)
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindFirstObjectByType(System.Type)
UnityEngine.Object.FindAnyObjectByType(System.Type)
UnityEngine.Object.FindFirstObjectByType(System.Type, UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType(System.Type, UnityEngine.FindObjectsInactive)
Namespace: Unity.RenderStreaming
Syntax
[AddComponentMenu("Render Streaming/Input Receiver")]
public class InputReceiver : InputChannelReceiverBase, IDataChannel

Properties

actionEvents

Declaration
public ReadOnlyArray<PlayerInput.ActionEvent> actionEvents { get; set; }
Property Value
Type Description
ReadOnlyArray<PlayerInput.ActionEvent>

actions

Declaration
public InputActionAsset actions { get; set; }
Property Value
Type Description
InputActionAsset

currentActionMap

Declaration
public InputActionMap currentActionMap { get; set; }
Property Value
Type Description
InputActionMap

defaultActionMap

Declaration
public string defaultActionMap { get; set; }
Property Value
Type Description
String

devices

Declaration
public ReadOnlyArray<InputDevice> devices { get; }
Property Value
Type Description
ReadOnlyArray<InputDevice>

inputIsActive

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

user

Declaration
public InputUser user { get; }
Property Value
Type Description
InputUser

Methods

ActivateInput()

Declaration
public void ActivateInput()

CalculateInputRegion(Vector2Int, Rect)

Declaration
public void CalculateInputRegion(Vector2Int size, Rect region)
Parameters
Type Name Description
Vector2Int size

Texture Size.
Rect region

Region of the texture in world coordinate system.

DeactivateInput()

Declaration
public void DeactivateInput()

Dispose()

Declaration
protected virtual void Dispose()

OnDestroy()

Declaration
protected virtual void OnDestroy()

OnDeviceChange(InputDevice, InputDeviceChange)

Declaration
protected virtual void OnDeviceChange(InputDevice device, InputDeviceChange change)
Parameters
Type Name Description
InputDevice device
InputDeviceChange change

OnDisable()

Declaration
protected virtual void OnDisable()

OnEnable()

Declaration
protected virtual void OnEnable()

PerformPairingWithAllLocalDevices()

Declaration
public void PerformPairingWithAllLocalDevices()

PerformPairingWithDevice(InputDevice)

Declaration
public void PerformPairingWithDevice(InputDevice device)
Parameters
Type Name Description
InputDevice device

SetChannel(String, RTCDataChannel)

Declaration
public override void SetChannel(string connectionId, RTCDataChannel channel)
Parameters
Type Name Description
String connectionId
RTCDataChannel channel
Overrides

SetEnableInputPositionCorrection(Boolean)

Declaration
public void SetEnableInputPositionCorrection(bool enabled)
Parameters
Type Name Description
Boolean enabled

SwitchCurrentActionMap(String)

Declaration
public void SwitchCurrentActionMap(string mapNameOrId)
Parameters
Type Name Description
String mapNameOrId

UnpairDevices(InputDevice)

Declaration
public void UnpairDevices(InputDevice device)
Parameters
Type Name Description
InputDevice device

Events

onDeviceChange

Declaration
public override event Action<InputDevice, InputDeviceChange> onDeviceChange
Event Type
Type Description
Action<InputDevice, InputDeviceChange>
Overrides