Table of Contents

Class IngressInfo

Namespace
LiveKit.Proto
Assembly
LiveKit.AspNetCore.ServerSdk.Abstractions.dll
public sealed class IngressInfo : IMessage<IngressInfo>, IEquatable<IngressInfo>, IDeepCloneable<IngressInfo>, IBufferMessage, IMessage
Inheritance
IngressInfo
Implements
IMessage<IngressInfo>
IDeepCloneable<IngressInfo>
IBufferMessage
IMessage
Inherited Members

Constructors

IngressInfo() 

public IngressInfo()

IngressInfo(IngressInfo) 

public IngressInfo(IngressInfo other)

Parameters

other IngressInfo

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 = 13

Field Value

int

EnableTranscodingFieldNumber

Field number for the "enable_transcoding" field.

public const int EnableTranscodingFieldNumber = 15

Field Value

int

EnabledFieldNumber

Field number for the "enabled" field.

public const int EnabledFieldNumber = 16

Field Value

int

IngressIdFieldNumber

Field number for the "ingress_id" field.

public const int IngressIdFieldNumber = 1

Field Value

int

InputTypeFieldNumber

Field number for the "input_type" field.

public const int InputTypeFieldNumber = 5

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 = 9

Field Value

int

ParticipantMetadataFieldNumber

Field number for the "participant_metadata" field.

public const int ParticipantMetadataFieldNumber = 14

Field Value

int

ParticipantNameFieldNumber

Field number for the "participant_name" field.

public const int ParticipantNameFieldNumber = 10

Field Value

int

ReusableFieldNumber

Field number for the "reusable" field.

public const int ReusableFieldNumber = 11

Field Value

int

RoomNameFieldNumber

Field number for the "room_name" field.

public const int RoomNameFieldNumber = 8

Field Value

int

StateFieldNumber

Field number for the "state" field.

public const int StateFieldNumber = 12

Field Value

int

StreamKeyFieldNumber

Field number for the "stream_key" field.

public const int StreamKeyFieldNumber = 3

Field Value

int

UrlFieldNumber

Field number for the "url" field.

public const int UrlFieldNumber = 4

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 

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

Property Value

bool

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EnableTranscoding 

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

IngressId 

public string IngressId { get; set; }

Property Value

string

InputType

for RTMP input, it'll be a rtmp:// URL for FILE input, it'll be a http:// URL for SRT input, it'll be a srt:// URL

public IngressInput InputType { get; set; }

Property Value

IngressInput

Name 

public string Name { get; set; }

Property Value

string

Parser 

public static MessageParser<IngressInfo> Parser { get; }

Property Value

MessageParser<IngressInfo>

ParticipantIdentity 

public string ParticipantIdentity { get; set; }

Property Value

string

ParticipantMetadata 

public string ParticipantMetadata { get; set; }

Property Value

string

ParticipantName 

public string ParticipantName { get; set; }

Property Value

string

Reusable 

public bool Reusable { get; set; }

Property Value

bool

RoomName 

public string RoomName { get; set; }

Property Value

string

State

Description of error/stream non compliance and debug info for publisher otherwise (received bitrate, resolution, bandwidth)

public IngressState State { get; set; }

Property Value

IngressState

StreamKey 

public string StreamKey { get; set; }

Property Value

string

Url

URL to point the encoder to for push (RTMP, WHIP), or location to pull media from for pull (URL)

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 IngressInfo Clone()

Returns

IngressInfo

A deep clone of this object.

Equals(IngressInfo) 

public bool Equals(IngressInfo other)

Parameters

other IngressInfo

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(IngressInfo)

Merges the given message into this one.

public void MergeFrom(IngressInfo other)

Parameters

other IngressInfo

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.

Edit this page