Unity Error Events and Cleaning (#84)

* Added errors event, cleaning

* Documentation for error events

* Bumped version to 1.0.0

* Documentation fixes

Author: 4thlabs

cmake/version.cmake

@@ -1,3 +1,3 @@
 set(CSSDK_MAJOR 1)
 set(CSSDK_MINOR 0)
-set(CSSDK_PATH 0-beta.1)
+set(CSSDK_PATH 0)

docs/documentation/unity/visualscripting.md

@@ -182,6 +182,22 @@ Emitted when the active audio device has [changed](xref:DolbyIO.Comms.Services.M
     <img style="padding:25px 0" src="~/images/nodes/event-audio-changed.png" width="250px">
 </div>
 
+### On Signaling Channel Error Event
+
+Emitted when an error occurs during a Session Initiation Protocol (SIP) negotiation of the local participant's peer connection.
+
+<div style="text-align:center">
+    <img style="padding:25px 0" src="~/images/nodes/event-signaling-error.png" width="250px">
+</div>
+
+### On Invalid Token Error Event
+
+Emitted when the access token is invalid or has expired.
+
+<div style="text-align:center">
+    <img style="padding:25px 0" src="~/images/nodes/event-token-error.png" width="250px">
+</div>
+
 ## Examples
 ### Joining a Conference
 

docs/images/nodes/event-signaling-error.png

@@ -94,6 +94,22 @@ private IEnumerator InitAndOpen(Flow flow)
                 }
             );
 
+            _sdk.InvalidTokenError = new InvalidTokenErrorEventHandler
+            (
+                (string reason, string description) => 
+                {
+                    DolbyIOManager.QueueOnMainThread(() => EventBus.Trigger(EventNames.InvalidTokenErrorEvent, $"${reason}: ${description}"));
+                }
+            );
+
+            _sdk.SignalingChannelError = new SignalingChannelErrorEventHandler
+            (
+                (string message) => 
+                {
+                    DolbyIOManager.QueueOnMainThread(() => EventBus.Trigger(EventNames.InvalidTokenErrorEvent, $"${message}"));
+                }
+            );
+
             var userInfo = new UserInfo();
             userInfo.Name = flow.GetValue<string>(ParticipantName);
 

docs/images/nodes/event-token-error.png

@@ -8,5 +8,7 @@ public static class EventNames
         public static string ActiveSpeakerChangeEvent = "ActiveSpeakerChangeEvent";
         public static string AudioDeviceChangedEvent = "AudioDeviceChangedEvent";
         public static string AudioDeviceAddedEvent = "AudioDeviceAddedEvent";
+        public static string InvalidTokenErrorEvent = "InvalidTokenErrorEvent";
+        public static string SignalingChannelErrorEvent = "SignalingChannelErrorEvent";
     }
 }

scripts/Units/DolbyIOUnit.cs

@@ -0,0 +1,37 @@
+using System.Collections;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using UnityEngine;
+using Unity.VisualScripting;
+using DolbyIO.Comms;
+
+namespace DolbyIO.Comms.Unity
+{
+    [UnitTitle("On Invalid Token Error Event")]
+    [UnitCategory("Events\\DolbyIO")]
+    public class InvalidTokenErrorEvent : EventUnit<string>
+    {
+        [DoNotSerialize]
+        public ValueOutput Message { get; private set; }
+        protected override bool register => true;
+
+        // Adding an EventHook with the name of the event to the list of visual scripting events.
+        public override EventHook GetHook(GraphReference reference)
+        {
+            return new EventHook(EventNames.InvalidTokenErrorEvent);
+        }
+
+        protected override void Definition()
+        {
+            base.Definition();
+            // Setting the value on our port.
+            Message = ValueOutput<string>(nameof(Message));
+        }
+        
+        // Setting the value on our port.
+        protected override void AssignArguments(Flow flow, string data)
+        {
+            flow.SetValue(Message, data);
+        }
+    }
+}

scripts/Units/EventNames.cs

@@ -27,28 +27,31 @@ private ControlOutput SetPosition(Flow flow)
         {
             var direction = flow.GetValue<Vector3>(Direction);
             var position = flow.GetValue<Vector3>(Postition);
-    
-            _sdk.Conference.SetSpatialPositionAsync
-            (
-                _sdk.Session.User.Id,
-                new System.Numerics.Vector3(position.x, position.y, position.z)
-            )
-            .ContinueWith(t =>
+
+            if (_sdk.IsInitialized && _sdk.Session.IsOpen && _sdk.Conference.IsInConference)
             {
-                if (t.IsFaulted)
+                _sdk.Conference.SetSpatialPositionAsync
+                (
+                    _sdk.Session.User.Id,
+                    new System.Numerics.Vector3(position.x, position.y, position.z)
+                )
+                .ContinueWith(t =>
                 {
-                    throw t.Exception;
-                }
+                    if (t.IsFaulted)
+                    {
+                        throw t.Exception;
+                    }
 
-                return _sdk.Conference.SetSpatialDirectionAsync
-                (
-                    new System.Numerics.Vector3(direction.x, direction.y, direction.z)
-                );
-            })
-            .ContinueWith(t =>
-            {
-                Debug.Log(t.Exception);
-            }, TaskContinuationOptions.OnlyOnFaulted);
+                    return _sdk.Conference.SetSpatialDirectionAsync
+                    (
+                        new System.Numerics.Vector3(direction.x, direction.y, direction.z)
+                    );
+                })
+                .ContinueWith(t =>
+                {
+                    Debug.Log(t.Exception);
+                }, TaskContinuationOptions.OnlyOnFaulted);
+            }
 
             return OutputTrigger;
         }

scripts/Units/InvalidTokenErrorEvent.cs

@@ -29,19 +29,20 @@ private ControlOutput SetPosition(Flow flow)
             var position = flow.GetValue<Vector3>(Postition);
             var p = flow.GetValue<Participant>(Participant);
 
-            Debug.Log(p.Id);
-
-            if (p.Id != _sdk.Session.User.Id)
+            if (_sdk.IsInitialized && _sdk.Session.IsOpen && _sdk.Conference.IsInConference)
             {
-                _sdk.Conference.SetSpatialPositionAsync
-                (
-                    p.Id,
-                    new System.Numerics.Vector3(position.x, position.y, position.z)
-                )
-                .ContinueWith(t =>
+                if (p.Id != _sdk.Session.User.Id)
                 {
-                    Debug.Log(t.Exception);
-                }, TaskContinuationOptions.OnlyOnFaulted);
+                    _sdk.Conference.SetSpatialPositionAsync
+                    (
+                        p.Id,
+                        new System.Numerics.Vector3(position.x, position.y, position.z)
+                    )
+                    .ContinueWith(t =>
+                    {
+                        Debug.Log(t.Exception);
+                    }, TaskContinuationOptions.OnlyOnFaulted);
+                }
             }
 
             return OutputTrigger;

scripts/Units/PlayerPositionUnit.cs

@@ -0,0 +1,37 @@
+using System.Collections;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using UnityEngine;
+using Unity.VisualScripting;
+using DolbyIO.Comms;
+
+namespace DolbyIO.Comms.Unity
+{
+    [UnitTitle("On Signaling Channel Error Event")]
+    [UnitCategory("Events\\DolbyIO")]
+    public class SignalingChannelErrorEvent : EventUnit<string>
+    {
+        [DoNotSerialize]
+        public ValueOutput Message { get; private set; }
+        protected override bool register => true;
+
+        // Adding an EventHook with the name of the event to the list of visual scripting events.
+        public override EventHook GetHook(GraphReference reference)
+        {
+            return new EventHook(EventNames.SignalingChannelErrorEvent);
+        }
+
+        protected override void Definition()
+        {
+            base.Definition();
+            // Setting the value on our port.
+            Message = ValueOutput<string>(nameof(Message));
+        }
+        
+        // Setting the value on our port.
+        protected override void AssignArguments(Flow flow, string data)
+        {
+            flow.SetValue(Message, data);
+        }
+    }
+}