Class Connection

The base class for clients and servers used to communicate with external devices.

Inheritance

object

Object

ScriptableObject

Connection

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Unity.LiveCapture

Assembly: Unity.LiveCapture.dll

Syntax

public abstract class Connection : ScriptableObject

Remarks

You should instantiate connections using CreateConnection(Type, bool) to prevent creating duplicates. The ConnectionManager serializes connections to the Library folder of the project, so the connection configuration is stored locally for the user. The user manages connections via the Connections window.

Methods

GetName()

Gets the display name for this connection.

Declaration

public abstract string GetName()

Returns

Type	Description
string	A string containing the name of the connection.

IsEnabled()

Checks the connection state.

Declaration

public abstract bool IsEnabled()

Returns

Type	Description
bool	True if the connection is enabled.

OnChanged(bool)

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

Declaration

protected void OnChanged(bool save)

Parameters

Type	Name	Description
bool	save	Should the connection's serialized data be re-written to disk.

Remarks

This triggers a refresh of the connection GUI.

OnDestroy()

Called when the connection is destroyed.

Declaration

protected virtual void OnDestroy()

OnDisable()

Called when the connection is disabled.

Declaration

protected virtual void OnDisable()

OnEnable()

Called when the connection is created.

Declaration

protected virtual void OnEnable()

OnUpdate()

Unity calls this method regularly to update the connection.

Declaration

public virtual void OnUpdate()

OnValidate()

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

Declaration

protected virtual void OnValidate()

SetEnabled(bool)

Enables or disables the connection.

Declaration

public abstract void SetEnabled(bool enabled)

Parameters

Type	Name	Description
bool	enabled	The new connection state.