Documentation

SIPDispatchRule extends Message
in package

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

Table of Contents

Properties

$rule  : mixed

Methods

__construct()  : mixed
Constructor.
getDispatchRuleCallee()  : SIPDispatchRuleCallee|null
SIPDispatchRuleCallee is a `SIP Dispatch Rule` that creates a new room for each callee.
getDispatchRuleDirect()  : SIPDispatchRuleDirect|null
SIPDispatchRuleDirect is a `SIP Dispatch Rule` that puts a user directly into a room This places users into an existing room. Optionally you can require a pin before a user can enter the room
getDispatchRuleIndividual()  : SIPDispatchRuleIndividual|null
SIPDispatchRuleIndividual is a `SIP Dispatch Rule` that creates a new room for each caller.
getRule()  : string
hasDispatchRuleCallee()  : mixed
hasDispatchRuleDirect()  : mixed
hasDispatchRuleIndividual()  : mixed
setDispatchRuleCallee()  : $this
SIPDispatchRuleCallee is a `SIP Dispatch Rule` that creates a new room for each callee.
setDispatchRuleDirect()  : $this
SIPDispatchRuleDirect is a `SIP Dispatch Rule` that puts a user directly into a room This places users into an existing room. Optionally you can require a pin before a user can enter the room
setDispatchRuleIndividual()  : $this
SIPDispatchRuleIndividual is a `SIP Dispatch Rule` that creates a new room for each caller.

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 \Livekit\SIPDispatchRuleDirect $dispatch_rule_direct
      SIPDispatchRuleDirect is a `SIP Dispatch Rule` that puts a user directly into a room
      This places users into an existing room. Optionally you can require a pin before a user can
      enter the room
@type \Livekit\SIPDispatchRuleIndividual $dispatch_rule_individual
      SIPDispatchRuleIndividual is a `SIP Dispatch Rule` that creates a new room for each caller.
@type \Livekit\SIPDispatchRuleCallee $dispatch_rule_callee
      SIPDispatchRuleCallee is a `SIP Dispatch Rule` that creates a new room for each callee.

}

getDispatchRuleCallee()

SIPDispatchRuleCallee is a `SIP Dispatch Rule` that creates a new room for each callee.

public getDispatchRuleCallee() : SIPDispatchRuleCallee|null

Generated from protobuf field .livekit.SIPDispatchRuleCallee dispatch_rule_callee = 3;

Return values
SIPDispatchRuleCallee|null

getDispatchRuleDirect()

SIPDispatchRuleDirect is a `SIP Dispatch Rule` that puts a user directly into a room This places users into an existing room. Optionally you can require a pin before a user can enter the room

public getDispatchRuleDirect() : SIPDispatchRuleDirect|null

Generated from protobuf field .livekit.SIPDispatchRuleDirect dispatch_rule_direct = 1;

Return values
SIPDispatchRuleDirect|null

getDispatchRuleIndividual()

SIPDispatchRuleIndividual is a `SIP Dispatch Rule` that creates a new room for each caller.

public getDispatchRuleIndividual() : SIPDispatchRuleIndividual|null

Generated from protobuf field .livekit.SIPDispatchRuleIndividual dispatch_rule_individual = 2;

Return values
SIPDispatchRuleIndividual|null

hasDispatchRuleIndividual()

public hasDispatchRuleIndividual() : mixed

setDispatchRuleCallee()

SIPDispatchRuleCallee is a `SIP Dispatch Rule` that creates a new room for each callee.

public setDispatchRuleCallee(SIPDispatchRuleCallee $var) : $this

Generated from protobuf field .livekit.SIPDispatchRuleCallee dispatch_rule_callee = 3;

Parameters
$var : SIPDispatchRuleCallee
Return values
$this

setDispatchRuleDirect()

SIPDispatchRuleDirect is a `SIP Dispatch Rule` that puts a user directly into a room This places users into an existing room. Optionally you can require a pin before a user can enter the room

public setDispatchRuleDirect(SIPDispatchRuleDirect $var) : $this

Generated from protobuf field .livekit.SIPDispatchRuleDirect dispatch_rule_direct = 1;

Parameters
$var : SIPDispatchRuleDirect
Return values
$this

setDispatchRuleIndividual()

SIPDispatchRuleIndividual is a `SIP Dispatch Rule` that creates a new room for each caller.

public setDispatchRuleIndividual(SIPDispatchRuleIndividual $var) : $this

Generated from protobuf field .livekit.SIPDispatchRuleIndividual dispatch_rule_individual = 2;

Parameters
$var : SIPDispatchRuleIndividual
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results