Class CreateIngressRequest

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

public sealed class CreateIngressRequest : IMessage<CreateIngressRequest>, IEquatable<CreateIngressRequest>, IDeepCloneable<CreateIngressRequest>, IBufferMessage, IMessage

Inheritance

object

CreateIngressRequest

Implements

IMessage<CreateIngressRequest>

IEquatable<CreateIngressRequest>

IDeepCloneable<CreateIngressRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CreateIngressRequest()

public CreateIngressRequest()

CreateIngressRequest(CreateIngressRequest)

public CreateIngressRequest(CreateIngressRequest other)

Parameters

other CreateIngressRequest

Fields

AudioFieldNumber

Field number for the "audio" field.

public const int AudioFieldNumber = 6

Field Value

int

BypassTranscodingFieldNumber

Field number for the "bypass_transcoding" field.

public const int BypassTranscodingFieldNumber = 8

Field Value

int

EnableTranscodingFieldNumber

Field number for the "enable_transcoding" field.

public const int EnableTranscodingFieldNumber = 11

Field Value

int

EnabledFieldNumber

Field number for the "enabled" field.

public const int EnabledFieldNumber = 12

Field Value

int

InputTypeFieldNumber

Field number for the "input_type" field.

public const int InputTypeFieldNumber = 1

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 2

Field Value

int

ParticipantIdentityFieldNumber

Field number for the "participant_identity" field.

public const int ParticipantIdentityFieldNumber = 4

Field Value

int

ParticipantMetadataFieldNumber

Field number for the "participant_metadata" field.

public const int ParticipantMetadataFieldNumber = 10

Field Value

int

ParticipantNameFieldNumber

Field number for the "participant_name" field.

public const int ParticipantNameFieldNumber = 5

Field Value

int

RoomNameFieldNumber

Field number for the "room_name" field.

public const int RoomNameFieldNumber = 3

Field Value

int

UrlFieldNumber

Field number for the "url" field.

public const int UrlFieldNumber = 9

Field Value

int

VideoFieldNumber

Field number for the "video" field.

public const int VideoFieldNumber = 7

Field Value

int

Properties

Audio

public IngressAudioOptions Audio { get; set; }

Property Value

IngressAudioOptions

BypassTranscoding

[depreacted ] whether to pass through the incoming media without transcoding, only compatible with some input types. Use enable_transcoding instead.

[Obsolete]
public bool BypassTranscoding { get; set; }

Property Value

bool

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EnableTranscoding

Whether to transcode the ingested media. Only WHIP supports disabling transcoding currently. WHIP will default to transcoding disabled. Replaces `bypass_transcoding.

public bool EnableTranscoding { get; set; }

Property Value

bool

Enabled

The default value is true and when set to false, the new connection attempts will be rejected

public bool Enabled { get; set; }

Property Value

bool

HasEnableTranscoding

Gets whether the "enable_transcoding" field is set

public bool HasEnableTranscoding { get; }

Property Value

bool

HasEnabled

Gets whether the "enabled" field is set

public bool HasEnabled { get; }

Property Value

bool

InputType

public IngressInput InputType { get; set; }

Property Value

IngressInput

Name

User provided identifier for the ingress

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<CreateIngressRequest> Parser { get; }

Property Value

MessageParser<CreateIngressRequest>

ParticipantIdentity

publish as participant

public string ParticipantIdentity { get; set; }

Property Value

string

ParticipantMetadata

metadata associated with the publishing participant

public string ParticipantMetadata { get; set; }

Property Value

string

ParticipantName

name of publishing participant (used for display only)

public string ParticipantName { get; set; }

Property Value

string

RoomName

room to publish to

public string RoomName { get; set; }

Property Value

string

Url

Where to pull media from, only for URL input type

public string Url { get; set; }

Property Value

string

Video

public IngressVideoOptions Video { get; set; }

Property Value

IngressVideoOptions

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

ClearEnableTranscoding()

Clears the value of the "enable_transcoding" field

public void ClearEnableTranscoding()

ClearEnabled()

Clears the value of the "enabled" field

public void ClearEnabled()

Clone()

Creates a deep clone of this object.

public CreateIngressRequest Clone()

Returns

CreateIngressRequest

A deep clone of this object.

Equals(CreateIngressRequest)

public bool Equals(CreateIngressRequest other)

Parameters

other CreateIngressRequest

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(CreateIngressRequest)

Merges the given message into this one.

public void MergeFrom(CreateIngressRequest other)

Parameters

other CreateIngressRequest

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.