@cloudflare/realtimekit-react 1.2.0-staging.2 → 1.2.0-staging.20

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import RTKClient, { RealtimeKitClientOptions } from '@cloudflare/realtimekit';
+import RTKClient, { RTKSelfMedia, MediaConstraints, CachedUserDetails, RTKClientOptions } from '@cloudflare/realtimekit';
 export { ActiveTab, ActiveTabType, AudioConsumerScoreStats, AudioMiddleware, AudioProducerScoreStats, BroadcastMessagePayload, ChatChannel, ChatUpdateParams, CustomMessage, DeviceConfig, FileMessage, ImageMessage, JoinedPeer, LeaveRoomState, LivestreamIngestionCredentials, LivestreamState, LogData, MediaConnectionState, MediaConnectionUpdate, MediaKind, MediaPermission, Message, ProducerScoreStats, RTKBasicParticipant, RTKChat, RTKConnectedMeetings, RTKLivestream, RTKMeta, RTKParticipant, RTKParticipantMap, RTKParticipants, RTKPermissionsPreset, RTKPlugin, RTKPluginMap, RTKPlugins, RTKPolls, RTKRecording, RTKSelf, RTKSelfMedia, RTKStore, RTKThemePreset, RecordingState, RequestToJoinType, SocketConnectionState, StageStatus, StartLivestreamConfig, TextMessage, VideoConsumerScoreStats, VideoMiddleware, VideoProducerScoreStats, VideoQualityConstraints, leaveRoomState } from '@cloudflare/realtimekit';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import React, { ReactNode } from 'react';
 
 type Listener = () => void;
@@ -17,7 +18,7 @@ declare const RealtimeKitContext: React.Context<{
     updates: RTKUpdates | undefined;
 }>;
 /**
- * Provider component which makes the RealtimeKit meeting object
+ * Provider component which makes the RealtimeKit object
  * available to nested components
  * @component
  * @param value The RealtimeKitClient instance from `useRealtimeKitClient()`
@@ -27,28 +28,35 @@ declare function RealtimeKitProvider({ value, children, fallback, }: {
     value: RTKClient | undefined;
     children: ReactNode;
     fallback?: ReactNode;
-}): React.JSX.Element;
+}): react_jsx_runtime.JSX.Element;
 /**
- * Hook which returns the reference to the RealtimeKit meeting object
- * @returns meeting instance
+ * Hook which returns the reference to the RealtimeKitClient object
+ * @returns meeting instance from `useRealtimeKitClient()`
  */
 declare const useRealtimeKitMeeting: () => {
     meeting: RTKClient;
 };
 
-interface DyteClientParams {
+interface RealtimeKitClientParams {
     resetOnLeave?: boolean;
 }
+type SelfMedia = Pick<RTKSelfMedia, 'addAudioMiddleware' | 'addVideoMiddleware' | 'audioEnabled' | 'audioTrack' | 'disableAudio' | 'disableScreenShare' | 'disableVideo' | 'enableAudio' | 'enableScreenShare' | 'enableVideo' | 'getAudioDevices' | 'getCurrentDevices' | 'getDeviceById' | 'getSpeakerDevices' | 'getVideoDevices' | 'init' | 'mediaPermissions' | 'rawAudioTrack' | 'rawVideoTrack' | 'removeAllAudioMiddlewares' | 'removeAllVideoMiddlewares' | 'removeVideoMiddleware' | 'removeAudioMiddleware' | 'screenShareEnabled' | 'screenShareTracks' | 'setDevice' | 'videoEnabled' | 'videoTrack' | 'setVideoMiddlewareGlobalConfig'>;
 /**
- * Hook to get and intialise an instance of RealtimeKit meeting object
+ * Hook to initialise media before initialising RTKClient
  */
-declare const useRealtimeKitClient: (dyteClientParams?: DyteClientParams) => readonly [RTKClient | undefined, (options: RealtimeKitClientOptions) => Promise<RTKClient | undefined>];
+declare const initRTKMedia: (options?: {
+    video?: boolean;
+    audio?: boolean;
+    constraints?: MediaConstraints;
+}, skipAwaits?: boolean, cachedUserDetails?: CachedUserDetails | undefined) => SelfMedia;
+/**
+ * Hook which manages a RTKClient instance
+ */
+declare const useRealtimeKitClient: (clientParams?: RealtimeKitClientParams) => [RTKClient, (options: RTKClientOptions) => Promise<RTKClient | undefined>];
 type StateSelector<T extends object, U> = (state: T) => U;
 /**
- * Hook which extracts data from the RealtimeKit meeting object and re-renders on change.
- * @param selector The selector function which takes the meeting object and returns a slice of state
- * @returns The slice of state returned by the selector function
+ * Hook which extracts data from the RTKClient object
  */
 declare const useRealtimeKitSelector: <StateSlice>(selector: StateSelector<RTKClient, StateSlice>) => StateSlice;
 
-export { RealtimeKitContext, RealtimeKitProvider, useRealtimeKitClient, useRealtimeKitMeeting, useRealtimeKitSelector };
+export { RealtimeKitContext, RealtimeKitProvider, SelfMedia, initRTKMedia, useRealtimeKitClient, useRealtimeKitMeeting, useRealtimeKitSelector };