Documentation

PublishDataTrackRequest extends Message
in package

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

Table of Contents

Properties

$encryption  : mixed
Method used for end-to-end encryption (E2EE) on frame payloads.
$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.

Methods

__construct()  : mixed
Constructor.
getEncryption()  : int
Method used for end-to-end encryption (E2EE) on frame payloads.
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.
setEncryption()  : $this
Method used for end-to-end encryption (E2EE) on frame payloads.
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.

Properties

$encryption

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

protected mixed $encryption = 0

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

$name

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

protected mixed $name = ''

This must be non-empty and no longer than 256 characters.

Generated from protobuf field string name = 2;

$pub_handle

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

protected mixed $pub_handle = 0

This must be non-zero and unique for each data track published by the publisher.

Generated from protobuf field uint32 pub_handle = 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 int $pub_handle
      Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.
      This must be non-zero and unique for each data track published by the publisher.
@type string $name
      Human-readable identifier (e.g., `geoLocation`, `servoPosition.x`, etc.), unique per publisher.
      This must be non-empty and no longer than 256 characters.
@type int $encryption
      Method used for end-to-end encryption (E2EE) on frame payloads.

}

getEncryption()

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

public getEncryption() : int

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

Return values
int

getName()

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

public getName() : string

This must be non-empty and no longer than 256 characters.

Generated from protobuf field string name = 2;

Return values
string

getPubHandle()

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

public getPubHandle() : int

This must be non-zero and unique for each data track published by the publisher.

Generated from protobuf field uint32 pub_handle = 1;

Return values
int

setEncryption()

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

public setEncryption(int $var) : $this

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

Parameters
$var : int
Return values
$this

setName()

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

public setName(string $var) : $this

This must be non-empty and no longer than 256 characters.

Generated from protobuf field string name = 2;

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

This must be non-zero and unique for each data track published by the publisher.

Generated from protobuf field uint32 pub_handle = 1;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results