Class TrackEgressRequest

record tracks individually, without transcoding

Generated

from message livekit.TrackEgressRequest

Hierarchy

Message<TrackEgressRequest>
- TrackEgressRequest

Index

Constructors

constructor

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

Properties

output

output: {
    case: "file";
    value: DirectFileOutput;
} | {
    case: "websocketUrl";
    value: string;
} | {
    case: undefined;
    value?: undefined;
} = ...

required

Type declaration

case: "file"
value: DirectFileOutput
Generated
from field: livekit.DirectFileOutput file = 3;

Type declaration

case: "websocketUrl"
value: string
Generated
from field: string websocket_url = 4;

Type declaration

case: undefined
Optional value?: undefined

Generated

from oneof livekit.TrackEgressRequest.output

roomName

roomName: string = ""

required

Generated

from field: string room_name = 1;

trackId

trackId: string = ""

required

Generated

from field: string track_id = 2;

`Static` `Readonly` fields

fields: FieldList = ...

`Static` `Readonly` runtime

runtime: ProtoRuntime = proto3

`Static` `Readonly` typeName

typeName: "livekit.TrackEgressRequest" = "livekit.TrackEgressRequest"

Methods

`Static` equals

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

`Static` fromBinary

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

`Static` fromJson

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

`Static` fromJsonString

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

Class TrackEgressRequest

Generated

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional data: PartialMessage<TrackEgressRequest>

Returns TrackEgressRequest

Properties

output

Type declaration

case: "file"

value: DirectFileOutput

Generated

Type declaration

case: "websocketUrl"

value: string

Generated

Type declaration

case: undefined

Optional value?: undefined

Generated

roomName

Generated

trackId

Generated

Static Readonly fields

Static Readonly runtime

Static Readonly typeName

Methods

Static equals

Parameters

a: undefined | TrackEgressRequest | PlainMessage<TrackEgressRequest>

b: undefined | TrackEgressRequest | PlainMessage<TrackEgressRequest>

Returns boolean

Static fromBinary

Parameters

bytes: Uint8Array

Optional options: Partial<BinaryReadOptions>

Returns TrackEgressRequest

Static fromJson

Parameters

jsonValue: JsonValue

Optional options: Partial<JsonReadOptions>

Returns TrackEgressRequest

Static fromJsonString

Parameters

jsonString: string

Optional options: Partial<JsonReadOptions>

Returns TrackEgressRequest

Settings

Member Visibility

Theme

On This Page

`Optional` data: PartialMessage<TrackEgressRequest>

`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>