Documentation

VideoLayer extends Message
in package

provide information about available spatial layers

Generated from protobuf message livekit.VideoLayer

Table of Contents

Properties

$bitrate  : mixed
target bitrate in bit per second (bps), server will measure actual
$height  : mixed
Generated from protobuf field <code>uint32 height = 3;</code>
$quality  : mixed
for tracks with a single layer, this should be HIGH
$rid  : mixed
Generated from protobuf field <code>string rid = 7;</code>
$spatial_layer  : mixed
Generated from protobuf field <code>int32 spatial_layer = 6;</code>
$ssrc  : mixed
Generated from protobuf field <code>uint32 ssrc = 5;</code>
$width  : mixed
Generated from protobuf field <code>uint32 width = 2;</code>

Methods

__construct()  : mixed
Constructor.
getBitrate()  : int
target bitrate in bit per second (bps), server will measure actual
getHeight()  : int
Generated from protobuf field <code>uint32 height = 3;</code>
getQuality()  : int
for tracks with a single layer, this should be HIGH
getRid()  : string
Generated from protobuf field <code>string rid = 7;</code>
getSpatialLayer()  : int
Generated from protobuf field <code>int32 spatial_layer = 6;</code>
getSsrc()  : int
Generated from protobuf field <code>uint32 ssrc = 5;</code>
getWidth()  : int
Generated from protobuf field <code>uint32 width = 2;</code>
setBitrate()  : $this
target bitrate in bit per second (bps), server will measure actual
setHeight()  : $this
Generated from protobuf field <code>uint32 height = 3;</code>
setQuality()  : $this
for tracks with a single layer, this should be HIGH
setRid()  : $this
Generated from protobuf field <code>string rid = 7;</code>
setSpatialLayer()  : $this
Generated from protobuf field <code>int32 spatial_layer = 6;</code>
setSsrc()  : $this
Generated from protobuf field <code>uint32 ssrc = 5;</code>
setWidth()  : $this
Generated from protobuf field <code>uint32 width = 2;</code>

Properties

$bitrate

target bitrate in bit per second (bps), server will measure actual

protected mixed $bitrate = 0

Generated from protobuf field uint32 bitrate = 4;

$height

Generated from protobuf field <code>uint32 height = 3;</code>

protected mixed $height = 0

$quality

for tracks with a single layer, this should be HIGH

protected mixed $quality = 0

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

$rid

Generated from protobuf field <code>string rid = 7;</code>

protected mixed $rid = ''

$spatial_layer

Generated from protobuf field <code>int32 spatial_layer = 6;</code>

protected mixed $spatial_layer = 0

$ssrc

Generated from protobuf field <code>uint32 ssrc = 5;</code>

protected mixed $ssrc = 0

$width

Generated from protobuf field <code>uint32 width = 2;</code>

protected mixed $width = 0

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 $quality
      for tracks with a single layer, this should be HIGH
@type int $width
@type int $height
@type int $bitrate
      target bitrate in bit per second (bps), server will measure actual
@type int $ssrc
@type int $spatial_layer
@type string $rid

}

getBitrate()

target bitrate in bit per second (bps), server will measure actual

public getBitrate() : int

Generated from protobuf field uint32 bitrate = 4;

Return values
int

getHeight()

Generated from protobuf field <code>uint32 height = 3;</code>

public getHeight() : int
Return values
int

getQuality()

for tracks with a single layer, this should be HIGH

public getQuality() : int

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

Return values
int

getRid()

Generated from protobuf field <code>string rid = 7;</code>

public getRid() : string
Return values
string

getSpatialLayer()

Generated from protobuf field <code>int32 spatial_layer = 6;</code>

public getSpatialLayer() : int
Return values
int

getSsrc()

Generated from protobuf field <code>uint32 ssrc = 5;</code>

public getSsrc() : int
Return values
int

getWidth()

Generated from protobuf field <code>uint32 width = 2;</code>

public getWidth() : int
Return values
int

setBitrate()

target bitrate in bit per second (bps), server will measure actual

public setBitrate(int $var) : $this

Generated from protobuf field uint32 bitrate = 4;

Parameters
$var : int
Return values
$this

setHeight()

Generated from protobuf field <code>uint32 height = 3;</code>

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

setQuality()

for tracks with a single layer, this should be HIGH

public setQuality(int $var) : $this

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

Parameters
$var : int
Return values
$this

setRid()

Generated from protobuf field <code>string rid = 7;</code>

public setRid(string $var) : $this
Parameters
$var : string
Return values
$this

setSpatialLayer()

Generated from protobuf field <code>int32 spatial_layer = 6;</code>

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

setSsrc()

Generated from protobuf field <code>uint32 ssrc = 5;</code>

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

setWidth()

Generated from protobuf field <code>uint32 width = 2;</code>

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results