Documentation

Chunk extends Message
in package

Generated from protobuf message <code>livekit.DataStream.Chunk</code>

Table of Contents

Properties

$chunk_index  : mixed
Generated from protobuf field <code>uint64 chunk_index = 2;</code>
$content  : mixed
content as binary (bytes)
$iv  : mixed
this is set on the DataPacket
$stream_id  : mixed
unique identifier for this data stream to map it to the correct header
$version  : mixed
a version indicating that this chunk_index has been retroactively modified and the original one needs to be replaced

Methods

__construct()  : mixed
Constructor.
clearIv()  : mixed
getChunkIndex()  : int|string
Generated from protobuf field <code>uint64 chunk_index = 2;</code>
getContent()  : string
content as binary (bytes)
getIv()  : string
this is set on the DataPacket
getStreamId()  : string
unique identifier for this data stream to map it to the correct header
getVersion()  : int
a version indicating that this chunk_index has been retroactively modified and the original one needs to be replaced
hasIv()  : mixed
setChunkIndex()  : $this
Generated from protobuf field <code>uint64 chunk_index = 2;</code>
setContent()  : $this
content as binary (bytes)
setIv()  : $this
this is set on the DataPacket
setStreamId()  : $this
unique identifier for this data stream to map it to the correct header
setVersion()  : $this
a version indicating that this chunk_index has been retroactively modified and the original one needs to be replaced

Properties

$chunk_index

Generated from protobuf field <code>uint64 chunk_index = 2;</code>

protected mixed $chunk_index = 0

$content

content as binary (bytes)

protected mixed $content = ''

Generated from protobuf field bytes content = 3;

$iv

this is set on the DataPacket

protected mixed $iv = null

Generated from protobuf field optional bytes iv = 5 [deprecated = true];

$stream_id

unique identifier for this data stream to map it to the correct header

protected mixed $stream_id = ''

Generated from protobuf field string stream_id = 1;

$version

a version indicating that this chunk_index has been retroactively modified and the original one needs to be replaced

protected mixed $version = 0

Generated from protobuf field int32 version = 4;

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 to map it to the correct header
@type int|string $chunk_index
@type string $content
      content as binary (bytes)
@type int $version
      a version indicating that this chunk_index has been retroactively modified and the original one needs to be replaced
@type string $iv
      this is set on the DataPacket

}

clearIv()

public clearIv() : mixed

getChunkIndex()

Generated from protobuf field <code>uint64 chunk_index = 2;</code>

public getChunkIndex() : int|string
Return values
int|string

getContent()

content as binary (bytes)

public getContent() : string

Generated from protobuf field bytes content = 3;

Return values
string

getIv()

this is set on the DataPacket

public getIv() : string

Generated from protobuf field optional bytes iv = 5 [deprecated = true];

Return values
string

getStreamId()

unique identifier for this data stream to map it to the correct header

public getStreamId() : string

Generated from protobuf field string stream_id = 1;

Return values
string

getVersion()

a version indicating that this chunk_index has been retroactively modified and the original one needs to be replaced

public getVersion() : int

Generated from protobuf field int32 version = 4;

Return values
int

hasIv()

public hasIv() : mixed

setChunkIndex()

Generated from protobuf field <code>uint64 chunk_index = 2;</code>

public setChunkIndex(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setContent()

content as binary (bytes)

public setContent(string $var) : $this

Generated from protobuf field bytes content = 3;

Parameters
$var : string
Return values
$this

setIv()

this is set on the DataPacket

public setIv(string $var) : $this

Generated from protobuf field optional bytes iv = 5 [deprecated = true];

Parameters
$var : string
Return values
$this

setStreamId()

unique identifier for this data stream to map it to the correct header

public setStreamId(string $var) : $this

Generated from protobuf field string stream_id = 1;

Parameters
$var : string
Return values
$this

setVersion()

a version indicating that this chunk_index has been retroactively modified and the original one needs to be replaced

public setVersion(int $var) : $this

Generated from protobuf field int32 version = 4;

Parameters
$var : int
Return values
$this

        
On this page

Search results