@fishjam-cloud/react-native-client 0.2.3 → 0.2.4

package/ios/RNFishjamClientModule.swift

@@ -13,7 +13,7 @@ struct CameraConfig: Record {
     var quality: String = "VGA169"
 
     @Field
-    var flipVideo: Bool = false
+    var flipDimensions: Bool = false
 
     @Field
     var videoTrackMetadata: [String: Any] = [:]
@@ -39,12 +39,12 @@ struct MicrophoneConfig: Record {
     var microphoneEnabled: Bool = true
 }
 
-struct ScreencastOptions: Record {
+struct ScreenShareOptions: Record {
     @Field
     var quality: String = "HD15"
 
     @Field
-    var screencastMetadata: [String: Any] = [:]
+    var screenShareMetadata: [String: Any] = [:]
 
     @Field
     var simulcastConfig: RNSimulcastConfig = RNSimulcastConfig()
@@ -78,7 +78,7 @@ public class RNFishjamClientModule: Module {
         Events(
             "IsCameraOn",
             "IsMicrophoneOn",
-            "IsScreencastOn",
+            "IsScreenShareOn",
             "SimulcastConfigUpdate",
             "PeersUpdate",
             "AudioDeviceUpdate",
@@ -86,7 +86,8 @@ public class RNFishjamClientModule: Module {
             "BandwidthEstimation",
             "ReconnectionRetriesLimitReached",
             "ReconnectionStarted",
-            "Reconnected")
+            "Reconnected",
+            "Warning")
 
         let rnFishjamClient: RNFishjamClient = {
             let client = RNFishjamClient {
@@ -143,12 +144,12 @@ public class RNFishjamClientModule: Module {
             rnFishjamClient.getCaptureDevices()
         }
 
-        AsyncFunction("toggleScreencast") { (screencastOptions: ScreencastOptions) in
-            try rnFishjamClient.toggleScreencast(screencastOptions: screencastOptions)
+        AsyncFunction("toggleScreenShare") { (screenShareOptions: ScreenShareOptions) in
+            try rnFishjamClient.toggleScreenShare(screenShareOptions: screenShareOptions)
         }
 
-        Property("isScreencastOn") {
-            return rnFishjamClient.isScreencastOn
+        Property("isScreenShareOn") {
+            return rnFishjamClient.isScreenShareOn
         }
 
         AsyncFunction("getPeers") {
@@ -167,20 +168,20 @@ public class RNFishjamClientModule: Module {
             try rnFishjamClient.updateLocalAudioTrackMetadata(metadata: metadata)
         }
 
-        AsyncFunction("updateScreencastTrackMetadata") { (metadata: [String: Any]) in
-            try rnFishjamClient.updateLocalScreencastTrackMetadata(metadata: metadata)
+        AsyncFunction("updateScreenShareTrackMetadata") { (metadata: [String: Any]) in
+            try rnFishjamClient.updateLocalScreenShareTrackMetadata(metadata: metadata)
         }
 
-        AsyncFunction("toggleScreencastTrackEncoding") { (encoding: String) in
-            try rnFishjamClient.toggleScreencastTrackEncoding(encoding: encoding)
+        AsyncFunction("toggleScreenShareTrackEncoding") { (encoding: String) in
+            try rnFishjamClient.toggleScreenShareTrackEncoding(encoding: encoding)
         }
 
-        AsyncFunction("setScreencastTrackBandwidth") { (bandwidth: Int) in
-            try rnFishjamClient.setScreencastTrackBandwidth(bandwidth: bandwidth)
+        AsyncFunction("setScreenShareTrackBandwidth") { (bandwidth: Int) in
+            try rnFishjamClient.setScreenShareTrackBandwidth(bandwidth: bandwidth)
         }
 
-        AsyncFunction("setScreencastTrackEncodingBandwidth") { (encoding: String, bandwidth: Int) in
-            try rnFishjamClient.setScreencastTrackEncodingBandwidth(
+        AsyncFunction("setScreenShareTrackEncodingBandwidth") { (encoding: String, bandwidth: Int) in
+            try rnFishjamClient.setScreenShareTrackEncodingBandwidth(
                 encoding: encoding, bandwidth: bandwidth)
         }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishjam-cloud/react-native-client",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "A React Native client for Fishjam Cloud",
   "author": "Fishjam Cloud Team",
   "license": "Apache-2.0",
@@ -22,20 +22,22 @@
   "keywords": [
     "react-native",
     "expo",
-    "@fishjam-cloud/react-native-client",
-    "fishjam-cloud",
+    "FishjamCloud",
     "MembraneWebRTC",
-    "fishjam"
+    "webRTC",
+    "streaming",
+    "video",
+    "audio"
   ],
-  "repository": "github:fishjam-cloud/mobile-client-sdk",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fishjam-cloud/mobile-client-sdk.git",
+    "directory": "packages/react-native-client"
+  },
   "bugs": {
     "url": "https://github.com/fishjam-cloud/mobile-client-sdk/issues"
   },
   "homepage": "https://fishjam.io",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/",
-    "access": "public"
-  },
   "dependencies": {
     "phoenix": "^1.7.6",
     "promise-fs": "^2.1.1",

package/plugin/broadcastExtensionFiles/FishjamBroadcastSampleHandler.swift

@@ -9,7 +9,7 @@ let appGroup = "{{GROUP_IDENTIFIER}}"
 
 let logger = OSLog(subsystem: "{{BUNDLE_IDENTIFIER}}.FishjamBroadcastSampleHandler", category: "Broadcaster")
 
-/// An example `SampleHandler` utilizing `BroadcastSampleSource` from `MembraneRTC` sending broadcast samples and necessary notification enabling device's screencast.
+/// An example `SampleHandler` utilizing `BroadcastSampleSource` from `MembraneRTC` sending broadcast samples and necessary notification enabling device's screen share.
 class FishjamBroadcastSampleHandler: RPBroadcastSampleHandler {
     let broadcastSource = BroadcastSampleSource(appGroup: appGroup)
     var started: Bool = false

package/plugin/build/withFishjamIos.js

@@ -99,7 +99,7 @@ const withInfoPlistConstants = (config) => {
     return (0, config_plugins_1.withInfoPlist)(config, (config) => {
         const bundleIdentifier = config.ios?.bundleIdentifier || '';
         config.modResults['AppGroupName'] = `group.${bundleIdentifier}`;
-        config.modResults['ScreencastExtensionBundleId'] =
+        config.modResults['ScreenShareExtensionBundleId'] =
             `${bundleIdentifier}.${SBE_TARGET_NAME}`;
         return config;
     });

package/build/hooks/useScreencast.d.ts

@@ -1,57 +0,0 @@
-import { BandwidthLimit, SimulcastConfig, TrackBandwidthLimit, TrackEncoding, TrackMetadata } from '../types';
-export type ScreencastQuality = 'VGA' | 'HD5' | 'HD15' | 'FHD15' | 'FHD30';
-export type ScreencastOptions = {
-    /**
-     * Resolution + fps of screencast track, one of: `VGA`, `HD5`, `HD15`, `FHD15`, `FHD30`.
-     * Note that quality might be worse than specified due to device capabilities, internet
-     * connection etc.
-     * @default `HD15``
-     */
-    quality: ScreencastQuality;
-    /**
-     *  bandwidth limit of a screencast track. By default there is no bandwidth limit.
-     */
-    maxBandwidth: TrackBandwidthLimit;
-};
-export type ScreencastOptionsInternal = {
-    screencastMetadata: TrackMetadata & {
-        displayName?: string;
-    };
-    /**
-     * SimulcastConfig of a screencast track. By default simulcast is disabled.
-     */
-    simulcastConfig: SimulcastConfig;
-};
-/**
- * This hook can toggle screen sharing on/off and provides current screencast state.
- * @returns An object with functions to manage screencast.
- * @category Screenshare
- * @group Hooks
- */
-export declare function useScreencast(): {
-    isScreencastOn: boolean;
-    simulcastConfig: SimulcastConfig;
-    /**
-     * Toggles the screencast on/off
-     */
-    toggleScreencast: (screencastOptions?: Partial<ScreencastOptions>) => Promise<void>;
-    handleScreencastPermission: () => Promise<"granted" | "denied">;
-    /**
-     * @deprecated
-     */
-    setScreencastTrackBandwidth: (bandwidth: BandwidthLimit) => Promise<void>;
-    /**
-     * Toggles simulcast encoding of a screencast track on/off
-     * @param encoding encoding to toggle
-     * @deprecated
-     */
-    toggleScreencastTrackEncoding: (encoding: TrackEncoding) => Promise<void>;
-    /**
-     * updates maximum bandwidth for the given simulcast encoding of the screencast track
-     * @param encoding encoding to update
-     * @param bandwidth BandwidthLimit to set
-     * @deprecated
-     */
-    setScreencastTrackEncodingBandwidth: (encoding: TrackEncoding, bandwidth: BandwidthLimit) => Promise<void>;
-};
-//# sourceMappingURL=useScreencast.d.ts.map

package/build/hooks/useScreencast.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useScreencast.d.ts","sourceRoot":"","sources":["../../src/hooks/useScreencast.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,aAAa,EACb,aAAa,EACd,MAAM,UAAU,CAAC;AAKlB,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAE3E,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;OAKG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,YAAY,EAAE,mBAAmB,CAAC;CACnC,CAAC;AACF,MAAM,MAAM,yBAAyB,GAAG;IACtC,kBAAkB,EAAE,aAAa,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7D;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC;AASF;;;;;GAKG;AACH,wBAAgB,aAAa;;;IAiEzB;;OAEG;2CAvDuB,OAAO,CAAC,iBAAiB,CAAC;;IA2DpD;;OAEG;6CAzBe,cAAc;IA2BhC;;;;OAIG;8CAlDc,aAAa;IAoD9B;;;;;OAKG;oDAhDc,aAAa,aAAa,cAAc;EA2D5D"}

package/build/hooks/useScreencast.js

@@ -1,85 +0,0 @@
-import { useCallback, useState } from 'react';
-import RNFishjamClientModule from '../RNFishjamClientModule';
-import { Platform } from 'react-native';
-import { ReceivableEvents, useFishjamEvent } from './useFishjamEvent';
-const defaultSimulcastConfig = () => ({
-    enabled: false,
-    activeEncodings: [],
-});
-let screencastSimulcastConfig = defaultSimulcastConfig();
-/**
- * This hook can toggle screen sharing on/off and provides current screencast state.
- * @returns An object with functions to manage screencast.
- * @category Screenshare
- * @group Hooks
- */
-export function useScreencast() {
-    const [isScreencastOn, setIsScreencastOn] = useState(RNFishjamClientModule.isScreencastOn);
-    const [simulcastConfig, setSimulcastConfig] = useState(screencastSimulcastConfig);
-    useFishjamEvent(ReceivableEvents.IsScreencastOn, setIsScreencastOn);
-    const toggleScreencast = useCallback(async (screencastOptions = {}) => {
-        const options = {
-            ...screencastOptions,
-            screencastMetadata: {
-                displayName: 'presenting',
-                type: 'screensharing',
-                active: !isScreencastOn,
-            },
-        };
-        await RNFishjamClientModule.toggleScreencast(options);
-        screencastSimulcastConfig = defaultSimulcastConfig(); //to do: sync with camera settings
-        setSimulcastConfig(screencastSimulcastConfig);
-    }, [isScreencastOn]);
-    const toggleScreencastTrackEncoding = useCallback(async (encoding) => {
-        screencastSimulcastConfig =
-            await RNFishjamClientModule.toggleScreencastTrackEncoding(encoding);
-        setSimulcastConfig(screencastSimulcastConfig);
-    }, []);
-    const setScreencastTrackEncodingBandwidth = useCallback(async (encoding, bandwidth) => {
-        await RNFishjamClientModule.setScreencastTrackEncodingBandwidth(encoding, bandwidth);
-    }, []);
-    const setScreencastTrackBandwidth = useCallback(async (bandwidth) => {
-        await RNFishjamClientModule.setScreencastTrackBandwidth(bandwidth);
-    }, []);
-    const handleScreencastPermission = useCallback(async () => {
-        if (Platform.OS == 'android') {
-            return await RNFishjamClientModule.handleScreencastPermission();
-        }
-        return 'denied';
-    }, []);
-    return {
-        isScreencastOn,
-        simulcastConfig,
-        /**
-         * Toggles the screencast on/off
-         */
-        toggleScreencast,
-        handleScreencastPermission,
-        /**
-         * @deprecated
-         */
-        setScreencastTrackBandwidth,
-        /**
-         * Toggles simulcast encoding of a screencast track on/off
-         * @param encoding encoding to toggle
-         * @deprecated
-         */
-        toggleScreencastTrackEncoding,
-        /**
-         * updates maximum bandwidth for the given simulcast encoding of the screencast track
-         * @param encoding encoding to update
-         * @param bandwidth BandwidthLimit to set
-         * @deprecated
-         */
-        setScreencastTrackEncodingBandwidth,
-        /**
-         * updates maximum bandwidth for the screencast track. This value directly translates
-         * to quality of the stream and the amount of RTP packets being sent. In case simulcast
-         * is enabled bandwidth is split between all of the variant streams proportionally to
-         * their resolution
-         * @param bandwidth BandwidthLimit to set
-         * @deprecated
-         */
-    };
-}
-//# sourceMappingURL=useScreencast.js.map

package/build/hooks/useScreencast.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useScreencast.js","sourceRoot":"","sources":["../../src/hooks/useScreencast.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAS9C,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAyBtE,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,CAAC;IACpC,OAAO,EAAE,KAAK;IACd,eAAe,EAAE,EAAE;CACpB,CAAC,CAAC;AAEH,IAAI,yBAAyB,GAAoB,sBAAsB,EAAE,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,CAClD,qBAAqB,CAAC,cAAc,CACrC,CAAC;IAEF,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,QAAQ,CACpD,yBAAyB,CAC1B,CAAC;IAEF,eAAe,CAAC,gBAAgB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;IAEpE,MAAM,gBAAgB,GAAG,WAAW,CAClC,KAAK,EAAE,oBAAgD,EAAE,EAAE,EAAE;QAC3D,MAAM,OAAO,GAAG;YACd,GAAG,iBAAiB;YACpB,kBAAkB,EAAE;gBAClB,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,eAAwB;gBAC9B,MAAM,EAAE,CAAC,cAAc;aACxB;SACF,CAAC;QACF,MAAM,qBAAqB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtD,yBAAyB,GAAG,sBAAsB,EAAE,CAAC,CAAC,kCAAkC;QACxF,kBAAkB,CAAC,yBAAyB,CAAC,CAAC;IAChD,CAAC,EACD,CAAC,cAAc,CAAC,CACjB,CAAC;IAEF,MAAM,6BAA6B,GAAG,WAAW,CAC/C,KAAK,EAAE,QAAuB,EAAE,EAAE;QAChC,yBAAyB;YACvB,MAAM,qBAAqB,CAAC,6BAA6B,CAAC,QAAQ,CAAC,CAAC;QACtE,kBAAkB,CAAC,yBAAyB,CAAC,CAAC;IAChD,CAAC,EACD,EAAE,CACH,CAAC;IAEF,MAAM,mCAAmC,GAAG,WAAW,CACrD,KAAK,EAAE,QAAuB,EAAE,SAAyB,EAAE,EAAE;QAC3D,MAAM,qBAAqB,CAAC,mCAAmC,CAC7D,QAAQ,EACR,SAAS,CACV,CAAC;IACJ,CAAC,EACD,EAAE,CACH,CAAC;IAEF,MAAM,2BAA2B,GAAG,WAAW,CAC7C,KAAK,EAAE,SAAyB,EAAE,EAAE;QAClC,MAAM,qBAAqB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC,EACD,EAAE,CACH,CAAC;IAEF,MAAM,0BAA0B,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;QACxD,IAAI,QAAQ,CAAC,EAAE,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,MAAM,qBAAqB,CAAC,0BAA0B,EAAE,CAAC;QAClE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACL,cAAc;QACd,eAAe;QAEf;;WAEG;QACH,gBAAgB;QAChB,0BAA0B;QAE1B;;WAEG;QACH,2BAA2B;QAC3B;;;;WAIG;QACH,6BAA6B;QAC7B;;;;;WAKG;QACH,mCAAmC;QACnC;;;;;;;WAOG;KACJ,CAAC;AACJ,CAAC","sourcesContent":["import { useCallback, useState } from 'react';\n\nimport {\n  BandwidthLimit,\n  SimulcastConfig,\n  TrackBandwidthLimit,\n  TrackEncoding,\n  TrackMetadata,\n} from '../types';\nimport RNFishjamClientModule from '../RNFishjamClientModule';\nimport { Platform } from 'react-native';\nimport { ReceivableEvents, useFishjamEvent } from './useFishjamEvent';\n\nexport type ScreencastQuality = 'VGA' | 'HD5' | 'HD15' | 'FHD15' | 'FHD30';\n\nexport type ScreencastOptions = {\n  /**\n   * Resolution + fps of screencast track, one of: `VGA`, `HD5`, `HD15`, `FHD15`, `FHD30`.\n   * Note that quality might be worse than specified due to device capabilities, internet\n   * connection etc.\n   * @default `HD15``\n   */\n  quality: ScreencastQuality;\n  /**\n   *  bandwidth limit of a screencast track. By default there is no bandwidth limit.\n   */\n  maxBandwidth: TrackBandwidthLimit;\n};\nexport type ScreencastOptionsInternal = {\n  screencastMetadata: TrackMetadata & { displayName?: string };\n  /**\n   * SimulcastConfig of a screencast track. By default simulcast is disabled.\n   */\n  simulcastConfig: SimulcastConfig;\n};\n\nconst defaultSimulcastConfig = () => ({\n  enabled: false,\n  activeEncodings: [],\n});\n\nlet screencastSimulcastConfig: SimulcastConfig = defaultSimulcastConfig();\n\n/**\n * This hook can toggle screen sharing on/off and provides current screencast state.\n * @returns An object with functions to manage screencast.\n * @category Screenshare\n * @group Hooks\n */\nexport function useScreencast() {\n  const [isScreencastOn, setIsScreencastOn] = useState(\n    RNFishjamClientModule.isScreencastOn,\n  );\n\n  const [simulcastConfig, setSimulcastConfig] = useState<SimulcastConfig>(\n    screencastSimulcastConfig,\n  );\n\n  useFishjamEvent(ReceivableEvents.IsScreencastOn, setIsScreencastOn);\n\n  const toggleScreencast = useCallback(\n    async (screencastOptions: Partial<ScreencastOptions> = {}) => {\n      const options = {\n        ...screencastOptions,\n        screencastMetadata: {\n          displayName: 'presenting',\n          type: 'screensharing' as const,\n          active: !isScreencastOn,\n        },\n      };\n      await RNFishjamClientModule.toggleScreencast(options);\n      screencastSimulcastConfig = defaultSimulcastConfig(); //to do: sync with camera settings\n      setSimulcastConfig(screencastSimulcastConfig);\n    },\n    [isScreencastOn],\n  );\n\n  const toggleScreencastTrackEncoding = useCallback(\n    async (encoding: TrackEncoding) => {\n      screencastSimulcastConfig =\n        await RNFishjamClientModule.toggleScreencastTrackEncoding(encoding);\n      setSimulcastConfig(screencastSimulcastConfig);\n    },\n    [],\n  );\n\n  const setScreencastTrackEncodingBandwidth = useCallback(\n    async (encoding: TrackEncoding, bandwidth: BandwidthLimit) => {\n      await RNFishjamClientModule.setScreencastTrackEncodingBandwidth(\n        encoding,\n        bandwidth,\n      );\n    },\n    [],\n  );\n\n  const setScreencastTrackBandwidth = useCallback(\n    async (bandwidth: BandwidthLimit) => {\n      await RNFishjamClientModule.setScreencastTrackBandwidth(bandwidth);\n    },\n    [],\n  );\n\n  const handleScreencastPermission = useCallback(async () => {\n    if (Platform.OS == 'android') {\n      return await RNFishjamClientModule.handleScreencastPermission();\n    }\n    return 'denied';\n  }, []);\n\n  return {\n    isScreencastOn,\n    simulcastConfig,\n\n    /**\n     * Toggles the screencast on/off\n     */\n    toggleScreencast,\n    handleScreencastPermission,\n\n    /**\n     * @deprecated\n     */\n    setScreencastTrackBandwidth,\n    /**\n     * Toggles simulcast encoding of a screencast track on/off\n     * @param encoding encoding to toggle\n     * @deprecated\n     */\n    toggleScreencastTrackEncoding,\n    /**\n     * updates maximum bandwidth for the given simulcast encoding of the screencast track\n     * @param encoding encoding to update\n     * @param bandwidth BandwidthLimit to set\n     * @deprecated\n     */\n    setScreencastTrackEncodingBandwidth,\n    /**\n     * updates maximum bandwidth for the screencast track. This value directly translates\n     * to quality of the stream and the amount of RTP packets being sent. In case simulcast\n     * is enabled bandwidth is split between all of the variant streams proportionally to\n     * their resolution\n     * @param bandwidth BandwidthLimit to set\n     * @deprecated\n     */\n  };\n}\n"]}