Table of Contents

Class CaptureSourceEvent

Namespace
LiveKit.Proto

Delivered exactly once when a started capture ends, regardless of why (stop request, end of stream, or failure).

public sealed class CaptureSourceEvent : Google.Protobuf.IMessage<CaptureSourceEvent>, Google.Protobuf.IBufferMessage
Inheritance
CaptureSourceEvent
Implements
IBufferMessage
Extension Methods

Constructors

CaptureSourceEvent()

public CaptureSourceEvent()

CaptureSourceEvent(CaptureSourceEvent)

public CaptureSourceEvent(CaptureSourceEvent other)

Parameters

other CaptureSourceEvent

Fields

CaptureHandleFieldNumber

Field number for the "capture_handle" field.

public const int CaptureHandleFieldNumber = 1

Field Value

int

ErrorFieldNumber

Field number for the "error" field.

public const int ErrorFieldNumber = 3

Field Value

int

FinishedFieldNumber

Field number for the "finished" field.

public const int FinishedFieldNumber = 2

Field Value

int

Properties

CaptureHandle

public ulong CaptureHandle { get; set; }

Property Value

ulong

Descriptor

public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Error

public CaptureError Error { get; set; }

Property Value

CaptureError

Finished

public CaptureFinished Finished { get; set; }

Property Value

CaptureFinished

HasCaptureHandle

Gets whether the "capture_handle" field is set

public bool HasCaptureHandle { get; }

Property Value

bool

MessageCase

public CaptureSourceEvent.MessageOneofCase MessageCase { get; }

Property Value

CaptureSourceEvent.MessageOneofCase

Parser

public static Google.Protobuf.MessageParser<CaptureSourceEvent> Parser { get; }

Property Value

MessageParser<CaptureSourceEvent>

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearCaptureHandle()

Clears the value of the "capture_handle" field

public void ClearCaptureHandle()

ClearMessage()

public void ClearMessage()

Clone()

public CaptureSourceEvent Clone()

Returns

CaptureSourceEvent

Equals(CaptureSourceEvent)

public bool Equals(CaptureSourceEvent other)

Parameters

other CaptureSourceEvent

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

public void MergeFrom(Google.Protobuf.CodedInputStream input)

Parameters

input CodedInputStream

MergeFrom(CaptureSourceEvent)

public void MergeFrom(CaptureSourceEvent other)

Parameters

other CaptureSourceEvent

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream