Documentation

RoomInternal extends Message
in package

room info that should not be returned to clients

Generated from protobuf message livekit.RoomInternal

Table of Contents

Properties

$participant_egress  : mixed
Generated from protobuf field <code>.livekit.AutoParticipantEgress participant_egress = 2;</code>
$playout_delay  : mixed
Generated from protobuf field <code>.livekit.PlayoutDelay playout_delay = 3;</code>
$replay_enabled  : mixed
Generated from protobuf field <code>bool replay_enabled = 6;</code>
$sync_streams  : mixed
Generated from protobuf field <code>bool sync_streams = 4;</code>
$track_egress  : mixed
Generated from protobuf field <code>.livekit.AutoTrackEgress track_egress = 1;</code>
$agent_dispatches  : mixed
Generated from protobuf field <code>repeated .livekit.RoomAgentDispatch agent_dispatches = 5;</code>

Methods

__construct()  : mixed
Constructor.
clearParticipantEgress()  : mixed
clearPlayoutDelay()  : mixed
clearTrackEgress()  : mixed
getAgentDispatches()  : RepeatedField<string|int, RoomAgentDispatch>
Generated from protobuf field <code>repeated .livekit.RoomAgentDispatch agent_dispatches = 5;</code>
getParticipantEgress()  : AutoParticipantEgress|null
Generated from protobuf field <code>.livekit.AutoParticipantEgress participant_egress = 2;</code>
getPlayoutDelay()  : PlayoutDelay|null
Generated from protobuf field <code>.livekit.PlayoutDelay playout_delay = 3;</code>
getReplayEnabled()  : bool
Generated from protobuf field <code>bool replay_enabled = 6;</code>
getSyncStreams()  : bool
Generated from protobuf field <code>bool sync_streams = 4;</code>
getTrackEgress()  : AutoTrackEgress|null
Generated from protobuf field <code>.livekit.AutoTrackEgress track_egress = 1;</code>
hasParticipantEgress()  : mixed
hasPlayoutDelay()  : mixed
hasTrackEgress()  : mixed
setAgentDispatches()  : $this
Generated from protobuf field <code>repeated .livekit.RoomAgentDispatch agent_dispatches = 5;</code>
setParticipantEgress()  : $this
Generated from protobuf field <code>.livekit.AutoParticipantEgress participant_egress = 2;</code>
setPlayoutDelay()  : $this
Generated from protobuf field <code>.livekit.PlayoutDelay playout_delay = 3;</code>
setReplayEnabled()  : $this
Generated from protobuf field <code>bool replay_enabled = 6;</code>
setSyncStreams()  : $this
Generated from protobuf field <code>bool sync_streams = 4;</code>
setTrackEgress()  : $this
Generated from protobuf field <code>.livekit.AutoTrackEgress track_egress = 1;</code>

Properties

$participant_egress

Generated from protobuf field <code>.livekit.AutoParticipantEgress participant_egress = 2;</code>

protected mixed $participant_egress = null

$playout_delay

Generated from protobuf field <code>.livekit.PlayoutDelay playout_delay = 3;</code>

protected mixed $playout_delay = null

$replay_enabled

Generated from protobuf field <code>bool replay_enabled = 6;</code>

protected mixed $replay_enabled = false

$sync_streams

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

protected mixed $sync_streams = false

$track_egress

Generated from protobuf field <code>.livekit.AutoTrackEgress track_egress = 1;</code>

protected mixed $track_egress = null

$agent_dispatches

Generated from protobuf field <code>repeated .livekit.RoomAgentDispatch agent_dispatches = 5;</code>

private mixed $agent_dispatches

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\AutoTrackEgress $track_egress
@type \Livekit\AutoParticipantEgress $participant_egress
@type \Livekit\PlayoutDelay $playout_delay
@type \Livekit\RoomAgentDispatch[] $agent_dispatches
@type bool $sync_streams
@type bool $replay_enabled

}

clearParticipantEgress()

public clearParticipantEgress() : mixed

getAgentDispatches()

Generated from protobuf field <code>repeated .livekit.RoomAgentDispatch agent_dispatches = 5;</code>

public getAgentDispatches() : RepeatedField<string|int, RoomAgentDispatch>
Return values
RepeatedField<string|int, RoomAgentDispatch>

getPlayoutDelay()

Generated from protobuf field <code>.livekit.PlayoutDelay playout_delay = 3;</code>

public getPlayoutDelay() : PlayoutDelay|null
Return values
PlayoutDelay|null

getReplayEnabled()

Generated from protobuf field <code>bool replay_enabled = 6;</code>

public getReplayEnabled() : bool
Return values
bool

getSyncStreams()

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

public getSyncStreams() : bool
Return values
bool

hasParticipantEgress()

public hasParticipantEgress() : mixed

setAgentDispatches()

Generated from protobuf field <code>repeated .livekit.RoomAgentDispatch agent_dispatches = 5;</code>

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

setPlayoutDelay()

Generated from protobuf field <code>.livekit.PlayoutDelay playout_delay = 3;</code>

public setPlayoutDelay(PlayoutDelay $var) : $this
Parameters
$var : PlayoutDelay
Return values
$this

setReplayEnabled()

Generated from protobuf field <code>bool replay_enabled = 6;</code>

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

setSyncStreams()

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

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

setTrackEgress()

Generated from protobuf field <code>.livekit.AutoTrackEgress track_egress = 1;</code>

public setTrackEgress(AutoTrackEgress $var) : $this
Parameters
$var : AutoTrackEgress
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results