Documentation

UpdateTrackSettings extends Message
in package

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

Table of Contents

Properties

$disabled  : mixed
when true, the track is placed in a paused state, with no new data returned
$fps  : mixed
Generated from protobuf field <code>uint32 fps = 7;</code>
$height  : mixed
for video, height to receive
$priority  : mixed
subscription priority. 1 being the highest (0 is unset) when unset, server sill assign priority based on the order of subscription server will use priority in the following ways: 1. when subscribed tracks exceed per-participant subscription limit, server will pause the lowest priority tracks 2. when the network is congested, server will assign available bandwidth to higher priority tracks first. lowest priority tracks can be paused
$quality  : mixed
deprecated in favor of width & height
$width  : mixed
for video, width to receive
$track_sids  : mixed
Generated from protobuf field <code>repeated string track_sids = 1;</code>

Methods

__construct()  : mixed
Constructor.
getDisabled()  : bool
when true, the track is placed in a paused state, with no new data returned
getFps()  : int
Generated from protobuf field <code>uint32 fps = 7;</code>
getHeight()  : int
for video, height to receive
getPriority()  : int
subscription priority. 1 being the highest (0 is unset) when unset, server sill assign priority based on the order of subscription server will use priority in the following ways: 1. when subscribed tracks exceed per-participant subscription limit, server will pause the lowest priority tracks 2. when the network is congested, server will assign available bandwidth to higher priority tracks first. lowest priority tracks can be paused
getQuality()  : int
deprecated in favor of width & height
getTrackSids()  : RepeatedField<string|int, string>
Generated from protobuf field <code>repeated string track_sids = 1;</code>
getWidth()  : int
for video, width to receive
setDisabled()  : $this
when true, the track is placed in a paused state, with no new data returned
setFps()  : $this
Generated from protobuf field <code>uint32 fps = 7;</code>
setHeight()  : $this
for video, height to receive
setPriority()  : $this
subscription priority. 1 being the highest (0 is unset) when unset, server sill assign priority based on the order of subscription server will use priority in the following ways: 1. when subscribed tracks exceed per-participant subscription limit, server will pause the lowest priority tracks 2. when the network is congested, server will assign available bandwidth to higher priority tracks first. lowest priority tracks can be paused
setQuality()  : $this
deprecated in favor of width & height
setTrackSids()  : $this
Generated from protobuf field <code>repeated string track_sids = 1;</code>
setWidth()  : $this
for video, width to receive

Properties

$disabled

when true, the track is placed in a paused state, with no new data returned

protected mixed $disabled = false

Generated from protobuf field bool disabled = 3;

$fps

Generated from protobuf field <code>uint32 fps = 7;</code>

protected mixed $fps = 0

$height

for video, height to receive

protected mixed $height = 0

Generated from protobuf field uint32 height = 6;

$priority

subscription priority. 1 being the highest (0 is unset) when unset, server sill assign priority based on the order of subscription server will use priority in the following ways: 1. when subscribed tracks exceed per-participant subscription limit, server will pause the lowest priority tracks 2. when the network is congested, server will assign available bandwidth to higher priority tracks first. lowest priority tracks can be paused

protected mixed $priority = 0

Generated from protobuf field uint32 priority = 8;

$quality

deprecated in favor of width & height

protected mixed $quality = 0

Generated from protobuf field .livekit.VideoQuality quality = 4;

$width

for video, width to receive

protected mixed $width = 0

Generated from protobuf field uint32 width = 5;

$track_sids

Generated from protobuf field <code>repeated string track_sids = 1;</code>

private mixed $track_sids

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[] $track_sids
@type bool $disabled
      when true, the track is placed in a paused state, with no new data returned
@type int $quality
      deprecated in favor of width & height
@type int $width
      for video, width to receive
@type int $height
      for video, height to receive
@type int $fps
@type int $priority
      subscription priority. 1 being the highest (0 is unset)
      when unset, server sill assign priority based on the order of subscription
      server will use priority in the following ways:
      1. when subscribed tracks exceed per-participant subscription limit, server will
         pause the lowest priority tracks
      2. when the network is congested, server will assign available bandwidth to
         higher priority tracks first. lowest priority tracks can be paused

}

getDisabled()

when true, the track is placed in a paused state, with no new data returned

public getDisabled() : bool

Generated from protobuf field bool disabled = 3;

Return values
bool

getFps()

Generated from protobuf field <code>uint32 fps = 7;</code>

public getFps() : int
Return values
int

getHeight()

for video, height to receive

public getHeight() : int

Generated from protobuf field uint32 height = 6;

Return values
int

getPriority()

subscription priority. 1 being the highest (0 is unset) when unset, server sill assign priority based on the order of subscription server will use priority in the following ways: 1. when subscribed tracks exceed per-participant subscription limit, server will pause the lowest priority tracks 2. when the network is congested, server will assign available bandwidth to higher priority tracks first. lowest priority tracks can be paused

public getPriority() : int

Generated from protobuf field uint32 priority = 8;

Return values
int

getQuality()

deprecated in favor of width & height

public getQuality() : int

Generated from protobuf field .livekit.VideoQuality quality = 4;

Return values
int

getTrackSids()

Generated from protobuf field <code>repeated string track_sids = 1;</code>

public getTrackSids() : RepeatedField<string|int, string>
Return values
RepeatedField<string|int, string>

getWidth()

for video, width to receive

public getWidth() : int

Generated from protobuf field uint32 width = 5;

Return values
int

setDisabled()

when true, the track is placed in a paused state, with no new data returned

public setDisabled(bool $var) : $this

Generated from protobuf field bool disabled = 3;

Parameters
$var : bool
Return values
$this

setFps()

Generated from protobuf field <code>uint32 fps = 7;</code>

public setFps(int $var) : $this
Parameters
$var : int
Return values
$this

setHeight()

for video, height to receive

public setHeight(int $var) : $this

Generated from protobuf field uint32 height = 6;

Parameters
$var : int
Return values
$this

setPriority()

subscription priority. 1 being the highest (0 is unset) when unset, server sill assign priority based on the order of subscription server will use priority in the following ways: 1. when subscribed tracks exceed per-participant subscription limit, server will pause the lowest priority tracks 2. when the network is congested, server will assign available bandwidth to higher priority tracks first. lowest priority tracks can be paused

public setPriority(int $var) : $this

Generated from protobuf field uint32 priority = 8;

Parameters
$var : int
Return values
$this

setQuality()

deprecated in favor of width & height

public setQuality(int $var) : $this

Generated from protobuf field .livekit.VideoQuality quality = 4;

Parameters
$var : int
Return values
$this

setTrackSids()

Generated from protobuf field <code>repeated string track_sids = 1;</code>

public setTrackSids(array<string|int, string> $var) : $this
Parameters
$var : array<string|int, string>
Return values
$this

setWidth()

for video, width to receive

public setWidth(int $var) : $this

Generated from protobuf field uint32 width = 5;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results