Documentation

SignalRequest extends Message
in package

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

Table of Contents

Properties

$message  : mixed

Methods

__construct()  : mixed
Constructor.
getAddTrack()  : AddTrackRequest|null
Generated from protobuf field <code>.livekit.AddTrackRequest add_track = 4;</code>
getAnswer()  : SessionDescription|null
participant answering subscriber offer
getLeave()  : LeaveRequest|null
Immediately terminate session
getMessage()  : string
getMute()  : MuteTrackRequest|null
mute the participant's published tracks
getOffer()  : SessionDescription|null
participant offer for publisher
getPing()  : int|string
client triggered ping to server
getPingReq()  : Ping|null
Generated from protobuf field <code>.livekit.Ping ping_req = 16;</code>
getPublishDataTrackRequest()  : PublishDataTrackRequest|null
Publish a data track
getSimulate()  : SimulateScenario|null
Simulate conditions, for client validations
getSubscription()  : UpdateSubscription|null
Subscribe or unsubscribe from tracks
getSubscriptionPermission()  : SubscriptionPermission|null
Update subscriber permissions
getSyncState()  : SyncState|null
sync client's subscribe state to server during reconnect
getTrackSetting()  : UpdateTrackSettings|null
Update settings of subscribed tracks
getTrickle()  : TrickleRequest|null
Generated from protobuf field <code>.livekit.TrickleRequest trickle = 3;</code>
getUnpublishDataTrackRequest()  : UnpublishDataTrackRequest|null
Unpublish a data track
getUpdateAudioTrack()  : UpdateLocalAudioTrack|null
Update local audio track settings
getUpdateDataSubscription()  : UpdateDataSubscription|null
Update subscription state for one or more data tracks
getUpdateLayers()  : UpdateVideoLayers|null
Update published video layers
getUpdateMetadata()  : UpdateParticipantMetadata|null
update a participant's own metadata, name, or attributes requires canUpdateOwnParticipantMetadata permission
getUpdateVideoTrack()  : UpdateLocalVideoTrack|null
Update local video track settings
hasAddTrack()  : mixed
hasAnswer()  : mixed
hasLeave()  : mixed
hasMute()  : mixed
hasOffer()  : mixed
hasPing()  : mixed
hasPingReq()  : mixed
hasPublishDataTrackRequest()  : mixed
hasSimulate()  : mixed
hasSubscription()  : mixed
hasSubscriptionPermission()  : mixed
hasSyncState()  : mixed
hasTrackSetting()  : mixed
hasTrickle()  : mixed
hasUnpublishDataTrackRequest()  : mixed
hasUpdateAudioTrack()  : mixed
hasUpdateDataSubscription()  : mixed
hasUpdateLayers()  : mixed
hasUpdateMetadata()  : mixed
hasUpdateVideoTrack()  : mixed
setAddTrack()  : $this
Generated from protobuf field <code>.livekit.AddTrackRequest add_track = 4;</code>
setAnswer()  : $this
participant answering subscriber offer
setLeave()  : $this
Immediately terminate session
setMute()  : $this
mute the participant's published tracks
setOffer()  : $this
participant offer for publisher
setPing()  : $this
client triggered ping to server
setPingReq()  : $this
Generated from protobuf field <code>.livekit.Ping ping_req = 16;</code>
setPublishDataTrackRequest()  : $this
Publish a data track
setSimulate()  : $this
Simulate conditions, for client validations
setSubscription()  : $this
Subscribe or unsubscribe from tracks
setSubscriptionPermission()  : $this
Update subscriber permissions
setSyncState()  : $this
sync client's subscribe state to server during reconnect
setTrackSetting()  : $this
Update settings of subscribed tracks
setTrickle()  : $this
Generated from protobuf field <code>.livekit.TrickleRequest trickle = 3;</code>
setUnpublishDataTrackRequest()  : $this
Unpublish a data track
setUpdateAudioTrack()  : $this
Update local audio track settings
setUpdateDataSubscription()  : $this
Update subscription state for one or more data tracks
setUpdateLayers()  : $this
Update published video layers
setUpdateMetadata()  : $this
update a participant's own metadata, name, or attributes requires canUpdateOwnParticipantMetadata permission
setUpdateVideoTrack()  : $this
Update local video track settings

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\SessionDescription $offer
      participant offer for publisher
@type \Livekit\SessionDescription $answer
      participant answering subscriber offer
@type \Livekit\TrickleRequest $trickle
@type \Livekit\AddTrackRequest $add_track
@type \Livekit\MuteTrackRequest $mute
      mute the participant's published tracks
@type \Livekit\UpdateSubscription $subscription
      Subscribe or unsubscribe from tracks
@type \Livekit\UpdateTrackSettings $track_setting
      Update settings of subscribed tracks
@type \Livekit\LeaveRequest $leave
      Immediately terminate session
@type \Livekit\UpdateVideoLayers $update_layers
      Update published video layers
@type \Livekit\SubscriptionPermission $subscription_permission
      Update subscriber permissions
@type \Livekit\SyncState $sync_state
      sync client's subscribe state to server during reconnect
@type \Livekit\SimulateScenario $simulate
      Simulate conditions, for client validations
@type int|string $ping
      client triggered ping to server
@type \Livekit\UpdateParticipantMetadata $update_metadata
      update a participant's own metadata, name, or attributes
      requires canUpdateOwnParticipantMetadata permission
@type \Livekit\Ping $ping_req
@type \Livekit\UpdateLocalAudioTrack $update_audio_track
      Update local audio track settings
@type \Livekit\UpdateLocalVideoTrack $update_video_track
      Update local video track settings
@type \Livekit\PublishDataTrackRequest $publish_data_track_request
      Publish a data track
@type \Livekit\UnpublishDataTrackRequest $unpublish_data_track_request
      Unpublish a data track
@type \Livekit\UpdateDataSubscription $update_data_subscription
      Update subscription state for one or more data tracks

}

getMessage()

public getMessage() : string
Return values
string

getPing()

client triggered ping to server

public getPing() : int|string

Generated from protobuf field int64 ping = 14;

Return values
int|string

getPingReq()

Generated from protobuf field <code>.livekit.Ping ping_req = 16;</code>

public getPingReq() : Ping|null
Return values
Ping|null

getSyncState()

sync client's subscribe state to server during reconnect

public getSyncState() : SyncState|null

Generated from protobuf field .livekit.SyncState sync_state = 12;

Return values
SyncState|null

getUpdateDataSubscription()

Update subscription state for one or more data tracks

public getUpdateDataSubscription() : UpdateDataSubscription|null

Generated from protobuf field .livekit.UpdateDataSubscription update_data_subscription = 21;

Return values
UpdateDataSubscription|null

getUpdateLayers()

Update published video layers

public getUpdateLayers() : UpdateVideoLayers|null

Generated from protobuf field .livekit.UpdateVideoLayers update_layers = 10 [deprecated = true];

Return values
UpdateVideoLayers|null

getUpdateMetadata()

update a participant's own metadata, name, or attributes requires canUpdateOwnParticipantMetadata permission

public getUpdateMetadata() : UpdateParticipantMetadata|null

Generated from protobuf field .livekit.UpdateParticipantMetadata update_metadata = 15;

Return values
UpdateParticipantMetadata|null

hasPublishDataTrackRequest()

public hasPublishDataTrackRequest() : mixed

hasSubscriptionPermission()

public hasSubscriptionPermission() : mixed

hasUnpublishDataTrackRequest()

public hasUnpublishDataTrackRequest() : mixed

hasUpdateDataSubscription()

public hasUpdateDataSubscription() : mixed

setLeave()

Immediately terminate session

public setLeave(LeaveRequest $var) : $this

Generated from protobuf field .livekit.LeaveRequest leave = 8;

Parameters
$var : LeaveRequest
Return values
$this

setPing()

client triggered ping to server

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

Generated from protobuf field int64 ping = 14;

Parameters
$var : int|string
Return values
$this

setPingReq()

Generated from protobuf field <code>.livekit.Ping ping_req = 16;</code>

public setPingReq(Ping $var) : $this
Parameters
$var : Ping
Return values
$this

setSimulate()

Simulate conditions, for client validations

public setSimulate(SimulateScenario $var) : $this

Generated from protobuf field .livekit.SimulateScenario simulate = 13;

Parameters
$var : SimulateScenario
Return values
$this

setSubscription()

Subscribe or unsubscribe from tracks

public setSubscription(UpdateSubscription $var) : $this

Generated from protobuf field .livekit.UpdateSubscription subscription = 6;

Parameters
$var : UpdateSubscription
Return values
$this

setSubscriptionPermission()

Update subscriber permissions

public setSubscriptionPermission(SubscriptionPermission $var) : $this

Generated from protobuf field .livekit.SubscriptionPermission subscription_permission = 11;

Parameters
$var : SubscriptionPermission
Return values
$this

setSyncState()

sync client's subscribe state to server during reconnect

public setSyncState(SyncState $var) : $this

Generated from protobuf field .livekit.SyncState sync_state = 12;

Parameters
$var : SyncState
Return values
$this

setUpdateDataSubscription()

Update subscription state for one or more data tracks

public setUpdateDataSubscription(UpdateDataSubscription $var) : $this

Generated from protobuf field .livekit.UpdateDataSubscription update_data_subscription = 21;

Parameters
$var : UpdateDataSubscription
Return values
$this

setUpdateLayers()

Update published video layers

public setUpdateLayers(UpdateVideoLayers $var) : $this

Generated from protobuf field .livekit.UpdateVideoLayers update_layers = 10 [deprecated = true];

Parameters
$var : UpdateVideoLayers
Return values
$this

setUpdateMetadata()

update a participant's own metadata, name, or attributes requires canUpdateOwnParticipantMetadata permission

public setUpdateMetadata(UpdateParticipantMetadata $var) : $this

Generated from protobuf field .livekit.UpdateParticipantMetadata update_metadata = 15;

Parameters
$var : UpdateParticipantMetadata
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results