Documentation

Room extends Message
in package

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

Table of Contents

Properties

$active_recording  : mixed
Generated from protobuf field <code>bool active_recording = 10;</code>
$creation_time  : mixed
Generated from protobuf field <code>int64 creation_time = 5;</code>
$creation_time_ms  : mixed
Generated from protobuf field <code>int64 creation_time_ms = 15;</code>
$departure_timeout  : mixed
Generated from protobuf field <code>uint32 departure_timeout = 14;</code>
$empty_timeout  : mixed
Generated from protobuf field <code>uint32 empty_timeout = 3;</code>
$max_participants  : mixed
Generated from protobuf field <code>uint32 max_participants = 4;</code>
$metadata  : mixed
Generated from protobuf field <code>string metadata = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
$name  : mixed
Generated from protobuf field <code>string name = 2;</code>
$num_participants  : mixed
Generated from protobuf field <code>uint32 num_participants = 9;</code>
$num_publishers  : mixed
Generated from protobuf field <code>uint32 num_publishers = 11;</code>
$sid  : mixed
Generated from protobuf field <code>string sid = 1;</code>
$turn_password  : mixed
Generated from protobuf field <code>string turn_password = 6;</code>
$version  : mixed
Generated from protobuf field <code>.livekit.TimedVersion version = 13;</code>
$enabled_codecs  : mixed
Generated from protobuf field <code>repeated .livekit.Codec enabled_codecs = 7;</code>

Methods

__construct()  : mixed
Constructor.
clearVersion()  : mixed
getActiveRecording()  : bool
Generated from protobuf field <code>bool active_recording = 10;</code>
getCreationTime()  : int|string
Generated from protobuf field <code>int64 creation_time = 5;</code>
getCreationTimeMs()  : int|string
Generated from protobuf field <code>int64 creation_time_ms = 15;</code>
getDepartureTimeout()  : int
Generated from protobuf field <code>uint32 departure_timeout = 14;</code>
getEmptyTimeout()  : int
Generated from protobuf field <code>uint32 empty_timeout = 3;</code>
getEnabledCodecs()  : RepeatedField<string|int, Codec>
Generated from protobuf field <code>repeated .livekit.Codec enabled_codecs = 7;</code>
getMaxParticipants()  : int
Generated from protobuf field <code>uint32 max_participants = 4;</code>
getMetadata()  : string
Generated from protobuf field <code>string metadata = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
getName()  : string
Generated from protobuf field <code>string name = 2;</code>
getNumParticipants()  : int
Generated from protobuf field <code>uint32 num_participants = 9;</code>
getNumPublishers()  : int
Generated from protobuf field <code>uint32 num_publishers = 11;</code>
getSid()  : string
Generated from protobuf field <code>string sid = 1;</code>
getTurnPassword()  : string
Generated from protobuf field <code>string turn_password = 6;</code>
getVersion()  : TimedVersion|null
Generated from protobuf field <code>.livekit.TimedVersion version = 13;</code>
hasVersion()  : mixed
setActiveRecording()  : $this
Generated from protobuf field <code>bool active_recording = 10;</code>
setCreationTime()  : $this
Generated from protobuf field <code>int64 creation_time = 5;</code>
setCreationTimeMs()  : $this
Generated from protobuf field <code>int64 creation_time_ms = 15;</code>
setDepartureTimeout()  : $this
Generated from protobuf field <code>uint32 departure_timeout = 14;</code>
setEmptyTimeout()  : $this
Generated from protobuf field <code>uint32 empty_timeout = 3;</code>
setEnabledCodecs()  : $this
Generated from protobuf field <code>repeated .livekit.Codec enabled_codecs = 7;</code>
setMaxParticipants()  : $this
Generated from protobuf field <code>uint32 max_participants = 4;</code>
setMetadata()  : $this
Generated from protobuf field <code>string metadata = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setName()  : $this
Generated from protobuf field <code>string name = 2;</code>
setNumParticipants()  : $this
Generated from protobuf field <code>uint32 num_participants = 9;</code>
setNumPublishers()  : $this
Generated from protobuf field <code>uint32 num_publishers = 11;</code>
setSid()  : $this
Generated from protobuf field <code>string sid = 1;</code>
setTurnPassword()  : $this
Generated from protobuf field <code>string turn_password = 6;</code>
setVersion()  : $this
Generated from protobuf field <code>.livekit.TimedVersion version = 13;</code>

Properties

$active_recording

Generated from protobuf field <code>bool active_recording = 10;</code>

protected mixed $active_recording = false

$creation_time

Generated from protobuf field <code>int64 creation_time = 5;</code>

protected mixed $creation_time = 0

$creation_time_ms

Generated from protobuf field <code>int64 creation_time_ms = 15;</code>

protected mixed $creation_time_ms = 0

$departure_timeout

Generated from protobuf field <code>uint32 departure_timeout = 14;</code>

protected mixed $departure_timeout = 0

$empty_timeout

Generated from protobuf field <code>uint32 empty_timeout = 3;</code>

protected mixed $empty_timeout = 0

$max_participants

Generated from protobuf field <code>uint32 max_participants = 4;</code>

protected mixed $max_participants = 0

$metadata

Generated from protobuf field <code>string metadata = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

protected mixed $metadata = ''

$name

Generated from protobuf field <code>string name = 2;</code>

protected mixed $name = ''

$num_participants

Generated from protobuf field <code>uint32 num_participants = 9;</code>

protected mixed $num_participants = 0

$num_publishers

Generated from protobuf field <code>uint32 num_publishers = 11;</code>

protected mixed $num_publishers = 0

$sid

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

protected mixed $sid = ''

$turn_password

Generated from protobuf field <code>string turn_password = 6;</code>

protected mixed $turn_password = ''

$version

Generated from protobuf field <code>.livekit.TimedVersion version = 13;</code>

protected mixed $version = null

$enabled_codecs

Generated from protobuf field <code>repeated .livekit.Codec enabled_codecs = 7;</code>

private mixed $enabled_codecs

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 string $name
@type int $empty_timeout
@type int $departure_timeout
@type int $max_participants
@type int|string $creation_time
@type int|string $creation_time_ms
@type string $turn_password
@type \Livekit\Codec[] $enabled_codecs
@type string $metadata
@type int $num_participants
@type int $num_publishers
@type bool $active_recording
@type \Livekit\TimedVersion $version

}

clearVersion()

public clearVersion() : mixed

getActiveRecording()

Generated from protobuf field <code>bool active_recording = 10;</code>

public getActiveRecording() : bool
Return values
bool

getCreationTime()

Generated from protobuf field <code>int64 creation_time = 5;</code>

public getCreationTime() : int|string
Return values
int|string

getCreationTimeMs()

Generated from protobuf field <code>int64 creation_time_ms = 15;</code>

public getCreationTimeMs() : int|string
Return values
int|string

getDepartureTimeout()

Generated from protobuf field <code>uint32 departure_timeout = 14;</code>

public getDepartureTimeout() : int
Return values
int

getEmptyTimeout()

Generated from protobuf field <code>uint32 empty_timeout = 3;</code>

public getEmptyTimeout() : int
Return values
int

getEnabledCodecs()

Generated from protobuf field <code>repeated .livekit.Codec enabled_codecs = 7;</code>

public getEnabledCodecs() : RepeatedField<string|int, Codec>
Return values
RepeatedField<string|int, Codec>

getMaxParticipants()

Generated from protobuf field <code>uint32 max_participants = 4;</code>

public getMaxParticipants() : int
Return values
int

getMetadata()

Generated from protobuf field <code>string metadata = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

public getMetadata() : string
Return values
string

getName()

Generated from protobuf field <code>string name = 2;</code>

public getName() : string
Return values
string

getNumParticipants()

Generated from protobuf field <code>uint32 num_participants = 9;</code>

public getNumParticipants() : int
Return values
int

getNumPublishers()

Generated from protobuf field <code>uint32 num_publishers = 11;</code>

public getNumPublishers() : int
Return values
int

getSid()

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

public getSid() : string
Return values
string

getTurnPassword()

Generated from protobuf field <code>string turn_password = 6;</code>

public getTurnPassword() : string
Return values
string

getVersion()

Generated from protobuf field <code>.livekit.TimedVersion version = 13;</code>

public getVersion() : TimedVersion|null
Return values
TimedVersion|null

hasVersion()

public hasVersion() : mixed

setActiveRecording()

Generated from protobuf field <code>bool active_recording = 10;</code>

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

setCreationTime()

Generated from protobuf field <code>int64 creation_time = 5;</code>

public setCreationTime(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setCreationTimeMs()

Generated from protobuf field <code>int64 creation_time_ms = 15;</code>

public setCreationTimeMs(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setDepartureTimeout()

Generated from protobuf field <code>uint32 departure_timeout = 14;</code>

public setDepartureTimeout(int $var) : $this
Parameters
$var : int
Return values
$this

setEmptyTimeout()

Generated from protobuf field <code>uint32 empty_timeout = 3;</code>

public setEmptyTimeout(int $var) : $this
Parameters
$var : int
Return values
$this

setEnabledCodecs()

Generated from protobuf field <code>repeated .livekit.Codec enabled_codecs = 7;</code>

public setEnabledCodecs(array<string|int, Codec> $var) : $this
Parameters
$var : array<string|int, Codec>
Return values
$this

setMaxParticipants()

Generated from protobuf field <code>uint32 max_participants = 4;</code>

public setMaxParticipants(int $var) : $this
Parameters
$var : int
Return values
$this

setMetadata()

Generated from protobuf field <code>string metadata = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

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

setName()

Generated from protobuf field <code>string name = 2;</code>

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

setNumParticipants()

Generated from protobuf field <code>uint32 num_participants = 9;</code>

public setNumParticipants(int $var) : $this
Parameters
$var : int
Return values
$this

setNumPublishers()

Generated from protobuf field <code>uint32 num_publishers = 11;</code>

public setNumPublishers(int $var) : $this
Parameters
$var : int
Return values
$this

setSid()

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

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

setTurnPassword()

Generated from protobuf field <code>string turn_password = 6;</code>

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

setVersion()

Generated from protobuf field <code>.livekit.TimedVersion version = 13;</code>

public setVersion(TimedVersion $var) : $this
Parameters
$var : TimedVersion
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results