@cloudflare/realtimekit-react 1.2.3-staging.2 → 1.2.3-staging.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/dist/index.d.ts +0 -62
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloudflare/realtimekit-react",
|
|
3
|
-
"version": "1.2.3-staging.
|
|
3
|
+
"version": "1.2.3-staging.3",
|
|
4
4
|
"description": "A real-time video and audio SDK for building custom, collaborative communication experiences.",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"module": "./dist/index.es.js",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
},
|
|
18
18
|
"private": false,
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@cloudflare/realtimekit": "1.2.3-staging.
|
|
20
|
+
"@cloudflare/realtimekit": "1.2.3-staging.3"
|
|
21
21
|
},
|
|
22
22
|
"peerDependencies": {
|
|
23
23
|
"react": ">=16.8.6"
|
package/dist/index.d.ts
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
import RTKClient, { RTKSelfMedia, MediaConstraints, CachedUserDetails, RTKClientOptions } from '@cloudflare/realtimekit';
|
|
2
|
-
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';
|
|
3
|
-
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
4
|
-
import React, { ReactNode } from 'react';
|
|
5
|
-
|
|
6
|
-
type Listener = () => void;
|
|
7
|
-
declare class RTKUpdates {
|
|
8
|
-
private meeting;
|
|
9
|
-
private l;
|
|
10
|
-
constructor(meeting: RTKClient);
|
|
11
|
-
clean(): void;
|
|
12
|
-
addListener(listener: Listener): void;
|
|
13
|
-
removeListener(listener: Listener): void;
|
|
14
|
-
private onUpdate;
|
|
15
|
-
}
|
|
16
|
-
declare const RealtimeKitContext: React.Context<{
|
|
17
|
-
meeting: RTKClient | undefined;
|
|
18
|
-
updates: RTKUpdates | undefined;
|
|
19
|
-
}>;
|
|
20
|
-
/**
|
|
21
|
-
* Provider component which makes the RealtimeKit object
|
|
22
|
-
* available to nested components
|
|
23
|
-
* @component
|
|
24
|
-
* @param value The RealtimeKitClient instance from `useRealtimeKitClient()`
|
|
25
|
-
* @param fallback Any fallback UI you want to render until the instance initialises.
|
|
26
|
-
*/
|
|
27
|
-
declare function RealtimeKitProvider({ value, children, fallback, }: {
|
|
28
|
-
value: RTKClient | undefined;
|
|
29
|
-
children: ReactNode;
|
|
30
|
-
fallback?: ReactNode;
|
|
31
|
-
}): react_jsx_runtime.JSX.Element;
|
|
32
|
-
/**
|
|
33
|
-
* Hook which returns the reference to the RealtimeKitClient object
|
|
34
|
-
* @returns meeting instance from `useRealtimeKitClient()`
|
|
35
|
-
*/
|
|
36
|
-
declare const useRealtimeKitMeeting: () => {
|
|
37
|
-
meeting: RTKClient;
|
|
38
|
-
};
|
|
39
|
-
|
|
40
|
-
interface RealtimeKitClientParams {
|
|
41
|
-
resetOnLeave?: boolean;
|
|
42
|
-
}
|
|
43
|
-
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'>;
|
|
44
|
-
/**
|
|
45
|
-
* Hook to initialise media before initialising RTKClient
|
|
46
|
-
*/
|
|
47
|
-
declare const initRTKMedia: (options?: {
|
|
48
|
-
video?: boolean;
|
|
49
|
-
audio?: boolean;
|
|
50
|
-
constraints?: MediaConstraints;
|
|
51
|
-
}, skipAwaits?: boolean, cachedUserDetails?: CachedUserDetails | undefined) => SelfMedia;
|
|
52
|
-
/**
|
|
53
|
-
* Hook which manages a RTKClient instance
|
|
54
|
-
*/
|
|
55
|
-
declare const useRealtimeKitClient: (clientParams?: RealtimeKitClientParams) => [RTKClient, (options: RTKClientOptions) => Promise<RTKClient | undefined>];
|
|
56
|
-
type StateSelector<T extends object, U> = (state: T) => U;
|
|
57
|
-
/**
|
|
58
|
-
* Hook which extracts data from the RTKClient object
|
|
59
|
-
*/
|
|
60
|
-
declare const useRealtimeKitSelector: <StateSlice>(selector: StateSelector<RTKClient, StateSlice>) => StateSlice;
|
|
61
|
-
|
|
62
|
-
export { RealtimeKitContext, RealtimeKitProvider, SelfMedia, initRTKMedia, useRealtimeKitClient, useRealtimeKitMeeting, useRealtimeKitSelector };
|