Documentation

DataBlob extends Message
in package

A blob of data stored in a room identified by a unique key.

Generated from protobuf message livekit.DataBlob

Table of Contents

Properties

$contents  : mixed
Contents of the data blob. This must not exceed 50 KB.
$key  : mixed
Unique key the data blob is identified by.

Methods

__construct()  : mixed
Constructor.
clearKey()  : mixed
getContents()  : string
Contents of the data blob. This must not exceed 50 KB.
getKey()  : DataBlobKey|null
Unique key the data blob is identified by.
hasKey()  : mixed
setContents()  : $this
Contents of the data blob. This must not exceed 50 KB.
setKey()  : $this
Unique key the data blob is identified by.

Properties

$contents

Contents of the data blob. This must not exceed 50 KB.

protected mixed $contents = ''

Generated from protobuf field bytes contents = 2 [(.logger.redact_format) = "<redacted ({{ .Size }} bytes)>", (.logger.sensitivity) = SENSITIVITY_PII];

$key

Unique key the data blob is identified by.

protected mixed $key = null

Generated from protobuf field .livekit.DataBlobKey key = 1;

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 \Livekit\DataBlobKey $key
      Unique key the data blob is identified by.
@type string $contents
      Contents of the data blob. This must not exceed 50 KB.

}

getContents()

Contents of the data blob. This must not exceed 50 KB.

public getContents() : string

Generated from protobuf field bytes contents = 2 [(.logger.redact_format) = "<redacted ({{ .Size }} bytes)>", (.logger.sensitivity) = SENSITIVITY_PII];

Return values
string

getKey()

Unique key the data blob is identified by.

public getKey() : DataBlobKey|null

Generated from protobuf field .livekit.DataBlobKey key = 1;

Return values
DataBlobKey|null

setContents()

Contents of the data blob. This must not exceed 50 KB.

public setContents(string $var) : $this

Generated from protobuf field bytes contents = 2 [(.logger.redact_format) = "<redacted ({{ .Size }} bytes)>", (.logger.sensitivity) = SENSITIVITY_PII];

Parameters
$var : string
Return values
$this

setKey()

Unique key the data blob is identified by.

public setKey(DataBlobKey $var) : $this

Generated from protobuf field .livekit.DataBlobKey key = 1;

Parameters
$var : DataBlobKey
Return values
$this
On this page

Search results