Documentation

SimulateScenario extends Message
in package

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

Table of Contents

Properties

$scenario  : mixed

Methods

__construct()  : mixed
Constructor.
getDisconnectSignalOnResume()  : bool
disconnect signal on resume
getDisconnectSignalOnResumeNoMessages()  : bool
disconnect signal on resume before sending any messages from server
getLeaveRequestFullReconnect()  : bool
full reconnect leave request
getMigration()  : bool
simulate migration
getNodeFailure()  : bool
simulate local node failure
getScenario()  : string
getServerLeave()  : bool
server to send leave
getSpeakerUpdate()  : int
simulate N seconds of speaker activity
getSubscriberBandwidth()  : int|string
maximum bandwidth for subscribers, in bps when zero, clears artificial bandwidth limit
getSwitchCandidateProtocol()  : int
switch candidate protocol to tcp
hasDisconnectSignalOnResume()  : mixed
hasDisconnectSignalOnResumeNoMessages()  : mixed
hasLeaveRequestFullReconnect()  : mixed
hasMigration()  : mixed
hasNodeFailure()  : mixed
hasServerLeave()  : mixed
hasSpeakerUpdate()  : mixed
hasSubscriberBandwidth()  : mixed
hasSwitchCandidateProtocol()  : mixed
setDisconnectSignalOnResume()  : $this
disconnect signal on resume
setDisconnectSignalOnResumeNoMessages()  : $this
disconnect signal on resume before sending any messages from server
setLeaveRequestFullReconnect()  : $this
full reconnect leave request
setMigration()  : $this
simulate migration
setNodeFailure()  : $this
simulate local node failure
setServerLeave()  : $this
server to send leave
setSpeakerUpdate()  : $this
simulate N seconds of speaker activity
setSubscriberBandwidth()  : $this
maximum bandwidth for subscribers, in bps when zero, clears artificial bandwidth limit
setSwitchCandidateProtocol()  : $this
switch candidate protocol to tcp

Properties

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 $speaker_update
      simulate N seconds of speaker activity
@type bool $node_failure
      simulate local node failure
@type bool $migration
      simulate migration
@type bool $server_leave
      server to send leave
@type int $switch_candidate_protocol
      switch candidate protocol to tcp
@type int|string $subscriber_bandwidth
      maximum bandwidth for subscribers, in bps
      when zero, clears artificial bandwidth limit
@type bool $disconnect_signal_on_resume
      disconnect signal on resume
@type bool $disconnect_signal_on_resume_no_messages
      disconnect signal on resume before sending any messages from server
@type bool $leave_request_full_reconnect
      full reconnect leave request

}

getDisconnectSignalOnResume()

disconnect signal on resume

public getDisconnectSignalOnResume() : bool

Generated from protobuf field bool disconnect_signal_on_resume = 7;

Return values
bool

getDisconnectSignalOnResumeNoMessages()

disconnect signal on resume before sending any messages from server

public getDisconnectSignalOnResumeNoMessages() : bool

Generated from protobuf field bool disconnect_signal_on_resume_no_messages = 8;

Return values
bool

getLeaveRequestFullReconnect()

full reconnect leave request

public getLeaveRequestFullReconnect() : bool

Generated from protobuf field bool leave_request_full_reconnect = 9;

Return values
bool

getMigration()

simulate migration

public getMigration() : bool

Generated from protobuf field bool migration = 3;

Return values
bool

getNodeFailure()

simulate local node failure

public getNodeFailure() : bool

Generated from protobuf field bool node_failure = 2;

Return values
bool

getServerLeave()

server to send leave

public getServerLeave() : bool

Generated from protobuf field bool server_leave = 4;

Return values
bool

getSpeakerUpdate()

simulate N seconds of speaker activity

public getSpeakerUpdate() : int

Generated from protobuf field int32 speaker_update = 1;

Return values
int

getSubscriberBandwidth()

maximum bandwidth for subscribers, in bps when zero, clears artificial bandwidth limit

public getSubscriberBandwidth() : int|string

Generated from protobuf field int64 subscriber_bandwidth = 6;

Return values
int|string

getSwitchCandidateProtocol()

switch candidate protocol to tcp

public getSwitchCandidateProtocol() : int

Generated from protobuf field .livekit.CandidateProtocol switch_candidate_protocol = 5;

Return values
int

hasDisconnectSignalOnResume()

public hasDisconnectSignalOnResume() : mixed

hasDisconnectSignalOnResumeNoMessages()

public hasDisconnectSignalOnResumeNoMessages() : mixed

hasLeaveRequestFullReconnect()

public hasLeaveRequestFullReconnect() : mixed

hasSwitchCandidateProtocol()

public hasSwitchCandidateProtocol() : mixed

setDisconnectSignalOnResume()

disconnect signal on resume

public setDisconnectSignalOnResume(bool $var) : $this

Generated from protobuf field bool disconnect_signal_on_resume = 7;

Parameters
$var : bool
Return values
$this

setDisconnectSignalOnResumeNoMessages()

disconnect signal on resume before sending any messages from server

public setDisconnectSignalOnResumeNoMessages(bool $var) : $this

Generated from protobuf field bool disconnect_signal_on_resume_no_messages = 8;

Parameters
$var : bool
Return values
$this

setLeaveRequestFullReconnect()

full reconnect leave request

public setLeaveRequestFullReconnect(bool $var) : $this

Generated from protobuf field bool leave_request_full_reconnect = 9;

Parameters
$var : bool
Return values
$this

setMigration()

simulate migration

public setMigration(bool $var) : $this

Generated from protobuf field bool migration = 3;

Parameters
$var : bool
Return values
$this

setNodeFailure()

simulate local node failure

public setNodeFailure(bool $var) : $this

Generated from protobuf field bool node_failure = 2;

Parameters
$var : bool
Return values
$this

setServerLeave()

server to send leave

public setServerLeave(bool $var) : $this

Generated from protobuf field bool server_leave = 4;

Parameters
$var : bool
Return values
$this

setSpeakerUpdate()

simulate N seconds of speaker activity

public setSpeakerUpdate(int $var) : $this

Generated from protobuf field int32 speaker_update = 1;

Parameters
$var : int
Return values
$this

setSubscriberBandwidth()

maximum bandwidth for subscribers, in bps when zero, clears artificial bandwidth limit

public setSubscriberBandwidth(int|string $var) : $this

Generated from protobuf field int64 subscriber_bandwidth = 6;

Parameters
$var : int|string
Return values
$this

setSwitchCandidateProtocol()

switch candidate protocol to tcp

public setSwitchCandidateProtocol(int $var) : $this

Generated from protobuf field .livekit.CandidateProtocol switch_candidate_protocol = 5;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results