@cloudflare/realtimekit 0.0.3 → 0.2.0

package/dist/index.d.ts

@@ -1978,8 +1978,6 @@ declare class ChatSocketHandler {
 }
 
 declare class RTKSelectedPeers {
-    private readonly _activeSpeakerPeers;
-    private readonly _compulsoryPeers;
     constructor();
     add(peerId: string, priority: number): number;
     delete(peerId: string): void;
@@ -1987,7 +1985,6 @@ declare class RTKSelectedPeers {
     get peers(): string[];
     get compulsoryPeers(): string[];
     get activeSpeakerPeers(): string[];
-    private _removeFromCompulsoryPeer;
 }
 
 type PipEvents = {
@@ -2001,40 +1998,15 @@ type PipEvents = {
 declare class RTKPip extends RTKTypedEventEmitter<PipEvents> {
     private constructor();
     static _init(context: Context<RTKContextState>, self: RTKSelf$1): Promise<RTKPip>;
-    private setupIcon;
     overrideIcon(icon: 'handRaise' | 'pin', value: string): Promise<void>;
-    private constructImage;
-    private createVideoContainer;
-    private setupEventListeners;
-    private cleanupEventListeners;
-    private enablePipMediaControls;
-    private onSelfVideoUpdateListener;
-    private onSelfAudioUpdateListener;
-    private handlePipMediaControls;
-    private createCanvas;
-    private eventCallback;
-    private setupMediaSessionEvents;
-    private mountAudioEvents;
-    private mountVideoEvents;
-    private unmountEvents;
-    private getSources;
-    private drawEmptyTile;
-    private drawIcons;
-    private drawTile;
-    private calcGridElemSize;
-    private paintCanvas;
-    private animate;
     isSupported(): boolean;
     get isActive(): boolean;
-    private cleanup;
     init({ height, width }?: {
         height?: number;
         width?: number;
     }): void;
-    private updateMediaSession;
     enableSource(source: string): void;
     disableSource(source: string): void;
-    private generateAvatar;
     addSource(id: string, element: HTMLVideoElement, enabled: boolean, pinned?: boolean, displayText?: string, imageUrl?: string, handRaised?: boolean): void;
     updateSource(id: string, source: any): void;
     removeSource(id: string): void;
@@ -2124,7 +2096,6 @@ declare class RoomSocketHandler {
         id: string;
         payload: Uint8Array;
     }>;
-    private handleSocketEvents;
     on(event: number, handler: (message: EventHandlerTypes) => void): void;
     getUserPermissions(userId: string): Promise<Pick<PresetTypeV2['permissions'], 'chat' | 'polls' | 'plugins'>>;
 }
@@ -2164,12 +2135,7 @@ interface HandlerSendResult extends GenericHandlerResult {
     mid: string;
 }
 declare abstract class HandlerInterface<TransportPromiseEvents> extends EnhancedEventEmitter<TransportPromiseEvents> {
-    protected _sendWebStream: MediaStream;
-    protected _sendScreenShareStream: MediaStream;
-    protected _direction?: 'send' | 'recv';
     pc: RTCPeerConnection;
-    protected _transportReady: boolean;
-    private readonly _mapMidTransceiver;
     enableHighBitrate: boolean;
     enableStereo: boolean;
     enableDtx: boolean;
@@ -2180,8 +2146,6 @@ declare abstract class HandlerInterface<TransportPromiseEvents> extends Enhanced
     init({ direction, iceServers, iceTransportPolicy, additionalSettings, proprietaryConstraints, onTrackHandler, }: HandlerRunOptions): void;
     connect(): Promise<GenericHandlerResult>;
     getTransportStats(): Promise<RTCStatsReport>;
-    protected _assertSendDirection(): void;
-    protected _assertRecvDirection(): void;
     getReceiverStats(localId: string): Promise<RTCStatsReport>;
     stopSending(localId: string): Promise<GenericHandlerResult>;
     abstract send(options: HandlerSendOptions): Promise<HandlerSendResult>;
@@ -2217,18 +2181,13 @@ declare enum MediaNodeType {
 type MediaConnectionState = {
     recv: {
         state: `${TransportState}`;
-        reconnected: boolean;
     };
     send: {
         state: `${TransportState}`;
-        reconnected: boolean;
     };
 };
 
 type TransportPromiseEvents = {
-    'connect': {
-        answer: RTCSessionDescriptionInit;
-    };
     'close': {
         answer: RTCSessionDescriptionInit;
     };
@@ -2430,13 +2389,10 @@ declare class RTKParticipant$1 extends RTKTypedEventEmitter<ParticipantEvents> {
     supportsRemoteControl: boolean;
     presetName?: string;
     get stageStatus(): StageStatus;
-    private get mediaJoined();
-    private get socketJoined();
     constructor(context: Context<RTKContextState>, participant: Participant, self: RTKSelf, roomSocket: RoomSocketHandler);
     setVideoEnabled(videoEnabled: boolean, emitEvent?: boolean): void;
     setAudioEnabled(audioEnabled: boolean, emitEvent?: boolean): void;
     setScreenShareEnabled(screenShareEnabled: boolean, emitEvent?: boolean): void;
-    private setupEvents;
     pin(): Promise<void>;
     unpin(): Promise<void>;
     setIsPinned(isPinned: boolean, emitEvent?: boolean): void;
@@ -2448,7 +2404,6 @@ declare class RTKParticipant$1 extends RTKTypedEventEmitter<ParticipantEvents> {
     get isPinned(): boolean;
     registerVideoElement(videoElem: HTMLVideoElement): void;
     deregisterVideoElement(videoElem: HTMLVideoElement): void;
-    private updateVideo;
 }
 
 type TranscriptionData = {
@@ -2517,7 +2472,6 @@ declare class RTKMeta$1 extends RTKTypedEventEmitter<MetaEvents> {
     get meetingId(): string;
     setBroadcastTabChanges(broadcastTabChanges: boolean): void;
     setSelfActiveTab(spotlightTab: ActiveTab, tabChangeSource: TabChangeSource): void;
-    private assertActiveTabToRoom;
 }
 
 interface RTKMapEvents<T extends EventMap> {
@@ -2610,6 +2564,25 @@ type BroadcastMessageTarget = {
 } | {
     meetingIds: string[];
 };
+type JoinedPeer = {
+    id: string;
+    userId: string;
+    name: string;
+    stageType?: StageStatus;
+    customParticipantId?: string;
+    presetId?: string;
+    picture?: string;
+    waitlisted: boolean;
+    recorderType?: string;
+    stageStatus?: StageStatus;
+    metadata?: {
+        preset_name?: string;
+    };
+    flags?: {
+        hiddenParticipant?: boolean;
+        recorder?: boolean;
+    };
+};
 type ParticipantsEvents = {
     ['viewModeChanged']: (payload: {
         viewMode: string;
@@ -2657,8 +2630,6 @@ declare class RTKParticipants$1 extends RTKTypedEventEmitter<ParticipantsEvents>
     readonly pinned: Readonly<RTKParticipantMap$1>;
     readonly all: Readonly<RTKBasicParticipantsMap>;
     get pip(): RTKPip;
-    private get socketJoined();
-    private get mediaJoined();
     rateLimitConfig: {
         maxInvocations: number;
         period: number;
@@ -2754,7 +2725,6 @@ declare class FetchClient {
         retryDelay: number;
         responseType?: string;
     });
-    private buildURL;
     request<T = any>(config: FetchRequestConfig): Promise<FetchResponse<T>>;
     get<T = any>(url: string, config?: FetchRequestConfig): Promise<FetchResponse<T>>;
     post<T = any>(url: string, data?: any, config?: FetchRequestConfig): Promise<FetchResponse<T>>;
@@ -2772,7 +2742,6 @@ declare class LocalMediaHandler extends RTKEventEmitter<LocalMediaEvents> {
     audioUpdateInProgress: boolean;
     videoUpdateInProgress: boolean;
     constructor(context: Context<RTKContextState>, mediaConstraints: MediaConstraints, isNonPreferredDevice?: (media: MediaDeviceInfo) => boolean, autoSwitchDevice?: boolean);
-    private onVisibilityChange;
     repopulateAvailableDevices(): Promise<boolean>;
     setupStreams({ audio, video, }: {
         audio: boolean;
@@ -2790,28 +2759,23 @@ declare class LocalMediaHandler extends RTKEventEmitter<LocalMediaEvents> {
     };
     getAllDevices(): Promise<InputDeviceInfo[]>;
     getDeviceById(deviceId: string, kind?: 'audioinput' | 'audiooutput' | 'videoinput'): Promise<MediaDeviceInfo>;
-    private onAudioTrackMuted;
-    private onAudioTrackChanged;
     get rawAudioTrack(): MediaStreamTrack;
     get audioTrack(): MediaStreamTrack;
     get audioEnabled(): boolean;
-    enableAudio(): Promise<void>;
+    enableAudio(customTrack?: MediaStreamTrack): Promise<void>;
     disableAudio(): void;
     getAudioDevices(devices?: MediaDeviceInfo[]): Promise<MediaDeviceInfo[]>;
     setAudioDevice(device: MediaDeviceInfo): Promise<void>;
     setupSpeaker(): Promise<void>;
     setSpeakerDevice(device: MediaDeviceInfo): Promise<void>;
-    private onVideoTrackChanged;
-    private onVideoTrackEnded;
     get rawVideoTrack(): MediaStreamTrack;
     get videoTrack(): MediaStreamTrack;
     get videoEnabled(): boolean;
-    enableVideo(): Promise<void>;
+    enableVideo(customTrack?: MediaStreamTrack): Promise<void>;
     disableVideo(): void;
     getVideoDevices(devices?: MediaDeviceInfo[]): Promise<MediaDeviceInfo[]>;
     setVideoDevice(device: MediaDeviceInfo): Promise<void>;
     updateVideoConstraints(resolution: VideoQualityConstraints): Promise<void>;
-    private onScreenShareEnded;
     get screenShareTracks(): {
         audio: MediaStreamTrack;
         video: MediaStreamTrack;
@@ -3108,7 +3072,6 @@ type PermissionEvents = {
 };
 declare class RTKPermissionsPreset$1 extends RTKTypedEventEmitter<PermissionEvents> {
     private constructor();
-    private setupEvents;
     static fromResponse(response: PresetPermissions, viewType: ViewType, context: Context<RTKContextState>): RTKPermissionsPreset$1;
     static default(context: Context<RTKContextState>, viewType: ViewType): RTKPermissionsPreset$1;
     static init(context: Context<RTKContextState>, viewType: ViewType, response?: PresetPermissions): RTKPermissionsPreset$1;
@@ -3191,7 +3154,6 @@ declare class RTKLivestream$1 extends RTKTypedEventEmitter<LivestreamEvents> {
     viewerCount: number;
     constructor(self: RTKSelf);
     setLivestreamState(livestreamState: LivestreamState): void;
-    private emitCurrentLivestreamState;
     start(livestreamConfig?: StartLivestreamConfig): Promise<void>;
     stop(): Promise<void>;
 }
@@ -3339,12 +3301,7 @@ declare class RTKChat$1 extends RTKTypedEventEmitter<ChatEvents> {
     channels: ChatChannel[];
     maxTextLimit: number;
     setMaxTextLimit(limit: number): void;
-    private get socketJoined();
     constructor(context: Context<RTKContextState>, chatSocketHandler: ChatSocketHandler, chatChannelSocketHandler: ChatChannelSocketHandler, self: RTKSelf$1, participants: RTKParticipants$1);
-    private sendMessageInternal;
-    private sendTextMessageInternal;
-    private sendImageMessageInternal;
-    private sendFileMessageInternal;
     get rateLimits(): {
         maxInvocations: number;
         period: number;
@@ -3422,7 +3379,6 @@ type PollsEvents = {
 };
 declare class RTKPolls$1 extends RTKTypedEventEmitter<PollsEvents> {
     items: Poll[];
-    private get socketJoined();
     constructor(context: Context<RTKContextState>, self: RTKSelf$1, pollSocketHandler: PollSocketHandler);
     create(question: string, options: string[], anonymous?: boolean, hideVotes?: boolean): Promise<void>;
     vote(id: string, index: number): Promise<void>;
@@ -3486,12 +3442,6 @@ declare class PluginSocketHandler {
 }
 
 declare class RTKSelfMedia extends RTKTypedEventEmitter<SelfEvents> {
-    protected localMediaHandler: LocalMediaHandler;
-    protected updatePermission(): Promise<void>;
-    protected populateMediaPermissionsInCallstats({ message, kind, }: {
-        message: keyof typeof MediaPermission;
-        kind: 'audio' | 'video' | 'screenshare';
-    }): Promise<void>;
     init(options?: {
             video?: boolean;
             audio?: boolean;
@@ -3917,6 +3867,10 @@ type LogData$2 = {
     };
     peerIds?: string[];
     producers?: ProducerState[];
+    sdp?: RTCSessionDescription['sdp'];
+    queueSizeAtStart?: number;
+    taskStartTime?: number;
+    subTasksSize?: number;
 };
 
 type EventSeverities = SupportedEventSeverities;
@@ -3984,14 +3938,12 @@ declare class RTKStore$1 {
         maxInvocations: number;
         period: number;
     };
-    private listeners;
     constructor({ name, socketHandler, meetingId }: {
         name: string;
         socketHandler: PluginSocketHandler;
         meetingId: string;
     });
     set(key: string, value: any, sync?: boolean, emit?: boolean): Promise<void>;
-    private remoteSet;
     bulkSet(data: {
         key: string;
         payload: any;
@@ -4034,7 +3986,6 @@ declare class MediaNodeClient {
     readonly context: Context<RTKContextState>;
     readonly authToken: string;
     readonly e2ee: boolean;
-    maxPreferredStreams: number;
     get peerId(): string;
     constructor(context: Context<RTKContextState>, nodeType: MediaNodeType, options: MediaNodeClientOptions);
     get mediaJoined(): boolean;
@@ -4047,15 +3998,11 @@ declare class MediaNodeClient {
     }, forceFullReset?: boolean, rejoining?: boolean): Promise<{
         roomJoined: boolean;
     }>;
-    private partialJoinRoomPromise;
     _partialJoinRoom(displayName: string, roomUuid: string, rejoining?: boolean, loc?: GeoLocation): Promise<void>;
     partialJoinRoom(displayName: string, roomUuid: string, rejoining?: boolean, loc?: GeoLocation): Promise<any>;
-    private _joinRoom;
-    private completeJoinRoom;
     leaveRoom(): Promise<void>;
     getConsumers(): Map<string, Consumer>;
     activatePeers(producers: ProducerState[]): Promise<void>;
-    deactivatePeers(producers: ProducerState[], mode?: 'manual' | 'default'): Promise<void>;
     createConsumers(producers: ProducerState[]): Promise<void>;
     closeConsumers(producers: ProducerState[]): Promise<void>;
     _shareWebcam(videoTrack: MediaStreamTrack & {
@@ -4080,8 +4027,8 @@ declare class MediaNodeClient {
     unmuteSelf(): Promise<void>;
     resetVideoProducers(videoTrack: MediaStreamTrack, screenShareTrack?: MediaStreamTrack): Promise<void>;
     changeDisplayName(displayName: string, peerId?: string): Promise<void>;
-    kick(peerId: string): Promise<void>;
-    kickAll(): Promise<void>;
+    kick(peerId: string): void;
+    kickAll(): void;
     muteAll(_allowUnMute: boolean): Promise<void>;
     muteAllVideo(): Promise<void>;
     disableAudio(peerId: string): Promise<void>;
@@ -4318,7 +4265,6 @@ declare class SocketService {
         capabilities: SocketServiceCapabilities;
     });
     updateURL(peerID: string): void;
-    private static getSocketEdgeDomain;
     get url(): string;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
@@ -4395,7 +4341,6 @@ type StageEvents = {
 declare class RTKStage extends RTKTypedEventEmitter<StageEvents> {
     constructor(context: Context<RTKContextState>, self: RTKSelf$1, participants: RTKParticipants, stageSocketHandler: StageSocketHandler, roomSocketHandler: RoomSocketHandler);
     get status(): StageStatus;
-    private setupEvents;
     getAccessRequests(): {
         stageRequests: StageRequestPayload[];
     };
@@ -4440,7 +4385,6 @@ declare class RTKSelf$1 extends RTKSelfMedia {
     private constructor();
     static __init__(context: Context<RTKContextState>, details: UserDetailsResponse, permissions: RTKPermissionsPreset$1, theme: RTKThemePreset$1, presetName: string, skipAwaits?: boolean): Promise<RTKSelf$1>;
     cleanupEvents(): void;
-    private setupEvents;
     get permissions(): RTKPermissionsPreset$1;
     get config(): RTKThemePreset$1;
     get roomJoined(): boolean;
@@ -4452,8 +4396,8 @@ declare class RTKSelf$1 extends RTKSelfMedia {
     }): Promise<void>;
     destructMediaHandler(): Promise<void>;
     removeDocumentEventListeners(): Promise<void>;
-    enableAudio(): Promise<void>;
-    enableVideo(): Promise<void>;
+    enableAudio(customTrack?: MediaStreamTrack): Promise<void>;
+    enableVideo(customTrack?: MediaStreamTrack): Promise<void>;
     updateVideoConstraints(resolution: VideoQualityConstraints): Promise<void>;
     enableScreenShare(): Promise<void>;
     updateScreenshareConstraints(resolution: VideoQualityConstraints): Promise<void>;
@@ -4471,7 +4415,6 @@ declare class RTKSelf$1 extends RTKSelfMedia {
     cleanUpTracks(): void;
     registerVideoElement(videoElem: HTMLVideoElement, isPreview?: boolean): void;
     deregisterVideoElement(videoElem: HTMLVideoElement, isPreview?: boolean): void;
-    private updateVideo;
 }
 
 interface RTKPluginResponse {
@@ -4579,11 +4522,9 @@ declare class RTKPlugin$1 extends RTKEventEmitter<PluginEvents> {
     enabledBy: string;
     constructor(context: Context<RTKContextState>, { baseURL, createdAt, description, id, name, organizationId, picture, private: isPrivate, published, staggered, tags, type, updatedAt, }: RTKPluginResponse, pluginSocketHandler: PluginSocketHandler, self: RTKSelf$1, participants: RTKParticipants$1, chat: Readonly<RTKChat$1>, meetingTitle: string);
     sendIframeEvent(message: PluginIframeMessage): void;
-    private handleIframeMessage;
     sendData(payload: SendDataOptions): void;
     removePluginView(viewId?: string): void;
     addPluginView(iframe: HTMLIFrameElement | ReactNativeWebView, viewId?: string): void;
-    private setActive;
     activateForSelf(): Promise<void>;
     deactivateForSelf(): void;
     enable(): Promise<void>;
@@ -4615,16 +4556,6 @@ interface APIOptions {
 }
 declare class API {
     ipInfo: any;
-    protected fetchClient: FetchClient;
-    protected requests: FetchClient;
-    protected roomName: string;
-    protected roomUUID: string;
-    protected authToken: string;
-    protected organizationId: string;
-    protected iceServers: IceServerInformation[];
-    protected pluginInformation: RTKPluginResponse[];
-    protected userDetails: UserDetailsResponseV2;
-    protected roomDetails: RoomDetails;
     get peerId(): string;
     context: Context<RTKContextState>;
     constructor(context: Context<RTKContextState>, options?: APIOptions);
@@ -4666,7 +4597,6 @@ declare class RTKConnectedMeetings$1 extends RTKTypedEventEmitter<ConnectedMeeti
     get supportsConnectedMeetings(): boolean;
     get isActive(): boolean;
     get currentMeetingId(): string;
-    private validateConnectedMeetingsAction;
     getConnectedMeetings(): Promise<{
         parentMeeting: ConnectedMeeting;
         meetings: ConnectedMeeting[];
@@ -4701,7 +4631,6 @@ declare class RTKConnectedMeetings$1 extends RTKTypedEventEmitter<ConnectedMeeti
         success: boolean;
         error: any;
     }>;
-    private moveSuccessHandler;
 }
 
 interface Overrides {
@@ -4721,7 +4650,6 @@ interface RealtimeKitClientOptions {
 declare class RealtimeKitClient {
     private constructor();
     static init(options: RealtimeKitClientOptions): Promise<RealtimeKitClient>;
-    private static setupContext;
     join(): Promise<void>;
     leave(state?: LeaveRoomState): Promise<void>;
     get participants(): Readonly<RTKParticipants$1>;
@@ -4741,13 +4669,27 @@ declare class RealtimeKitClient {
     leaveRoom(state?: LeaveRoomState): Promise<void>;
 }
 
+declare enum RequestToJoinType {
+    PRESENT = "REQUEST_TO_PRESENT"
+}
+
 type RTKParticipant = Readonly<RTKParticipant$1>;
 
 type RTKParticipants = Readonly<RTKParticipants$1>;
 type RTKParticipantMap = Readonly<RTKParticipantMap$1>;
 
 type RTKPlugin = Readonly<RTKPlugin$1>;
+type RTKPlugins = Readonly<RTKPlugins$1>;
+type RTKPluginMap = Readonly<RTKPluginMap$1>;
+type RTKMeta = Readonly<RTKMeta$1>;
 type RTKSelf = Readonly<RTKSelf$1>;
+type RTKChat = Readonly<RTKChat$1>;
+type RTKPolls = Readonly<RTKPolls$1>;
+type RTKRecording = Readonly<RTKRecording$1>;
+
+type RTKLivestream = Readonly<RTKLivestream$1>;
+
+type RTKStore = RTKStore$1;
 
 type RTKConnectedMeetings = Readonly<RTKConnectedMeetings$1>;
 
@@ -4772,4 +4714,4 @@ declare global {
     }
 }
 
-export { ActiveTab, ActiveTabType, AudioProducerScoreStats, ChatChannel, ChatUpdateParams, CustomMessage, DeviceConfig, RTKBasicParticipant, RealtimeKitClientOptions, RTKConnectedMeetings, RTKParticipant, RTKParticipantMap, RTKParticipants, RTKPermissionsPreset, RTKPlugin, RTKSelf, RTKSelfMedia, RTKThemePreset, FileMessage, ImageMessage, LivestreamState, MediaConnectionState, MediaKind$1 as MediaKind, Message, ProducerScoreStats, RecordingState, SocketConnectionState, StageStatus, TextMessage, VideoProducerScoreStats, RealtimeKitClient as default, LeaveRoomState as leaveRoomState };
+export { ActiveTab, ActiveTabType, AudioConsumerScoreStats, AudioMiddleware, AudioProducerScoreStats, BroadcastMessagePayload, ChatChannel, ChatUpdateParams, CustomMessage, DeviceConfig, RTKBasicParticipant, RTKChat, RealtimeKitClientOptions, RTKConnectedMeetings, RTKLivestream, RTKMeta, RTKParticipant, RTKParticipantMap, RTKParticipants, RTKPermissionsPreset, RTKPlugin, RTKPluginMap, RTKPlugins, RTKPolls, RTKRecording, RTKSelf, RTKStore, RTKThemePreset, FileMessage, ImageMessage, JoinedPeer, LeaveRoomState, LivestreamIngestionCredentials, LivestreamState, LogData, MediaConnectionState, MediaConnectionUpdate, MediaKind$1 as MediaKind, MediaPermission, Message, ProducerScoreStats, RTKSelfMedia as RTKSelfMedia, RecordingState, RequestToJoinType, SocketConnectionState, StageStatus, StartLivestreamConfig, TextMessage, VideoConsumerScoreStats, VideoMiddleware, VideoProducerScoreStats, VideoQualityConstraints, RealtimeKitClient as default, LeaveRoomState as leaveRoomState };