Documentation

SpeakerInfo extends Message
in package

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

Table of Contents

Properties

$active  : mixed
true if speaker is currently active
$level  : mixed
audio level, 0-1.0, 1 is loudest
$sid  : mixed
Generated from protobuf field <code>string sid = 1;</code>

Methods

__construct()  : mixed
Constructor.
getActive()  : bool
true if speaker is currently active
getLevel()  : float
audio level, 0-1.0, 1 is loudest
getSid()  : string
Generated from protobuf field <code>string sid = 1;</code>
setActive()  : $this
true if speaker is currently active
setLevel()  : $this
audio level, 0-1.0, 1 is loudest
setSid()  : $this
Generated from protobuf field <code>string sid = 1;</code>

Properties

$active

true if speaker is currently active

protected mixed $active = false

Generated from protobuf field bool active = 3;

$level

audio level, 0-1.0, 1 is loudest

protected mixed $level = 0.0

Generated from protobuf field float level = 2;

$sid

Generated from protobuf field <code>string sid = 1;</code>

protected mixed $sid = ''

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 string $sid
@type float $level
      audio level, 0-1.0, 1 is loudest
@type bool $active
      true if speaker is currently active

}

getActive()

true if speaker is currently active

public getActive() : bool

Generated from protobuf field bool active = 3;

Return values
bool

getLevel()

audio level, 0-1.0, 1 is loudest

public getLevel() : float

Generated from protobuf field float level = 2;

Return values
float

getSid()

Generated from protobuf field <code>string sid = 1;</code>

public getSid() : string
Return values
string

setActive()

true if speaker is currently active

public setActive(bool $var) : $this

Generated from protobuf field bool active = 3;

Parameters
$var : bool
Return values
$this

setLevel()

audio level, 0-1.0, 1 is loudest

public setLevel(float $var) : $this

Generated from protobuf field float level = 2;

Parameters
$var : float
Return values
$this

setSid()

Generated from protobuf field <code>string sid = 1;</code>

public setSid(string $var) : $this
Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results