@cloudflare/realtimekit 2.0.3-staging.16 → 2.0.3-staging.17

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/dist/index.d.ts CHANGED
@@ -2638,6 +2638,104 @@ declare class FetchClient {
2638
2638
  put<T = any>(url: string, data?: any, config?: FetchRequestConfig): Promise<FetchResponse<T>>;
2639
2639
  }
2640
2640
 
2641
+ type ProducerHandoverPayload = {
2642
+ oldPeerId: string;
2643
+ newPeerId: string;
2644
+ producerIds: string[];
2645
+ };
2646
+ type RoomJoinAttemptStates = {
2647
+ wasSocketJoinAttempted: boolean;
2648
+ wasMediaJoinAttempted: boolean;
2649
+ };
2650
+ declare enum SessionEvents {
2651
+ NEW_PRODUCER = "NEW_PRODUCER",
2652
+ PRODUCER_HANDOVER = "PRODUCER_HANDOVER",
2653
+ ROOM_NODE_CONNECTION_ERROR = "ROOM_NODE_CONNECTION_ERROR",
2654
+ SOCKET_SERVICE_ROOM_JOINED = "SOCKET_SERVICE_ROOM_JOINED",
2655
+ SOCKET_SERVICE_RECONNECTED = "SOCKET_SERVICE_RECONNECTED",
2656
+ SOCKET_SERVICE_DISCONNECTED = "SOCKET_SERVICE_DISCONNECTED",
2657
+ SOCKET_SERVICE_FAILED = "SOCKET_SERVICE_FAILED",
2658
+ SOCKET_STATE_UPDATE = "SOCKET_STATE_UPDATE",
2659
+ ROOM_NODE_RECONNECTED = "ROOM_NODE_RECONNECTED",
2660
+ ROOM_NODE_DISCONNECTED = "ROOM_NODE_DISCONNECTED",
2661
+ ROOM_NODE_FAILED = "ROOM_NODE_FAILED",
2662
+ MEDIA_ROOM_JOIN_FAILED = "MEDIA_ROOM_JOIN_FAILED",
2663
+ TRANSPORT_STATE_UPDATE = "TRANSPORT_STATE_UPDATE",
2664
+ PRODUCER_SCORE_UPDATE = "PRODUCER_SCORE_UPDATE",
2665
+ CONSUMER_SCORE_UPDATE = "CONSUMER_SCORE_UPDATE",
2666
+ PRODUCER_STATUS_UPDATE = "PRODUCER_STATUS_UPDATE",
2667
+ CONSUMER_STATUS_UPDATE = "CONSUMER_STATUS_UPDATE",
2668
+ LOW_CONSUMER_SCORE = "LOW_CONSUMER_SCORE",
2669
+ MEDIA_PERMISSION_ERROR = "MEDIA_PERMISSION_ERROR",
2670
+ MEDIA_PERMISSION_UPDATE = "MEDIA_PERMISSION_UPDATE",
2671
+ MESSAGE = "websocket/message",
2672
+ ROOM_MESSAGE = "websocket/room-message",
2673
+ PEER_JOINED_INTERNAL = "peer/joined-internal",
2674
+ PEER_CLOSED = "websocket/peer-closed",
2675
+ CONSUMER_CLOSED = "websocket/consumer-closed",
2676
+ CONSUMER_PAUSED = "websocket/consumer-paused",
2677
+ CONSUMER_RESUMED = "websocket/consumer-resumed",
2678
+ NEW_CONSUMER_CREATED = "NEW_CONSUMER_CREATED",
2679
+ PRODUCER_CLOSED = "websocket/producer-closed",
2680
+ PRODUCER_SCORE = "websocket/producer-score",
2681
+ CONSUMER_SCORE = "websocket/consumer-score",
2682
+ PRODUCER_TOGGLE = "cf/producer-toggle",
2683
+ UPDATE_ACTIVE = "media/update-active",
2684
+ RESET_PRODUCER_STATE = "cf/reset-producer-state",
2685
+ ROOM_STATE = "sockethub/room-state",
2686
+ GET_STAGE_REQUESTS = "GET_STAGE_REQUESTS",
2687
+ UPDATE_STAGE_REQUESTS = "UPDATE_STAGE_REQUESTS",
2688
+ KICK_PEER = "KICK_PEER",
2689
+ UPDATE_PEER_STAGE_STATUS = "UPDATE_PEER_STAGE_STATUS",
2690
+ JOIN_MEDIA_ROOM = "JOIN_MEDIA_ROOM",
2691
+ LEAVE_MEDIA_ROOM = "LEAVE_MEDIA_ROOM",
2692
+ PIP_HANGUP = "PIP_HANGUP",
2693
+ E2EE_ACTIVE_PRODUCER = "E2EE_ACTIVE_PRODUCER",
2694
+ E2EE_INACTIVE_PRODUCER = "E2EE_INACTIVE_PRODUCER",
2695
+ E2EE_ACTIVE_CONSUMER = "E2EE_ACTIVE_CONSUMER",
2696
+ E2EE_INACTIVE_CONSUMER = "E2EE_INACTIVE_CONSUMER",
2697
+ ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER = "ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER",
2698
+ SOCKET_PEERS = "SOCKET_PEERS",
2699
+ UPDATE_PERMISSIONS = "UPDATE_PERMISSIONS",
2700
+ MAX_SPATIAL_LAYER_CHANGE = "MAX_SPATIAL_LAYER_CHANGE",
2701
+ MUTE_SELF = "MUTE_SELF",
2702
+ MUTE_SELF_VIDEO = "MUTE_SELF_VIDEO"
2703
+ }
2704
+ type AllEvents = {
2705
+ [key in SessionEvents]: (payload?: any) => void;
2706
+ };
2707
+ type TypedEvents = {
2708
+ [SessionEvents.SOCKET_SERVICE_RECONNECTED]: (payload: RoomJoinAttemptStates) => void;
2709
+ [SessionEvents.PRODUCER_HANDOVER]: (payload: ProducerHandoverPayload) => void;
2710
+ [SessionEvents.TRANSPORT_STATE_UPDATE]: (payload: MediaConnectionUpdate) => void;
2711
+ [SessionEvents.UPDATE_PERMISSIONS]: (p: PresetUpdates) => void;
2712
+ [SessionEvents.MAX_SPATIAL_LAYER_CHANGE]: (p: {
2713
+ peerId: string;
2714
+ maxSpatialLayer: number;
2715
+ }) => void;
2716
+ [SessionEvents.UPDATE_ACTIVE]: (p?: {
2717
+ viewMode?: ViewMode;
2718
+ page?: number;
2719
+ }) => void;
2720
+ [SessionEvents.PEER_JOINED_INTERNAL]: (p: Participant) => void;
2721
+ [SessionEvents.UPDATE_PEER_STAGE_STATUS]: (p: {
2722
+ id: string;
2723
+ status: string;
2724
+ }) => void;
2725
+ [SessionEvents.GET_STAGE_REQUESTS]: (stageRequests: StageRequest[]) => void;
2726
+ [SessionEvents.UPDATE_STAGE_REQUESTS]: (payload: {
2727
+ request: StageRequestPayload;
2728
+ add: boolean;
2729
+ }) => void;
2730
+ [SessionEvents.KICK_PEER]: (payload: {
2731
+ peerId: string;
2732
+ }) => void;
2733
+ [SessionEvents.JOIN_MEDIA_ROOM]: () => void;
2734
+ [SessionEvents.LEAVE_MEDIA_ROOM]: (state: LeaveRoomState) => void;
2735
+ };
2736
+ type UntypedEvents = Omit<AllEvents, keyof TypedEvents>;
2737
+ type SessionEventsType = TypedEvents & UntypedEvents;
2738
+
2641
2739
  interface ResponseStatus {
2642
2740
  success: boolean;
2643
2741
  message: string;
@@ -3042,10 +3140,13 @@ declare class SelfController {
3042
3140
  private waitlistedHandler;
3043
3141
  private waitlistAcceptHandler;
3044
3142
  private waitlistRejectedHandler;
3045
- resetSelf(shouldAutoJoin: boolean): Promise<void>;
3143
+ resetSelf(joinAttempts: RoomJoinAttemptStates): Promise<void>;
3046
3144
  private setupEvents;
3047
3145
  private joinSocketRoomWithRetry;
3048
- joinRoom(reconnected?: boolean): Promise<void>;
3146
+ joinRoom({ reconnected, joinAttempts, }?: {
3147
+ reconnected?: boolean;
3148
+ joinAttempts?: RoomJoinAttemptStates;
3149
+ }): Promise<void>;
3049
3150
  leaveRoom(state?: LeaveRoomState): Promise<void>;
3050
3151
  private joinMediaRoom;
3051
3152
  private leaveMediaRoom;
@@ -4016,99 +4117,6 @@ interface TypedEventEmitter<Events extends EventMap> {
4016
4117
  reset(): void;
4017
4118
  }
4018
4119
 
4019
- type ProducerHandoverPayload = {
4020
- oldPeerId: string;
4021
- newPeerId: string;
4022
- producerIds: string[];
4023
- };
4024
- declare enum SessionEvents {
4025
- NEW_PRODUCER = "NEW_PRODUCER",
4026
- PRODUCER_HANDOVER = "PRODUCER_HANDOVER",
4027
- ROOM_NODE_CONNECTION_ERROR = "ROOM_NODE_CONNECTION_ERROR",
4028
- SOCKET_SERVICE_ROOM_JOINED = "SOCKET_SERVICE_ROOM_JOINED",
4029
- SOCKET_SERVICE_RECONNECTED = "SOCKET_SERVICE_RECONNECTED",
4030
- SOCKET_SERVICE_DISCONNECTED = "SOCKET_SERVICE_DISCONNECTED",
4031
- SOCKET_SERVICE_FAILED = "SOCKET_SERVICE_FAILED",
4032
- SOCKET_STATE_UPDATE = "SOCKET_STATE_UPDATE",
4033
- ROOM_NODE_RECONNECTED = "ROOM_NODE_RECONNECTED",
4034
- ROOM_NODE_DISCONNECTED = "ROOM_NODE_DISCONNECTED",
4035
- ROOM_NODE_FAILED = "ROOM_NODE_FAILED",
4036
- MEDIA_ROOM_JOIN_FAILED = "MEDIA_ROOM_JOIN_FAILED",
4037
- TRANSPORT_STATE_UPDATE = "TRANSPORT_STATE_UPDATE",
4038
- PRODUCER_SCORE_UPDATE = "PRODUCER_SCORE_UPDATE",
4039
- CONSUMER_SCORE_UPDATE = "CONSUMER_SCORE_UPDATE",
4040
- PRODUCER_STATUS_UPDATE = "PRODUCER_STATUS_UPDATE",
4041
- CONSUMER_STATUS_UPDATE = "CONSUMER_STATUS_UPDATE",
4042
- LOW_CONSUMER_SCORE = "LOW_CONSUMER_SCORE",
4043
- MEDIA_PERMISSION_ERROR = "MEDIA_PERMISSION_ERROR",
4044
- MEDIA_PERMISSION_UPDATE = "MEDIA_PERMISSION_UPDATE",
4045
- MESSAGE = "websocket/message",
4046
- ROOM_MESSAGE = "websocket/room-message",
4047
- PEER_JOINED_INTERNAL = "peer/joined-internal",
4048
- PEER_CLOSED = "websocket/peer-closed",
4049
- CONSUMER_CLOSED = "websocket/consumer-closed",
4050
- CONSUMER_PAUSED = "websocket/consumer-paused",
4051
- CONSUMER_RESUMED = "websocket/consumer-resumed",
4052
- NEW_CONSUMER_CREATED = "NEW_CONSUMER_CREATED",
4053
- PRODUCER_CLOSED = "websocket/producer-closed",
4054
- PRODUCER_SCORE = "websocket/producer-score",
4055
- CONSUMER_SCORE = "websocket/consumer-score",
4056
- PRODUCER_TOGGLE = "cf/producer-toggle",
4057
- UPDATE_ACTIVE = "media/update-active",
4058
- RESET_PRODUCER_STATE = "cf/reset-producer-state",
4059
- ROOM_STATE = "sockethub/room-state",
4060
- GET_STAGE_REQUESTS = "GET_STAGE_REQUESTS",
4061
- UPDATE_STAGE_REQUESTS = "UPDATE_STAGE_REQUESTS",
4062
- KICK_PEER = "KICK_PEER",
4063
- UPDATE_PEER_STAGE_STATUS = "UPDATE_PEER_STAGE_STATUS",
4064
- JOIN_MEDIA_ROOM = "JOIN_MEDIA_ROOM",
4065
- LEAVE_MEDIA_ROOM = "LEAVE_MEDIA_ROOM",
4066
- PIP_HANGUP = "PIP_HANGUP",
4067
- E2EE_ACTIVE_PRODUCER = "E2EE_ACTIVE_PRODUCER",
4068
- E2EE_INACTIVE_PRODUCER = "E2EE_INACTIVE_PRODUCER",
4069
- E2EE_ACTIVE_CONSUMER = "E2EE_ACTIVE_CONSUMER",
4070
- E2EE_INACTIVE_CONSUMER = "E2EE_INACTIVE_CONSUMER",
4071
- ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER = "ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER",
4072
- SOCKET_PEERS = "SOCKET_PEERS",
4073
- UPDATE_PERMISSIONS = "UPDATE_PERMISSIONS",
4074
- MAX_SPATIAL_LAYER_CHANGE = "MAX_SPATIAL_LAYER_CHANGE",
4075
- MUTE_SELF = "MUTE_SELF",
4076
- MUTE_SELF_VIDEO = "MUTE_SELF_VIDEO"
4077
- }
4078
- type AllEvents = {
4079
- [key in SessionEvents]: (payload?: any) => void;
4080
- };
4081
- type TypedEvents = {
4082
- [SessionEvents.PRODUCER_HANDOVER]: (payload: ProducerHandoverPayload) => void;
4083
- [SessionEvents.TRANSPORT_STATE_UPDATE]: (payload: MediaConnectionUpdate) => void;
4084
- [SessionEvents.UPDATE_PERMISSIONS]: (p: PresetUpdates) => void;
4085
- [SessionEvents.MAX_SPATIAL_LAYER_CHANGE]: (p: {
4086
- peerId: string;
4087
- maxSpatialLayer: number;
4088
- }) => void;
4089
- [SessionEvents.UPDATE_ACTIVE]: (p?: {
4090
- viewMode?: ViewMode;
4091
- page?: number;
4092
- }) => void;
4093
- [SessionEvents.PEER_JOINED_INTERNAL]: (p: Participant) => void;
4094
- [SessionEvents.UPDATE_PEER_STAGE_STATUS]: (p: {
4095
- id: string;
4096
- status: string;
4097
- }) => void;
4098
- [SessionEvents.GET_STAGE_REQUESTS]: (stageRequests: StageRequest[]) => void;
4099
- [SessionEvents.UPDATE_STAGE_REQUESTS]: (payload: {
4100
- request: StageRequestPayload;
4101
- add: boolean;
4102
- }) => void;
4103
- [SessionEvents.KICK_PEER]: (payload: {
4104
- peerId: string;
4105
- }) => void;
4106
- [SessionEvents.JOIN_MEDIA_ROOM]: () => void;
4107
- [SessionEvents.LEAVE_MEDIA_ROOM]: (state: LeaveRoomState) => void;
4108
- };
4109
- type UntypedEvents = Omit<AllEvents, keyof TypedEvents>;
4110
- type SessionEventsType = TypedEvents & UntypedEvents;
4111
-
4112
4120
  type ErrorCallback = (error: Error) => void;
4113
4121
  declare class AudioPlayback {
4114
4122
  constructor();