Class WebhookEvent

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

WebhookEvent

Implements

IMessage<WebhookEvent>

IEquatable<WebhookEvent>

IDeepCloneable<WebhookEvent>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WebhookEvent()

public WebhookEvent()

WebhookEvent(WebhookEvent)

public WebhookEvent(WebhookEvent other)

Parameters

other WebhookEvent

Fields

CreatedAtFieldNumber

Field number for the "created_at" field.

public const int CreatedAtFieldNumber = 7

Field Value

int

EgressInfoFieldNumber

Field number for the "egress_info" field.

public const int EgressInfoFieldNumber = 9

Field Value

int

EventFieldNumber

Field number for the "event" field.

public const int EventFieldNumber = 1

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 6

Field Value

int

IngressInfoFieldNumber

Field number for the "ingress_info" field.

public const int IngressInfoFieldNumber = 10

Field Value

int

NumDroppedFieldNumber

Field number for the "num_dropped" field.

public const int NumDroppedFieldNumber = 11

Field Value

int

ParticipantFieldNumber

Field number for the "participant" field.

public const int ParticipantFieldNumber = 3

Field Value

int

RoomFieldNumber

Field number for the "room" field.

public const int RoomFieldNumber = 2

Field Value

int

TrackFieldNumber

Field number for the "track" field.

public const int TrackFieldNumber = 8

Field Value

int

Properties

CreatedAt

timestamp in seconds

public long CreatedAt { get; set; }

Property Value

long

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EgressInfo

set when event is egress_*

public EgressInfo EgressInfo { get; set; }

Property Value

EgressInfo

Event

one of room_started, room_finished, participant_joined, participant_left, participant_connection_aborted, track_published, track_unpublished, egress_started, egress_updated, egress_ended, ingress_started, ingress_ended

public string Event { get; set; }

Property Value

string

Id

unique event uuid

public string Id { get; set; }

Property Value

string

IngressInfo

set when event is ingress_*

public IngressInfo IngressInfo { get; set; }

Property Value

IngressInfo

NumDropped

[Obsolete]
public int NumDropped { get; set; }

Property Value

int

Parser

public static MessageParser<WebhookEvent> Parser { get; }

Property Value

MessageParser<WebhookEvent>

Participant

set when event is participant_* or track_*

public ParticipantInfo Participant { get; set; }

Property Value

ParticipantInfo

Room

public Room Room { get; set; }

Property Value

Room

Track

set when event is track_*

public TrackInfo Track { get; set; }

Property Value

TrackInfo

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.

Clone()

Creates a deep clone of this object.

public WebhookEvent Clone()

Returns

WebhookEvent

A deep clone of this object.

Equals(WebhookEvent)

public bool Equals(WebhookEvent other)

Parameters

other WebhookEvent

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

Merges the given message into this one.

public void MergeFrom(WebhookEvent other)

Parameters

other WebhookEvent

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.