Table of Contents

Class StopCaptureRequest

Namespace
LiveKit.Proto

Signal a running capture to stop after the frame in flight. The terminal CaptureSourceEvent follows shortly. Stopping an already-finished capture is a no-op.

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

Constructors

StopCaptureRequest()

public StopCaptureRequest()

StopCaptureRequest(StopCaptureRequest)

public StopCaptureRequest(StopCaptureRequest other)

Parameters

other StopCaptureRequest

Fields

CaptureHandleFieldNumber

Field number for the "capture_handle" field.

public const int CaptureHandleFieldNumber = 1

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

HasCaptureHandle

Gets whether the "capture_handle" field is set

public bool HasCaptureHandle { get; }

Property Value

bool

Parser

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

Property Value

MessageParser<StopCaptureRequest>

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearCaptureHandle()

Clears the value of the "capture_handle" field

public void ClearCaptureHandle()

Clone()

public StopCaptureRequest Clone()

Returns

StopCaptureRequest

Equals(StopCaptureRequest)

public bool Equals(StopCaptureRequest other)

Parameters

other StopCaptureRequest

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

public void MergeFrom(StopCaptureRequest other)

Parameters

other StopCaptureRequest

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream