fix: Make WebRTC.Update obsolete

Runtime/Scripts/Internal/UpdateCoroutine.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Collections;
+using UnityEngine;
+
+namespace Unity.WebRTC
+{
+    public class UpdateCoroutine : MonoBehaviour
+    {
+        Coroutine _coroutine;
+
+        public Func<IEnumerator> routine
+        {
+            set
+            {
+                if (_coroutine != null)
+                    StopCoroutine(_coroutine);
+                _coroutine = StartCoroutine(value());
+            }
+        }
+
+
+        void OnDestroy()
+        {
+            if (_coroutine != null)
+                StopCoroutine(_coroutine);
+        }
+    }
+}

Runtime/Scripts/WebRTC.cs

@@ -633,12 +633,21 @@ public static class WebRTC
         private static Context s_context = null;
         private static SynchronizationContext s_syncContext;
         private static ILogger s_logger;
+        private static GameObject s_obj;
 
         [RuntimeInitializeOnLoadMethod]
         static void RuntimeInitializeOnLoadMethod()
         {
             // Initialize a custom invokable synchronization context to wrap the main thread UnitySynchronizationContext
             s_syncContext = new ExecutableUnitySynchronizationContext(SynchronizationContext.Current);
+
+            // Instantiate GameObject for coroutine.
+            s_obj = new GameObject("webrtc");
+            s_obj.hideFlags = HideFlags.HideAndDontSave;
+            if (Application.isPlaying)
+                UnityEngine.Object.DontDestroyOnLoad(s_obj);
+            var comp = s_obj.AddComponent<UpdateCoroutine>();
+            comp.routine = UpdateInternal;
         }
 
         internal static void InitializeInternal(bool limitTextureSize = true, bool enableNativeLog = false,
@@ -666,10 +675,21 @@ internal static void InitializeInternal(bool limitTextureSize = true, bool enabl
         ///
         /// </summary>
         /// <returns></returns>
+        [Obsolete]
         public static IEnumerator Update()
         {
             var instruction = new WaitForEndOfFrame();
 
+            while (true)
+            {
+                yield return instruction;
+            }
+        }
+
+        public static IEnumerator UpdateInternal()
+        {
+            var instruction = new WaitForEndOfFrame();
+
             while (true)
             {
                 // Wait until all frame rendering is done
@@ -999,6 +1019,7 @@ static void DestroyImmediate(object state)
         {
             var obj = state as UnityEngine.Object;
             UnityEngine.Object.DestroyImmediate(obj);
+            obj = null;
         }
 
         static void Destroy(object state)

Samples~/Audio/AudioSample.cs

@@ -60,7 +60,6 @@ class AudioSample : MonoBehaviour
 
         void Start()
         {
-            StartCoroutine(WebRTC.Update());
             StartCoroutine(LoopStatsCoroutine());
 
             toggleEnableMicrophone.isOn = false;

Samples~/Bandwidth/BandwidthSample.cs

@@ -225,7 +225,6 @@ private void AddTracks()
 
         if (!videoUpdateStarted)
         {
-            StartCoroutine(WebRTC.Update());
             StartCoroutine(LoopStatsCoroutine());
             videoUpdateStarted = true;
         }

Samples~/ChangeCodecs/ChangeCodecsSample.cs

@@ -32,7 +32,6 @@ class ChangeCodecsSample : MonoBehaviour
     private DelegateOnIceCandidate pc2OnIceCandidate;
     private DelegateOnTrack pc2Ontrack;
     private DelegateOnNegotiationNeeded pc1OnNegotiationNeeded;
-    private bool videoUpdateStarted;
 
     private readonly string[] excludeCodecMimeType = { "video/red", "video/ulpfec", "video/rtx" };
     private RTCRtpCodecCapability[] availableCodecs;
@@ -166,12 +165,6 @@ private void AddTracks()
             pc1Senders.Add(_pc1.AddTrack(track, videoStream));
         }
 
-        if (!videoUpdateStarted)
-        {
-            StartCoroutine(WebRTC.Update());
-            videoUpdateStarted = true;
-        }
-
         RTCRtpCodecCapability[] codecs = null;
         if (codecSelector.value == 0)
         {

Samples~/E2ELatency/E2ELatencySample.cs

@@ -96,8 +96,6 @@ private void Start()
             receiveStream.AddTrack(e.Track);
         };
         pc1OnNegotiationNeeded = () => { StartCoroutine(PeerNegotiationNeeded(_pc1)); };
-
-        StartCoroutine(WebRTC.Update());
     }
 
     private void OnFramerateChanged(int value)

Samples~/Encryption/EncryptionSample.cs

@@ -34,7 +34,6 @@ class EncryptionSample : MonoBehaviour
     private DelegateOnIceCandidate pc2OnIceCandidate;
     private DelegateOnTrack pc2Ontrack;
     private DelegateOnNegotiationNeeded pc1OnNegotiationNeeded;
-    private bool videoUpdateStarted;
 
     Dictionary<RTCEncodedVideoFrameType, int> frameTypeToCryptoOffset;
 
@@ -408,12 +407,6 @@ private void AddTracks()
         {
             SetUpSenderTransform(sender);
         }
-
-        if (!videoUpdateStarted)
-        {
-            StartCoroutine(WebRTC.Update());
-            videoUpdateStarted = true;
-        }
     }
 
     private void RemoveTracks()

Samples~/MediaStream/MediaStreamSample.cs

@@ -30,7 +30,6 @@ class MediaStreamSample : MonoBehaviour
         private DelegateOnTrack pc2Ontrack;
         private DelegateOnNegotiationNeeded pc1OnNegotiationNeeded;
         private StringBuilder trackInfos;
-        private bool videoUpdateStarted;
 
         private void Awake()
         {
@@ -129,13 +128,6 @@ private void AddTracks()
                     }
                 }
             }
-
-            if (!videoUpdateStarted)
-            {
-                StartCoroutine(WebRTC.Update());
-                videoUpdateStarted = true;
-            }
-
             addTracksButton.interactable = false;
             removeTracksButton.interactable = true;
         }

Samples~/Metadata/MetadataSample.cs

@@ -34,7 +34,6 @@ class MetadataSample : MonoBehaviour
     private DelegateOnIceCandidate pc2OnIceCandidate;
     private DelegateOnTrack pc2Ontrack;
     private DelegateOnNegotiationNeeded pc1OnNegotiationNeeded;
-    private bool videoUpdateStarted;
 
     private readonly object metadataInputLock = new object();
     private readonly object metadataOutputLock = new object();
@@ -308,12 +307,6 @@ private void AddTracks()
         {
             SetUpSenderTransform(sender);
         }
-
-        if (!videoUpdateStarted)
-        {
-            StartCoroutine(WebRTC.Update());
-            videoUpdateStarted = true;
-        }
     }
 
     private void RemoveTracks()

Samples~/MultiAudioReceive/MultiAudioReceiveSample.cs

@@ -37,7 +37,6 @@ class MultiAudioReceiveSample : MonoBehaviour
 
         private void Awake()
         {
-            StartCoroutine(WebRTC.Update());
             callButton.onClick.AddListener(Call);
             hangUpButton.onClick.AddListener(HangUp);
             addAudioObjectButton.onClick.AddListener(AddVideoObject);

Samples~/MultiVideoReceive/MultiVideoReceiveSample.cs

@@ -34,7 +34,6 @@ class MultiVideoReceiveSample : MonoBehaviour
         private DelegateOnTrack pc2Ontrack;
         private DelegateOnNegotiationNeeded pc1OnNegotiationNeeded;
         private DelegateOnNegotiationNeeded pc2OnNegotiationNeeded;
-        private bool videoUpdateStarted;
         private int objectIndex = 0;
         private int videoIndex = 0;
 
@@ -194,12 +193,6 @@ private void Call()
             _pc2.OnIceConnectionChange = pc2OnIceConnectionChange;
             _pc2.OnTrack = pc2Ontrack;
             _pc2.OnNegotiationNeeded = pc2OnNegotiationNeeded;
-
-            if (!videoUpdateStarted)
-            {
-                StartCoroutine(WebRTC.Update());
-                videoUpdateStarted = true;
-            }
         }
 
         private void AddTracks()

Samples~/MultiplePeerConnections/MultiplePeerConnectionsSample.cs

@@ -32,8 +32,6 @@ class MultiplePeerConnectionsSample : MonoBehaviour
 
         private void Start()
         {
-            StartCoroutine(WebRTC.Update());
-
             startButton.onClick.AddListener(Setup);
             callButton.onClick.AddListener(Call);
             hangUpButton.onClick.AddListener(HangUp);

Samples~/MungeSDP/MungeSDPSample.cs

@@ -62,8 +62,6 @@ private void Setup()
 
         sourceVideoStream = cam.CaptureStream(WebRTCSettings.StreamSize.x, WebRTCSettings.StreamSize.y);
         sourceImage.texture = cam.targetTexture;
-        updateCoroutine = StartCoroutine(WebRTC.Update());
-
         receiveVideoStream = new MediaStream();
         receiveVideoStream.OnAddTrack = e =>
         {

Samples~/PeerConnection/PeerConnectionSample.cs

@@ -40,7 +40,6 @@ enum ProtocolOption
     private DelegateOnIceCandidate pc2OnIceCandidate;
     private DelegateOnTrack pc2Ontrack;
     private DelegateOnNegotiationNeeded pc1OnNegotiationNeeded;
-    private bool videoUpdateStarted;
 
     private void Awake()
     {
@@ -211,12 +210,6 @@ private void AddTracks()
                 }
             }
         }
-
-        if (!videoUpdateStarted)
-        {
-            StartCoroutine(WebRTC.Update());
-            videoUpdateStarted = true;
-        }
     }
 
     private void RemoveTracks()

Samples~/PerfectNegotiation/PerfectNegotiationSample.cs

@@ -65,8 +65,6 @@ private void Start()
             impolitePeer.SwapTransceivers();
             politePeer.SwapTransceivers();
         });
-
-        StartCoroutine(WebRTC.Update());
     }
 
     private void Update()

Samples~/ReplaceTrack/ReplaceTrackSample.cs

@@ -63,8 +63,6 @@ private void Start()
         stopButton.gameObject.SetActive(false);
         switchButton.onClick.AddListener(OnSwitchTrack);
         switchButton.interactable = false;
-
-        StartCoroutine(WebRTC.Update());
     }
 
     private void OnStart()

Samples~/Simulcast/SimulcastSample.cs

@@ -39,7 +39,6 @@ class SimulcastSample : MonoBehaviour
     private DelegateOnIceCandidate pc2OnIceCandidate;
     private DelegateOnTrack pc2Ontrack;
     private DelegateOnNegotiationNeeded pc1OnNegotiationNeeded;
-    private bool videoUpdateStarted;
 
     private ulong[] optionBitrate = new ulong[] { 100, 150, 200, 300, 400, 600, 800, 1100, 1400 };
     private int[] optionScaleResolution = new[] { 1, 2, 4, 8 };
@@ -202,12 +201,6 @@ private void AddTracks()
             transceiver.SetCodecPreferences(codecs);
         }
         _pc1Transceiver = transceiver;
-
-        if (!videoUpdateStarted)
-        {
-            StartCoroutine(WebRTC.Update());
-            videoUpdateStarted = true;
-        }
     }
 
     private void RemoveTracks()

Samples~/VideoReceive/VideoReceiveSample.cs

@@ -92,7 +92,6 @@ private void Start()
                 }
             };
             pc1OnNegotiationNeeded = () => { StartCoroutine(PeerNegotiationNeeded(_pc1)); };
-            StartCoroutine(WebRTC.Update());
         }
 
         private void Update()

Tests/Runtime/MediaStreamTest.cs

@@ -180,7 +180,6 @@ public IEnumerator SenderGetStats()
             var test = new MonoBehaviourTest<SignalingPeers>();
             test.component.AddStream(0, videoStream);
             yield return test;
-            test.component.CoroutineUpdate();
             yield return new WaitForSeconds(0.1f);
             var op = test.component.GetSenderStats(0, 0);
             yield return op;
@@ -225,7 +224,6 @@ public IEnumerator ReceiverGetStats()
             var test = new MonoBehaviourTest<SignalingPeers>();
             test.component.AddStream(0, videoStream);
             yield return test;
-            test.component.CoroutineUpdate();
             yield return new WaitForSeconds(0.1f);
             var op = test.component.GetReceiverStats(1, 0);
             yield return op;
@@ -268,7 +266,6 @@ public IEnumerator SetParametersReturnNoError()
             var test = new MonoBehaviourTest<SignalingPeers>();
             test.component.AddStream(0, videoStream);
             yield return test;
-            test.component.CoroutineUpdate();
             yield return new WaitForSeconds(0.1f);
 
             var senders = test.component.GetPeerSenders(0);
@@ -311,7 +308,6 @@ public IEnumerator SetParametersReturnErrorIfInvalidTextureResolution()
             var test = new MonoBehaviourTest<SignalingPeers>();
             test.component.AddStream(0, videoStream);
             yield return test;
-            test.component.CoroutineUpdate();
             yield return new WaitForSeconds(0.1f);
 
             var senders = test.component.GetPeerSenders(0);
@@ -360,7 +356,6 @@ public IEnumerator AddAndRemoveTrack()
             var test = new MonoBehaviourTest<SignalingPeers>();
             test.component.AddStream(0, stream1);
             yield return test;
-            test.component.CoroutineUpdate();
             yield return new WaitUntil(() => test.component.NegotiationCompleted());
 
             bool calledOnAddTrack = false;
@@ -398,7 +393,6 @@ public IEnumerator OnAddTrackDelegatesWithEvent()
             var test = new MonoBehaviourTest<SignalingPeers>();
             test.component.AddStream(0, videoStream);
             yield return test;
-            test.component.CoroutineUpdate();
             yield return new WaitForSeconds(0.1f);
 
             bool isCalledOnAddTrack = false;

Tests/Runtime/PeerConnectionTest.cs

@@ -1073,7 +1073,6 @@ public IEnumerator GetStatsReturnsReport()
             test.component.AddTransceiver(0, track1);
             test.component.AddTransceiver(1, track2);
             yield return test;
-            test.component.CoroutineUpdate();
 
             var op1 = test.component.GetSenderStats(0, 0);
             var op2 = test.component.GetReceiverStats(0, 0);

Tests/Runtime/SignalingPeers.cs

@@ -87,12 +87,6 @@ public IEnumerable<RTCRtpTransceiver> GetPeerTransceivers(int indexPeer)
             return peers[indexPeer].GetTransceivers();
         }
 
-
-        public Coroutine CoroutineUpdate()
-        {
-            return StartCoroutine(WebRTC.Update());
-        }
-
         void Awake()
         {
             RTCConfiguration config = default;