Table of Contents

Class CaptureSourceInfo

Namespace
LiveKit.Proto
public sealed class CaptureSourceInfo : Google.Protobuf.IMessage<CaptureSourceInfo>, Google.Protobuf.IBufferMessage
Inheritance
CaptureSourceInfo
Implements
IBufferMessage
Extension Methods

Constructors

CaptureSourceInfo()

public CaptureSourceInfo()

CaptureSourceInfo(CaptureSourceInfo)

public CaptureSourceInfo(CaptureSourceInfo other)

Parameters

other CaptureSourceInfo

Fields

CodecFieldNumber

Field number for the "codec" field.

public const int CodecFieldNumber = 3

Field Value

int

KindFieldNumber

Field number for the "kind" field.

public const int KindFieldNumber = 1

Field Value

int

RecommendedPublishOptionsFieldNumber

Field number for the "recommended_publish_options" field.

public const int RecommendedPublishOptionsFieldNumber = 4

Field Value

int

ResolutionFieldNumber

Field number for the "resolution" field.

public const int ResolutionFieldNumber = 2

Field Value

int

VideoSourceFieldNumber

Field number for the "video_source" field.

public const int VideoSourceFieldNumber = 5

Field Value

int

Properties

Codec

Codec produced by the source; encoded sources only.

public VideoCodec Codec { get; set; }

Property Value

VideoCodec

Descriptor

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

Property Value

MessageDescriptor

HasCodec

Gets whether the "codec" field is set

public bool HasCodec { get; }

Property Value

bool

HasKind

Gets whether the "kind" field is set

public bool HasKind { get; }

Property Value

bool

Kind

public CaptureSourceKind Kind { get; set; }

Property Value

CaptureSourceKind

Parser

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

Property Value

MessageParser<CaptureSourceInfo>

RecommendedPublishOptions

Publish options derived from the source (codec, encoder backend, ...). Merge application options (e.g. track source) over these when calling PublishTrackRequest.

public TrackPublishOptions RecommendedPublishOptions { get; set; }

Property Value

TrackPublishOptions

Resolution

Declared or discovered stream resolution.

public VideoSourceResolution Resolution { get; set; }

Property Value

VideoSourceResolution

VideoSource

RTC video source fed by this capture source; pass its handle to CreateVideoTrackRequest. Owned by the client like any other handle.

public OwnedVideoSource VideoSource { get; set; }

Property Value

OwnedVideoSource

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearCodec()

Clears the value of the "codec" field

public void ClearCodec()

ClearKind()

Clears the value of the "kind" field

public void ClearKind()

Clone()

public CaptureSourceInfo Clone()

Returns

CaptureSourceInfo

Equals(CaptureSourceInfo)

public bool Equals(CaptureSourceInfo other)

Parameters

other CaptureSourceInfo

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

public void MergeFrom(CaptureSourceInfo other)

Parameters

other CaptureSourceInfo

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream