Class CreateIngressRequest

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.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.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CreateIngressRequest()

public CreateIngressRequest()

CreateIngressRequest(CreateIngressRequest)

public CreateIngressRequest(CreateIngressRequest other)

Parameters

other CreateIngressRequest

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

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

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

ClearEnableTranscoding()

Clears the value of the "enable_transcoding" field

public void ClearEnableTranscoding()

ClearEnabled()

Clears the value of the "enabled" field

public void ClearEnabled()