Deprecate publishOnly option (#310)

livekit · Jul 6, 2022 · 40a51f5 · 40a51f5
1 parent 5b1c5a0
commit 40a51f5
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/.changeset/spotty-dragons-push.md b/.changeset/spotty-dragons-push.md
@@ -0,0 +1,5 @@
+---
+'livekit-client': minor
+---
+
+Deprecate publishOnly connect option
diff --git a/example/index.html b/example/index.html
@@ -56,10 +56,6 @@ <h2>Livekit Sample App</h2>
               <input type="checkbox" class="form-check-input" id="force-turn" />
               <label for="force-turn" class="form-check-label"> Force TURN </label>
             </div>
-            <div>
-              <input type="checkbox" class="form-check-input" id="publish-only" />
-              <label for="publish-only" class="form-check-label"> PublishOnly </label>
-            </div>
             <div>
               <select id="preferred-codec" class="custom-select" style="width: auto">
                 <option value="" selected>PreferredCodec</option>

diff --git a/example/sample.ts b/example/sample.ts
@@ -57,7 +57,6 @@ const appActions = {
     const dynacast = (<HTMLInputElement>$('dynacast')).checked;
     const forceTURN = (<HTMLInputElement>$('force-turn')).checked;
     const adaptiveStream = (<HTMLInputElement>$('adaptive-stream')).checked;
-    const publishOnly = (<HTMLInputElement>$('publish-only')).checked;
     const shouldPublish = (<HTMLInputElement>$('publish-option')).checked;
     const preferredCodec = (<HTMLSelectElement>$('preferred-codec')).value as VideoCodec;
 
@@ -78,8 +77,7 @@ const appActions = {
     };
 
     const connectOpts: RoomConnectOptions = {
-      autoSubscribe: !publishOnly,
-      publishOnly: publishOnly ? 'publish_only' : undefined,
+      autoSubscribe: true,
     };
     if (forceTURN) {
       connectOpts.rtcConfig = {

diff --git a/src/api/SignalClient.ts b/src/api/SignalClient.ts
@@ -37,6 +37,7 @@ interface ConnectOpts {
   /** internal */
   reconnect?: boolean;
 
+  /** @deprecated */
   publishOnly?: string;
 
   adaptiveStream?: boolean;
@@ -45,6 +46,7 @@ interface ConnectOpts {
 // public options
 export interface SignalOptions {
   autoSubscribe?: boolean;
+  /** @deprecated */
   publishOnly?: string;
   adaptiveStream?: boolean;
 }

diff --git a/src/options.ts b/src/options.ts
@@ -68,6 +68,7 @@ export interface RoomConnectOptions {
   rtcConfig?: RTCConfiguration;
 
   /**
+   * @deprecated
    * publish only mode
    */
   publishOnly?: string;