plugnmeet-protocol-js 1.3.1-9 → 1.4.0
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.cjs.js +157 -57
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +281 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs.js +158 -58
- package/dist/index.mjs.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -436,7 +436,11 @@ export enum AnalyticsEvents {
|
|
|
436
436
|
/**
|
|
437
437
|
* @generated from enum value: ANALYTICS_EVENT_USER_CONNECTION_QUALITY = 30;
|
|
438
438
|
*/
|
|
439
|
-
ANALYTICS_EVENT_USER_CONNECTION_QUALITY = 30
|
|
439
|
+
ANALYTICS_EVENT_USER_CONNECTION_QUALITY = 30,
|
|
440
|
+
/**
|
|
441
|
+
* @generated from enum value: ANALYTICS_EVENT_USER_REACTION = 40;
|
|
442
|
+
*/
|
|
443
|
+
ANALYTICS_EVENT_USER_REACTION = 40
|
|
440
444
|
}
|
|
441
445
|
/**
|
|
442
446
|
* Describes the enum plugnmeet.AnalyticsEvents.
|
|
@@ -588,7 +592,11 @@ export enum DataMsgBodyType {
|
|
|
588
592
|
/**
|
|
589
593
|
* @generated from enum value: RES_PUBLIC_CHAT_DATA = 19;
|
|
590
594
|
*/
|
|
591
|
-
RES_PUBLIC_CHAT_DATA = 19
|
|
595
|
+
RES_PUBLIC_CHAT_DATA = 19,
|
|
596
|
+
/**
|
|
597
|
+
* @generated from enum value: REACTION = 20;
|
|
598
|
+
*/
|
|
599
|
+
REACTION = 20
|
|
592
600
|
}
|
|
593
601
|
/**
|
|
594
602
|
* Describes the enum plugnmeet.DataMsgBodyType.
|
|
@@ -2395,6 +2403,13 @@ type ParticipantInfo = Message<"livekit.ParticipantInfo"> & {
|
|
|
2395
2403
|
* @generated from field: int32 client_protocol = 20;
|
|
2396
2404
|
*/
|
|
2397
2405
|
clientProtocol: number;
|
|
2406
|
+
/**
|
|
2407
|
+
* capabilities the participant's client advertises, mirrored from ClientInfo.
|
|
2408
|
+
* Lets other participants perform client-side feature detection.
|
|
2409
|
+
*
|
|
2410
|
+
* @generated from field: repeated livekit.ClientInfo.Capability capabilities = 21;
|
|
2411
|
+
*/
|
|
2412
|
+
capabilities: ClientInfo_Capability[];
|
|
2398
2413
|
};
|
|
2399
2414
|
/**
|
|
2400
2415
|
* @generated from enum livekit.ParticipantInfo.State
|
|
@@ -2696,6 +2711,210 @@ type DataTrackInfo = Message<"livekit.DataTrackInfo"> & {
|
|
|
2696
2711
|
* @generated from field: livekit.Encryption.Type encryption = 4;
|
|
2697
2712
|
*/
|
|
2698
2713
|
encryption: Encryption_Type;
|
|
2714
|
+
/**
|
|
2715
|
+
* Encoding for frame payloads on this track. If unspecified, the track is untyped.
|
|
2716
|
+
*
|
|
2717
|
+
* @generated from field: optional livekit.DataTrackFrameEncoding frame_encoding = 5;
|
|
2718
|
+
*/
|
|
2719
|
+
frameEncoding?: DataTrackFrameEncoding | undefined;
|
|
2720
|
+
/**
|
|
2721
|
+
* ID of the schema used by frames on this track if the track is typed.
|
|
2722
|
+
*
|
|
2723
|
+
* @generated from field: optional livekit.DataTrackSchemaId schema = 6;
|
|
2724
|
+
*/
|
|
2725
|
+
schema?: DataTrackSchemaId | undefined;
|
|
2726
|
+
};
|
|
2727
|
+
/**
|
|
2728
|
+
* Encoding for frame payloads.
|
|
2729
|
+
*
|
|
2730
|
+
* @generated from message livekit.DataTrackFrameEncoding
|
|
2731
|
+
*/
|
|
2732
|
+
type DataTrackFrameEncoding = Message<"livekit.DataTrackFrameEncoding"> & {
|
|
2733
|
+
/**
|
|
2734
|
+
* @generated from oneof livekit.DataTrackFrameEncoding.value
|
|
2735
|
+
*/
|
|
2736
|
+
value: {
|
|
2737
|
+
/**
|
|
2738
|
+
* @generated from field: livekit.DataTrackFrameEncoding.WellKnownFrameEncoding well_known = 1;
|
|
2739
|
+
*/
|
|
2740
|
+
value: DataTrackFrameEncoding_WellKnownFrameEncoding;
|
|
2741
|
+
case: "wellKnown";
|
|
2742
|
+
} | {
|
|
2743
|
+
/**
|
|
2744
|
+
* Identifier of a custom encoding not covered by the well-known cases.
|
|
2745
|
+
* This must be non-empty and no longer than 32 characters.
|
|
2746
|
+
*
|
|
2747
|
+
* @generated from field: string custom = 2;
|
|
2748
|
+
*/
|
|
2749
|
+
value: string;
|
|
2750
|
+
case: "custom";
|
|
2751
|
+
} | {
|
|
2752
|
+
case: undefined;
|
|
2753
|
+
value?: undefined;
|
|
2754
|
+
};
|
|
2755
|
+
};
|
|
2756
|
+
/**
|
|
2757
|
+
* Well-known encoding for frame payloads.
|
|
2758
|
+
*
|
|
2759
|
+
* Mirrors the well-known message encodings from the MCAP spec:
|
|
2760
|
+
* https://mcap.dev/spec/registry#message-encodings
|
|
2761
|
+
*
|
|
2762
|
+
*
|
|
2763
|
+
* @generated from enum livekit.DataTrackFrameEncoding.WellKnownFrameEncoding
|
|
2764
|
+
*/
|
|
2765
|
+
enum DataTrackFrameEncoding_WellKnownFrameEncoding {
|
|
2766
|
+
/**
|
|
2767
|
+
* @generated from enum value: WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED = 0;
|
|
2768
|
+
*/
|
|
2769
|
+
UNSPECIFIED = 0,
|
|
2770
|
+
/**
|
|
2771
|
+
* ROS 1: must be described by `ROS1_MSG` schema encoding.
|
|
2772
|
+
*
|
|
2773
|
+
* @generated from enum value: WELL_KNOWN_FRAME_ENCODING_ROS1 = 1;
|
|
2774
|
+
*/
|
|
2775
|
+
ROS1 = 1,
|
|
2776
|
+
/**
|
|
2777
|
+
* CDR: must be described by `ROS2_MSG`, `ROS2_IDL`, or `OMG_IDL` schema encoding.
|
|
2778
|
+
*
|
|
2779
|
+
* @generated from enum value: WELL_KNOWN_FRAME_ENCODING_CDR = 2;
|
|
2780
|
+
*/
|
|
2781
|
+
CDR = 2,
|
|
2782
|
+
/**
|
|
2783
|
+
* Protocol Buffer: must be described by `PROTOBUF` schema encoding.
|
|
2784
|
+
*
|
|
2785
|
+
* @generated from enum value: WELL_KNOWN_FRAME_ENCODING_PROTOBUF = 3;
|
|
2786
|
+
*/
|
|
2787
|
+
PROTOBUF = 3,
|
|
2788
|
+
/**
|
|
2789
|
+
* FlatBuffer: must be described by `FLATBUFFER` schema encoding.
|
|
2790
|
+
*
|
|
2791
|
+
* @generated from enum value: WELL_KNOWN_FRAME_ENCODING_FLATBUFFER = 4;
|
|
2792
|
+
*/
|
|
2793
|
+
FLATBUFFER = 4,
|
|
2794
|
+
/**
|
|
2795
|
+
* CBOR: self-describing.
|
|
2796
|
+
*
|
|
2797
|
+
* @generated from enum value: WELL_KNOWN_FRAME_ENCODING_CBOR = 5;
|
|
2798
|
+
*/
|
|
2799
|
+
CBOR = 5,
|
|
2800
|
+
/**
|
|
2801
|
+
* MessagePack: self-describing.
|
|
2802
|
+
*
|
|
2803
|
+
* @generated from enum value: WELL_KNOWN_FRAME_ENCODING_MSGPACK = 6;
|
|
2804
|
+
*/
|
|
2805
|
+
MSGPACK = 6,
|
|
2806
|
+
/**
|
|
2807
|
+
* JSON: self-describing or described by `JSON_SCHEMA` schema encoding.
|
|
2808
|
+
*
|
|
2809
|
+
* @generated from enum value: WELL_KNOWN_FRAME_ENCODING_JSON = 7;
|
|
2810
|
+
*/
|
|
2811
|
+
JSON = 7
|
|
2812
|
+
}
|
|
2813
|
+
/**
|
|
2814
|
+
* Encoding for schema definition.
|
|
2815
|
+
*
|
|
2816
|
+
* @generated from message livekit.DataTrackSchemaEncoding
|
|
2817
|
+
*/
|
|
2818
|
+
type DataTrackSchemaEncoding = Message<"livekit.DataTrackSchemaEncoding"> & {
|
|
2819
|
+
/**
|
|
2820
|
+
* @generated from oneof livekit.DataTrackSchemaEncoding.value
|
|
2821
|
+
*/
|
|
2822
|
+
value: {
|
|
2823
|
+
/**
|
|
2824
|
+
* @generated from field: livekit.DataTrackSchemaEncoding.WellKnownSchemaEncoding well_known = 1;
|
|
2825
|
+
*/
|
|
2826
|
+
value: DataTrackSchemaEncoding_WellKnownSchemaEncoding;
|
|
2827
|
+
case: "wellKnown";
|
|
2828
|
+
} | {
|
|
2829
|
+
/**
|
|
2830
|
+
* Identifier of a custom encoding not covered by the well-known cases.
|
|
2831
|
+
* This must be non-empty and no longer than 32 characters.
|
|
2832
|
+
*
|
|
2833
|
+
* @generated from field: string custom = 2;
|
|
2834
|
+
*/
|
|
2835
|
+
value: string;
|
|
2836
|
+
case: "custom";
|
|
2837
|
+
} | {
|
|
2838
|
+
case: undefined;
|
|
2839
|
+
value?: undefined;
|
|
2840
|
+
};
|
|
2841
|
+
};
|
|
2842
|
+
/**
|
|
2843
|
+
* Well-known encoding for schema definition.
|
|
2844
|
+
*
|
|
2845
|
+
* Mirrors the well-known schema encodings from the MCAP spec:
|
|
2846
|
+
* https://mcap.dev/spec/registry#schema-encodings
|
|
2847
|
+
*
|
|
2848
|
+
*
|
|
2849
|
+
* @generated from enum livekit.DataTrackSchemaEncoding.WellKnownSchemaEncoding
|
|
2850
|
+
*/
|
|
2851
|
+
enum DataTrackSchemaEncoding_WellKnownSchemaEncoding {
|
|
2852
|
+
/**
|
|
2853
|
+
* @generated from enum value: WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED = 0;
|
|
2854
|
+
*/
|
|
2855
|
+
UNSPECIFIED = 0,
|
|
2856
|
+
/**
|
|
2857
|
+
* Protocol Buffer IDL: describes `PROTOBUF` frame encoding.
|
|
2858
|
+
*
|
|
2859
|
+
* @generated from enum value: WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF = 1;
|
|
2860
|
+
*/
|
|
2861
|
+
PROTOBUF = 1,
|
|
2862
|
+
/**
|
|
2863
|
+
* FlatBuffer IDL: describes `FLATBUFFER` frame encoding.
|
|
2864
|
+
*
|
|
2865
|
+
* @generated from enum value: WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER = 2;
|
|
2866
|
+
*/
|
|
2867
|
+
FLATBUFFER = 2,
|
|
2868
|
+
/**
|
|
2869
|
+
* ROS 1 Message: describes `ROS1` frame encoding.
|
|
2870
|
+
*
|
|
2871
|
+
* @generated from enum value: WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG = 3;
|
|
2872
|
+
*/
|
|
2873
|
+
ROS1_MSG = 3,
|
|
2874
|
+
/**
|
|
2875
|
+
* ROS 2 Message: describes `CDR` frame encoding.
|
|
2876
|
+
*
|
|
2877
|
+
* @generated from enum value: WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG = 4;
|
|
2878
|
+
*/
|
|
2879
|
+
ROS2_MSG = 4,
|
|
2880
|
+
/**
|
|
2881
|
+
* ROS 2 IDL: describes `CDR` frame encoding.
|
|
2882
|
+
*
|
|
2883
|
+
* @generated from enum value: WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL = 5;
|
|
2884
|
+
*/
|
|
2885
|
+
ROS2_IDL = 5,
|
|
2886
|
+
/**
|
|
2887
|
+
* OMG IDL: describes `CDR` frame encoding.
|
|
2888
|
+
*
|
|
2889
|
+
* @generated from enum value: WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL = 6;
|
|
2890
|
+
*/
|
|
2891
|
+
OMG_IDL = 6,
|
|
2892
|
+
/**
|
|
2893
|
+
* JSON Schema: describes `JSON` frame encoding.
|
|
2894
|
+
*
|
|
2895
|
+
* @generated from enum value: WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA = 7;
|
|
2896
|
+
*/
|
|
2897
|
+
JSON_SCHEMA = 7
|
|
2898
|
+
}
|
|
2899
|
+
/**
|
|
2900
|
+
* Identifier for a data track schema.
|
|
2901
|
+
*
|
|
2902
|
+
* Schemas with the same name but different encodings are distinct.
|
|
2903
|
+
*
|
|
2904
|
+
*
|
|
2905
|
+
* @generated from message livekit.DataTrackSchemaId
|
|
2906
|
+
*/
|
|
2907
|
+
type DataTrackSchemaId = Message<"livekit.DataTrackSchemaId"> & {
|
|
2908
|
+
/**
|
|
2909
|
+
* This must be non-empty and no longer than 256 characters.
|
|
2910
|
+
*
|
|
2911
|
+
* @generated from field: string name = 1;
|
|
2912
|
+
*/
|
|
2913
|
+
name: string;
|
|
2914
|
+
/**
|
|
2915
|
+
* @generated from field: livekit.DataTrackSchemaEncoding encoding = 2;
|
|
2916
|
+
*/
|
|
2917
|
+
encoding?: DataTrackSchemaEncoding | undefined;
|
|
2699
2918
|
};
|
|
2700
2919
|
/**
|
|
2701
2920
|
* provide information about available spatial layers
|
|
@@ -2761,6 +2980,28 @@ enum VideoLayer_Mode {
|
|
|
2761
2980
|
*/
|
|
2762
2981
|
ONE_SPATIAL_LAYER_PER_STREAM_INCOMPLETE_RTCP_SR = 3
|
|
2763
2982
|
}
|
|
2983
|
+
/**
|
|
2984
|
+
* Optional capabilities advertised by the client at connect time. The SFU
|
|
2985
|
+
* uses these flags to decide whether to enable features that require
|
|
2986
|
+
* client-side support (e.g. passing RTP packet trailers through to the
|
|
2987
|
+
* subscriber instead of stripping them).
|
|
2988
|
+
*
|
|
2989
|
+
* @generated from enum livekit.ClientInfo.Capability
|
|
2990
|
+
*/
|
|
2991
|
+
enum ClientInfo_Capability {
|
|
2992
|
+
/**
|
|
2993
|
+
* @generated from enum value: CAP_UNUSED = 0;
|
|
2994
|
+
*/
|
|
2995
|
+
CAP_UNUSED = 0,
|
|
2996
|
+
/**
|
|
2997
|
+
* @generated from enum value: CAP_PACKET_TRAILER = 1;
|
|
2998
|
+
*/
|
|
2999
|
+
CAP_PACKET_TRAILER = 1,
|
|
3000
|
+
/**
|
|
3001
|
+
* @generated from enum value: CAP_COMPRESSION_DEFLATE_RAW = 2;
|
|
3002
|
+
*/
|
|
3003
|
+
CAP_COMPRESSION_DEFLATE_RAW = 2
|
|
3004
|
+
}
|
|
2764
3005
|
/**
|
|
2765
3006
|
* @generated from message livekit.TimedVersion
|
|
2766
3007
|
*/
|
|
@@ -3014,7 +3255,11 @@ enum PacketTrailerFeature {
|
|
|
3014
3255
|
/**
|
|
3015
3256
|
* @generated from enum value: PTF_FRAME_ID = 1;
|
|
3016
3257
|
*/
|
|
3017
|
-
PTF_FRAME_ID = 1
|
|
3258
|
+
PTF_FRAME_ID = 1,
|
|
3259
|
+
/**
|
|
3260
|
+
* @generated from enum value: PTF_USER_DATA = 2;
|
|
3261
|
+
*/
|
|
3262
|
+
PTF_USER_DATA = 2
|
|
3018
3263
|
}
|
|
3019
3264
|
/**
|
|
3020
3265
|
* Describes the file plugnmeet_auth_room.proto.
|
|
@@ -5069,6 +5314,26 @@ export type UserInfo = Message<"plugnmeet.UserInfo"> & {
|
|
|
5069
5314
|
* Use `create(UserInfoSchema)` to create a new message.
|
|
5070
5315
|
*/
|
|
5071
5316
|
export const UserInfoSchema: GenMessage<UserInfo>;
|
|
5317
|
+
/**
|
|
5318
|
+
* @generated from message plugnmeet.UserRaisedHand
|
|
5319
|
+
*/
|
|
5320
|
+
export type UserRaisedHand = Message<"plugnmeet.UserRaisedHand"> & {
|
|
5321
|
+
/**
|
|
5322
|
+
* @generated from field: bool is_raised = 1;
|
|
5323
|
+
*/
|
|
5324
|
+
isRaised: boolean;
|
|
5325
|
+
/**
|
|
5326
|
+
* Unix timestamp (in milliseconds)
|
|
5327
|
+
*
|
|
5328
|
+
* @generated from field: int64 raised_at = 2 [jstype = JS_STRING];
|
|
5329
|
+
*/
|
|
5330
|
+
raisedAt: string;
|
|
5331
|
+
};
|
|
5332
|
+
/**
|
|
5333
|
+
* Describes the message plugnmeet.UserRaisedHand.
|
|
5334
|
+
* Use `create(UserRaisedHandSchema)` to create a new message.
|
|
5335
|
+
*/
|
|
5336
|
+
export const UserRaisedHandSchema: GenMessage<UserRaisedHand>;
|
|
5072
5337
|
/**
|
|
5073
5338
|
* @generated from message plugnmeet.UserMetadata
|
|
5074
5339
|
*/
|
|
@@ -5090,9 +5355,11 @@ export type UserMetadata = Message<"plugnmeet.UserMetadata"> & {
|
|
|
5090
5355
|
*/
|
|
5091
5356
|
isPresenter: boolean;
|
|
5092
5357
|
/**
|
|
5093
|
-
*
|
|
5358
|
+
* This field is managed by the server and cannot be set by clients.
|
|
5359
|
+
*
|
|
5360
|
+
* @generated from field: plugnmeet.UserRaisedHand raised_hand = 5;
|
|
5094
5361
|
*/
|
|
5095
|
-
raisedHand
|
|
5362
|
+
raisedHand?: UserRaisedHand | undefined;
|
|
5096
5363
|
/**
|
|
5097
5364
|
* @generated from field: bool wait_for_approval = 6;
|
|
5098
5365
|
*/
|
|
@@ -5201,6 +5468,10 @@ export type LockSettings = Message<"plugnmeet.LockSettings"> & {
|
|
|
5201
5468
|
* @generated from field: optional bool lock_shared_notepad = 9;
|
|
5202
5469
|
*/
|
|
5203
5470
|
lockSharedNotepad?: boolean | undefined;
|
|
5471
|
+
/**
|
|
5472
|
+
* @generated from field: optional bool lock_reactions = 10;
|
|
5473
|
+
*/
|
|
5474
|
+
lockReactions?: boolean | undefined;
|
|
5204
5475
|
};
|
|
5205
5476
|
/**
|
|
5206
5477
|
* Describes the message plugnmeet.LockSettings.
|
|
@@ -5507,6 +5778,10 @@ export type RoomCreateFeatures = Message<"plugnmeet.RoomCreateFeatures"> & {
|
|
|
5507
5778
|
* @generated from field: optional bool allow_raise_hand = 11;
|
|
5508
5779
|
*/
|
|
5509
5780
|
allowRaiseHand?: boolean | undefined;
|
|
5781
|
+
/**
|
|
5782
|
+
* @generated from field: optional bool allow_reactions = 27;
|
|
5783
|
+
*/
|
|
5784
|
+
allowReactions?: boolean | undefined;
|
|
5510
5785
|
/**
|
|
5511
5786
|
* @generated from field: optional bool auto_gen_user_id = 12;
|
|
5512
5787
|
*/
|
|
@@ -5564,7 +5839,7 @@ export type RoomCreateFeatures = Message<"plugnmeet.RoomCreateFeatures"> & {
|
|
|
5564
5839
|
*/
|
|
5565
5840
|
sipDialInFeatures?: SipDialInFeatures | undefined;
|
|
5566
5841
|
/**
|
|
5567
|
-
* next ID:
|
|
5842
|
+
* next ID: 28
|
|
5568
5843
|
*
|
|
5569
5844
|
* @generated from field: plugnmeet.ExternalBroadcastingFeatures external_broadcasting_features = 26;
|
|
5570
5845
|
*/
|