Documentation

Header extends Message

in package

• Application

main DataStream.Header that contains a oneof for specific headers

Table of Contents

Properties

$compression  : mixed

Generated from protobuf field <code>.livekit.DataStream.CompressionType compression = 12;</code>

$content_header  : mixed

$encryption_type  : mixed

this is set on the DataPacket

$inline_content  : mixed

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

$mime_type  : mixed

Generated from protobuf field <code>string mime_type = 4;</code>

$stream_id  : mixed

unique identifier for this data stream

$timestamp  : mixed

using int64 for Unix timestamp

$topic  : mixed

Generated from protobuf field <code>string topic = 3;</code>

$total_length  : mixed

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

$attributes  : mixed

user defined attributes map that can carry additional info

Methods

__construct()  : mixed

Constructor.

clearInlineContent()  : mixed

clearTotalLength()  : mixed

getAttributes()  : MapField

user defined attributes map that can carry additional info

getByteHeader()  : ByteHeader|null

Generated from protobuf field <code>.livekit.DataStream.ByteHeader byte_header = 10;</code>

getCompression()  : int

Generated from protobuf field <code>.livekit.DataStream.CompressionType compression = 12;</code>

getContentHeader()  : string

getEncryptionType()  : int

this is set on the DataPacket

getInlineContent()  : string

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

getMimeType()  : string

Generated from protobuf field <code>string mime_type = 4;</code>

getStreamId()  : string

unique identifier for this data stream

getTextHeader()  : TextHeader|null

Generated from protobuf field <code>.livekit.DataStream.TextHeader text_header = 9;</code>

getTimestamp()  : int|string

using int64 for Unix timestamp

getTopic()  : string

Generated from protobuf field <code>string topic = 3;</code>

getTotalLength()  : int|string

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

hasByteHeader()  : mixed

hasInlineContent()  : mixed

hasTextHeader()  : mixed

hasTotalLength()  : mixed

setAttributes()  : $this

user defined attributes map that can carry additional info

setByteHeader()  : $this

Generated from protobuf field <code>.livekit.DataStream.ByteHeader byte_header = 10;</code>

setCompression()  : $this

Generated from protobuf field <code>.livekit.DataStream.CompressionType compression = 12;</code>

setEncryptionType()  : $this

this is set on the DataPacket

setInlineContent()  : $this

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

setMimeType()  : $this

Generated from protobuf field <code>string mime_type = 4;</code>

setStreamId()  : $this

unique identifier for this data stream

setTextHeader()  : $this

Generated from protobuf field <code>.livekit.DataStream.TextHeader text_header = 9;</code>

setTimestamp()  : $this

using int64 for Unix timestamp

setTopic()  : $this

Generated from protobuf field <code>string topic = 3;</code>

setTotalLength()  : $this

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