Class RoomCompositeEgressRequest

composite using a web browser

Generated

from message livekit.RoomCompositeEgressRequest

Hierarchy

Constructors

Properties

audioOnly: boolean = false

(default false)

Generated

from field: bool audio_only = 3;

customBaseUrl: string = ""

template base url (default https://recorder.livekit.io)

Generated

from field: string custom_base_url = 5;

fileOutputs: EncodedFileOutput[] = []

Generated

from field: repeated livekit.EncodedFileOutput file_outputs = 11;

imageOutputs: ImageOutput[] = []

Generated

from field: repeated livekit.ImageOutput image_outputs = 14;

layout: string = ""

(optional)

Generated

from field: string layout = 2;

options: {
    case: "preset";
    value: EncodingOptionsPreset;
} | {
    case: "advanced";
    value: EncodingOptions;
} | {
    case: undefined;
    value?: undefined;
} = ...

Type declaration

  • case: "preset"
  • value: EncodingOptionsPreset

    (default H264_720P_30)

    Generated

    from field: livekit.EncodingOptionsPreset preset = 8;

Type declaration

  • case: "advanced"
  • value: EncodingOptions

    (optional)

    Generated

    from field: livekit.EncodingOptions advanced = 9;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof livekit.RoomCompositeEgressRequest.options

output: {
    case: "file";
    value: EncodedFileOutput;
} | {
    case: "stream";
    value: StreamOutput;
} | {
    case: "segments";
    value: SegmentedFileOutput;
} | {
    case: undefined;
    value?: undefined;
} = ...

deprecated (use _output fields)

Type declaration

  • case: "file"
  • value: EncodedFileOutput

    Generated

    from field: livekit.EncodedFileOutput file = 6 [deprecated = true];

    Deprecated

Type declaration

  • case: "stream"
  • value: StreamOutput

    Generated

    from field: livekit.StreamOutput stream = 7 [deprecated = true];

    Deprecated

Type declaration

  • case: "segments"
  • value: SegmentedFileOutput

    Generated

    from field: livekit.SegmentedFileOutput segments = 10 [deprecated = true];

    Deprecated

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof livekit.RoomCompositeEgressRequest.output

roomName: string = ""

required

Generated

from field: string room_name = 1;

segmentOutputs: SegmentedFileOutput[] = []

Generated

from field: repeated livekit.SegmentedFileOutput segment_outputs = 13;

streamOutputs: StreamOutput[] = []

Generated

from field: repeated livekit.StreamOutput stream_outputs = 12;

videoOnly: boolean = false

(default false)

Generated

from field: bool video_only = 4;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "livekit.RoomCompositeEgressRequest" = "livekit.RoomCompositeEgressRequest"

Methods

Generated using TypeDoc