livekit-server-sdk 0.5.10 → 1.0.2

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.
Files changed (43) hide show
  1. package/.eslintrc.js +1 -1
  2. package/.github/workflows/test.yaml +3 -0
  3. package/.prettierignore +7 -0
  4. package/README.md +8 -8
  5. package/dist/AccessToken.js +1 -1
  6. package/dist/AccessToken.js.map +1 -1
  7. package/dist/EgressClient.d.ts +42 -27
  8. package/dist/EgressClient.js +114 -57
  9. package/dist/EgressClient.js.map +1 -1
  10. package/dist/RoomServiceClient.js.map +1 -1
  11. package/dist/TwirpRPC.js.map +1 -1
  12. package/dist/WebhookReceiver.test.js.map +1 -1
  13. package/dist/index.d.ts +1 -1
  14. package/dist/index.js +12 -3
  15. package/dist/index.js.map +1 -1
  16. package/dist/proto/google/protobuf/empty.d.ts +1 -1
  17. package/dist/proto/google/protobuf/empty.js +1 -1
  18. package/dist/proto/google/protobuf/empty.js.map +1 -1
  19. package/dist/proto/google/protobuf/timestamp.d.ts +1 -1
  20. package/dist/proto/google/protobuf/timestamp.js +8 -9
  21. package/dist/proto/google/protobuf/timestamp.js.map +1 -1
  22. package/dist/proto/livekit_egress.d.ts +1412 -128
  23. package/dist/proto/livekit_egress.js +735 -386
  24. package/dist/proto/livekit_egress.js.map +1 -1
  25. package/dist/proto/livekit_ingress.d.ts +1803 -0
  26. package/dist/proto/livekit_ingress.js +1095 -0
  27. package/dist/proto/livekit_ingress.js.map +1 -0
  28. package/dist/proto/livekit_models.d.ts +397 -1
  29. package/dist/proto/livekit_models.js +797 -402
  30. package/dist/proto/livekit_models.js.map +1 -1
  31. package/dist/proto/livekit_room.d.ts +246 -2
  32. package/dist/proto/livekit_room.js +81 -109
  33. package/dist/proto/livekit_room.js.map +1 -1
  34. package/dist/proto/livekit_webhook.d.ts +1174 -124
  35. package/dist/proto/livekit_webhook.js +35 -47
  36. package/dist/proto/livekit_webhook.js.map +1 -1
  37. package/package.json +11 -6
  38. package/dist/RecordingServiceClient.d.ts +0 -25
  39. package/dist/RecordingServiceClient.js +0 -87
  40. package/dist/RecordingServiceClient.js.map +0 -1
  41. package/dist/proto/livekit_recording.d.ts +0 -361
  42. package/dist/proto/livekit_recording.js +0 -879
  43. package/dist/proto/livekit_recording.js.map +0 -1
@@ -1,361 +0,0 @@
1
- import * as _m0 from "protobufjs/minimal";
2
- import { Empty } from "./google/protobuf/empty";
3
- export declare const protobufPackage = "livekit";
4
- export declare enum RecordingPreset {
5
- /** NONE - All presets use 44100 Hz, 128k bitrate for audio and a color depth of 24 */
6
- NONE = 0,
7
- /** HD_30 - 720p, 30fps, 3000 kpbs */
8
- HD_30 = 1,
9
- /** HD_60 - 720p, 60fps, 4500 kbps */
10
- HD_60 = 2,
11
- /** FULL_HD_30 - 1080p, 30fps, 4500 kbps */
12
- FULL_HD_30 = 3,
13
- /** FULL_HD_60 - 1080p, 60fps, 6000 kbps */
14
- FULL_HD_60 = 4,
15
- UNRECOGNIZED = -1
16
- }
17
- export declare function recordingPresetFromJSON(object: any): RecordingPreset;
18
- export declare function recordingPresetToJSON(object: RecordingPreset): string;
19
- export interface StartRecordingRequest {
20
- url: string | undefined;
21
- template?: RecordingTemplate | undefined;
22
- rtmp?: RtmpOutput | undefined;
23
- filepath: string | undefined;
24
- options?: RecordingOptions;
25
- }
26
- export interface RecordingTemplate {
27
- layout: string;
28
- roomName: string;
29
- /** defaults to https://recorder.livekit.io */
30
- baseUrl: string;
31
- }
32
- export interface RtmpOutput {
33
- urls: string[];
34
- }
35
- export interface RecordingOptions {
36
- preset: RecordingPreset;
37
- /** default 1920 */
38
- width: number;
39
- /** default 1080 */
40
- height: number;
41
- /** default 24 */
42
- depth: number;
43
- /** default 30 */
44
- framerate: number;
45
- /** default 128 */
46
- audioBitrate: number;
47
- /** default 44100 */
48
- audioFrequency: number;
49
- /** default 4500 */
50
- videoBitrate: number;
51
- /** baseline, main, or high. default main */
52
- profile: string;
53
- }
54
- export interface StartRecordingResponse {
55
- recordingId: string;
56
- }
57
- export interface AddOutputRequest {
58
- recordingId: string;
59
- rtmpUrl: string;
60
- }
61
- export interface RemoveOutputRequest {
62
- recordingId: string;
63
- rtmpUrl: string;
64
- }
65
- export interface EndRecordingRequest {
66
- recordingId: string;
67
- }
68
- export interface RecordingInfo {
69
- id: string;
70
- roomName: string;
71
- active: boolean;
72
- error: string;
73
- file?: FileResult;
74
- rtmp: RtmpResult[];
75
- }
76
- export interface FileResult {
77
- downloadUrl: string;
78
- duration: number;
79
- }
80
- export interface RtmpResult {
81
- streamUrl: string;
82
- duration: number;
83
- }
84
- export declare const StartRecordingRequest: {
85
- encode(message: StartRecordingRequest, writer?: _m0.Writer): _m0.Writer;
86
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): StartRecordingRequest;
87
- fromJSON(object: any): StartRecordingRequest;
88
- toJSON(message: StartRecordingRequest): unknown;
89
- fromPartial<I extends {
90
- url?: string | undefined;
91
- template?: {
92
- layout?: string | undefined;
93
- roomName?: string | undefined;
94
- baseUrl?: string | undefined;
95
- } | undefined;
96
- rtmp?: {
97
- urls?: string[] | undefined;
98
- } | undefined;
99
- filepath?: string | undefined;
100
- options?: {
101
- preset?: RecordingPreset | undefined;
102
- width?: number | undefined;
103
- height?: number | undefined;
104
- depth?: number | undefined;
105
- framerate?: number | undefined;
106
- audioBitrate?: number | undefined;
107
- audioFrequency?: number | undefined;
108
- videoBitrate?: number | undefined;
109
- profile?: string | undefined;
110
- } | undefined;
111
- } & {
112
- url?: string | undefined;
113
- template?: ({
114
- layout?: string | undefined;
115
- roomName?: string | undefined;
116
- baseUrl?: string | undefined;
117
- } & {
118
- layout?: string | undefined;
119
- roomName?: string | undefined;
120
- baseUrl?: string | undefined;
121
- } & Record<Exclude<keyof I["template"], keyof RecordingTemplate>, never>) | undefined;
122
- rtmp?: ({
123
- urls?: string[] | undefined;
124
- } & {
125
- urls?: (string[] & string[] & Record<Exclude<keyof I["rtmp"]["urls"], number | keyof string[]>, never>) | undefined;
126
- } & Record<Exclude<keyof I["rtmp"], "urls">, never>) | undefined;
127
- filepath?: string | undefined;
128
- options?: ({
129
- preset?: RecordingPreset | undefined;
130
- width?: number | undefined;
131
- height?: number | undefined;
132
- depth?: number | undefined;
133
- framerate?: number | undefined;
134
- audioBitrate?: number | undefined;
135
- audioFrequency?: number | undefined;
136
- videoBitrate?: number | undefined;
137
- profile?: string | undefined;
138
- } & {
139
- preset?: RecordingPreset | undefined;
140
- width?: number | undefined;
141
- height?: number | undefined;
142
- depth?: number | undefined;
143
- framerate?: number | undefined;
144
- audioBitrate?: number | undefined;
145
- audioFrequency?: number | undefined;
146
- videoBitrate?: number | undefined;
147
- profile?: string | undefined;
148
- } & Record<Exclude<keyof I["options"], keyof RecordingOptions>, never>) | undefined;
149
- } & Record<Exclude<keyof I, keyof StartRecordingRequest>, never>>(object: I): StartRecordingRequest;
150
- };
151
- export declare const RecordingTemplate: {
152
- encode(message: RecordingTemplate, writer?: _m0.Writer): _m0.Writer;
153
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingTemplate;
154
- fromJSON(object: any): RecordingTemplate;
155
- toJSON(message: RecordingTemplate): unknown;
156
- fromPartial<I extends {
157
- layout?: string | undefined;
158
- roomName?: string | undefined;
159
- baseUrl?: string | undefined;
160
- } & {
161
- layout?: string | undefined;
162
- roomName?: string | undefined;
163
- baseUrl?: string | undefined;
164
- } & Record<Exclude<keyof I, keyof RecordingTemplate>, never>>(object: I): RecordingTemplate;
165
- };
166
- export declare const RtmpOutput: {
167
- encode(message: RtmpOutput, writer?: _m0.Writer): _m0.Writer;
168
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RtmpOutput;
169
- fromJSON(object: any): RtmpOutput;
170
- toJSON(message: RtmpOutput): unknown;
171
- fromPartial<I extends {
172
- urls?: string[] | undefined;
173
- } & {
174
- urls?: (string[] & string[] & Record<Exclude<keyof I["urls"], number | keyof string[]>, never>) | undefined;
175
- } & Record<Exclude<keyof I, "urls">, never>>(object: I): RtmpOutput;
176
- };
177
- export declare const RecordingOptions: {
178
- encode(message: RecordingOptions, writer?: _m0.Writer): _m0.Writer;
179
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingOptions;
180
- fromJSON(object: any): RecordingOptions;
181
- toJSON(message: RecordingOptions): unknown;
182
- fromPartial<I extends {
183
- preset?: RecordingPreset | undefined;
184
- width?: number | undefined;
185
- height?: number | undefined;
186
- depth?: number | undefined;
187
- framerate?: number | undefined;
188
- audioBitrate?: number | undefined;
189
- audioFrequency?: number | undefined;
190
- videoBitrate?: number | undefined;
191
- profile?: string | undefined;
192
- } & {
193
- preset?: RecordingPreset | undefined;
194
- width?: number | undefined;
195
- height?: number | undefined;
196
- depth?: number | undefined;
197
- framerate?: number | undefined;
198
- audioBitrate?: number | undefined;
199
- audioFrequency?: number | undefined;
200
- videoBitrate?: number | undefined;
201
- profile?: string | undefined;
202
- } & Record<Exclude<keyof I, keyof RecordingOptions>, never>>(object: I): RecordingOptions;
203
- };
204
- export declare const StartRecordingResponse: {
205
- encode(message: StartRecordingResponse, writer?: _m0.Writer): _m0.Writer;
206
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): StartRecordingResponse;
207
- fromJSON(object: any): StartRecordingResponse;
208
- toJSON(message: StartRecordingResponse): unknown;
209
- fromPartial<I extends {
210
- recordingId?: string | undefined;
211
- } & {
212
- recordingId?: string | undefined;
213
- } & Record<Exclude<keyof I, "recordingId">, never>>(object: I): StartRecordingResponse;
214
- };
215
- export declare const AddOutputRequest: {
216
- encode(message: AddOutputRequest, writer?: _m0.Writer): _m0.Writer;
217
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): AddOutputRequest;
218
- fromJSON(object: any): AddOutputRequest;
219
- toJSON(message: AddOutputRequest): unknown;
220
- fromPartial<I extends {
221
- recordingId?: string | undefined;
222
- rtmpUrl?: string | undefined;
223
- } & {
224
- recordingId?: string | undefined;
225
- rtmpUrl?: string | undefined;
226
- } & Record<Exclude<keyof I, keyof AddOutputRequest>, never>>(object: I): AddOutputRequest;
227
- };
228
- export declare const RemoveOutputRequest: {
229
- encode(message: RemoveOutputRequest, writer?: _m0.Writer): _m0.Writer;
230
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RemoveOutputRequest;
231
- fromJSON(object: any): RemoveOutputRequest;
232
- toJSON(message: RemoveOutputRequest): unknown;
233
- fromPartial<I extends {
234
- recordingId?: string | undefined;
235
- rtmpUrl?: string | undefined;
236
- } & {
237
- recordingId?: string | undefined;
238
- rtmpUrl?: string | undefined;
239
- } & Record<Exclude<keyof I, keyof RemoveOutputRequest>, never>>(object: I): RemoveOutputRequest;
240
- };
241
- export declare const EndRecordingRequest: {
242
- encode(message: EndRecordingRequest, writer?: _m0.Writer): _m0.Writer;
243
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): EndRecordingRequest;
244
- fromJSON(object: any): EndRecordingRequest;
245
- toJSON(message: EndRecordingRequest): unknown;
246
- fromPartial<I extends {
247
- recordingId?: string | undefined;
248
- } & {
249
- recordingId?: string | undefined;
250
- } & Record<Exclude<keyof I, "recordingId">, never>>(object: I): EndRecordingRequest;
251
- };
252
- export declare const RecordingInfo: {
253
- encode(message: RecordingInfo, writer?: _m0.Writer): _m0.Writer;
254
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingInfo;
255
- fromJSON(object: any): RecordingInfo;
256
- toJSON(message: RecordingInfo): unknown;
257
- fromPartial<I extends {
258
- id?: string | undefined;
259
- roomName?: string | undefined;
260
- active?: boolean | undefined;
261
- error?: string | undefined;
262
- file?: {
263
- downloadUrl?: string | undefined;
264
- duration?: number | undefined;
265
- } | undefined;
266
- rtmp?: {
267
- streamUrl?: string | undefined;
268
- duration?: number | undefined;
269
- }[] | undefined;
270
- } & {
271
- id?: string | undefined;
272
- roomName?: string | undefined;
273
- active?: boolean | undefined;
274
- error?: string | undefined;
275
- file?: ({
276
- downloadUrl?: string | undefined;
277
- duration?: number | undefined;
278
- } & {
279
- downloadUrl?: string | undefined;
280
- duration?: number | undefined;
281
- } & Record<Exclude<keyof I["file"], keyof FileResult>, never>) | undefined;
282
- rtmp?: ({
283
- streamUrl?: string | undefined;
284
- duration?: number | undefined;
285
- }[] & ({
286
- streamUrl?: string | undefined;
287
- duration?: number | undefined;
288
- } & {
289
- streamUrl?: string | undefined;
290
- duration?: number | undefined;
291
- } & Record<Exclude<keyof I["rtmp"][number], keyof RtmpResult>, never>)[] & Record<Exclude<keyof I["rtmp"], number | keyof {
292
- streamUrl?: string | undefined;
293
- duration?: number | undefined;
294
- }[]>, never>) | undefined;
295
- } & Record<Exclude<keyof I, keyof RecordingInfo>, never>>(object: I): RecordingInfo;
296
- };
297
- export declare const FileResult: {
298
- encode(message: FileResult, writer?: _m0.Writer): _m0.Writer;
299
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): FileResult;
300
- fromJSON(object: any): FileResult;
301
- toJSON(message: FileResult): unknown;
302
- fromPartial<I extends {
303
- downloadUrl?: string | undefined;
304
- duration?: number | undefined;
305
- } & {
306
- downloadUrl?: string | undefined;
307
- duration?: number | undefined;
308
- } & Record<Exclude<keyof I, keyof FileResult>, never>>(object: I): FileResult;
309
- };
310
- export declare const RtmpResult: {
311
- encode(message: RtmpResult, writer?: _m0.Writer): _m0.Writer;
312
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RtmpResult;
313
- fromJSON(object: any): RtmpResult;
314
- toJSON(message: RtmpResult): unknown;
315
- fromPartial<I extends {
316
- streamUrl?: string | undefined;
317
- duration?: number | undefined;
318
- } & {
319
- streamUrl?: string | undefined;
320
- duration?: number | undefined;
321
- } & Record<Exclude<keyof I, keyof RtmpResult>, never>>(object: I): RtmpResult;
322
- };
323
- /**
324
- * Recording service that can be performed on any node
325
- * they are Twirp-based HTTP req/responses
326
- */
327
- export interface RecordingService {
328
- /**
329
- * Starts a room
330
- *
331
- * @deprecated
332
- */
333
- StartRecording(request: StartRecordingRequest): Promise<StartRecordingResponse>;
334
- /**
335
- * Adds an rtmp output to a live recording
336
- *
337
- * @deprecated
338
- */
339
- AddOutput(request: AddOutputRequest): Promise<Empty>;
340
- /**
341
- * Removes an rtmp output from a live recording
342
- *
343
- * @deprecated
344
- */
345
- RemoveOutput(request: RemoveOutputRequest): Promise<Empty>;
346
- /**
347
- * Ends a recording
348
- *
349
- * @deprecated
350
- */
351
- EndRecording(request: EndRecordingRequest): Promise<Empty>;
352
- }
353
- declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
354
- export declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
355
- [K in keyof T]?: DeepPartial<T[K]>;
356
- } : Partial<T>;
357
- declare type KeysOfUnion<T> = T extends T ? keyof T : never;
358
- export declare type Exact<P, I extends P> = P extends Builtin ? P : P & {
359
- [K in keyof P]: Exact<P[K], I[K]>;
360
- } & Record<Exclude<keyof I, KeysOfUnion<P>>, never>;
361
- export {};