add force relay configuration (#414)

* add force relay configuration * proto version
livekit · Aug 25, 2022 · 6b748da · 6b748da
1 parent 1f33f80
commit 6b748da
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 1 deletion.
diff --git a/.changeset/empty-gorillas-battle.md b/.changeset/empty-gorillas-battle.md
@@ -0,0 +1,5 @@
+---
+'livekit-client': patch
+---
+
+add force relay configuration
diff --git a/src/proto/livekit_models.ts b/src/proto/livekit_models.ts
@@ -623,6 +623,7 @@ export interface ClientConfiguration {
  screen?: VideoConfiguration;
  resumeConnection: ClientConfigSetting;
  disabledCodecs?: DisabledCodecs;
+ forceRelay: ClientConfigSetting;
 }
 
 export interface VideoConfiguration {
@@ -2094,7 +2095,13 @@ export const ClientInfo = {
 };
 
 function createBaseClientConfiguration(): ClientConfiguration {
- return { video: undefined, screen: undefined, resumeConnection: 0, disabledCodecs: undefined };
+ return {
+ video: undefined,
+ screen: undefined,
+ resumeConnection: 0,
+ disabledCodecs: undefined,
+ forceRelay: 0,
+ };
 }
 
 export const ClientConfiguration = {
@@ -2111,6 +2118,9 @@ export const ClientConfiguration = {
  if (message.disabledCodecs !== undefined) {
  DisabledCodecs.encode(message.disabledCodecs, writer.uint32(34).fork()).ldelim();
  }
+ if (message.forceRelay !== 0) {
+ writer.uint32(40).int32(message.forceRelay);
+ }
  return writer;
  },
 
@@ -2133,6 +2143,9 @@ export const ClientConfiguration = {
  case 4:
  message.disabledCodecs = DisabledCodecs.decode(reader, reader.uint32());
  break;
+ case 5:
+ message.forceRelay = reader.int32() as any;
+ break;
  default:
  reader.skipType(tag & 7);
  break;
@@ -2151,6 +2164,7 @@ export const ClientConfiguration = {
  disabledCodecs: isSet(object.disabledCodecs)
  ? DisabledCodecs.fromJSON(object.disabledCodecs)
  : undefined,
+ forceRelay: isSet(object.forceRelay) ? clientConfigSettingFromJSON(object.forceRelay) : 0,
  };
  },
 
@@ -2166,6 +2180,8 @@ export const ClientConfiguration = {
  (obj.disabledCodecs = message.disabledCodecs
  ? DisabledCodecs.toJSON(message.disabledCodecs)
  : undefined);
+ message.forceRelay !== undefined &&
+ (obj.forceRelay = clientConfigSettingToJSON(message.forceRelay));
  return obj;
  },
 
@@ -2186,6 +2202,7 @@ export const ClientConfiguration = {
  object.disabledCodecs !== undefined && object.disabledCodecs !== null
  ? DisabledCodecs.fromPartial(object.disabledCodecs)
  : undefined;
+ message.forceRelay = object.forceRelay ?? 0;
  return message;
  },
 };

diff --git a/src/proto/livekit_rtc.ts b/src/proto/livekit_rtc.ts
@@ -98,6 +98,7 @@ export function streamStateToJSON(object: StreamState): string {
 export enum CandidateProtocol {
  UDP = 0,
  TCP = 1,
+ TLS = 2,
  UNRECOGNIZED = -1,
 }
 
@@ -109,6 +110,9 @@ export function candidateProtocolFromJSON(object: any): CandidateProtocol {
  case 1:
  case 'TCP':
  return CandidateProtocol.TCP;
+ case 2:
+ case 'TLS':
+ return CandidateProtocol.TLS;
  case -1:
  case 'UNRECOGNIZED':
  default:
@@ -122,6 +126,8 @@ export function candidateProtocolToJSON(object: CandidateProtocol): string {
  return 'UDP';
  case CandidateProtocol.TCP:
  return 'TCP';
+ case CandidateProtocol.TLS:
+ return 'TLS';
  case CandidateProtocol.UNRECOGNIZED:
  default:
  return 'UNRECOGNIZED';

diff --git a/src/room/RTCEngine.ts b/src/room/RTCEngine.ts
@@ -242,6 +242,13 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
  this.rtcConfig.iceServers = rtcIceServers;
  }
 
+ if (
+ joinResponse.clientConfiguration &&
+ joinResponse.clientConfiguration.forceRelay === ClientConfigSetting.ENABLED
+ ) {
+ this.rtcConfig.iceTransportPolicy = 'relay';
+ }
+
  // @ts-ignore
  this.rtcConfig.sdpSemantics = 'unified-plan';
  // @ts-ignore