ClientConfiguration
extends Message
in package
server provided client configuration
Generated from protobuf message livekit.ClientConfiguration
Table of Contents
Properties
- $disabled_codecs : mixed
- Generated from protobuf field <code>.livekit.DisabledCodecs disabled_codecs = 4;</code>
- $force_relay : mixed
- Generated from protobuf field <code>.livekit.ClientConfigSetting force_relay = 5;</code>
- $resume_connection : mixed
- Generated from protobuf field <code>.livekit.ClientConfigSetting resume_connection = 3;</code>
- $screen : mixed
- Generated from protobuf field <code>.livekit.VideoConfiguration screen = 2;</code>
- $video : mixed
- Generated from protobuf field <code>.livekit.VideoConfiguration video = 1;</code>
Methods
- __construct() : mixed
- Constructor.
- clearDisabledCodecs() : mixed
- clearScreen() : mixed
- clearVideo() : mixed
- getDisabledCodecs() : DisabledCodecs|null
- Generated from protobuf field <code>.livekit.DisabledCodecs disabled_codecs = 4;</code>
- getForceRelay() : int
- Generated from protobuf field <code>.livekit.ClientConfigSetting force_relay = 5;</code>
- getResumeConnection() : int
- Generated from protobuf field <code>.livekit.ClientConfigSetting resume_connection = 3;</code>
- getScreen() : VideoConfiguration|null
- Generated from protobuf field <code>.livekit.VideoConfiguration screen = 2;</code>
- getVideo() : VideoConfiguration|null
- Generated from protobuf field <code>.livekit.VideoConfiguration video = 1;</code>
- hasDisabledCodecs() : mixed
- hasScreen() : mixed
- hasVideo() : mixed
- setDisabledCodecs() : $this
- Generated from protobuf field <code>.livekit.DisabledCodecs disabled_codecs = 4;</code>
- setForceRelay() : $this
- Generated from protobuf field <code>.livekit.ClientConfigSetting force_relay = 5;</code>
- setResumeConnection() : $this
- Generated from protobuf field <code>.livekit.ClientConfigSetting resume_connection = 3;</code>
- setScreen() : $this
- Generated from protobuf field <code>.livekit.VideoConfiguration screen = 2;</code>
- setVideo() : $this
- Generated from protobuf field <code>.livekit.VideoConfiguration video = 1;</code>
Properties
$disabled_codecs
Generated from protobuf field <code>.livekit.DisabledCodecs disabled_codecs = 4;</code>
protected
mixed
$disabled_codecs
= null
$force_relay
Generated from protobuf field <code>.livekit.ClientConfigSetting force_relay = 5;</code>
protected
mixed
$force_relay
= 0
$resume_connection
Generated from protobuf field <code>.livekit.ClientConfigSetting resume_connection = 3;</code>
protected
mixed
$resume_connection
= 0
$screen
Generated from protobuf field <code>.livekit.VideoConfiguration screen = 2;</code>
protected
mixed
$screen
= null
$video
Generated from protobuf field <code>.livekit.VideoConfiguration video = 1;</code>
protected
mixed
$video
= null
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 \Livekit\VideoConfiguration $video @type \Livekit\VideoConfiguration $screen @type int $resume_connection @type \Livekit\DisabledCodecs $disabled_codecs @type int $force_relay}
clearDisabledCodecs()
public
clearDisabledCodecs() : mixed
clearScreen()
public
clearScreen() : mixed
clearVideo()
public
clearVideo() : mixed
getDisabledCodecs()
Generated from protobuf field <code>.livekit.DisabledCodecs disabled_codecs = 4;</code>
public
getDisabledCodecs() : DisabledCodecs|null
Return values
DisabledCodecs|nullgetForceRelay()
Generated from protobuf field <code>.livekit.ClientConfigSetting force_relay = 5;</code>
public
getForceRelay() : int
Return values
intgetResumeConnection()
Generated from protobuf field <code>.livekit.ClientConfigSetting resume_connection = 3;</code>
public
getResumeConnection() : int
Return values
intgetScreen()
Generated from protobuf field <code>.livekit.VideoConfiguration screen = 2;</code>
public
getScreen() : VideoConfiguration|null
Return values
VideoConfiguration|nullgetVideo()
Generated from protobuf field <code>.livekit.VideoConfiguration video = 1;</code>
public
getVideo() : VideoConfiguration|null
Return values
VideoConfiguration|nullhasDisabledCodecs()
public
hasDisabledCodecs() : mixed
hasScreen()
public
hasScreen() : mixed
hasVideo()
public
hasVideo() : mixed
setDisabledCodecs()
Generated from protobuf field <code>.livekit.DisabledCodecs disabled_codecs = 4;</code>
public
setDisabledCodecs(DisabledCodecs $var) : $this
Parameters
- $var : DisabledCodecs
Return values
$thissetForceRelay()
Generated from protobuf field <code>.livekit.ClientConfigSetting force_relay = 5;</code>
public
setForceRelay(int $var) : $this
Parameters
- $var : int
Return values
$thissetResumeConnection()
Generated from protobuf field <code>.livekit.ClientConfigSetting resume_connection = 3;</code>
public
setResumeConnection(int $var) : $this
Parameters
- $var : int
Return values
$thissetScreen()
Generated from protobuf field <code>.livekit.VideoConfiguration screen = 2;</code>
public
setScreen(VideoConfiguration $var) : $this
Parameters
- $var : VideoConfiguration
Return values
$thissetVideo()
Generated from protobuf field <code>.livekit.VideoConfiguration video = 1;</code>
public
setVideo(VideoConfiguration $var) : $this
Parameters
- $var : VideoConfiguration