Documentation

Header extends Message
in package

main DataStream.Header that contains a oneof for specific headers

Generated from protobuf message livekit.DataStream.Header

Table of Contents

Properties

$content_header  : mixed
$encryption_type  : mixed
this is set on the DataPacket
$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.
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>
getContentHeader()  : string
getEncryptionType()  : int
this is set on the DataPacket
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
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>
setEncryptionType()  : $this
this is set on the DataPacket
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

Properties

$content_header

protected mixed $content_header

$encryption_type

this is set on the DataPacket

protected mixed $encryption_type = 0

Generated from protobuf field .livekit.Encryption.Type encryption_type = 7 [deprecated = true];

$mime_type

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

protected mixed $mime_type = ''

$stream_id

unique identifier for this data stream

protected mixed $stream_id = ''

Generated from protobuf field string stream_id = 1;

$timestamp

using int64 for Unix timestamp

protected mixed $timestamp = 0

Generated from protobuf field int64 timestamp = 2;

$topic

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

protected mixed $topic = ''

$total_length

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

protected mixed $total_length = null

Generated from protobuf field optional uint64 total_length = 5;

$attributes

user defined attributes map that can carry additional info

private mixed $attributes

Generated from protobuf field map<string, string> attributes = 8;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type string $stream_id
      unique identifier for this data stream
@type int|string $timestamp
      using int64 for Unix timestamp
@type string $topic
@type string $mime_type
@type int|string $total_length
      only populated for finite streams, if it's a stream of unknown size this stays empty
@type int $encryption_type
       this is set on the DataPacket
@type array|\Google\Protobuf\Internal\MapField $attributes
      user defined attributes map that can carry additional info
@type \Livekit\DataStream\TextHeader $text_header
@type \Livekit\DataStream\ByteHeader $byte_header

}

clearTotalLength()

public clearTotalLength() : mixed

getAttributes()

user defined attributes map that can carry additional info

public getAttributes() : MapField

Generated from protobuf field map<string, string> attributes = 8;

Return values
MapField

getByteHeader()

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

public getByteHeader() : ByteHeader|null
Return values
ByteHeader|null

getContentHeader()

public getContentHeader() : string
Return values
string

getEncryptionType()

this is set on the DataPacket

public getEncryptionType() : int

Generated from protobuf field .livekit.Encryption.Type encryption_type = 7 [deprecated = true];

Return values
int

getMimeType()

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

public getMimeType() : string
Return values
string

getStreamId()

unique identifier for this data stream

public getStreamId() : string

Generated from protobuf field string stream_id = 1;

Return values
string

getTextHeader()

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

public getTextHeader() : TextHeader|null
Return values
TextHeader|null

getTimestamp()

using int64 for Unix timestamp

public getTimestamp() : int|string

Generated from protobuf field int64 timestamp = 2;

Return values
int|string

getTopic()

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

public getTopic() : string
Return values
string

getTotalLength()

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

public getTotalLength() : int|string

Generated from protobuf field optional uint64 total_length = 5;

Return values
int|string

hasByteHeader()

public hasByteHeader() : mixed

hasTextHeader()

public hasTextHeader() : mixed

hasTotalLength()

public hasTotalLength() : mixed

setAttributes()

user defined attributes map that can carry additional info

public setAttributes(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> attributes = 8;

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setByteHeader()

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

public setByteHeader(ByteHeader $var) : $this
Parameters
$var : ByteHeader
Return values
$this

setEncryptionType()

this is set on the DataPacket

public setEncryptionType(int $var) : $this

Generated from protobuf field .livekit.Encryption.Type encryption_type = 7 [deprecated = true];

Parameters
$var : int
Return values
$this

setMimeType()

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

public setMimeType(string $var) : $this
Parameters
$var : string
Return values
$this

setStreamId()

unique identifier for this data stream

public setStreamId(string $var) : $this

Generated from protobuf field string stream_id = 1;

Parameters
$var : string
Return values
$this

setTextHeader()

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

public setTextHeader(TextHeader $var) : $this
Parameters
$var : TextHeader
Return values
$this

setTimestamp()

using int64 for Unix timestamp

public setTimestamp(int|string $var) : $this

Generated from protobuf field int64 timestamp = 2;

Parameters
$var : int|string
Return values
$this

setTopic()

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

public setTopic(string $var) : $this
Parameters
$var : string
Return values
$this

setTotalLength()

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

public setTotalLength(int|string $var) : $this

Generated from protobuf field optional uint64 total_length = 5;

Parameters
$var : int|string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results