Documentation

IngressVideoEncodingOptions extends Message
in package

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

Table of Contents

Properties

$frame_rate  : mixed
Generated from protobuf field <code>double frame_rate = 2;</code>
$video_codec  : mixed
desired codec to publish to room
$layers  : mixed
simulcast layers to publish, when empty, should usually be set to layers at 1/2 and 1/4 of the dimensions

Methods

__construct()  : mixed
Constructor.
getFrameRate()  : float
Generated from protobuf field <code>double frame_rate = 2;</code>
getLayers()  : RepeatedField<string|int, VideoLayer>
simulcast layers to publish, when empty, should usually be set to layers at 1/2 and 1/4 of the dimensions
getVideoCodec()  : int
desired codec to publish to room
setFrameRate()  : $this
Generated from protobuf field <code>double frame_rate = 2;</code>
setLayers()  : $this
simulcast layers to publish, when empty, should usually be set to layers at 1/2 and 1/4 of the dimensions
setVideoCodec()  : $this
desired codec to publish to room

Properties

$video_codec

desired codec to publish to room

protected mixed $video_codec = 0

Generated from protobuf field .livekit.VideoCodec video_codec = 1;

$layers

simulcast layers to publish, when empty, should usually be set to layers at 1/2 and 1/4 of the dimensions

private mixed $layers

Generated from protobuf field repeated .livekit.VideoLayer layers = 3;

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 $video_codec
      desired codec to publish to room
@type float $frame_rate
@type \Livekit\VideoLayer[] $layers
      simulcast layers to publish, when empty, should usually be set to layers at 1/2 and 1/4 of the dimensions

}

getFrameRate()

Generated from protobuf field <code>double frame_rate = 2;</code>

public getFrameRate() : float
Return values
float

getLayers()

simulcast layers to publish, when empty, should usually be set to layers at 1/2 and 1/4 of the dimensions

public getLayers() : RepeatedField<string|int, VideoLayer>

Generated from protobuf field repeated .livekit.VideoLayer layers = 3;

Return values
RepeatedField<string|int, VideoLayer>

getVideoCodec()

desired codec to publish to room

public getVideoCodec() : int

Generated from protobuf field .livekit.VideoCodec video_codec = 1;

Return values
int

setFrameRate()

Generated from protobuf field <code>double frame_rate = 2;</code>

public setFrameRate(float $var) : $this
Parameters
$var : float
Return values
$this

setLayers()

simulcast layers to publish, when empty, should usually be set to layers at 1/2 and 1/4 of the dimensions

public setLayers(array<string|int, VideoLayer> $var) : $this

Generated from protobuf field repeated .livekit.VideoLayer layers = 3;

Parameters
$var : array<string|int, VideoLayer>
Return values
$this

setVideoCodec()

desired codec to publish to room

public setVideoCodec(int $var) : $this

Generated from protobuf field .livekit.VideoCodec video_codec = 1;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results