@fishjam-cloud/react-native-client 0.1.0 → 0.2.0

package/src/stats/types.ts

@@ -1,56 +0,0 @@
-/**
- * A record of the total time, in seconds,
- * that this stream has spent in each quality limitation state.
- * none: The resolution and/or framerate is not limited.
- * bandwidth: The resolution and/or framerate is primarily limited due to
- * congestion cues during bandwidth estimation.
- * Typical, congestion control algorithms use inter-arrival time,
- * round-trip time, packet or other congestion cues to perform bandwidth estimation.
- * cpu: The resolution and/or framerate is primarily limited due to CPU load.
- * other: The resolution and/or framerate is primarily limited
- * for a reason other than the above.
- */
-export type QualityLimitationDurations = {
-  bandwidth: number;
-  cpu: number;
-  none: number;
-  other: number;
-};
-
-export type RTCOutboundStats = {
-  'kind': string;
-  'rid': string;
-  'bytesSent': number;
-  'targetBitrate': number;
-  'packetsSent': number;
-  'framesEncoded': number;
-  'framesPerSecond': number;
-  'frameWidth': number;
-  'frameHeight': number;
-  'qualityLimitationDurations': QualityLimitationDurations;
-  'bytesSent/s': number;
-  'packetsSent/s': number;
-  'framesEncoded/s': number;
-};
-
-export type RTCInboundStats = {
-  'kind': number;
-  'jitter': number;
-  'packetsLost': number;
-  'packetsReceived': number;
-  'bytesReceived': number;
-  'framesReceived': number;
-  'frameWidth': number;
-  'frameHeight': number;
-  'framesPerSecond': number;
-  'framesDropped': number;
-  'packetsLost/s': number;
-  'packetsReceived/s': number;
-  'bytesReceived/s': number;
-  'framesReceived/s': number;
-  'framesDropped/s': number;
-};
-
-export type RTCTrackStats = RTCOutboundStats | RTCInboundStats;
-
-export type RTCStats = { [key: string]: RTCTrackStats };

package/src/stats/useRTCStatistics.ts

@@ -1,97 +0,0 @@
-import { takeRight } from 'lodash';
-import { useCallback, useEffect, useState } from 'react';
-
-import type { RTCInboundStats, RTCOutboundStats, RTCStats } from './types';
-import RNFishjamClientModule from '../RNFishjamClientModule';
-
-/**
- * This hook provides access to current rtc statistics data.
- */
-export function useRTCStatistics(refreshInterval: number) {
-  const MAX_SIZE = 120;
-  const [statistics, setStatistics] = useState<RTCStats[]>([]);
-
-  // Calculates diff between pervious and current stats,
-  // providing end users with a per second metric.
-  const processIncomingStats = useCallback(
-    (statistics: ReadonlyArray<RTCStats>, stats: Readonly<RTCStats>) => {
-      Object.keys(stats).forEach((obj) => {
-        if (obj.includes('Inbound')) {
-          const rtcStats = stats[obj] as RTCInboundStats;
-
-          if (
-            statistics.length > 0 &&
-            Object.keys(statistics[statistics.length - 1]).includes(obj)
-          ) {
-            const prevRtcStats = statistics[statistics.length - 1][
-              obj
-            ] as RTCInboundStats;
-
-            rtcStats['packetsLost/s'] =
-              rtcStats['packetsLost'] - prevRtcStats['packetsLost'];
-            rtcStats['packetsReceived/s'] =
-              rtcStats['packetsReceived'] - prevRtcStats['packetsReceived'];
-            rtcStats['bytesReceived/s'] =
-              rtcStats['bytesReceived'] - prevRtcStats['bytesReceived'];
-            rtcStats['framesReceived/s'] =
-              rtcStats['framesReceived'] - prevRtcStats['framesReceived'];
-            rtcStats['framesDropped/s'] =
-              rtcStats['framesDropped'] - prevRtcStats['framesDropped'];
-          } else {
-            rtcStats['packetsLost/s'] = 0;
-            rtcStats['packetsReceived/s'] = 0;
-            rtcStats['bytesReceived/s'] = 0;
-            rtcStats['framesReceived/s'] = 0;
-            rtcStats['framesDropped/s'] = 0;
-          }
-          return stats;
-        }
-        // Outbound
-        const rtcStats = stats[obj] as RTCOutboundStats;
-
-        if (
-          statistics.length > 0 &&
-          Object.keys(statistics[statistics.length - 1]).includes(obj)
-        ) {
-          const prevRtcStats = statistics[statistics.length - 1][
-            obj
-          ] as RTCOutboundStats;
-
-          rtcStats['bytesSent/s'] =
-            rtcStats['bytesSent'] - prevRtcStats['bytesSent'];
-          rtcStats['packetsSent/s'] =
-            rtcStats['packetsSent'] - prevRtcStats['packetsSent'];
-          rtcStats['framesEncoded/s'] =
-            rtcStats['framesEncoded'] - prevRtcStats['framesEncoded'];
-        } else {
-          rtcStats['bytesSent/s'] = 0;
-          rtcStats['packetsSent/s'] = 0;
-          rtcStats['framesEncoded/s'] = 0;
-        }
-        return stats;
-      });
-      return stats;
-    },
-    [],
-  );
-
-  // Gets stats from the native libraries.
-  const getStatistics = useCallback(async () => {
-    const stats = await RNFishjamClientModule.getStatistics();
-    setStatistics((prev) => {
-      const newStats = [...prev, processIncomingStats(prev, stats)];
-      takeRight(newStats, MAX_SIZE);
-      return newStats;
-    });
-  }, [processIncomingStats]);
-
-  useEffect(() => {
-    const intervalId = setInterval(getStatistics, refreshInterval);
-    return () => {
-      clearInterval(intervalId);
-      setStatistics([]);
-    };
-  }, [getStatistics, refreshInterval]);
-
-  return { statistics };
-}

package/src/types.ts

@@ -1,49 +0,0 @@
-// global
-export type VideoLayout = 'FILL' | 'FIT';
-
-export type TrackEncoding = 'l' | 'm' | 'h';
-
-/**
- * A type describing simulcast configuration.
- *
- * At the moment, simulcast track is initialized in three versions - low, medium and high.
- * High resolution is the original track resolution, while medium and low resolutions are
- * the original track resolution scaled down by 2 and 4 respectively.
- */
-export type SimulcastConfig = {
-  /**
-   * whether to simulcast track or not. By default simulcast is disabled.
-   */
-  enabled: boolean;
-  /**
-   *  list of active encodings. Encoding can be one of `"h"` (original encoding), `"m"` (scaled down x2), `"l"` (scaled down x4).
-   */
-  activeEncodings: TrackEncoding[];
-};
-
-/**
- * Type describing maximal bandwidth that can be used, in kbps. 0 is interpreted as unlimited bandwidth.
- */
-export type BandwidthLimit = number;
-
-/**
- * Type describing bandwidth limit for simulcast track. It is a mapping `encoding -> BandwidthLimit`. If encoding isn't present in this mapping,
- * it will be assumed that this particular encoding shouldn't have any bandwidth limit.
- */
-export type SimulcastBandwidthLimit = Record<TrackEncoding, BandwidthLimit>;
-
-/**
- * A type describing bandwidth limitation of a track, including simulcast and non-simulcast tracks. Can be `BandwidthLimit` or `SimulcastBandwidthLimit`.
- */
-export type TrackBandwidthLimit = BandwidthLimit | SimulcastBandwidthLimit;
-
-export type TrackMetadata = {
-  active: boolean;
-  type: 'audio' | 'camera' | 'screensharing';
-};
-
-export type GenericMetadata = Record<string, unknown>;
-
-// branded types are useful for restricting where given value can be passed
-declare const brand: unique symbol;
-export type Brand<T, TBrand extends string> = T & { [brand]: TBrand };

package/tsconfig.json

@@ -1,9 +0,0 @@
-// @generated by expo-module-scripts
-{
-  "extends": "expo-module-scripts/tsconfig.base",
-  "compilerOptions": {
-    "outDir": "./build"
-  },
-  "include": ["./src"],
-  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
-}

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "includeVersion": true,
-  "entryPoints": ["src/index.tsx"]
-}