Documentation

DataTrackInfo extends Message
in package

Generated from protobuf message <code>livekit.DataTrackInfo</code>

Table of Contents

Properties

$encryption  : mixed
Method used for end-to-end encryption (E2EE) on packet payloads.
$frame_encoding  : mixed
Encoding for frame payloads on this track. If unspecified, the track is untyped.
$name  : mixed
Human-readable identifier (e.g., `geoLocation`, `servoPosition.x`, etc.), unique per publisher.
$pub_handle  : mixed
Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.
$schema  : mixed
ID of the schema used by frames on this track if the track is typed.
$sid  : mixed
Server-assigned track identifier.

Methods

__construct()  : mixed
Constructor.
clearFrameEncoding()  : mixed
clearSchema()  : mixed
getEncryption()  : int
Method used for end-to-end encryption (E2EE) on packet payloads.
getFrameEncoding()  : DataTrackFrameEncoding|null
Encoding for frame payloads on this track. If unspecified, the track is untyped.
getName()  : string
Human-readable identifier (e.g., `geoLocation`, `servoPosition.x`, etc.), unique per publisher.
getPubHandle()  : int
Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.
getSchema()  : DataTrackSchemaId|null
ID of the schema used by frames on this track if the track is typed.
getSid()  : string
Server-assigned track identifier.
hasFrameEncoding()  : mixed
hasSchema()  : mixed
setEncryption()  : $this
Method used for end-to-end encryption (E2EE) on packet payloads.
setFrameEncoding()  : $this
Encoding for frame payloads on this track. If unspecified, the track is untyped.
setName()  : $this
Human-readable identifier (e.g., `geoLocation`, `servoPosition.x`, etc.), unique per publisher.
setPubHandle()  : $this
Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.
setSchema()  : $this
ID of the schema used by frames on this track if the track is typed.
setSid()  : $this
Server-assigned track identifier.

Properties

$encryption

Method used for end-to-end encryption (E2EE) on packet payloads.

protected mixed $encryption = 0

Generated from protobuf field .livekit.Encryption.Type encryption = 4;

$frame_encoding

Encoding for frame payloads on this track. If unspecified, the track is untyped.

protected mixed $frame_encoding = null

Generated from protobuf field optional .livekit.DataTrackFrameEncoding frame_encoding = 5;

$name

Human-readable identifier (e.g., `geoLocation`, `servoPosition.x`, etc.), unique per publisher.

protected mixed $name = ''

Generated from protobuf field string name = 3;

$pub_handle

Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.

protected mixed $pub_handle = 0

Generated from protobuf field uint32 pub_handle = 1;

$schema

ID of the schema used by frames on this track if the track is typed.

protected mixed $schema = null

Generated from protobuf field optional .livekit.DataTrackSchemaId schema = 6;

$sid

Server-assigned track identifier.

protected mixed $sid = ''

Generated from protobuf field string sid = 2;

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 int $pub_handle
      Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.
@type string $sid
      Server-assigned track identifier.
@type string $name
      Human-readable identifier (e.g., `geoLocation`, `servoPosition.x`, etc.), unique per publisher.
@type int $encryption
      Method used for end-to-end encryption (E2EE) on packet payloads.
@type \Livekit\DataTrackFrameEncoding $frame_encoding
      Encoding for frame payloads on this track. If unspecified, the track is untyped.
@type \Livekit\DataTrackSchemaId $schema
      ID of the schema used by frames on this track if the track is typed.

}

getEncryption()

Method used for end-to-end encryption (E2EE) on packet payloads.

public getEncryption() : int

Generated from protobuf field .livekit.Encryption.Type encryption = 4;

Return values
int

getFrameEncoding()

Encoding for frame payloads on this track. If unspecified, the track is untyped.

public getFrameEncoding() : DataTrackFrameEncoding|null

Generated from protobuf field optional .livekit.DataTrackFrameEncoding frame_encoding = 5;

Return values
DataTrackFrameEncoding|null

getName()

Human-readable identifier (e.g., `geoLocation`, `servoPosition.x`, etc.), unique per publisher.

public getName() : string

Generated from protobuf field string name = 3;

Return values
string

getPubHandle()

Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.

public getPubHandle() : int

Generated from protobuf field uint32 pub_handle = 1;

Return values
int

getSchema()

ID of the schema used by frames on this track if the track is typed.

public getSchema() : DataTrackSchemaId|null

Generated from protobuf field optional .livekit.DataTrackSchemaId schema = 6;

Return values
DataTrackSchemaId|null

getSid()

Server-assigned track identifier.

public getSid() : string

Generated from protobuf field string sid = 2;

Return values
string

setEncryption()

Method used for end-to-end encryption (E2EE) on packet payloads.

public setEncryption(int $var) : $this

Generated from protobuf field .livekit.Encryption.Type encryption = 4;

Parameters
$var : int
Return values
$this

setFrameEncoding()

Encoding for frame payloads on this track. If unspecified, the track is untyped.

public setFrameEncoding(DataTrackFrameEncoding $var) : $this

Generated from protobuf field optional .livekit.DataTrackFrameEncoding frame_encoding = 5;

Parameters
$var : DataTrackFrameEncoding
Return values
$this

setName()

Human-readable identifier (e.g., `geoLocation`, `servoPosition.x`, etc.), unique per publisher.

public setName(string $var) : $this

Generated from protobuf field string name = 3;

Parameters
$var : string
Return values
$this

setPubHandle()

Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.

public setPubHandle(int $var) : $this

Generated from protobuf field uint32 pub_handle = 1;

Parameters
$var : int
Return values
$this

setSchema()

ID of the schema used by frames on this track if the track is typed.

public setSchema(DataTrackSchemaId $var) : $this

Generated from protobuf field optional .livekit.DataTrackSchemaId schema = 6;

Parameters
$var : DataTrackSchemaId
Return values
$this

setSid()

Server-assigned track identifier.

public setSid(string $var) : $this

Generated from protobuf field string sid = 2;

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

Search results