Documentation

ConnectionSettings extends Message
in package

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

Table of Contents

Properties

$adaptive_stream  : mixed
Generated from protobuf field <code>bool adaptive_stream = 2;</code>
$auto_subscribe  : mixed
Generated from protobuf field <code>bool auto_subscribe = 1;</code>
$auto_subscribe_data_track  : mixed
Generated from protobuf field <code>optional bool auto_subscribe_data_track = 5;</code>
$disable_ice_lite  : mixed
Generated from protobuf field <code>bool disable_ice_lite = 4;</code>
$subscriber_allow_pause  : mixed
Generated from protobuf field <code>optional bool subscriber_allow_pause = 3;</code>

Methods

__construct()  : mixed
Constructor.
clearAutoSubscribeDataTrack()  : mixed
clearSubscriberAllowPause()  : mixed
getAdaptiveStream()  : bool
Generated from protobuf field <code>bool adaptive_stream = 2;</code>
getAutoSubscribe()  : bool
Generated from protobuf field <code>bool auto_subscribe = 1;</code>
getAutoSubscribeDataTrack()  : bool
Generated from protobuf field <code>optional bool auto_subscribe_data_track = 5;</code>
getDisableIceLite()  : bool
Generated from protobuf field <code>bool disable_ice_lite = 4;</code>
getSubscriberAllowPause()  : bool
Generated from protobuf field <code>optional bool subscriber_allow_pause = 3;</code>
hasAutoSubscribeDataTrack()  : mixed
hasSubscriberAllowPause()  : mixed
setAdaptiveStream()  : $this
Generated from protobuf field <code>bool adaptive_stream = 2;</code>
setAutoSubscribe()  : $this
Generated from protobuf field <code>bool auto_subscribe = 1;</code>
setAutoSubscribeDataTrack()  : $this
Generated from protobuf field <code>optional bool auto_subscribe_data_track = 5;</code>
setDisableIceLite()  : $this
Generated from protobuf field <code>bool disable_ice_lite = 4;</code>
setSubscriberAllowPause()  : $this
Generated from protobuf field <code>optional bool subscriber_allow_pause = 3;</code>

Properties

$adaptive_stream

Generated from protobuf field <code>bool adaptive_stream = 2;</code>

protected mixed $adaptive_stream = false

$auto_subscribe

Generated from protobuf field <code>bool auto_subscribe = 1;</code>

protected mixed $auto_subscribe = false

$auto_subscribe_data_track

Generated from protobuf field <code>optional bool auto_subscribe_data_track = 5;</code>

protected mixed $auto_subscribe_data_track = null

$disable_ice_lite

Generated from protobuf field <code>bool disable_ice_lite = 4;</code>

protected mixed $disable_ice_lite = false

$subscriber_allow_pause

Generated from protobuf field <code>optional bool subscriber_allow_pause = 3;</code>

protected mixed $subscriber_allow_pause = 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 bool $auto_subscribe
@type bool $adaptive_stream
@type bool $subscriber_allow_pause
@type bool $disable_ice_lite
@type bool $auto_subscribe_data_track

}

getAdaptiveStream()

Generated from protobuf field <code>bool adaptive_stream = 2;</code>

public getAdaptiveStream() : bool
Return values
bool

getAutoSubscribe()

Generated from protobuf field <code>bool auto_subscribe = 1;</code>

public getAutoSubscribe() : bool
Return values
bool

getAutoSubscribeDataTrack()

Generated from protobuf field <code>optional bool auto_subscribe_data_track = 5;</code>

public getAutoSubscribeDataTrack() : bool
Return values
bool

getDisableIceLite()

Generated from protobuf field <code>bool disable_ice_lite = 4;</code>

public getDisableIceLite() : bool
Return values
bool

getSubscriberAllowPause()

Generated from protobuf field <code>optional bool subscriber_allow_pause = 3;</code>

public getSubscriberAllowPause() : bool
Return values
bool

setAdaptiveStream()

Generated from protobuf field <code>bool adaptive_stream = 2;</code>

public setAdaptiveStream(bool $var) : $this
Parameters
$var : bool
Return values
$this

setAutoSubscribe()

Generated from protobuf field <code>bool auto_subscribe = 1;</code>

public setAutoSubscribe(bool $var) : $this
Parameters
$var : bool
Return values
$this

setAutoSubscribeDataTrack()

Generated from protobuf field <code>optional bool auto_subscribe_data_track = 5;</code>

public setAutoSubscribeDataTrack(bool $var) : $this
Parameters
$var : bool
Return values
$this

setDisableIceLite()

Generated from protobuf field <code>bool disable_ice_lite = 4;</code>

public setDisableIceLite(bool $var) : $this
Parameters
$var : bool
Return values
$this

setSubscriberAllowPause()

Generated from protobuf field <code>optional bool subscriber_allow_pause = 3;</code>

public setSubscriberAllowPause(bool $var) : $this
Parameters
$var : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results