Class DataStream.Types.Header

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.dll

main DataStream.Header that contains a oneof for specific headers

public sealed class DataStream.Types.Header : IMessage<DataStream.Types.Header>, IEquatable<DataStream.Types.Header>, IDeepCloneable<DataStream.Types.Header>, IBufferMessage, IMessage

Inheritance

object

DataStream.Types.Header

Implements

IMessage<DataStream.Types.Header>

IEquatable<DataStream.Types.Header>

IDeepCloneable<DataStream.Types.Header>

IBufferMessage

IMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Header()

public Header()

Header(Header)

public Header(DataStream.Types.Header other)

Parameters

other DataStream.Types.Header

Properties

Attributes

user defined attributes map that can carry additional info

public MapField<string, string> Attributes { get; }

Property Value

MapField<string, string>

ByteHeader

public DataStream.Types.ByteHeader ByteHeader { get; set; }

Property Value

DataStream.Types.ByteHeader

Compression

public DataStream.Types.CompressionType Compression { get; set; }

Property Value

DataStream.Types.CompressionType

ContentHeaderCase

public DataStream.Types.Header.ContentHeaderOneofCase ContentHeaderCase { get; }

Property Value

DataStream.Types.Header.ContentHeaderOneofCase

EncryptionType

this is set on the DataPacket

[Obsolete]
public Encryption.Types.Type EncryptionType { get; set; }

Property Value

Encryption.Types.Type

HasInlineContent

Gets whether the "inline_content" field is set

public bool HasInlineContent { get; }

Property Value

bool

HasTotalLength

Gets whether the "total_length" field is set

public bool HasTotalLength { get; }

Property Value

bool

InlineContent

Optional inline content so that a data stream can be sent as a single packet for short payloads.

public ByteString InlineContent { get; set; }

Property Value

ByteString

MimeType

public string MimeType { get; set; }

Property Value

string

StreamId

unique identifier for this data stream

public string StreamId { get; set; }

Property Value

string

TextHeader

public DataStream.Types.TextHeader TextHeader { get; set; }

Property Value

DataStream.Types.TextHeader

Timestamp

using int64 for Unix timestamp

public long Timestamp { get; set; }

Property Value

long

Topic

public string Topic { get; set; }

Property Value

string

TotalLength

only populated for finite streams, if it's a stream of unknown size this stays empty

public ulong TotalLength { get; set; }

Property Value

ulong

Methods

ClearContentHeader()

public void ClearContentHeader()

ClearInlineContent()

Clears the value of the "inline_content" field

public void ClearInlineContent()

ClearTotalLength()

Clears the value of the "total_length" field

public void ClearTotalLength()