livekit-server-sdk 0.5.3 → 0.5.7

package/dist/proto/livekit_recording.d.ts

@@ -1,57 +1,84 @@
 import _m0 from "protobufjs/minimal";
+import { Empty } from "./google/protobuf/empty";
 export declare const protobufPackage = "livekit";
 export declare enum RecordingPreset {
+    /** NONE - All presets use 44100 Hz, 128k bitrate for audio and a color depth of 24 */
     NONE = 0,
-    /** HD_30 - 720p, 30fps */
+    /** HD_30 - 720p, 30fps, 3000 kpbs */
     HD_30 = 1,
-    /** HD_60 - 720p, 60fps */
+    /** HD_60 - 720p, 60fps, 4500 kbps */
     HD_60 = 2,
-    /** FULL_HD_30 - 1080p, 30fps */
+    /** FULL_HD_30 - 1080p, 30fps, 4500 kbps */
     FULL_HD_30 = 3,
-    /** FULL_HD_60 - 1080p, 60fps */
+    /** FULL_HD_60 - 1080p, 60fps, 6000 kbps */
     FULL_HD_60 = 4,
     UNRECOGNIZED = -1
 }
 export declare function recordingPresetFromJSON(object: any): RecordingPreset;
 export declare function recordingPresetToJSON(object: RecordingPreset): string;
 export interface StartRecordingRequest {
-    input?: RecordingInput;
-    output?: RecordingOutput;
+    url: string | undefined;
+    template?: RecordingTemplate | undefined;
+    rtmp?: RtmpOutput | undefined;
+    filepath: string | undefined;
     options?: RecordingOptions;
 }
-export interface EndRecordingRequest {
-    recordingId: string;
-}
-export interface RecordingResponse {
-    recordingId: string;
-}
-export interface RecordingInput {
-    url: string;
-    template?: RecordingTemplate;
-}
 export interface RecordingTemplate {
     layout: string;
-    /** either token or room name required */
-    token: string;
     roomName: string;
+    /** defaults to https://recorder.livekit.io */
+    baseUrl: string;
 }
-export interface RecordingOutput {
-    rtmp: string;
-    /** bucket/key */
-    s3Path: string;
+export interface RtmpOutput {
+    urls: string[];
 }
 export interface RecordingOptions {
     preset: RecordingPreset;
-    inputWidth: number;
-    inputHeight: number;
-    outputWidth: number;
-    outputHeight: number;
+    /** default 1920 */
+    width: number;
+    /** default 1080 */
+    height: number;
+    /** default 24 */
     depth: number;
+    /** default 30 */
     framerate: number;
+    /** default 128 */
     audioBitrate: number;
+    /** default 44100 */
     audioFrequency: number;
+    /** default 4500 */
     videoBitrate: number;
 }
+export interface StartRecordingResponse {
+    recordingId: string;
+}
+export interface AddOutputRequest {
+    recordingId: string;
+    rtmpUrl: string;
+}
+export interface RemoveOutputRequest {
+    recordingId: string;
+    rtmpUrl: string;
+}
+export interface EndRecordingRequest {
+    recordingId: string;
+}
+export interface RecordingInfo {
+    id: string;
+    roomName: string;
+    active: boolean;
+    error: string;
+    file?: FileResult;
+    rtmp: RtmpResult[];
+}
+export interface FileResult {
+    downloadUrl: string;
+    duration: number;
+}
+export interface RtmpResult {
+    streamUrl: string;
+    duration: number;
+}
 export declare const StartRecordingRequest: {
     encode(message: StartRecordingRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number | undefined): StartRecordingRequest;
@@ -59,27 +86,6 @@ export declare const StartRecordingRequest: {
     toJSON(message: StartRecordingRequest): unknown;
     fromPartial(object: DeepPartial<StartRecordingRequest>): StartRecordingRequest;
 };
-export declare const EndRecordingRequest: {
-    encode(message: EndRecordingRequest, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): EndRecordingRequest;
-    fromJSON(object: any): EndRecordingRequest;
-    toJSON(message: EndRecordingRequest): unknown;
-    fromPartial(object: DeepPartial<EndRecordingRequest>): EndRecordingRequest;
-};
-export declare const RecordingResponse: {
-    encode(message: RecordingResponse, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingResponse;
-    fromJSON(object: any): RecordingResponse;
-    toJSON(message: RecordingResponse): unknown;
-    fromPartial(object: DeepPartial<RecordingResponse>): RecordingResponse;
-};
-export declare const RecordingInput: {
-    encode(message: RecordingInput, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingInput;
-    fromJSON(object: any): RecordingInput;
-    toJSON(message: RecordingInput): unknown;
-    fromPartial(object: DeepPartial<RecordingInput>): RecordingInput;
-};
 export declare const RecordingTemplate: {
     encode(message: RecordingTemplate, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingTemplate;
@@ -87,12 +93,12 @@ export declare const RecordingTemplate: {
     toJSON(message: RecordingTemplate): unknown;
     fromPartial(object: DeepPartial<RecordingTemplate>): RecordingTemplate;
 };
-export declare const RecordingOutput: {
-    encode(message: RecordingOutput, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingOutput;
-    fromJSON(object: any): RecordingOutput;
-    toJSON(message: RecordingOutput): unknown;
-    fromPartial(object: DeepPartial<RecordingOutput>): RecordingOutput;
+export declare const RtmpOutput: {
+    encode(message: RtmpOutput, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RtmpOutput;
+    fromJSON(object: any): RtmpOutput;
+    toJSON(message: RtmpOutput): unknown;
+    fromPartial(object: DeepPartial<RtmpOutput>): RtmpOutput;
 };
 export declare const RecordingOptions: {
     encode(message: RecordingOptions, writer?: _m0.Writer): _m0.Writer;
@@ -101,15 +107,68 @@ export declare const RecordingOptions: {
     toJSON(message: RecordingOptions): unknown;
     fromPartial(object: DeepPartial<RecordingOptions>): RecordingOptions;
 };
+export declare const StartRecordingResponse: {
+    encode(message: StartRecordingResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): StartRecordingResponse;
+    fromJSON(object: any): StartRecordingResponse;
+    toJSON(message: StartRecordingResponse): unknown;
+    fromPartial(object: DeepPartial<StartRecordingResponse>): StartRecordingResponse;
+};
+export declare const AddOutputRequest: {
+    encode(message: AddOutputRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): AddOutputRequest;
+    fromJSON(object: any): AddOutputRequest;
+    toJSON(message: AddOutputRequest): unknown;
+    fromPartial(object: DeepPartial<AddOutputRequest>): AddOutputRequest;
+};
+export declare const RemoveOutputRequest: {
+    encode(message: RemoveOutputRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RemoveOutputRequest;
+    fromJSON(object: any): RemoveOutputRequest;
+    toJSON(message: RemoveOutputRequest): unknown;
+    fromPartial(object: DeepPartial<RemoveOutputRequest>): RemoveOutputRequest;
+};
+export declare const EndRecordingRequest: {
+    encode(message: EndRecordingRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): EndRecordingRequest;
+    fromJSON(object: any): EndRecordingRequest;
+    toJSON(message: EndRecordingRequest): unknown;
+    fromPartial(object: DeepPartial<EndRecordingRequest>): EndRecordingRequest;
+};
+export declare const RecordingInfo: {
+    encode(message: RecordingInfo, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RecordingInfo;
+    fromJSON(object: any): RecordingInfo;
+    toJSON(message: RecordingInfo): unknown;
+    fromPartial(object: DeepPartial<RecordingInfo>): RecordingInfo;
+};
+export declare const FileResult: {
+    encode(message: FileResult, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): FileResult;
+    fromJSON(object: any): FileResult;
+    toJSON(message: FileResult): unknown;
+    fromPartial(object: DeepPartial<FileResult>): FileResult;
+};
+export declare const RtmpResult: {
+    encode(message: RtmpResult, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RtmpResult;
+    fromJSON(object: any): RtmpResult;
+    toJSON(message: RtmpResult): unknown;
+    fromPartial(object: DeepPartial<RtmpResult>): RtmpResult;
+};
 /**
  * Recording service that can be performed on any node
  * they are Twirp-based HTTP req/responses
  */
 export interface RecordingService {
     /** Starts a room */
-    StartRecording(request: StartRecordingRequest): Promise<RecordingResponse>;
+    StartRecording(request: StartRecordingRequest): Promise<StartRecordingResponse>;
+    /** Adds an rtmp output to a live recording */
+    AddOutput(request: AddOutputRequest): Promise<Empty>;
+    /** Removes an rtmp output from a live recording */
+    RemoveOutput(request: RemoveOutputRequest): Promise<Empty>;
     /** Ends a recording */
-    EndRecording(request: EndRecordingRequest): Promise<RecordingResponse>;
+    EndRecording(request: EndRecordingRequest): Promise<Empty>;
 }
 declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 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 {} ? {