@livedigital/client 3.57.0-lk-5354-api-reference.2 → 3.57.0-release-preferred-dc.1

package/dist/engine/index.d.ts

@@ -66,7 +66,7 @@ declare class Engine {
     getPeers(): Peer[];
     get myPeerId(): string | undefined;
     confirmActivity(): Promise<void>;
-    join({ token, appData, isP2pCall }: JoinChannelParams): Promise<void>;
+    join({ token, appData, isP2pCall, preferredDC }: JoinChannelParams): Promise<void>;
     loadPeers(role?: Role): Promise<void>;
     requestChannelStateSync(): void;
     updateAppData(appData: Record<string, unknown>): Promise<void>;

package/dist/engine/media/index.d.ts

@@ -33,7 +33,7 @@ declare class Media {
     get mediasoupDevice(): Device;
     get effectsSDKInitialized(): boolean;
     get effectsSDKParams(): InitEffectsSDKParams | null;
-    getTrack(label: TrackLabel): BaseTrack | undefined;
+    getTrackByLabel(label: TrackLabel): BaseTrack | undefined;
     loadDevice(routerRtpCapabilities: types.RtpCapabilities): Promise<void>;
     getTrackCodec(track: TrackWithEncodings): types.RtpCodecCapability | undefined;
     private createTracks;

package/dist/engine/signalingApiClient/SignalingApiClient.d.ts

@@ -5,6 +5,7 @@ export interface SignalingSecurityData {
     token?: string;
     peerApiVersion?: number;
     datacenterType?: DatacenterType;
+    preferredDC?: string;
 }
 type SignalingErrorListener = (error: Error) => void;
 export default class SignalingApiClient extends Api<SignalingSecurityData> {

package/dist/engine/signalingApiClient/api.d.ts

@@ -229,7 +229,7 @@ export interface ErrorResponse {
     /** @example "Validation failed" */
     error: string;
     /** @example "invalid_request" */
-    errorCode: "check_access_fail" | "join_room_fail" | "need_joined_to_channel" | "forbidden" | "not_found" | "invalid_request" | "already_created" | "too_many_requests" | "something_went_wrong" | "di_error" | "resources_lock_error" | "already_connected" | "timeout" | "unauthorized";
+    errorCode: "check_access_fail" | "join_room_fail" | "need_joined_to_channel" | "forbidden" | "not_found" | "invalid_request" | "already_created" | "too_many_requests" | "something_went_wrong" | "di_error" | "resources_lock_error" | "already_connected" | "timeout" | "unauthorized" | "canceled";
 }
 export declare namespace Peers {
     /**
@@ -260,6 +260,8 @@ export declare namespace Peers {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = PeersResponse;
     }
@@ -290,6 +292,8 @@ export declare namespace Peers {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = RegisteredPeerResponse;
     }
@@ -318,6 +322,8 @@ export declare namespace Peers {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -352,6 +358,8 @@ export declare namespace Peers {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -385,6 +393,8 @@ export declare namespace Peers {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -418,6 +428,8 @@ export declare namespace Peers {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -448,6 +460,8 @@ export declare namespace Router {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             rtpCapabilities: RtpCapabilities;
@@ -480,6 +494,8 @@ export declare namespace Channel {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -511,6 +527,8 @@ export declare namespace Channel {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             /** @format int32 */
@@ -544,6 +562,8 @@ export declare namespace Ping {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = "Pong";
     }
@@ -576,6 +596,8 @@ export declare namespace AppData {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -606,6 +628,8 @@ export declare namespace Producer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             producerId: DataProducerId;
@@ -636,6 +660,8 @@ export declare namespace Producer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             producerId: DataProducerId;
@@ -666,6 +692,8 @@ export declare namespace Producer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             producerId: DataProducerId;
@@ -699,6 +727,8 @@ export declare namespace Producer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -730,6 +760,8 @@ export declare namespace Producer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -761,6 +793,8 @@ export declare namespace Producer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -795,6 +829,8 @@ export declare namespace Producer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -829,6 +865,8 @@ export declare namespace Producer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -867,6 +905,8 @@ export declare namespace Consumer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             id?: string;
@@ -908,6 +948,8 @@ export declare namespace Consumer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -939,6 +981,8 @@ export declare namespace Consumer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -970,6 +1014,8 @@ export declare namespace Consumer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -1006,6 +1052,8 @@ export declare namespace Consumer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -1037,6 +1085,8 @@ export declare namespace Consumer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -1072,6 +1122,8 @@ export declare namespace DataConsumer {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             id?: string;
@@ -1112,6 +1164,8 @@ export declare namespace Transport {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             id: string;
@@ -1152,6 +1206,8 @@ export declare namespace Transport {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             iceParameters: IceParameters;
@@ -1187,6 +1243,8 @@ export declare namespace Transport {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }
@@ -1224,6 +1282,8 @@ export declare namespace Transport {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             id: string;
@@ -1261,6 +1321,8 @@ export declare namespace Transport {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = {
             id: string;
@@ -1294,6 +1356,8 @@ export declare namespace Transport {
              * @default "common"
              */
             "x-datacenter-type"?: "p2p" | "common";
+            /** Preferred data center name for the initial channel assignment */
+            "x-datacenter-name"?: string;
         };
         type ResponseBody = void;
     }