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

package/build/common/client.js

@@ -1,14 +1,17 @@
 import RNFishjamClientModule from '../RNFishjamClientModule';
 /**
- *
  * @param url fishjam Url
  * @param participantToken
  * @param participantMetadata
  * @param config
+ * @category Connection
  */
 export async function joinRoom(url, participantToken, participantMetadata, config = {}) {
     await RNFishjamClientModule.joinRoom(url, participantToken, participantMetadata, config);
 }
+/**
+ * @category Connection
+ */
 export async function leaveRoom() {
     await RNFishjamClientModule.leaveRoom();
 }

package/build/common/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/common/client.ts"],"names":[],"mappings":"AACA,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAkB7D;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAG5B,GAAW,EACX,gBAAwB,EACxB,mBAAwC,EACxC,SAA2B,EAAE;IAE7B,MAAM,qBAAqB,CAAC,QAAQ,CAClC,GAAG,EACH,gBAAgB,EAChB,mBAAmB,EACnB,MAAM,CACP,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS;IAC7B,MAAM,qBAAqB,CAAC,SAAS,EAAE,CAAC;AAC1C,CAAC","sourcesContent":["import { GenericMetadata } from '../types';\nimport RNFishjamClientModule from '../RNFishjamClientModule';\n\nexport type ConnectionConfig = {\n  /**\n   * Configuration for automatic reconnection\n   * sdk uses a linear backoff algorithm, that is the formula\n   * for the delay of the nth attempt is\n   * n * delayMs + initialDelayMs\n   *\n   * Pass 0 for maxAttempts to disable automatic reconnection\n   */\n  reconnectConfig?: {\n    maxAttempts?: number;\n    initialDelayMs?: number;\n    delayMs?: number;\n  };\n};\n\n/**\n *\n * @param url fishjam Url\n * @param participantToken\n * @param participantMetadata\n * @param config\n */\nexport async function joinRoom<\n  ParticipantMetadata extends GenericMetadata = GenericMetadata,\n>(\n  url: string,\n  participantToken: string,\n  participantMetadata: ParticipantMetadata,\n  config: ConnectionConfig = {},\n) {\n  await RNFishjamClientModule.joinRoom(\n    url,\n    participantToken,\n    participantMetadata,\n    config,\n  );\n}\n\nexport async function leaveRoom() {\n  await RNFishjamClientModule.leaveRoom();\n}\n"]}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/common/client.ts"],"names":[],"mappings":"AACA,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAkB7D;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAG5B,GAAW,EACX,gBAAwB,EACxB,mBAAwC,EACxC,SAA2B,EAAE;IAE7B,MAAM,qBAAqB,CAAC,QAAQ,CAClC,GAAG,EACH,gBAAgB,EAChB,mBAAmB,EACnB,MAAM,CACP,CAAC;AACJ,CAAC;AACD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS;IAC7B,MAAM,qBAAqB,CAAC,SAAS,EAAE,CAAC;AAC1C,CAAC","sourcesContent":["import { GenericMetadata } from '../types';\nimport RNFishjamClientModule from '../RNFishjamClientModule';\n\nexport type ConnectionConfig = {\n  /**\n   * Configuration for automatic reconnection\n   * sdk uses a linear backoff algorithm, that is the formula\n   * for the delay of the nth attempt is\n   * n * delayMs + initialDelayMs\n   *\n   * Pass 0 for maxAttempts to disable automatic reconnection\n   */\n  reconnectConfig?: {\n    maxAttempts?: number;\n    initialDelayMs?: number;\n    delayMs?: number;\n  };\n};\n\n/**\n * @param url fishjam Url\n * @param participantToken\n * @param participantMetadata\n * @param config\n * @category Connection\n */\nexport async function joinRoom<\n  ParticipantMetadata extends GenericMetadata = GenericMetadata,\n>(\n  url: string,\n  participantToken: string,\n  participantMetadata: ParticipantMetadata,\n  config: ConnectionConfig = {},\n) {\n  await RNFishjamClientModule.joinRoom(\n    url,\n    participantToken,\n    participantMetadata,\n    config,\n  );\n}\n/**\n * @category Connection\n */\nexport async function leaveRoom() {\n  await RNFishjamClientModule.leaveRoom();\n}\n"]}

package/build/common/metadata.d.ts

@@ -2,6 +2,7 @@ import { GenericMetadata } from '../types';
 /**
  * a function that updates endpoints's metadata on the server
  * @param metadata a map indexed by strings, containing participants metadata to be sent to the server
+ * @category Connection
  */
 export declare function updatePeerMetadata<ParticipantMetadata extends GenericMetadata = GenericMetadata>(metadata: ParticipantMetadata): Promise<void>;
 //# sourceMappingURL=metadata.d.ts.map

package/build/common/metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/common/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,mBAAmB,SAAS,eAAe,GAAG,eAAe,EAC7D,QAAQ,EAAE,mBAAmB,iBAE9B"}
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/common/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,mBAAmB,SAAS,eAAe,GAAG,eAAe,EAC7D,QAAQ,EAAE,mBAAmB,iBAE9B"}

package/build/common/metadata.js

@@ -2,6 +2,7 @@ import RNFishjamClientModule from '../RNFishjamClientModule';
 /**
  * a function that updates endpoints's metadata on the server
  * @param metadata a map indexed by strings, containing participants metadata to be sent to the server
+ * @category Connection
  */
 export async function updatePeerMetadata(metadata) {
     await RNFishjamClientModule.updatePeerMetadata(metadata);

package/build/common/metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/common/metadata.ts"],"names":[],"mappings":"AACA,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAE7D;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAEtC,QAA6B;IAC7B,MAAM,qBAAqB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import { GenericMetadata } from '../types';\nimport RNFishjamClientModule from '../RNFishjamClientModule';\n\n/**\n * a function that updates endpoints's metadata on the server\n * @param metadata a map indexed by strings, containing participants metadata to be sent to the server\n */\nexport async function updatePeerMetadata<\n  ParticipantMetadata extends GenericMetadata = GenericMetadata,\n>(metadata: ParticipantMetadata) {\n  await RNFishjamClientModule.updatePeerMetadata(metadata);\n}\n"]}
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/common/metadata.ts"],"names":[],"mappings":"AACA,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAEtC,QAA6B;IAC7B,MAAM,qBAAqB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import { GenericMetadata } from '../types';\nimport RNFishjamClientModule from '../RNFishjamClientModule';\n\n/**\n * a function that updates endpoints's metadata on the server\n * @param metadata a map indexed by strings, containing participants metadata to be sent to the server\n * @category Connection\n */\nexport async function updatePeerMetadata<\n  ParticipantMetadata extends GenericMetadata = GenericMetadata,\n>(metadata: ParticipantMetadata) {\n  await RNFishjamClientModule.updatePeerMetadata(metadata);\n}\n"]}

package/build/common/webRTC.d.ts

@@ -8,12 +8,14 @@ export type LoggingSeverity = 'verbose' | 'info' | 'warning' | 'error' | 'none';
  *
  * @param trackId id of a track which encoding you want to select
  * @param encoding encoding to select
+ * @category Debugging
  */
 export declare function setTargetTrackEncoding(trackId: string, encoding: TrackEncoding): Promise<void>;
 /**
  * Function that changes level of debugging logs in WebRTC.
  * @param severity to use when displaying logs
  * @returns a promise that is resolved when debug severity is changed
+ * @category Debugging
  */
 export declare function changeWebRTCLoggingSeverity(severity: LoggingSeverity): Promise<void>;
 //# sourceMappingURL=webRTC.d.ts.map

package/build/common/webRTC.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webRTC.d.ts","sourceRoot":"","sources":["../../src/common/webRTC.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AAEhF;;;;;;;;GAQG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,aAAa,iBAGxB;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,eAAe,GACxB,OAAO,CAAC,IAAI,CAAC,CAEf"}
+{"version":3,"file":"webRTC.d.ts","sourceRoot":"","sources":["../../src/common/webRTC.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AAEhF;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,aAAa,iBAGxB;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,eAAe,GACxB,OAAO,CAAC,IAAI,CAAC,CAEf"}

package/build/common/webRTC.js

@@ -7,6 +7,7 @@ import RNFishjamClientModule from '../RNFishjamClientModule';
  *
  * @param trackId id of a track which encoding you want to select
  * @param encoding encoding to select
+ * @category Debugging
  */
 export async function setTargetTrackEncoding(trackId, encoding) {
     await RNFishjamClientModule.setTargetTrackEncoding(trackId, encoding);
@@ -15,6 +16,7 @@ export async function setTargetTrackEncoding(trackId, encoding) {
  * Function that changes level of debugging logs in WebRTC.
  * @param severity to use when displaying logs
  * @returns a promise that is resolved when debug severity is changed
+ * @category Debugging
  */
 export function changeWebRTCLoggingSeverity(severity) {
     return RNFishjamClientModule.changeWebRTCLoggingSeverity(severity);

package/build/common/webRTC.js.map

@@ -1 +1 @@
-{"version":3,"file":"webRTC.js","sourceRoot":"","sources":["../../src/common/webRTC.ts"],"names":[],"mappings":"AACA,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAI7D;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAe,EACf,QAAuB;IAEvB,MAAM,qBAAqB,CAAC,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACxE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,QAAyB;IAEzB,OAAO,qBAAqB,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AACrE,CAAC","sourcesContent":["import { TrackEncoding } from '../types';\nimport RNFishjamClientModule from '../RNFishjamClientModule';\n\nexport type LoggingSeverity = 'verbose' | 'info' | 'warning' | 'error' | 'none';\n\n/**\n * sets track encoding that server should send to the client library.\n * The encoding will be sent whenever it is available. If chooses encoding is\n * temporarily unavailable, some other encoding will be sent until choose encoding\n *  becomes active again.\n *\n * @param trackId id of a track which encoding you want to select\n * @param encoding encoding to select\n */\nexport async function setTargetTrackEncoding(\n  trackId: string,\n  encoding: TrackEncoding,\n) {\n  await RNFishjamClientModule.setTargetTrackEncoding(trackId, encoding);\n}\n\n/**\n * Function that changes level of debugging logs in WebRTC.\n * @param severity to use when displaying logs\n * @returns a promise that is resolved when debug severity is changed\n */\nexport function changeWebRTCLoggingSeverity(\n  severity: LoggingSeverity,\n): Promise<void> {\n  return RNFishjamClientModule.changeWebRTCLoggingSeverity(severity);\n}\n"]}
+{"version":3,"file":"webRTC.js","sourceRoot":"","sources":["../../src/common/webRTC.ts"],"names":[],"mappings":"AACA,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAI7D;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAe,EACf,QAAuB;IAEvB,MAAM,qBAAqB,CAAC,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,QAAyB;IAEzB,OAAO,qBAAqB,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AACrE,CAAC","sourcesContent":["import { TrackEncoding } from '../types';\nimport RNFishjamClientModule from '../RNFishjamClientModule';\n\nexport type LoggingSeverity = 'verbose' | 'info' | 'warning' | 'error' | 'none';\n\n/**\n * sets track encoding that server should send to the client library.\n * The encoding will be sent whenever it is available. If chooses encoding is\n * temporarily unavailable, some other encoding will be sent until choose encoding\n *  becomes active again.\n *\n * @param trackId id of a track which encoding you want to select\n * @param encoding encoding to select\n * @category Debugging\n */\nexport async function setTargetTrackEncoding(\n  trackId: string,\n  encoding: TrackEncoding,\n) {\n  await RNFishjamClientModule.setTargetTrackEncoding(trackId, encoding);\n}\n\n/**\n * Function that changes level of debugging logs in WebRTC.\n * @param severity to use when displaying logs\n * @returns a promise that is resolved when debug severity is changed\n * @category Debugging\n */\nexport function changeWebRTCLoggingSeverity(\n  severity: LoggingSeverity,\n): Promise<void> {\n  return RNFishjamClientModule.changeWebRTCLoggingSeverity(severity);\n}\n"]}

package/build/components/VideoPreviewView.d.ts

@@ -4,9 +4,7 @@ import { VideoLayout } from '../types';
 import { CameraId } from '../hooks/useCamera';
 export type VideoPreviewViewProps = {
     /**
-     * `FILL` or `FIT` - it works just like RN Image component. `FILL` fills the whole view
-     * with video and it may cut some parts of the video. `FIT` scales the video so the whole
-     * video is visible, but it may leave some empty space in the view.
+     * Video layout inside of the component
      * @default `FILL`
      */
     videoLayout?: VideoLayout;
@@ -17,5 +15,10 @@ export type VideoPreviewViewProps = {
      */
     cameraId?: CameraId;
 };
+/**
+ * Render camera preview.
+ * Allows to display camera preview beofre streaming is started
+ * @category Components
+ */
 export declare const VideoPreviewView: React.ForwardRefExoticComponent<VideoPreviewViewProps & React.RefAttributes<React.ComponentType<VideoPreviewViewProps>>>;
 //# sourceMappingURL=VideoPreviewView.d.ts.map

package/build/components/VideoPreviewView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VideoPreviewView.d.ts","sourceRoot":"","sources":["../../src/components/VideoPreviewView.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAKF,eAAO,MAAM,gBAAgB,0HAM3B,CAAC"}
+{"version":3,"file":"VideoPreviewView.d.ts","sourceRoot":"","sources":["../../src/components/VideoPreviewView.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAKF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,0HAM3B,CAAC"}

package/build/components/VideoPreviewView.js

@@ -1,6 +1,11 @@
 import { requireNativeViewManager } from 'expo-modules-core';
 import * as React from 'react';
 const NativeView = requireNativeViewManager('VideoPreviewViewModule');
+/**
+ * Render camera preview.
+ * Allows to display camera preview beofre streaming is started
+ * @category Components
+ */
 export const VideoPreviewView = React.forwardRef((props, ref) => (
 // @ts-expect-error ref prop needs to be updated
 <NativeView {...props} captureDeviceId={props.cameraId} ref={ref}/>));

package/build/components/VideoPreviewView.js.map

@@ -1 +1 @@
-{"version":3,"file":"VideoPreviewView.js","sourceRoot":"","sources":["../../src/components/VideoPreviewView.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAsB/B,MAAM,UAAU,GACd,wBAAwB,CAAC,wBAAwB,CAAC,CAAC;AAErD,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAG9C,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC;AAChB,gDAAgD;AAChD,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAG,CACrE,CAAC,CAAC","sourcesContent":["import { requireNativeViewManager } from 'expo-modules-core';\nimport * as React from 'react';\nimport { ViewStyle } from 'react-native';\n\nimport { VideoLayout } from '../types';\nimport { CameraId } from '../hooks/useCamera';\n\nexport type VideoPreviewViewProps = {\n  /**\n   * `FILL` or `FIT` - it works just like RN Image component. `FILL` fills the whole view\n   * with video and it may cut some parts of the video. `FIT` scales the video so the whole\n   * video is visible, but it may leave some empty space in the view.\n   * @default `FILL`\n   */\n  videoLayout?: VideoLayout;\n  style?: ViewStyle;\n  /**\n   * Id of the camera used for preview. Get available cameras with `cameras` property.\n   * @default the first front camera\n   */\n  cameraId?: CameraId;\n};\n\nconst NativeView: React.ComponentType<VideoPreviewViewProps> =\n  requireNativeViewManager('VideoPreviewViewModule');\n\nexport const VideoPreviewView = React.forwardRef<\n  React.ComponentType<VideoPreviewViewProps>,\n  VideoPreviewViewProps\n>((props, ref) => (\n  // @ts-expect-error ref prop needs to be updated\n  <NativeView {...props} captureDeviceId={props.cameraId} ref={ref} />\n));\n"]}
+{"version":3,"file":"VideoPreviewView.js","sourceRoot":"","sources":["../../src/components/VideoPreviewView.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAoB/B,MAAM,UAAU,GACd,wBAAwB,CAAC,wBAAwB,CAAC,CAAC;AAErD;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAG9C,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC;AAChB,gDAAgD;AAChD,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAG,CACrE,CAAC,CAAC","sourcesContent":["import { requireNativeViewManager } from 'expo-modules-core';\nimport * as React from 'react';\nimport { ViewStyle } from 'react-native';\n\nimport { VideoLayout } from '../types';\nimport { CameraId } from '../hooks/useCamera';\n\nexport type VideoPreviewViewProps = {\n  /**\n   * Video layout inside of the component\n   * @default `FILL`\n   */\n  videoLayout?: VideoLayout;\n  style?: ViewStyle;\n  /**\n   * Id of the camera used for preview. Get available cameras with `cameras` property.\n   * @default the first front camera\n   */\n  cameraId?: CameraId;\n};\n\nconst NativeView: React.ComponentType<VideoPreviewViewProps> =\n  requireNativeViewManager('VideoPreviewViewModule');\n\n/**\n * Render camera preview.\n * Allows to display camera preview beofre streaming is started\n * @category Components\n */\nexport const VideoPreviewView = React.forwardRef<\n  React.ComponentType<VideoPreviewViewProps>,\n  VideoPreviewViewProps\n>((props, ref) => (\n  // @ts-expect-error ref prop needs to be updated\n  <NativeView {...props} captureDeviceId={props.cameraId} ref={ref} />\n));\n"]}

package/build/components/VideoRendererView.d.ts

@@ -7,13 +7,15 @@ export type VideoRendererProps = {
      */
     trackId: string;
     /**
-     * `FILL` or `FIT` - it works just like RN Image component. `FILL` fills the whole view
-     * with video and it may cut some parts of the video. `FIT` scales the video so the whole
-     * video is visible, but it may leave some empty space in the view.
+     * Video layout inside of the component
      * @default `FILL`
      */
     videoLayout?: VideoLayout;
     style?: ViewStyle;
 };
+/**
+ * Render video track received from {@link useParticipants} hook
+ * @category Components
+ */
 export declare const VideoRendererView: React.ForwardRefExoticComponent<VideoRendererProps & React.RefAttributes<React.ComponentType<VideoRendererProps>>>;
 //# sourceMappingURL=VideoRendererView.d.ts.map

package/build/components/VideoRendererView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VideoRendererView.d.ts","sourceRoot":"","sources":["../../src/components/VideoRendererView.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AAKF,eAAO,MAAM,iBAAiB,oHAM5B,CAAC"}
+{"version":3,"file":"VideoRendererView.d.ts","sourceRoot":"","sources":["../../src/components/VideoRendererView.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AAKF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,oHAM5B,CAAC"}

package/build/components/VideoRendererView.js

@@ -1,6 +1,10 @@
 import { requireNativeViewManager } from 'expo-modules-core';
 import * as React from 'react';
 const NativeView = requireNativeViewManager('VideoRendererViewModule');
+/**
+ * Render video track received from {@link useParticipants} hook
+ * @category Components
+ */
 export const VideoRendererView = React.forwardRef((props, ref) => (
 // @ts-expect-error ref prop needs to be updated
 <NativeView {...props} ref={ref}/>));

package/build/components/VideoRendererView.js.map

@@ -1 +1 @@
-{"version":3,"file":"VideoRendererView.js","sourceRoot":"","sources":["../../src/components/VideoRendererView.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAoB/B,MAAM,UAAU,GACd,wBAAwB,CAAC,yBAAyB,CAAC,CAAC;AAEtD,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC,UAAU,CAG/C,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC;AAChB,gDAAgD;AAChD,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAG,CACpC,CAAC,CAAC","sourcesContent":["import { requireNativeViewManager } from 'expo-modules-core';\nimport * as React from 'react';\nimport { ViewStyle } from 'react-native';\n\nimport { VideoLayout } from '../types';\n\nexport type VideoRendererProps = {\n  /**\n   * id of the video track which you want to render.\n   */\n  trackId: string;\n  /**\n   * `FILL` or `FIT` - it works just like RN Image component. `FILL` fills the whole view\n   * with video and it may cut some parts of the video. `FIT` scales the video so the whole\n   * video is visible, but it may leave some empty space in the view.\n   * @default `FILL`\n   */\n  videoLayout?: VideoLayout;\n  style?: ViewStyle;\n};\n\nconst NativeView: React.ComponentType<VideoRendererProps> =\n  requireNativeViewManager('VideoRendererViewModule');\n\nexport const VideoRendererView = React.forwardRef<\n  React.ComponentType<VideoRendererProps>,\n  VideoRendererProps\n>((props, ref) => (\n  // @ts-expect-error ref prop needs to be updated\n  <NativeView {...props} ref={ref} />\n));\n"]}
+{"version":3,"file":"VideoRendererView.js","sourceRoot":"","sources":["../../src/components/VideoRendererView.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAkB/B,MAAM,UAAU,GACd,wBAAwB,CAAC,yBAAyB,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC,UAAU,CAG/C,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC;AAChB,gDAAgD;AAChD,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAG,CACpC,CAAC,CAAC","sourcesContent":["import { requireNativeViewManager } from 'expo-modules-core';\nimport * as React from 'react';\nimport { ViewStyle } from 'react-native';\n\nimport { VideoLayout } from '../types';\n\nexport type VideoRendererProps = {\n  /**\n   * id of the video track which you want to render.\n   */\n  trackId: string;\n  /**\n   * Video layout inside of the component\n   * @default `FILL`\n   */\n  videoLayout?: VideoLayout;\n  style?: ViewStyle;\n};\n\nconst NativeView: React.ComponentType<VideoRendererProps> =\n  requireNativeViewManager('VideoRendererViewModule');\n\n/**\n * Render video track received from {@link useParticipants} hook\n * @category Components\n */\nexport const VideoRendererView = React.forwardRef<\n  React.ComponentType<VideoRendererProps>,\n  VideoRendererProps\n>((props, ref) => (\n  // @ts-expect-error ref prop needs to be updated\n  <NativeView {...props} ref={ref} />\n));\n"]}

package/build/hooks/useAudioSettings.d.ts

@@ -6,6 +6,8 @@ export type AudioOutputDevice = {
 };
 /**
  * This hook manages audio settings.
+ * @category Devices
+ * @group Hooks
  */
 export declare function useAudioSettings(): {
     /**
@@ -16,8 +18,21 @@ export declare function useAudioSettings(): {
      * [Android only] available audio output devices to be set
      */
     availableDevices: AudioOutputDevice[];
+    /**
+     * [Android only] selects output audio device.
+     * For detecting and selecting bluettoth devices make sure you have the BLUETOOTH_CONNECT permission.
+     */
     selectOutputAudioDevice: (device: AudioOutputDeviceType) => Promise<void>;
+    /**
+     * [iOS only] selects audio session mode. For more information refer to Apple's documentation:
+     *  https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/
+     *
+     */
     selectAudioSessionMode: (audioSessionMode: AudioSessionMode) => Promise<void>;
+    /**
+     * [iOS only] Shows a picker modal that allows user to select output audio device. For more
+     * information refer to Apple's documentation: https://developer.apple.com/documentation/avkit/avroutepickerview
+     */
     showAudioRoutePicker: () => Promise<void>;
 };
 //# sourceMappingURL=useAudioSettings.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useAudioSettings.d.ts","sourceRoot":"","sources":["../../src/hooks/useAudioSettings.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,qBAAqB,GAC7B,WAAW,GACX,SAAS,GACT,SAAS,GACT,UAAU,CAAC;AAEf,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,WAAW,CAAC;AAEzD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,qBAAqB,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAOF;;GAEG;AACH,wBAAgB,gBAAgB;IAsE5B;;OAEG;;IAEH;;OAEG;;sCAhDY,qBAAqB;+CAkBX,gBAAgB;;EAoC5C"}
+{"version":3,"file":"useAudioSettings.d.ts","sourceRoot":"","sources":["../../src/hooks/useAudioSettings.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,qBAAqB,GAC7B,WAAW,GACX,SAAS,GACT,SAAS,GACT,UAAU,CAAC;AAEf,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,WAAW,CAAC;AAEzD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,qBAAqB,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAOF;;;;GAIG;AACH,wBAAgB,gBAAgB;IAyD5B;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;sCA5CY,qBAAqB;IA8CpC;;;;OAIG;+CArCsB,gBAAgB;IAuCzC;;;OAGG;;EAGN"}

package/build/hooks/useAudioSettings.js

@@ -4,6 +4,8 @@ import RNFishjamClientModule from '../RNFishjamClientModule';
 import { ReceivableEvents, useFishjamEvent } from './useFishjamEvent';
 /**
  * This hook manages audio settings.
+ * @category Devices
+ * @group Hooks
  */
 export function useAudioSettings() {
     const [selectedAudioOutputDevice, setSelectedAudioOutputDevice] = useState(null);
@@ -21,10 +23,6 @@ export function useAudioSettings() {
             }
         };
     }, [onAudioDevice]);
-    /**
-     * [Android only] selects output audio device.
-     * For detecting and selecting bluettoth devices make sure you have the BLUETOOTH_CONNECT permission.
-     */
     const selectOutputAudioDevice = useCallback(async (device) => {
         if (Platform.OS === 'ios') {
             throw Error('selectOutputAudioDevice function is supported only on Android. ' +
@@ -32,21 +30,12 @@ export function useAudioSettings() {
         }
         await RNFishjamClientModule.setOutputAudioDevice(device);
     }, []);
-    /**
-     * [iOS only] selects audio session mode. For more information refer to Apple's documentation:
-     *  https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/
-     *
-     */
     const selectAudioSessionMode = useCallback(async (audioSessionMode) => {
         if (Platform.OS === 'android') {
             throw Error('selectAudioSessionMode function is supported only on iOS');
         }
         await RNFishjamClientModule.selectAudioSessionMode(audioSessionMode);
     }, []);
-    /**
-     * [iOS only] Shows a picker modal that allows user to select output audio device. For more
-     * information refer to Apple's documentation: https://developer.apple.com/documentation/avkit/avroutepickerview
-     */
     const showAudioRoutePicker = useCallback(async () => {
         if (Platform.OS === 'android') {
             throw Error('showAudioRoutePicker function is supported only on iOS. ' +
@@ -63,8 +52,21 @@ export function useAudioSettings() {
          * [Android only] available audio output devices to be set
          */
         availableDevices,
+        /**
+         * [Android only] selects output audio device.
+         * For detecting and selecting bluettoth devices make sure you have the BLUETOOTH_CONNECT permission.
+         */
         selectOutputAudioDevice,
+        /**
+         * [iOS only] selects audio session mode. For more information refer to Apple's documentation:
+         *  https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/
+         *
+         */
         selectAudioSessionMode,
+        /**
+         * [iOS only] Shows a picker modal that allows user to select output audio device. For more
+         * information refer to Apple's documentation: https://developer.apple.com/documentation/avkit/avroutepickerview
+         */
         showAudioRoutePicker,
     };
 }

package/build/hooks/useAudioSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAudioSettings.js","sourceRoot":"","sources":["../../src/hooks/useAudioSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAoBtE;;GAEG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,CAAC,yBAAyB,EAAE,4BAA4B,CAAC,GAC7D,QAAQ,CAA2B,IAAI,CAAC,CAAC;IAC3C,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CACtD,EAAE,CACH,CAAC;IAEF,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,KAAyB,EAAE,EAAE;QAC9D,4BAA4B,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACnD,mBAAmB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC9C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,eAAe,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IAEnE,SAAS,CAAC,GAAG,EAAE;QACb,qBAAqB,CAAC,kBAAkB,EAAE,CAAC;QAC3C,OAAO,GAAG,EAAE;YACV,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC9B,qBAAqB,CAAC,iBAAiB,EAAE,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpB;;;OAGG;IACH,MAAM,uBAAuB,GAAG,WAAW,CACzC,KAAK,EAAE,MAA6B,EAAE,EAAE;QACtC,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;YAC1B,MAAM,KAAK,CACT,iEAAiE;gBAC/D,sGAAsG,CACzG,CAAC;QACJ,CAAC;QACD,MAAM,qBAAqB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC,EACD,EAAE,CACH,CAAC;IAEF;;;;OAIG;IACH,MAAM,sBAAsB,GAAG,WAAW,CACxC,KAAK,EAAE,gBAAkC,EAAE,EAAE;QAC3C,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,qBAAqB,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;IACvE,CAAC,EACD,EAAE,CACH,CAAC;IAEF;;;OAGG;IACH,MAAM,oBAAoB,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;QAClD,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,KAAK,CACT,0DAA0D;gBACxD,kFAAkF,CACrF,CAAC;QACJ,CAAC;QACD,MAAM,qBAAqB,CAAC,oBAAoB,EAAE,CAAC;IACrD,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACL;;WAEG;QACH,yBAAyB;QACzB;;WAEG;QACH,gBAAgB;QAChB,uBAAuB;QACvB,sBAAsB;QACtB,oBAAoB;KACrB,CAAC;AACJ,CAAC","sourcesContent":["import { useCallback, useEffect, useState } from 'react';\nimport { Platform } from 'react-native';\n\nimport RNFishjamClientModule from '../RNFishjamClientModule';\nimport { ReceivableEvents, useFishjamEvent } from './useFishjamEvent';\n\nexport type AudioOutputDeviceType =\n  | 'bluetooth'\n  | 'headset'\n  | 'speaker'\n  | 'earpiece';\n\nexport type AudioSessionMode = 'voiceChat' | 'videoChat';\n\nexport type AudioOutputDevice = {\n  type: AudioOutputDeviceType;\n  name: string;\n};\n\ntype OnAudioDeviceEvent = {\n  selectedDevice: AudioOutputDevice;\n  availableDevices: AudioOutputDevice[];\n};\n\n/**\n * This hook manages audio settings.\n */\nexport function useAudioSettings() {\n  const [selectedAudioOutputDevice, setSelectedAudioOutputDevice] =\n    useState<AudioOutputDevice | null>(null);\n  const [availableDevices, setAvailableDevices] = useState<AudioOutputDevice[]>(\n    [],\n  );\n\n  const onAudioDevice = useCallback((event: OnAudioDeviceEvent) => {\n    setSelectedAudioOutputDevice(event.selectedDevice);\n    setAvailableDevices(event.availableDevices);\n  }, []);\n\n  useFishjamEvent(ReceivableEvents.AudioDeviceUpdate, onAudioDevice);\n\n  useEffect(() => {\n    RNFishjamClientModule.startAudioSwitcher();\n    return () => {\n      if (Platform.OS === 'android') {\n        RNFishjamClientModule.stopAudioSwitcher();\n      }\n    };\n  }, [onAudioDevice]);\n\n  /**\n   * [Android only] selects output audio device.\n   * For detecting and selecting bluettoth devices make sure you have the BLUETOOTH_CONNECT permission.\n   */\n  const selectOutputAudioDevice = useCallback(\n    async (device: AudioOutputDeviceType) => {\n      if (Platform.OS === 'ios') {\n        throw Error(\n          'selectOutputAudioDevice function is supported only on Android. ' +\n            'To select an output audio device on iOS use selectAudioSessionMode or showAudioRoutePicker functions',\n        );\n      }\n      await RNFishjamClientModule.setOutputAudioDevice(device);\n    },\n    [],\n  );\n\n  /**\n   * [iOS only] selects audio session mode. For more information refer to Apple's documentation:\n   *  https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/\n   *\n   */\n  const selectAudioSessionMode = useCallback(\n    async (audioSessionMode: AudioSessionMode) => {\n      if (Platform.OS === 'android') {\n        throw Error('selectAudioSessionMode function is supported only on iOS');\n      }\n      await RNFishjamClientModule.selectAudioSessionMode(audioSessionMode);\n    },\n    [],\n  );\n\n  /**\n   * [iOS only] Shows a picker modal that allows user to select output audio device. For more\n   * information refer to Apple's documentation: https://developer.apple.com/documentation/avkit/avroutepickerview\n   */\n  const showAudioRoutePicker = useCallback(async () => {\n    if (Platform.OS === 'android') {\n      throw Error(\n        'showAudioRoutePicker function is supported only on iOS. ' +\n          'To select an output audio device on Android use selectOutputAudioDevice function',\n      );\n    }\n    await RNFishjamClientModule.showAudioRoutePicker();\n  }, []);\n\n  return {\n    /**\n     * currently selected output audio device\n     */\n    selectedAudioOutputDevice,\n    /**\n     * [Android only] available audio output devices to be set\n     */\n    availableDevices,\n    selectOutputAudioDevice,\n    selectAudioSessionMode,\n    showAudioRoutePicker,\n  };\n}\n"]}
+{"version":3,"file":"useAudioSettings.js","sourceRoot":"","sources":["../../src/hooks/useAudioSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,OAAO,qBAAqB,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAoBtE;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,CAAC,yBAAyB,EAAE,4BAA4B,CAAC,GAC7D,QAAQ,CAA2B,IAAI,CAAC,CAAC;IAC3C,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CACtD,EAAE,CACH,CAAC;IAEF,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,KAAyB,EAAE,EAAE;QAC9D,4BAA4B,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACnD,mBAAmB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC9C,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,eAAe,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IAEnE,SAAS,CAAC,GAAG,EAAE;QACb,qBAAqB,CAAC,kBAAkB,EAAE,CAAC;QAC3C,OAAO,GAAG,EAAE;YACV,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC9B,qBAAqB,CAAC,iBAAiB,EAAE,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpB,MAAM,uBAAuB,GAAG,WAAW,CACzC,KAAK,EAAE,MAA6B,EAAE,EAAE;QACtC,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;YAC1B,MAAM,KAAK,CACT,iEAAiE;gBAC/D,sGAAsG,CACzG,CAAC;QACJ,CAAC;QACD,MAAM,qBAAqB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC,EACD,EAAE,CACH,CAAC;IAEF,MAAM,sBAAsB,GAAG,WAAW,CACxC,KAAK,EAAE,gBAAkC,EAAE,EAAE;QAC3C,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,qBAAqB,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;IACvE,CAAC,EACD,EAAE,CACH,CAAC;IAEF,MAAM,oBAAoB,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;QAClD,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,KAAK,CACT,0DAA0D;gBACxD,kFAAkF,CACrF,CAAC;QACJ,CAAC;QACD,MAAM,qBAAqB,CAAC,oBAAoB,EAAE,CAAC;IACrD,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACL;;WAEG;QACH,yBAAyB;QACzB;;WAEG;QACH,gBAAgB;QAChB;;;WAGG;QACH,uBAAuB;QACvB;;;;WAIG;QACH,sBAAsB;QACtB;;;WAGG;QACH,oBAAoB;KACrB,CAAC;AACJ,CAAC","sourcesContent":["import { useCallback, useEffect, useState } from 'react';\nimport { Platform } from 'react-native';\n\nimport RNFishjamClientModule from '../RNFishjamClientModule';\nimport { ReceivableEvents, useFishjamEvent } from './useFishjamEvent';\n\nexport type AudioOutputDeviceType =\n  | 'bluetooth'\n  | 'headset'\n  | 'speaker'\n  | 'earpiece';\n\nexport type AudioSessionMode = 'voiceChat' | 'videoChat';\n\nexport type AudioOutputDevice = {\n  type: AudioOutputDeviceType;\n  name: string;\n};\n\ntype OnAudioDeviceEvent = {\n  selectedDevice: AudioOutputDevice;\n  availableDevices: AudioOutputDevice[];\n};\n\n/**\n * This hook manages audio settings.\n * @category Devices\n * @group Hooks\n */\nexport function useAudioSettings() {\n  const [selectedAudioOutputDevice, setSelectedAudioOutputDevice] =\n    useState<AudioOutputDevice | null>(null);\n  const [availableDevices, setAvailableDevices] = useState<AudioOutputDevice[]>(\n    [],\n  );\n\n  const onAudioDevice = useCallback((event: OnAudioDeviceEvent) => {\n    setSelectedAudioOutputDevice(event.selectedDevice);\n    setAvailableDevices(event.availableDevices);\n  }, []);\n\n  useFishjamEvent(ReceivableEvents.AudioDeviceUpdate, onAudioDevice);\n\n  useEffect(() => {\n    RNFishjamClientModule.startAudioSwitcher();\n    return () => {\n      if (Platform.OS === 'android') {\n        RNFishjamClientModule.stopAudioSwitcher();\n      }\n    };\n  }, [onAudioDevice]);\n\n  const selectOutputAudioDevice = useCallback(\n    async (device: AudioOutputDeviceType) => {\n      if (Platform.OS === 'ios') {\n        throw Error(\n          'selectOutputAudioDevice function is supported only on Android. ' +\n            'To select an output audio device on iOS use selectAudioSessionMode or showAudioRoutePicker functions',\n        );\n      }\n      await RNFishjamClientModule.setOutputAudioDevice(device);\n    },\n    [],\n  );\n\n  const selectAudioSessionMode = useCallback(\n    async (audioSessionMode: AudioSessionMode) => {\n      if (Platform.OS === 'android') {\n        throw Error('selectAudioSessionMode function is supported only on iOS');\n      }\n      await RNFishjamClientModule.selectAudioSessionMode(audioSessionMode);\n    },\n    [],\n  );\n\n  const showAudioRoutePicker = useCallback(async () => {\n    if (Platform.OS === 'android') {\n      throw Error(\n        'showAudioRoutePicker function is supported only on iOS. ' +\n          'To select an output audio device on Android use selectOutputAudioDevice function',\n      );\n    }\n    await RNFishjamClientModule.showAudioRoutePicker();\n  }, []);\n\n  return {\n    /**\n     * currently selected output audio device\n     */\n    selectedAudioOutputDevice,\n    /**\n     * [Android only] available audio output devices to be set\n     */\n    availableDevices,\n    /**\n     * [Android only] selects output audio device.\n     * For detecting and selecting bluettoth devices make sure you have the BLUETOOTH_CONNECT permission.\n     */\n    selectOutputAudioDevice,\n    /**\n     * [iOS only] selects audio session mode. For more information refer to Apple's documentation:\n     *  https://developer.apple.com/documentation/avfaudio/avaudiosession/mode/\n     *\n     */\n    selectAudioSessionMode,\n    /**\n     * [iOS only] Shows a picker modal that allows user to select output audio device. For more\n     * information refer to Apple's documentation: https://developer.apple.com/documentation/avkit/avroutepickerview\n     */\n    showAudioRoutePicker,\n  };\n}\n"]}

package/build/hooks/useBandwidthEstimation.d.ts

@@ -2,6 +2,8 @@
  * This hook provides current bandwidth estimation
  * estimation - client's available incoming bitrate estimated
  * by the server. It's measured in bits per second.
+ * @category Debugging
+ * @group Hooks
  */
 export declare function useBandwidthEstimation(): {
     estimation: number | null;

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

@@ -1 +1 @@
-{"version":3,"file":"useBandwidthEstimation.d.ts","sourceRoot":"","sources":["../../src/hooks/useBandwidthEstimation.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,wBAAgB,sBAAsB;;EAMrC"}
+{"version":3,"file":"useBandwidthEstimation.d.ts","sourceRoot":"","sources":["../../src/hooks/useBandwidthEstimation.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,wBAAgB,sBAAsB;;EAMrC"}

package/build/hooks/useBandwidthEstimation.js

@@ -4,6 +4,8 @@ import { ReceivableEvents, useFishjamEvent } from './useFishjamEvent';
  * This hook provides current bandwidth estimation
  * estimation - client's available incoming bitrate estimated
  * by the server. It's measured in bits per second.
+ * @category Debugging
+ * @group Hooks
  */
 export function useBandwidthEstimation() {
     const [estimation, setEstimation] = useState(null);

package/build/hooks/useBandwidthEstimation.js.map

@@ -1 +1 @@
-{"version":3,"file":"useBandwidthEstimation.js","sourceRoot":"","sources":["../../src/hooks/useBandwidthEstimation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEtE;;;;GAIG;AACH,MAAM,UAAU,sBAAsB;IACpC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IAElE,eAAe,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;IAErE,OAAO,EAAE,UAAU,EAAE,CAAC;AACxB,CAAC","sourcesContent":["import { useState } from 'react';\n\nimport { ReceivableEvents, useFishjamEvent } from './useFishjamEvent';\n\n/**\n * This hook provides current bandwidth estimation\n * estimation - client's available incoming bitrate estimated\n * by the server. It's measured in bits per second.\n */\nexport function useBandwidthEstimation() {\n  const [estimation, setEstimation] = useState<number | null>(null);\n\n  useFishjamEvent(ReceivableEvents.BandwidthEstimation, setEstimation);\n\n  return { estimation };\n}\n"]}
+{"version":3,"file":"useBandwidthEstimation.js","sourceRoot":"","sources":["../../src/hooks/useBandwidthEstimation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB;IACpC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IAElE,eAAe,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;IAErE,OAAO,EAAE,UAAU,EAAE,CAAC;AACxB,CAAC","sourcesContent":["import { useState } from 'react';\n\nimport { ReceivableEvents, useFishjamEvent } from './useFishjamEvent';\n\n/**\n * This hook provides current bandwidth estimation\n * estimation - client's available incoming bitrate estimated\n * by the server. It's measured in bits per second.\n * @category Debugging\n * @group Hooks\n */\nexport function useBandwidthEstimation() {\n  const [estimation, setEstimation] = useState<number | null>(null);\n\n  useFishjamEvent(ReceivableEvents.BandwidthEstimation, setEstimation);\n\n  return { estimation };\n}\n"]}

package/build/hooks/useCamera.d.ts

@@ -54,17 +54,61 @@ export type CameraConfigInternal = CameraConfigBase & {
 export declare function updateCameraConfig(config: Readonly<CameraConfig>): CameraConfigInternal;
 /**
  * This hook can toggle camera on/off and provides current camera state.
+ * @category Devices
+ * @group Hooks
  */
 export declare function useCamera(): {
+    /**
+     * Informs if user camera is streaming video
+     */
     isCameraOn: boolean;
+    /**
+     * Which camera is now used for streaming (or will be used as default when camera will be enabled)
+     */
     currentCamera: Camera | undefined;
+    /**
+     * Simulcast configuration
+     */
     simulcastConfig: SimulcastConfig;
+    /**
+     * Property that lists cameras available on device.
+     * @returns A promise that resolves to the list of available cameras.
+     */
     cameras: readonly Camera[];
+    /** Enable/disable current camera */
     toggleCamera: () => Promise<void>;
+    /**
+     * Prepares camera and starts local video track
+     * @param config configuration of the camera capture
+     * @returns A promise that resolves when camera is started.
+     */
     prepareCamera: (config?: Readonly<CameraConfig>) => Promise<void>;
-    switchCamera: (cameraId: CameraId) => Promise<void>;
+    /**
+     * Switches to the specified camera.
+     * List of available devices can be retrieved from `cameras` variable
+     * @returns A promise that resolves when camera is switched.
+     */ switchCamera: (cameraId: CameraId) => Promise<void>;
+    /**
+     * @deprecated
+     * toggles encoding of a video track on/off
+     * @param encoding encoding to toggle
+     */
     toggleVideoTrackEncoding: (encoding: TrackEncoding) => Promise<void>;
+    /**
+     * updates maximum bandwidth for the given simulcast encoding of the video track
+     * @param encoding  encoding to update
+     * @param bandwidth BandwidthLimit to set
+     * @deprecated
+     */
     setVideoTrackEncodingBandwidth: (encoding: TrackEncoding, bandwidth: BandwidthLimit) => Promise<void>;
+    /**
+     * updates maximum bandwidth for the video 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 BandwidthLimit to set
+     * @deprecated
+     */
     setVideoTrackBandwidth: (bandwidth: BandwidthLimit) => Promise<void>;
 };
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"useCamera.d.ts","sourceRoot":"","sources":["../../src/hooks/useCamera.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,cAAc,EACd,KAAK,EACL,uBAAuB,EACvB,eAAe,EACf,mBAAmB,EACnB,aAAa,EACd,MAAM,UAAU,CAAC;AAKlB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAEjD,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,MAAM,GAAG,aAAa,CAAC;AAErE,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,QAAQ,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,qBAAqB,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,OAAO,GACP,MAAM,GACN,OAAO,CAAC;AAEZ,KAAK,gBAAgB,GAAG;IACtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG;IAC5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAI5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,kBAAkB,CAAC,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,CAAC;IACzD;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,GAAG,CACE;IAAE,eAAe,CAAC,EAAE,cAAc,CAAA;CAAE,GACpC;IAAE,eAAe,CAAC,EAAE,uBAAuB,CAAA;CAAE,CAChD,CAAC;AAuCJ,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,GAC7B,oBAAoB,CAOtB;AAED;;GAEG;AACH,wBAAgB,SAAS;;;;;;6BAkCN,QAAQ,CAAC,YAAY,CAAC;6BAmCpB,QAAQ;yCA4BR,aAAa;+CAeb,aAAa,aAAa,cAAc;wCA3BvC,cAAc;EAkDnC"}
+{"version":3,"file":"useCamera.d.ts","sourceRoot":"","sources":["../../src/hooks/useCamera.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,cAAc,EACd,KAAK,EACL,uBAAuB,EACvB,eAAe,EACf,mBAAmB,EACnB,aAAa,EACd,MAAM,UAAU,CAAC;AAKlB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAEjD,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,MAAM,GAAG,aAAa,CAAC;AAErE,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,QAAQ,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,qBAAqB,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,OAAO,GACP,MAAM,GACN,OAAO,CAAC;AAEZ,KAAK,gBAAgB,GAAG;IACtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG;IAC5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAI5B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,kBAAkB,CAAC,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,CAAC;IACzD;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,GAAG,CACE;IAAE,eAAe,CAAC,EAAE,cAAc,CAAA;CAAE,GACpC;IAAE,eAAe,CAAC,EAAE,uBAAuB,CAAA;CAAE,CAChD,CAAC;AAuCJ,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,GAC7B,oBAAoB,CAOtB;AAED;;;;GAIG;AACH,wBAAgB,SAAS;IAsFrB;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;;OAGG;;IAGH,oCAAoC;;IAEpC;;;;OAIG;6BArFY,QAAQ,CAAC,YAAY,CAAC;IAuFrC;;;;OAIG,0BAhEc,QAAQ;IAkEzB;;;;OAIG;yCAvDc,aAAa;IAyD9B;;;;;OAKG;+CArDc,aAAa,aAAa,cAAc;IAuDzD;;;;;;;OAOG;wCA9Ee,cAAc;EAiFnC"}

package/build/hooks/useCamera.js

@@ -45,6 +45,8 @@ export function updateCameraConfig(config) {
 }
 /**
  * This hook can toggle camera on/off and provides current camera state.
+ * @category Devices
+ * @group Hooks
  */
 export function useCamera() {
     const [isCameraOn, setIsCameraOn] = useState(RNFishjamClientModule.isCameraOn);
@@ -52,18 +54,9 @@ export function useCamera() {
     const [simulcastConfig, setSimulcastConfig] = useState(defaultSimulcastConfig());
     useFishjamEvent(ReceivableEvents.SimulcastConfigUpdate, setSimulcastConfig);
     useFishjamEvent(ReceivableEvents.IsCameraOn, setIsCameraOn);
-    /**
-     * Property that lists cameras available on device.
-     * @returns A promise that resolves to the list of available cameras.
-     */
     const cameras = useMemo(() => {
         return RNFishjamClientModule.cameras;
     }, []);
-    /**
-     * Prepares camera and starts local camera capture.
-     * @param config configuration of the camera capture
-     * @returns A promise that resolves when camera is started.
-     */
     const prepareCamera = useCallback(async (config = {}) => {
         const camera = RNFishjamClientModule.cameras.find((camera) => config.cameraId
             ? camera.id === config.cameraId
@@ -75,9 +68,6 @@ export function useCamera() {
         });
         await RNFishjamClientModule.startCamera(updatedConfig);
     }, []);
-    /**
-     * Toggles camera on/off
-     */
     const toggleCamera = useCallback(async () => {
         const state = await RNFishjamClientModule.toggleCamera();
         await RNFishjamClientModule.updateVideoTrackMetadata({
@@ -86,54 +76,72 @@ export function useCamera() {
         });
         setIsCameraOn(state);
     }, []);
-    /**
-     * Switches to the specified camera.
-     * List of available devices can be retrieved from `cameras` variable
-     * @returns A promise that resolves when camera is switched.
-     */
     const switchCamera = useCallback(async (cameraId) => {
         await RNFishjamClientModule.switchCamera(cameraId);
         setCurrentCamera(cameras.find((camera) => camera.id === cameraId));
     }, [cameras]);
-    /**
-     * @deprecated
-     * updates maximum bandwidth for the video 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 BandwidthLimit to set
-     */
     const setVideoTrackBandwidth = useCallback(async (bandwidth) => {
         await RNFishjamClientModule.setVideoTrackBandwidth(bandwidth);
     }, []);
-    /**
-     * @deprecated
-     * toggles encoding of a video track on/off
-     * @param encoding encoding to toggle
-     */
     const toggleVideoTrackEncoding = useCallback(async (encoding) => {
         const videoSimulcastConfig = await RNFishjamClientModule.toggleVideoTrackEncoding(encoding);
         setSimulcastConfig(videoSimulcastConfig);
     }, []);
-    /**
-     * @deprecated
-     * updates maximum bandwidth for the given simulcast encoding of the video track
-     * @param encoding  encoding to update
-     * @param bandwidth BandwidthLimit to set
-     */
     const setVideoTrackEncodingBandwidth = useCallback(async (encoding, bandwidth) => {
         await RNFishjamClientModule.setVideoTrackEncodingBandwidth(encoding, bandwidth);
     }, []);
     return {
+        /**
+         * Informs if user camera is streaming video
+         */
         isCameraOn,
+        /**
+         * Which camera is now used for streaming (or will be used as default when camera will be enabled)
+         */
         currentCamera,
+        /**
+         * Simulcast configuration
+         */
         simulcastConfig,
+        /**
+         * Property that lists cameras available on device.
+         * @returns A promise that resolves to the list of available cameras.
+         */
         cameras,
+        /** Enable/disable current camera */
         toggleCamera,
+        /**
+         * Prepares camera and starts local video track
+         * @param config configuration of the camera capture
+         * @returns A promise that resolves when camera is started.
+         */
         prepareCamera,
-        switchCamera,
+        /**
+         * Switches to the specified camera.
+         * List of available devices can be retrieved from `cameras` variable
+         * @returns A promise that resolves when camera is switched.
+         */ switchCamera,
+        /**
+         * @deprecated
+         * toggles encoding of a video track on/off
+         * @param encoding encoding to toggle
+         */
         toggleVideoTrackEncoding,
+        /**
+         * updates maximum bandwidth for the given simulcast encoding of the video track
+         * @param encoding  encoding to update
+         * @param bandwidth BandwidthLimit to set
+         * @deprecated
+         */
         setVideoTrackEncodingBandwidth,
+        /**
+         * updates maximum bandwidth for the video 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 BandwidthLimit to set
+         * @deprecated
+         */
         setVideoTrackBandwidth,
     };
 }