livekit-server-sdk 0.5.3 → 0.5.4

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.
@@ -1,57 +1,68 @@
1
1
  import _m0 from "protobufjs/minimal";
2
+ import { Empty } from "./google/protobuf/empty";
2
3
  export declare const protobufPackage = "livekit";
3
4
  export declare enum RecordingPreset {
5
+ /** NONE - All presets use 44100 Hz, 128k bitrate for audio and a color depth of 24 */
4
6
  NONE = 0,
5
- /** HD_30 - 720p, 30fps */
7
+ /** HD_30 - 720p, 30fps, 3000 kpbs */
6
8
  HD_30 = 1,
7
- /** HD_60 - 720p, 60fps */
9
+ /** HD_60 - 720p, 60fps, 4500 kbps */
8
10
  HD_60 = 2,
9
- /** FULL_HD_30 - 1080p, 30fps */
11
+ /** FULL_HD_30 - 1080p, 30fps, 4500 kbps */
10
12
  FULL_HD_30 = 3,
11
- /** FULL_HD_60 - 1080p, 60fps */
13
+ /** FULL_HD_60 - 1080p, 60fps, 6000 kbps */
12
14
  FULL_HD_60 = 4,
13
15
  UNRECOGNIZED = -1
14
16
  }
15
17
  export declare function recordingPresetFromJSON(object: any): RecordingPreset;
16
18
  export declare function recordingPresetToJSON(object: RecordingPreset): string;
17
19
  export interface StartRecordingRequest {
18
- input?: RecordingInput;
19
- output?: RecordingOutput;
20
+ url: string | undefined;
21
+ template?: RecordingTemplate | undefined;
22
+ s3Url: string | undefined;
23
+ rtmp?: RtmpOutput | undefined;
24
+ file: string | undefined;
20
25
  options?: RecordingOptions;
21
26
  }
22
- export interface EndRecordingRequest {
23
- recordingId: string;
24
- }
25
- export interface RecordingResponse {
26
- recordingId: string;
27
- }
28
- export interface RecordingInput {
29
- url: string;
30
- template?: RecordingTemplate;
31
- }
32
27
  export interface RecordingTemplate {
33
28
  layout: string;
34
- /** either token or room name required */
35
- token: string;
36
- roomName: string;
29
+ roomName: string | undefined;
30
+ token: string | undefined;
37
31
  }
38
- export interface RecordingOutput {
39
- rtmp: string;
40
- /** bucket/key */
41
- s3Path: string;
32
+ export interface RtmpOutput {
33
+ urls: string[];
42
34
  }
43
35
  export interface RecordingOptions {
44
36
  preset: RecordingPreset;
45
- inputWidth: number;
46
- inputHeight: number;
47
- outputWidth: number;
48
- outputHeight: number;
37
+ /** default 1920 */
38
+ width: number;
39
+ /** default 1080 */
40
+ height: number;
41
+ /** default 24 */
49
42
  depth: number;
43
+ /** default 30 */
50
44
  framerate: number;
45
+ /** default 128 */
51
46
  audioBitrate: number;
47
+ /** default 44100 */
52
48
  audioFrequency: number;
49
+ /** default 4500 */
53
50
  videoBitrate: number;
54
51
  }
52
+ export interface StartRecordingResponse {
53
+ recordingId: string;
54
+ }
55
+ export interface AddOutputRequest {
56
+ recordingId: string;
57
+ rtmpUrl: string;
58
+ }
59
+ export interface RemoveOutputRequest {
60
+ recordingId: string;
61
+ rtmpUrl: string;
62
+ }
63
+ export interface EndRecordingRequest {
64
+ recordingId: string;
65
+ }
55
66
  export declare const StartRecordingRequest: {
56
67
  encode(message: StartRecordingRequest, writer?: _m0.Writer): _m0.Writer;
57
68
  decode(input: _m0.Reader | Uint8Array, length?: number | undefined): StartRecordingRequest;
@@ -59,27 +70,6 @@ export declare const StartRecordingRequest: {
59
70
  toJSON(message: StartRecordingRequest): unknown;
60
71
  fromPartial(object: DeepPartial<StartRecordingRequest>): StartRecordingRequest;
61
72
  };
62
- export declare const EndRecordingRequest: {
63
- encode(message: EndRecordingRequest, writer?: _m0.Writer): _m0.Writer;
64
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): EndRecordingRequest;
65
- fromJSON(object: any): EndRecordingRequest;
66
- toJSON(message: EndRecordingRequest): unknown;
67
- fromPartial(object: DeepPartial<EndRecordingRequest>): EndRecordingRequest;
68
- };
69
- export declare const RecordingResponse: {
70
- encode(message: RecordingResponse, writer?: _m0.Writer): _m0.Writer;
71
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingResponse;
72
- fromJSON(object: any): RecordingResponse;
73
- toJSON(message: RecordingResponse): unknown;
74
- fromPartial(object: DeepPartial<RecordingResponse>): RecordingResponse;
75
- };
76
- export declare const RecordingInput: {
77
- encode(message: RecordingInput, writer?: _m0.Writer): _m0.Writer;
78
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingInput;
79
- fromJSON(object: any): RecordingInput;
80
- toJSON(message: RecordingInput): unknown;
81
- fromPartial(object: DeepPartial<RecordingInput>): RecordingInput;
82
- };
83
73
  export declare const RecordingTemplate: {
84
74
  encode(message: RecordingTemplate, writer?: _m0.Writer): _m0.Writer;
85
75
  decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingTemplate;
@@ -87,12 +77,12 @@ export declare const RecordingTemplate: {
87
77
  toJSON(message: RecordingTemplate): unknown;
88
78
  fromPartial(object: DeepPartial<RecordingTemplate>): RecordingTemplate;
89
79
  };
90
- export declare const RecordingOutput: {
91
- encode(message: RecordingOutput, writer?: _m0.Writer): _m0.Writer;
92
- decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingOutput;
93
- fromJSON(object: any): RecordingOutput;
94
- toJSON(message: RecordingOutput): unknown;
95
- fromPartial(object: DeepPartial<RecordingOutput>): RecordingOutput;
80
+ export declare const RtmpOutput: {
81
+ encode(message: RtmpOutput, writer?: _m0.Writer): _m0.Writer;
82
+ decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RtmpOutput;
83
+ fromJSON(object: any): RtmpOutput;
84
+ toJSON(message: RtmpOutput): unknown;
85
+ fromPartial(object: DeepPartial<RtmpOutput>): RtmpOutput;
96
86
  };
97
87
  export declare const RecordingOptions: {
98
88
  encode(message: RecordingOptions, writer?: _m0.Writer): _m0.Writer;
@@ -101,15 +91,47 @@ export declare const RecordingOptions: {
101
91
  toJSON(message: RecordingOptions): unknown;
102
92
  fromPartial(object: DeepPartial<RecordingOptions>): RecordingOptions;
103
93
  };
94
+ export declare const StartRecordingResponse: {
95
+ encode(message: StartRecordingResponse, writer?: _m0.Writer): _m0.Writer;
96
+ decode(input: _m0.Reader | Uint8Array, length?: number | undefined): StartRecordingResponse;
97
+ fromJSON(object: any): StartRecordingResponse;
98
+ toJSON(message: StartRecordingResponse): unknown;
99
+ fromPartial(object: DeepPartial<StartRecordingResponse>): StartRecordingResponse;
100
+ };
101
+ export declare const AddOutputRequest: {
102
+ encode(message: AddOutputRequest, writer?: _m0.Writer): _m0.Writer;
103
+ decode(input: _m0.Reader | Uint8Array, length?: number | undefined): AddOutputRequest;
104
+ fromJSON(object: any): AddOutputRequest;
105
+ toJSON(message: AddOutputRequest): unknown;
106
+ fromPartial(object: DeepPartial<AddOutputRequest>): AddOutputRequest;
107
+ };
108
+ export declare const RemoveOutputRequest: {
109
+ encode(message: RemoveOutputRequest, writer?: _m0.Writer): _m0.Writer;
110
+ decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RemoveOutputRequest;
111
+ fromJSON(object: any): RemoveOutputRequest;
112
+ toJSON(message: RemoveOutputRequest): unknown;
113
+ fromPartial(object: DeepPartial<RemoveOutputRequest>): RemoveOutputRequest;
114
+ };
115
+ export declare const EndRecordingRequest: {
116
+ encode(message: EndRecordingRequest, writer?: _m0.Writer): _m0.Writer;
117
+ decode(input: _m0.Reader | Uint8Array, length?: number | undefined): EndRecordingRequest;
118
+ fromJSON(object: any): EndRecordingRequest;
119
+ toJSON(message: EndRecordingRequest): unknown;
120
+ fromPartial(object: DeepPartial<EndRecordingRequest>): EndRecordingRequest;
121
+ };
104
122
  /**
105
123
  * Recording service that can be performed on any node
106
124
  * they are Twirp-based HTTP req/responses
107
125
  */
108
126
  export interface RecordingService {
109
127
  /** Starts a room */
110
- StartRecording(request: StartRecordingRequest): Promise<RecordingResponse>;
128
+ StartRecording(request: StartRecordingRequest): Promise<StartRecordingResponse>;
129
+ /** Adds an rtmp output to a live recording */
130
+ AddOutput(request: AddOutputRequest): Promise<Empty>;
131
+ /** Removes an rtmp output from a live recording */
132
+ RemoveOutput(request: RemoveOutputRequest): Promise<Empty>;
111
133
  /** Ends a recording */
112
- EndRecording(request: EndRecordingRequest): Promise<RecordingResponse>;
134
+ EndRecording(request: EndRecordingRequest): Promise<Empty>;
113
135
  }
114
136
  declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
115
137
  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 {} ? {