Class TrackCompositeEgressRequest

containerize up to one audio and one video track

Generated

from message livekit.TrackCompositeEgressRequest

Hierarchy

Message<TrackCompositeEgressRequest>
- TrackCompositeEgressRequest

Index

Constructors

constructor

new TrackCompositeEgressRequest(data?): TrackCompositeEgressRequest
Parameters
- Optional data: PartialMessage<TrackCompositeEgressRequest>
Returns TrackCompositeEgressRequest
Overrides Message<TrackCompositeEgressRequest>.constructor
- Defined in proto/livekit_egress_pb.ts:738

Properties

audioTrackId

audioTrackId: string = ""

(optional)

Generated

from field: string audio_track_id = 2;

fileOutputs

fileOutputs: EncodedFileOutput[] = []

Generated

from field: repeated livekit.EncodedFileOutput file_outputs = 11;

imageOutputs

imageOutputs: ImageOutput[] = []

Generated

from field: repeated livekit.ImageOutput image_outputs = 14;

options

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 = 6;

Type declaration

case: "advanced"
value: EncodingOptions
(optional)

Generated
from field: livekit.EncodingOptions advanced = 7;

Type declaration

case: undefined
Optional value?: undefined

Generated

from oneof livekit.TrackCompositeEgressRequest.options

output

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 = 4 [deprecated = true];

Deprecated

Type declaration

case: "stream"
value: StreamOutput
Generated
from field: livekit.StreamOutput stream = 5 [deprecated = true];

Deprecated

Type declaration

case: "segments"
value: SegmentedFileOutput
Generated
from field: livekit.SegmentedFileOutput segments = 8 [deprecated = true];

Deprecated

Type declaration

case: undefined
Optional value?: undefined

Generated

from oneof livekit.TrackCompositeEgressRequest.output

roomName

roomName: string = ""

required

Generated

from field: string room_name = 1;

segmentOutputs

segmentOutputs: SegmentedFileOutput[] = []

Generated

from field: repeated livekit.SegmentedFileOutput segment_outputs = 13;

streamOutputs

streamOutputs: StreamOutput[] = []

Generated

from field: repeated livekit.StreamOutput stream_outputs = 12;

videoTrackId

videoTrackId: string = ""

(optional)

Generated

from field: string video_track_id = 3;

`Static` `Readonly` fields

fields: FieldList = ...

`Static` `Readonly` runtime

runtime: ProtoRuntime = proto3

`Static` `Readonly` typeName

typeName: "livekit.TrackCompositeEgressRequest" = "livekit.TrackCompositeEgressRequest"

Methods

`Static` equals

equals(a, b): boolean
Parameters
- a: undefined | TrackCompositeEgressRequest | PlainMessage<TrackCompositeEgressRequest>
- b: undefined | TrackCompositeEgressRequest | PlainMessage<TrackCompositeEgressRequest>
Returns boolean
- Defined in proto/livekit_egress_pb.ts:772

`Static` fromBinary

fromBinary(bytes, options?): TrackCompositeEgressRequest
Parameters
- bytes: Uint8Array
- Optional options: Partial<BinaryReadOptions>
Returns TrackCompositeEgressRequest
- Defined in proto/livekit_egress_pb.ts:760

`Static` fromJson

fromJson(jsonValue, options?): TrackCompositeEgressRequest
Parameters
- jsonValue: JsonValue
- Optional options: Partial<JsonReadOptions>
Returns TrackCompositeEgressRequest
- Defined in proto/livekit_egress_pb.ts:764

`Static` fromJsonString

fromJsonString(jsonString, options?): TrackCompositeEgressRequest
Parameters
- jsonString: string
- Optional options: Partial<JsonReadOptions>
Returns TrackCompositeEgressRequest
- Defined in proto/livekit_egress_pb.ts:768

Class TrackCompositeEgressRequest

Generated

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional data: PartialMessage<TrackCompositeEgressRequest>

Returns TrackCompositeEgressRequest

Properties

audioTrackId

Generated

fileOutputs

Generated

imageOutputs

Generated

options

Type declaration

case: "preset"

value: EncodingOptionsPreset

Generated

Type declaration

case: "advanced"

value: EncodingOptions

Generated

Type declaration

case: undefined

Optional value?: undefined

Generated

output

Type declaration

case: "file"

value: EncodedFileOutput

Generated

Deprecated

Type declaration

case: "stream"

value: StreamOutput

Generated

Deprecated

Type declaration

case: "segments"

value: SegmentedFileOutput

Generated

Deprecated

Type declaration

case: undefined

Optional value?: undefined

Generated

roomName

Generated

segmentOutputs

Generated

streamOutputs

Generated

videoTrackId

Generated

Static Readonly fields

Static Readonly runtime

Static Readonly typeName

Methods

Static equals

Parameters

a: undefined | TrackCompositeEgressRequest | PlainMessage<TrackCompositeEgressRequest>

b: undefined | TrackCompositeEgressRequest | PlainMessage<TrackCompositeEgressRequest>

Returns boolean

Static fromBinary

Parameters

bytes: Uint8Array

Optional options: Partial<BinaryReadOptions>

Returns TrackCompositeEgressRequest

Static fromJson

Parameters

jsonValue: JsonValue

Optional options: Partial<JsonReadOptions>

Returns TrackCompositeEgressRequest

Static fromJsonString

`Optional` data: PartialMessage<TrackCompositeEgressRequest>

`Optional` value?: undefined

`Optional` value?: undefined

`Static` `Readonly` fields

`Static` `Readonly` runtime

`Static` `Readonly` typeName

`Static` equals

`Static` fromBinary

`Optional` options: Partial<BinaryReadOptions>

`Static` fromJson

`Optional` options: Partial<JsonReadOptions>

`Static` fromJsonString

`Optional` options: Partial<JsonReadOptions>