Documentation

EncodingOptions extends Message
in package

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

Table of Contents

Properties

$audio_bitrate  : mixed
(default 128)
$audio_codec  : mixed
(default OPUS)
$audio_frequency  : mixed
(default 44100)
$audio_quality  : mixed
quality setting on audio encoder
$depth  : mixed
(default 24)
$framerate  : mixed
(default 30)
$height  : mixed
(default 1080)
$key_frame_interval  : mixed
in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)
$video_bitrate  : mixed
(default 4500)
$video_codec  : mixed
(default H264_MAIN)
$video_quality  : mixed
quality setting on video encoder
$width  : mixed
(default 1920)

Methods

__construct()  : mixed
Constructor.
getAudioBitrate()  : int
(default 128)
getAudioCodec()  : int
(default OPUS)
getAudioFrequency()  : int
(default 44100)
getAudioQuality()  : int
quality setting on audio encoder
getDepth()  : int
(default 24)
getFramerate()  : int
(default 30)
getHeight()  : int
(default 1080)
getKeyFrameInterval()  : float
in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)
getVideoBitrate()  : int
(default 4500)
getVideoCodec()  : int
(default H264_MAIN)
getVideoQuality()  : int
quality setting on video encoder
getWidth()  : int
(default 1920)
setAudioBitrate()  : $this
(default 128)
setAudioCodec()  : $this
(default OPUS)
setAudioFrequency()  : $this
(default 44100)
setAudioQuality()  : $this
quality setting on audio encoder
setDepth()  : $this
(default 24)
setFramerate()  : $this
(default 30)
setHeight()  : $this
(default 1080)
setKeyFrameInterval()  : $this
in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)
setVideoBitrate()  : $this
(default 4500)
setVideoCodec()  : $this
(default H264_MAIN)
setVideoQuality()  : $this
quality setting on video encoder
setWidth()  : $this
(default 1920)

Properties

$audio_bitrate

(default 128)

protected mixed $audio_bitrate = 0

Generated from protobuf field int32 audio_bitrate = 6;

$audio_codec

(default OPUS)

protected mixed $audio_codec = 0

Generated from protobuf field .livekit.AudioCodec audio_codec = 5;

$audio_frequency

(default 44100)

protected mixed $audio_frequency = 0

Generated from protobuf field int32 audio_frequency = 7;

$audio_quality

quality setting on audio encoder

protected mixed $audio_quality = 0

Generated from protobuf field int32 audio_quality = 11;

$depth

(default 24)

protected mixed $depth = 0

Generated from protobuf field int32 depth = 3;

$framerate

(default 30)

protected mixed $framerate = 0

Generated from protobuf field int32 framerate = 4;

$height

(default 1080)

protected mixed $height = 0

Generated from protobuf field int32 height = 2;

$key_frame_interval

in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)

protected mixed $key_frame_interval = 0.0

Generated from protobuf field double key_frame_interval = 10;

$video_bitrate

(default 4500)

protected mixed $video_bitrate = 0

Generated from protobuf field int32 video_bitrate = 9;

$video_codec

(default H264_MAIN)

protected mixed $video_codec = 0

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

$video_quality

quality setting on video encoder

protected mixed $video_quality = 0

Generated from protobuf field int32 video_quality = 12;

$width

(default 1920)

protected mixed $width = 0

Generated from protobuf field int32 width = 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 $width
      (default 1920)
@type int $height
      (default 1080)
@type int $depth
      (default 24)
@type int $framerate
      (default 30)
@type int $audio_codec
      (default OPUS)
@type int $audio_bitrate
      (default 128)
@type int $audio_quality
      quality setting on audio encoder
@type int $audio_frequency
      (default 44100)
@type int $video_codec
      (default H264_MAIN)
@type int $video_bitrate
      (default 4500)
@type int $video_quality
      quality setting on video encoder
@type float $key_frame_interval
      in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)

}

getAudioBitrate()

(default 128)

public getAudioBitrate() : int

Generated from protobuf field int32 audio_bitrate = 6;

Return values
int

getAudioCodec()

(default OPUS)

public getAudioCodec() : int

Generated from protobuf field .livekit.AudioCodec audio_codec = 5;

Return values
int

getAudioFrequency()

(default 44100)

public getAudioFrequency() : int

Generated from protobuf field int32 audio_frequency = 7;

Return values
int

getAudioQuality()

quality setting on audio encoder

public getAudioQuality() : int

Generated from protobuf field int32 audio_quality = 11;

Return values
int

getDepth()

(default 24)

public getDepth() : int

Generated from protobuf field int32 depth = 3;

Return values
int

getFramerate()

(default 30)

public getFramerate() : int

Generated from protobuf field int32 framerate = 4;

Return values
int

getHeight()

(default 1080)

public getHeight() : int

Generated from protobuf field int32 height = 2;

Return values
int

getKeyFrameInterval()

in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)

public getKeyFrameInterval() : float

Generated from protobuf field double key_frame_interval = 10;

Return values
float

getVideoBitrate()

(default 4500)

public getVideoBitrate() : int

Generated from protobuf field int32 video_bitrate = 9;

Return values
int

getVideoCodec()

(default H264_MAIN)

public getVideoCodec() : int

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

Return values
int

getVideoQuality()

quality setting on video encoder

public getVideoQuality() : int

Generated from protobuf field int32 video_quality = 12;

Return values
int

getWidth()

(default 1920)

public getWidth() : int

Generated from protobuf field int32 width = 1;

Return values
int

setAudioBitrate()

(default 128)

public setAudioBitrate(int $var) : $this

Generated from protobuf field int32 audio_bitrate = 6;

Parameters
$var : int
Return values
$this

setAudioCodec()

(default OPUS)

public setAudioCodec(int $var) : $this

Generated from protobuf field .livekit.AudioCodec audio_codec = 5;

Parameters
$var : int
Return values
$this

setAudioFrequency()

(default 44100)

public setAudioFrequency(int $var) : $this

Generated from protobuf field int32 audio_frequency = 7;

Parameters
$var : int
Return values
$this

setAudioQuality()

quality setting on audio encoder

public setAudioQuality(int $var) : $this

Generated from protobuf field int32 audio_quality = 11;

Parameters
$var : int
Return values
$this

setDepth()

(default 24)

public setDepth(int $var) : $this

Generated from protobuf field int32 depth = 3;

Parameters
$var : int
Return values
$this

setFramerate()

(default 30)

public setFramerate(int $var) : $this

Generated from protobuf field int32 framerate = 4;

Parameters
$var : int
Return values
$this

setHeight()

(default 1080)

public setHeight(int $var) : $this

Generated from protobuf field int32 height = 2;

Parameters
$var : int
Return values
$this

setKeyFrameInterval()

in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)

public setKeyFrameInterval(float $var) : $this

Generated from protobuf field double key_frame_interval = 10;

Parameters
$var : float
Return values
$this

setVideoBitrate()

(default 4500)

public setVideoBitrate(int $var) : $this

Generated from protobuf field int32 video_bitrate = 9;

Parameters
$var : int
Return values
$this

setVideoCodec()

(default H264_MAIN)

public setVideoCodec(int $var) : $this

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

Parameters
$var : int
Return values
$this

setVideoQuality()

quality setting on video encoder

public setVideoQuality(int $var) : $this

Generated from protobuf field int32 video_quality = 12;

Parameters
$var : int
Return values
$this

setWidth()

(default 1920)

public setWidth(int $var) : $this

Generated from protobuf field int32 width = 1;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results