@videosdk.live/react-sdk 0.5.0 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -43,6 +43,8 @@ import { Character, CharacterMode, CharacterState } from './character';
43
43
  * ---
44
44
  * @param config.maxResolution - You can specify your custom participantId here.
45
45
  * ---
46
+ * @param config.signalingBaseUrl - You can specify the signaling base url here.
47
+ * ---
46
48
  * @param config.mode -
47
49
  *
48
50
  * - There are 3 types of modes:
@@ -97,6 +99,7 @@ export function MeetingProvider({
97
99
  maxResolution?: 'hd' | 'sd';
98
100
  customCameraVideoTrack?: MediaStream | undefined;
99
101
  customMicrophoneAudioTrack?: MediaStream | undefined;
102
+ signalingBaseUrl?: string | undefined;
100
103
  multiStream?: boolean;
101
104
  mode?: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY';
102
105
  metaData?: object;
@@ -1681,7 +1684,15 @@ export function createMicrophoneAudioTrack({
1681
1684
  * @param multiStream - It will specifiy if the stream should send multiple resolution layers or single resolution layer.
1682
1685
  * Please refere thi link for more understanding [What is multiStream ?](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/optimize-video-track#what-is-multistream)
1683
1686
  * ---
1684
- *
1687
+ * @param bitrateMode - It lets you decide whether to prioritize sharp details, save internet data, or find a good balance between the two.
1688
+ * #### Values : `bandwidth_optimized`, `balanced`, `high_quality`
1689
+ * ---
1690
+ *
1691
+ * ---
1692
+ * @param maxLayer - It specifies the maximum number of simulcast layers (maxLayer) to publish.
1693
+ * #### Values : 2, 3
1694
+ * ---
1695
+ *
1685
1696
  * **Code Example**
1686
1697
  * ```js
1687
1698
  * import { createCameraVideoTrack } from "@videosdk.live/react-sdk";
@@ -1689,9 +1700,11 @@ export function createMicrophoneAudioTrack({
1689
1700
  * let customTrack = await createCameraVideoTrack({
1690
1701
  * cameraId:"camera-id", // OPTIONAL
1691
1702
  * optimizationMode: "motion", // "text" | "detail", Default : "motion"
1692
- * encoderConfig: "h480p_w640p", // "h540p_w960p" | "h720p_w1280p" ... // Default : "h360p_w640p"
1703
+ * encoderConfig: "h540p_w960p", // "h540p_w960p" | "h720p_w1280p" ... // Default : "h720p_w1280p"
1693
1704
  * facingMode: "environment", // "front", Default : "environment"
1694
1705
  * multiStream:true // false, Default : true
1706
+ * bitrateMode: "bandwidth_optimized" // "balanced" | "high_quality" , Default : "balanced"
1707
+ * maxLayer: 2 // Default : 3
1695
1708
  * });
1696
1709
  * ```
1697
1710
  */
@@ -1700,7 +1713,9 @@ export function createCameraVideoTrack({
1700
1713
  encoderConfig,
1701
1714
  facingMode,
1702
1715
  optimizationMode,
1703
- multiStream
1716
+ multiStream,
1717
+ bitrateMode,
1718
+ maxLayer
1704
1719
  }: {
1705
1720
  cameraId?: string | undefined;
1706
1721
  encoderConfig?:
@@ -1708,7 +1723,6 @@ export function createCameraVideoTrack({
1708
1723
  | 'h180p_w320p'
1709
1724
  | 'h216p_w384p'
1710
1725
  | 'h360p_w640p'
1711
- | 'h360p_w640p_150kbps'
1712
1726
  | 'h540p_w960p'
1713
1727
  | 'h720p_w1280p'
1714
1728
  | 'h1080p_w1920p'
@@ -1727,6 +1741,8 @@ export function createCameraVideoTrack({
1727
1741
  facingMode?: 'user' | 'environment' | undefined;
1728
1742
  optimizationMode?: 'text' | 'motion' | 'detail' | undefined;
1729
1743
  multiStream?: boolean;
1744
+ bitrateMode?: "bandwidth_optimized" | "balanced" | "high_quality" | undefined,
1745
+ maxLayer?: 2 | 3 | undefined,
1730
1746
  }): Promise<MediaStream>;
1731
1747
 
1732
1748
  /**
@@ -1750,7 +1766,7 @@ export function createCameraVideoTrack({
1750
1766
  * ```js
1751
1767
  * import { createScreenShareVideoTrack } from "@videosdk.live/react-sdk";
1752
1768
  *
1753
- * let customTrack = await createCameraVideoTrack({
1769
+ * let customTrack = await createScreenShareVideoTrack({
1754
1770
  * optimizationMode: "motion", // "text" | "detail", Default : "motion"
1755
1771
  * encoderConfig: "h720p_15fps", // `h360p_30fps` | `h1080p_30fps` // Default : `h720p_15fps`
1756
1772
  * withAudio:'enable' // `disable`, Default : `disable`
@@ -2037,6 +2053,11 @@ export const Constants: {
2037
2053
  JOIN_ROOM_FAILED: number,
2038
2054
  SWITCH_ROOM_FAILED: number,
2039
2055
  CHARACTER_REMOVED: number,
2040
- }
2056
+ },
2057
+ BitrateMode: {
2058
+ HIGH_QUALITY: string;
2059
+ BALANCED: string;
2060
+ BANDWIDTH_OPTIMIZED: string;
2061
+ };
2041
2062
  };
2042
2063
  export { CameraDeviceInfo, DeviceInfo, MicrophoneDeviceInfo };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@videosdk.live/react-sdk",
3
- "version": "0.5.0",
3
+ "version": "0.6.1",
4
4
  "license": "ISC",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.modern.js",
@@ -74,7 +74,7 @@
74
74
  }
75
75
  },
76
76
  "dependencies": {
77
- "@videosdk.live/js-sdk": "0.4.0",
77
+ "@videosdk.live/js-sdk": "0.5.1",
78
78
  "events": "^3.3.0"
79
79
  }
80
80
  }