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

package/src/hooks/useParticipants.ts

@@ -1,118 +0,0 @@
-import { useEffect, useState } from 'react';
-
-import { GenericMetadata, TrackEncoding, TrackMetadata } from '../types';
-import RNFishjamClientModule from '../RNFishjamClientModule';
-import { ReceivableEvents, eventEmitter } from '../common/eventEmitter';
-
-export type TrackType = 'Audio' | 'Video';
-
-/**
- * Type describing Voice Activity Detection statuses.
- *
- * speech - voice activity has been detected
- * silence - lack of voice activity has been detected
- */
-export type VadStatus = 'silence' | 'speech';
-
-type TrackBase = {
-  id: string;
-  type: TrackType;
-  isActive: boolean;
-};
-
-export type AudioTrack = TrackBase & {
-  type: 'Audio';
-  vadStatus: VadStatus | undefined;
-};
-
-export type VideoTrack = TrackBase & {
-  type: 'Video';
-  // Encoding that is currently received. Only present for remote tracks.
-  encoding: TrackEncoding | null;
-  // The reason of currently selected encoding. Only present for remote tracks.
-  encodingReason: EncodingReason | null;
-};
-
-export type Track = VideoTrack | AudioTrack;
-/**
- * Type describing possible reasons of currently selected encoding.
- *
- * - other - the exact reason couldn't be determined
- * - encoding_inactive - previously selected encoding became inactive
- * - low_bandwidth - there is no longer enough bandwidth to maintain previously selected encoding
- */
-export type EncodingReason = 'other' | 'encoding_inactive' | 'low_bandwidth';
-
-export type Participant<
-  ParticipantMetadata extends GenericMetadata = GenericMetadata,
-> = {
-  /**
-   *  id used to identify a participant
-   */
-  id: string;
-  /**
-   * whether the participant is local or remote
-   */
-  isLocal: boolean;
-  /**
-   * a map indexed by strings, containing participant metadata from the server
-   */
-  metadata: ParticipantMetadata;
-  /**
-   * a list of participants's video and audio tracks
-   */
-  tracks: Track[];
-};
-
-export type ParticipantsUpdateEvent<
-  ParticipantMetadata extends GenericMetadata = GenericMetadata,
-> = {
-  PeersUpdate: Participant<ParticipantMetadata>[];
-};
-
-function addIsActiveToTracks<
-  ParticipantMetadata extends GenericMetadata = GenericMetadata,
->(
-  participants: ReadonlyArray<Participant<ParticipantMetadata>>,
-): Participant<ParticipantMetadata>[] {
-  return participants.map((participant) => ({
-    ...participant,
-    tracks: participant.tracks.map((track) => ({
-      ...track,
-      isActive:
-        (track as { metadata?: TrackMetadata })?.metadata?.active ?? true,
-    })),
-  }));
-}
-/**
- * This hook provides live updates of room participants.
- * @returns An array of room participants.
- */
-export function useParticipants<
-  ParticipantMetadata extends GenericMetadata = GenericMetadata,
->() {
-  const [participants, setParticipants] = useState<
-    Participant<ParticipantMetadata>[]
-  >([]);
-
-  useEffect(() => {
-    async function updateParticipants() {
-      const participants =
-        await RNFishjamClientModule.getPeers<ParticipantMetadata>();
-      setParticipants(addIsActiveToTracks<ParticipantMetadata>(participants));
-    }
-
-    const eventListener = eventEmitter.addListener<
-      ParticipantsUpdateEvent<ParticipantMetadata>
-    >(ReceivableEvents.PeersUpdate, (event) => {
-      setParticipants(
-        addIsActiveToTracks<ParticipantMetadata>(event.PeersUpdate),
-      );
-    });
-
-    updateParticipants();
-    return () => eventListener.remove();
-  }, []);
-
-  return { participants };
-}

package/src/hooks/useReconnection.ts

@@ -1,41 +0,0 @@
-import { useEffect, useState } from 'react';
-import { ReceivableEvents, eventEmitter } from '../common/eventEmitter';
-
-export type ReconnectionStatus = 'idle' | 'reconnecting' | 'error';
-
-export function useReconnection() {
-  const [reconnectionStatus, setReconnectionStatus] =
-    useState<ReconnectionStatus>('idle');
-
-  useEffect(() => {
-    const reconnectedEventListener = eventEmitter.addListener(
-      ReceivableEvents.Reconnected,
-      () => {
-        setReconnectionStatus('idle');
-      },
-    );
-
-    const reconnectionStartedEventListener = eventEmitter.addListener(
-      ReceivableEvents.ReconnectionStarted,
-      () => {
-        setReconnectionStatus('reconnecting');
-      },
-    );
-
-    const reconnectionRetriesLimitReachedEventListener =
-      eventEmitter.addListener(
-        ReceivableEvents.ReconnectionRetriesLimitReached,
-        () => {
-          setReconnectionStatus('error');
-        },
-      );
-
-    return () => {
-      reconnectedEventListener.remove();
-      reconnectionStartedEventListener.remove();
-      reconnectionRetriesLimitReachedEventListener.remove();
-    };
-  });
-
-  return { reconnectionStatus };
-}

package/src/hooks/useScreencast.ts

@@ -1,146 +0,0 @@
-import { useCallback, useEffect, useState } from 'react';
-
-import {
-  BandwidthLimit,
-  SimulcastConfig,
-  TrackBandwidthLimit,
-  TrackEncoding,
-  TrackMetadata,
-} from '../types';
-import RNFishjamClientModule from '../RNFishjamClientModule';
-import { ReceivableEvents, eventEmitter } from '../common/eventEmitter';
-import { Platform } from 'react-native';
-
-type IsScreencastOnEvent = { IsScreencastOn: boolean };
-
-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;
-};
-
-const defaultSimulcastConfig = () => ({
-  enabled: false,
-  activeEncodings: [],
-});
-
-let screencastSimulcastConfig: SimulcastConfig = defaultSimulcastConfig();
-
-/**
- * This hook can toggle screen sharing on/off and provides current screencast state.
- * @returns An object with functions to manage screencast.
- */
-export function useScreencast() {
-  const [isScreencastOn, setIsScreencastOn] = useState<boolean>(
-    RNFishjamClientModule.isScreencastOn,
-  );
-
-  const [simulcastConfig, setSimulcastConfig] = useState<SimulcastConfig>(
-    screencastSimulcastConfig,
-  );
-
-  useEffect(() => {
-    const eventListener = eventEmitter.addListener<IsScreencastOnEvent>(
-      ReceivableEvents.IsScreencastOn,
-      (event) => setIsScreencastOn(event.IsScreencastOn),
-    );
-    setIsScreencastOn(RNFishjamClientModule.isScreencastOn);
-    return () => eventListener.remove();
-  }, []);
-
-  /**
-   * Toggles the screencast on/off
-   */
-  const toggleScreencast = useCallback(
-    async (screencastOptions: Partial<ScreencastOptions> = {}) => {
-      const options = {
-        ...screencastOptions,
-        screencastMetadata: {
-          displayName: 'presenting',
-          type: 'screensharing' as const,
-          active: !isScreencastOn,
-        },
-      };
-      await RNFishjamClientModule.toggleScreencast(options);
-      screencastSimulcastConfig = defaultSimulcastConfig(); //to do: sync with camera settings
-      setSimulcastConfig(screencastSimulcastConfig);
-    },
-    [isScreencastOn],
-  );
-
-  /**
-   * Toggles simulcast encoding of a screencast track on/off
-   * @param encoding encoding to toggle
-   */
-  const toggleScreencastTrackEncoding = useCallback(
-    async (encoding: TrackEncoding) => {
-      screencastSimulcastConfig =
-        await RNFishjamClientModule.toggleScreencastTrackEncoding(encoding);
-      setSimulcastConfig(screencastSimulcastConfig);
-    },
-    [],
-  );
-
-  /**
-   * updates maximum bandwidth for the given simulcast encoding of the screencast track
-   * @param encoding encoding to update
-   * @param bandwidth BandwidthLimit to set
-   */
-  const setScreencastTrackEncodingBandwidth = useCallback(
-    async (encoding: TrackEncoding, bandwidth: BandwidthLimit) => {
-      await RNFishjamClientModule.setScreencastTrackEncodingBandwidth(
-        encoding,
-        bandwidth,
-      );
-    },
-    [],
-  );
-
-  /**
-   * 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
-   */
-  const setScreencastTrackBandwidth = useCallback(
-    async (bandwidth: BandwidthLimit) => {
-      await RNFishjamClientModule.setScreencastTrackBandwidth(bandwidth);
-    },
-    [],
-  );
-
-  const handleScreencastPermission = useCallback(async () => {
-    if (Platform.OS == 'android') {
-      return await RNFishjamClientModule.handleScreencastPermission();
-    }
-    return 'denied';
-  }, []);
-
-  return {
-    isScreencastOn,
-    toggleScreencast,
-    toggleScreencastTrackEncoding,
-    simulcastConfig,
-    setScreencastTrackEncodingBandwidth,
-    setScreencastTrackBandwidth,
-    handleScreencastPermission,
-  };
-}

package/src/index.tsx

@@ -1,63 +0,0 @@
-export type {
-  Participant,
-  Track,
-  TrackType,
-  VadStatus,
-  EncodingReason,
-} from './hooks/useParticipants';
-export { useParticipants } from './hooks/useParticipants';
-
-export type {
-  AudioOutputDevice,
-  AudioOutputDeviceType,
-  AudioSessionMode,
-} from './hooks/useAudioSettings';
-export { useAudioSettings } from './hooks/useAudioSettings';
-
-export type { BandwidthEstimationEvent } from './hooks/useBandwidthEstimation';
-export { useBandwidthEstimation } from './hooks/useBandwidthEstimation';
-
-export type {
-  CaptureDevice,
-  CameraConfig,
-  VideoQuality,
-} from './hooks/useCamera';
-export { useCamera } from './hooks/useCamera';
-
-export { useMicrophone } from './hooks/useMicrophone';
-
-export { useRTCStatistics } from './stats/useRTCStatistics';
-
-export type {
-  ScreencastOptions,
-  ScreencastQuality,
-} from './hooks/useScreencast';
-export { useScreencast } from './hooks/useScreencast';
-
-export type { ReconnectionStatus } from './hooks/useReconnection';
-export { useReconnection } from './hooks/useReconnection';
-
-export { updatePeerMetadata } from './common/metadata';
-
-export type { LoggingSeverity } from './common/webRTC';
-export {
-  changeWebRTCLoggingSeverity,
-  setTargetTrackEncoding,
-} from './common/webRTC';
-
-export { connect, leaveRoom } from './common/client';
-
-export type { VideoPreviewViewProps } from './components/VideoPreviewView';
-export { VideoPreviewView } from './components/VideoPreviewView';
-
-export type { VideoRendererProps } from './components/VideoRendererView';
-export { VideoRendererView } from './components/VideoRendererView';
-
-export type {
-  TrackBandwidthLimit,
-  TrackEncoding,
-  SimulcastBandwidthLimit,
-  BandwidthLimit,
-  SimulcastConfig,
-  VideoLayout,
-} from './types';

package/src/protos/fishjam/peer_notifications.ts

@@ -1,299 +0,0 @@
-// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
-// versions:
-//   protoc-gen-ts_proto  v1.178.0
-//   protoc               v5.26.1
-// source: protos/fishjam/peer_notifications.proto
-
-/* eslint-disable */
-import * as _m0 from "protobufjs/minimal";
-
-export const protobufPackage = "fishjam";
-
-/** Defines any type of message sent between FJ and a peer */
-export interface PeerMessage {
-  authenticated?: PeerMessage_Authenticated | undefined;
-  authRequest?: PeerMessage_AuthRequest | undefined;
-  mediaEvent?: PeerMessage_MediaEvent | undefined;
-}
-
-/** Response sent by FJ, confirming successfull authentication */
-export interface PeerMessage_Authenticated {
-}
-
-/** Request sent by peer, to authenticate to FJ server */
-export interface PeerMessage_AuthRequest {
-  token: string;
-}
-
-/** Any type of WebRTC messages passed betweend FJ and peer */
-export interface PeerMessage_MediaEvent {
-  data: string;
-}
-
-function createBasePeerMessage(): PeerMessage {
-  return { authenticated: undefined, authRequest: undefined, mediaEvent: undefined };
-}
-
-export const PeerMessage = {
-  encode(message: PeerMessage, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.authenticated !== undefined) {
-      PeerMessage_Authenticated.encode(message.authenticated, writer.uint32(10).fork()).ldelim();
-    }
-    if (message.authRequest !== undefined) {
-      PeerMessage_AuthRequest.encode(message.authRequest, writer.uint32(18).fork()).ldelim();
-    }
-    if (message.mediaEvent !== undefined) {
-      PeerMessage_MediaEvent.encode(message.mediaEvent, writer.uint32(26).fork()).ldelim();
-    }
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBasePeerMessage();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1:
-          if (tag !== 10) {
-            break;
-          }
-
-          message.authenticated = PeerMessage_Authenticated.decode(reader, reader.uint32());
-          continue;
-        case 2:
-          if (tag !== 18) {
-            break;
-          }
-
-          message.authRequest = PeerMessage_AuthRequest.decode(reader, reader.uint32());
-          continue;
-        case 3:
-          if (tag !== 26) {
-            break;
-          }
-
-          message.mediaEvent = PeerMessage_MediaEvent.decode(reader, reader.uint32());
-          continue;
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): PeerMessage {
-    return {
-      authenticated: isSet(object.authenticated) ? PeerMessage_Authenticated.fromJSON(object.authenticated) : undefined,
-      authRequest: isSet(object.authRequest) ? PeerMessage_AuthRequest.fromJSON(object.authRequest) : undefined,
-      mediaEvent: isSet(object.mediaEvent) ? PeerMessage_MediaEvent.fromJSON(object.mediaEvent) : undefined,
-    };
-  },
-
-  toJSON(message: PeerMessage): unknown {
-    const obj: any = {};
-    if (message.authenticated !== undefined) {
-      obj.authenticated = PeerMessage_Authenticated.toJSON(message.authenticated);
-    }
-    if (message.authRequest !== undefined) {
-      obj.authRequest = PeerMessage_AuthRequest.toJSON(message.authRequest);
-    }
-    if (message.mediaEvent !== undefined) {
-      obj.mediaEvent = PeerMessage_MediaEvent.toJSON(message.mediaEvent);
-    }
-    return obj;
-  },
-
-  create<I extends Exact<DeepPartial<PeerMessage>, I>>(base?: I): PeerMessage {
-    return PeerMessage.fromPartial(base ?? ({} as any));
-  },
-  fromPartial<I extends Exact<DeepPartial<PeerMessage>, I>>(object: I): PeerMessage {
-    const message = createBasePeerMessage();
-    message.authenticated = (object.authenticated !== undefined && object.authenticated !== null)
-      ? PeerMessage_Authenticated.fromPartial(object.authenticated)
-      : undefined;
-    message.authRequest = (object.authRequest !== undefined && object.authRequest !== null)
-      ? PeerMessage_AuthRequest.fromPartial(object.authRequest)
-      : undefined;
-    message.mediaEvent = (object.mediaEvent !== undefined && object.mediaEvent !== null)
-      ? PeerMessage_MediaEvent.fromPartial(object.mediaEvent)
-      : undefined;
-    return message;
-  },
-};
-
-function createBasePeerMessage_Authenticated(): PeerMessage_Authenticated {
-  return {};
-}
-
-export const PeerMessage_Authenticated = {
-  encode(_: PeerMessage_Authenticated, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage_Authenticated {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBasePeerMessage_Authenticated();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(_: any): PeerMessage_Authenticated {
-    return {};
-  },
-
-  toJSON(_: PeerMessage_Authenticated): unknown {
-    const obj: any = {};
-    return obj;
-  },
-
-  create<I extends Exact<DeepPartial<PeerMessage_Authenticated>, I>>(base?: I): PeerMessage_Authenticated {
-    return PeerMessage_Authenticated.fromPartial(base ?? ({} as any));
-  },
-  fromPartial<I extends Exact<DeepPartial<PeerMessage_Authenticated>, I>>(_: I): PeerMessage_Authenticated {
-    const message = createBasePeerMessage_Authenticated();
-    return message;
-  },
-};
-
-function createBasePeerMessage_AuthRequest(): PeerMessage_AuthRequest {
-  return { token: "" };
-}
-
-export const PeerMessage_AuthRequest = {
-  encode(message: PeerMessage_AuthRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.token !== "") {
-      writer.uint32(10).string(message.token);
-    }
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage_AuthRequest {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBasePeerMessage_AuthRequest();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1:
-          if (tag !== 10) {
-            break;
-          }
-
-          message.token = reader.string();
-          continue;
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): PeerMessage_AuthRequest {
-    return { token: isSet(object.token) ? globalThis.String(object.token) : "" };
-  },
-
-  toJSON(message: PeerMessage_AuthRequest): unknown {
-    const obj: any = {};
-    if (message.token !== "") {
-      obj.token = message.token;
-    }
-    return obj;
-  },
-
-  create<I extends Exact<DeepPartial<PeerMessage_AuthRequest>, I>>(base?: I): PeerMessage_AuthRequest {
-    return PeerMessage_AuthRequest.fromPartial(base ?? ({} as any));
-  },
-  fromPartial<I extends Exact<DeepPartial<PeerMessage_AuthRequest>, I>>(object: I): PeerMessage_AuthRequest {
-    const message = createBasePeerMessage_AuthRequest();
-    message.token = object.token ?? "";
-    return message;
-  },
-};
-
-function createBasePeerMessage_MediaEvent(): PeerMessage_MediaEvent {
-  return { data: "" };
-}
-
-export const PeerMessage_MediaEvent = {
-  encode(message: PeerMessage_MediaEvent, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.data !== "") {
-      writer.uint32(10).string(message.data);
-    }
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage_MediaEvent {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBasePeerMessage_MediaEvent();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1:
-          if (tag !== 10) {
-            break;
-          }
-
-          message.data = reader.string();
-          continue;
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): PeerMessage_MediaEvent {
-    return { data: isSet(object.data) ? globalThis.String(object.data) : "" };
-  },
-
-  toJSON(message: PeerMessage_MediaEvent): unknown {
-    const obj: any = {};
-    if (message.data !== "") {
-      obj.data = message.data;
-    }
-    return obj;
-  },
-
-  create<I extends Exact<DeepPartial<PeerMessage_MediaEvent>, I>>(base?: I): PeerMessage_MediaEvent {
-    return PeerMessage_MediaEvent.fromPartial(base ?? ({} as any));
-  },
-  fromPartial<I extends Exact<DeepPartial<PeerMessage_MediaEvent>, I>>(object: I): PeerMessage_MediaEvent {
-    const message = createBasePeerMessage_MediaEvent();
-    message.data = object.data ?? "";
-    return message;
-  },
-};
-
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-
-export type DeepPartial<T> = T extends Builtin ? T
-  : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>>
-  : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
-  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
-  : Partial<T>;
-
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-export type Exact<P, I extends P> = P extends Builtin ? P
-  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };
-
-function isSet(value: any): boolean {
-  return value !== null && value !== undefined;
-}