Documentation

SignalResponse extends Message
in package

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

Table of Contents

Properties

$message  : mixed

Methods

__construct()  : mixed
Constructor.
getAnswer()  : SessionDescription|null
sent when server answers publisher
getConnectionQuality()  : ConnectionQualityUpdate|null
when connection quality changed
getDataTrackSubscriberHandles()  : DataTrackSubscriberHandles|null
Sent to data track subscribers to provide mapping from track SIDs to handles.
getJoin()  : JoinResponse|null
sent when join is accepted
getLeave()  : LeaveRequest|null
Immediately terminate session
getMediaSectionsRequirement()  : MediaSectionsRequirement|null
notify number of required media sections to satisfy subscribed tracks
getMessage()  : string
getMute()  : MuteTrackRequest|null
server initiated mute
getOffer()  : SessionDescription|null
sent when server is sending subscriber an offer
getPong()  : int|string
respond to ping
getPongResp()  : Pong|null
respond to Ping
getPublishDataTrackResponse()  : PublishDataTrackResponse|null
Sent in response to `PublishDataTrackRequest`.
getReconnect()  : ReconnectResponse|null
sent when client reconnects
getRefreshToken()  : string
update the token the client was using, to prevent an active client from using an expired token
getRequestResponse()  : RequestResponse|null
Response relating to user inititated requests that carry a `request_id`
getRoomMoved()  : RoomMovedResponse|null
notify to the participant when they have been moved to a new room
getRoomUpdate()  : RoomUpdate|null
sent when metadata of the room has changed
getSpeakersChanged()  : SpeakersChanged|null
indicates changes to speaker status, including when they've gone to not speaking
getStreamStateUpdate()  : StreamStateUpdate|null
when streamed tracks state changed, used to notify when any of the streams were paused due to congestion
getSubscribedAudioCodecUpdate()  : SubscribedAudioCodecUpdate|null
when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions
getSubscribedQualityUpdate()  : SubscribedQualityUpdate|null
when max subscribe quality changed, used by dynamic broadcasting to disable unused layers
getSubscriptionPermissionUpdate()  : SubscriptionPermissionUpdate|null
when subscription permission changed
getSubscriptionResponse()  : SubscriptionResponse|null
Subscription response, client should not expect any media from this subscription if it fails
getTrackPublished()  : TrackPublishedResponse|null
sent to the participant when their track has been published
getTrackSubscribed()  : TrackSubscribed|null
notify to the publisher when a published track has been subscribed for the first time
getTrackUnpublished()  : TrackUnpublishedResponse|null
server initiated track unpublish
getTrickle()  : TrickleRequest|null
sent when an ICE candidate is available
getUnpublishDataTrackResponse()  : UnpublishDataTrackResponse|null
Sent in response to `UnpublishDataTrackRequest` or SFU-initiated unpublish.
getUpdate()  : ParticipantUpdate|null
sent when participants in the room has changed
hasAnswer()  : mixed
hasConnectionQuality()  : mixed
hasDataTrackSubscriberHandles()  : mixed
hasJoin()  : mixed
hasLeave()  : mixed
hasMediaSectionsRequirement()  : mixed
hasMute()  : mixed
hasOffer()  : mixed
hasPong()  : mixed
hasPongResp()  : mixed
hasPublishDataTrackResponse()  : mixed
hasReconnect()  : mixed
hasRefreshToken()  : mixed
hasRequestResponse()  : mixed
hasRoomMoved()  : mixed
hasRoomUpdate()  : mixed
hasSpeakersChanged()  : mixed
hasStreamStateUpdate()  : mixed
hasSubscribedAudioCodecUpdate()  : mixed
hasSubscribedQualityUpdate()  : mixed
hasSubscriptionPermissionUpdate()  : mixed
hasSubscriptionResponse()  : mixed
hasTrackPublished()  : mixed
hasTrackSubscribed()  : mixed
hasTrackUnpublished()  : mixed
hasTrickle()  : mixed
hasUnpublishDataTrackResponse()  : mixed
hasUpdate()  : mixed
setAnswer()  : $this
sent when server answers publisher
setConnectionQuality()  : $this
when connection quality changed
setDataTrackSubscriberHandles()  : $this
Sent to data track subscribers to provide mapping from track SIDs to handles.
setJoin()  : $this
sent when join is accepted
setLeave()  : $this
Immediately terminate session
setMediaSectionsRequirement()  : $this
notify number of required media sections to satisfy subscribed tracks
setMute()  : $this
server initiated mute
setOffer()  : $this
sent when server is sending subscriber an offer
setPong()  : $this
respond to ping
setPongResp()  : $this
respond to Ping
setPublishDataTrackResponse()  : $this
Sent in response to `PublishDataTrackRequest`.
setReconnect()  : $this
sent when client reconnects
setRefreshToken()  : $this
update the token the client was using, to prevent an active client from using an expired token
setRequestResponse()  : $this
Response relating to user inititated requests that carry a `request_id`
setRoomMoved()  : $this
notify to the participant when they have been moved to a new room
setRoomUpdate()  : $this
sent when metadata of the room has changed
setSpeakersChanged()  : $this
indicates changes to speaker status, including when they've gone to not speaking
setStreamStateUpdate()  : $this
when streamed tracks state changed, used to notify when any of the streams were paused due to congestion
setSubscribedAudioCodecUpdate()  : $this
when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions
setSubscribedQualityUpdate()  : $this
when max subscribe quality changed, used by dynamic broadcasting to disable unused layers
setSubscriptionPermissionUpdate()  : $this
when subscription permission changed
setSubscriptionResponse()  : $this
Subscription response, client should not expect any media from this subscription if it fails
setTrackPublished()  : $this
sent to the participant when their track has been published
setTrackSubscribed()  : $this
notify to the publisher when a published track has been subscribed for the first time
setTrackUnpublished()  : $this
server initiated track unpublish
setTrickle()  : $this
sent when an ICE candidate is available
setUnpublishDataTrackResponse()  : $this
Sent in response to `UnpublishDataTrackRequest` or SFU-initiated unpublish.
setUpdate()  : $this
sent when participants in the room has changed

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\JoinResponse $join
      sent when join is accepted
@type \Livekit\SessionDescription $answer
      sent when server answers publisher
@type \Livekit\SessionDescription $offer
      sent when server is sending subscriber an offer
@type \Livekit\TrickleRequest $trickle
      sent when an ICE candidate is available
@type \Livekit\ParticipantUpdate $update
      sent when participants in the room has changed
@type \Livekit\TrackPublishedResponse $track_published
      sent to the participant when their track has been published
@type \Livekit\LeaveRequest $leave
      Immediately terminate session
@type \Livekit\MuteTrackRequest $mute
      server initiated mute
@type \Livekit\SpeakersChanged $speakers_changed
      indicates changes to speaker status, including when they've gone to not speaking
@type \Livekit\RoomUpdate $room_update
      sent when metadata of the room has changed
@type \Livekit\ConnectionQualityUpdate $connection_quality
      when connection quality changed
@type \Livekit\StreamStateUpdate $stream_state_update
      when streamed tracks state changed, used to notify when any of the streams were paused due to
      congestion
@type \Livekit\SubscribedQualityUpdate $subscribed_quality_update
      when max subscribe quality changed, used by dynamic broadcasting to disable unused layers
@type \Livekit\SubscriptionPermissionUpdate $subscription_permission_update
      when subscription permission changed
@type string $refresh_token
      update the token the client was using, to prevent an active client from using an expired token
@type \Livekit\TrackUnpublishedResponse $track_unpublished
      server initiated track unpublish
@type int|string $pong
      respond to ping
@type \Livekit\ReconnectResponse $reconnect
      sent when client reconnects
@type \Livekit\Pong $pong_resp
      respond to Ping
@type \Livekit\SubscriptionResponse $subscription_response
      Subscription response, client should not expect any media from this subscription if it fails
@type \Livekit\RequestResponse $request_response
      Response relating to user inititated requests that carry a `request_id`
@type \Livekit\TrackSubscribed $track_subscribed
      notify to the publisher when a published track has been subscribed for the first time
@type \Livekit\RoomMovedResponse $room_moved
      notify to the participant when they have been moved to a new room
@type \Livekit\MediaSectionsRequirement $media_sections_requirement
      notify number of required media sections to satisfy subscribed tracks
@type \Livekit\SubscribedAudioCodecUpdate $subscribed_audio_codec_update
      when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions
@type \Livekit\PublishDataTrackResponse $publish_data_track_response
      Sent in response to `PublishDataTrackRequest`.
@type \Livekit\UnpublishDataTrackResponse $unpublish_data_track_response
      Sent in response to `UnpublishDataTrackRequest` or SFU-initiated unpublish.
@type \Livekit\DataTrackSubscriberHandles $data_track_subscriber_handles
      Sent to data track subscribers to provide mapping from track SIDs to handles.

}

getDataTrackSubscriberHandles()

Sent to data track subscribers to provide mapping from track SIDs to handles.

public getDataTrackSubscriberHandles() : DataTrackSubscriberHandles|null

Generated from protobuf field .livekit.DataTrackSubscriberHandles data_track_subscriber_handles = 29;

Return values
DataTrackSubscriberHandles|null

getMediaSectionsRequirement()

notify number of required media sections to satisfy subscribed tracks

public getMediaSectionsRequirement() : MediaSectionsRequirement|null

Generated from protobuf field .livekit.MediaSectionsRequirement media_sections_requirement = 25;

Return values
MediaSectionsRequirement|null

getPong()

respond to ping

public getPong() : int|string

Generated from protobuf field int64 pong = 18;

Return values
int|string

getPongResp()

respond to Ping

public getPongResp() : Pong|null

Generated from protobuf field .livekit.Pong pong_resp = 20;

Return values
Pong|null

getRefreshToken()

update the token the client was using, to prevent an active client from using an expired token

public getRefreshToken() : string

Generated from protobuf field string refresh_token = 16;

Return values
string

getRequestResponse()

Response relating to user inititated requests that carry a `request_id`

public getRequestResponse() : RequestResponse|null

Generated from protobuf field .livekit.RequestResponse request_response = 22;

Return values
RequestResponse|null

getRoomMoved()

notify to the participant when they have been moved to a new room

public getRoomMoved() : RoomMovedResponse|null

Generated from protobuf field .livekit.RoomMovedResponse room_moved = 24;

Return values
RoomMovedResponse|null

getRoomUpdate()

sent when metadata of the room has changed

public getRoomUpdate() : RoomUpdate|null

Generated from protobuf field .livekit.RoomUpdate room_update = 11;

Return values
RoomUpdate|null

getSpeakersChanged()

indicates changes to speaker status, including when they've gone to not speaking

public getSpeakersChanged() : SpeakersChanged|null

Generated from protobuf field .livekit.SpeakersChanged speakers_changed = 10;

Return values
SpeakersChanged|null

getStreamStateUpdate()

when streamed tracks state changed, used to notify when any of the streams were paused due to congestion

public getStreamStateUpdate() : StreamStateUpdate|null

Generated from protobuf field .livekit.StreamStateUpdate stream_state_update = 13;

Return values
StreamStateUpdate|null

getSubscribedAudioCodecUpdate()

when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions

public getSubscribedAudioCodecUpdate() : SubscribedAudioCodecUpdate|null

Generated from protobuf field .livekit.SubscribedAudioCodecUpdate subscribed_audio_codec_update = 26;

Return values
SubscribedAudioCodecUpdate|null

getSubscribedQualityUpdate()

when max subscribe quality changed, used by dynamic broadcasting to disable unused layers

public getSubscribedQualityUpdate() : SubscribedQualityUpdate|null

Generated from protobuf field .livekit.SubscribedQualityUpdate subscribed_quality_update = 14;

Return values
SubscribedQualityUpdate|null

getSubscriptionResponse()

Subscription response, client should not expect any media from this subscription if it fails

public getSubscriptionResponse() : SubscriptionResponse|null

Generated from protobuf field .livekit.SubscriptionResponse subscription_response = 21;

Return values
SubscriptionResponse|null

getTrackSubscribed()

notify to the publisher when a published track has been subscribed for the first time

public getTrackSubscribed() : TrackSubscribed|null

Generated from protobuf field .livekit.TrackSubscribed track_subscribed = 23;

Return values
TrackSubscribed|null

getUnpublishDataTrackResponse()

Sent in response to `UnpublishDataTrackRequest` or SFU-initiated unpublish.

public getUnpublishDataTrackResponse() : UnpublishDataTrackResponse|null

Generated from protobuf field .livekit.UnpublishDataTrackResponse unpublish_data_track_response = 28;

Return values
UnpublishDataTrackResponse|null

hasDataTrackSubscriberHandles()

public hasDataTrackSubscriberHandles() : mixed

hasMediaSectionsRequirement()

public hasMediaSectionsRequirement() : mixed

hasPublishDataTrackResponse()

public hasPublishDataTrackResponse() : mixed

hasSubscribedAudioCodecUpdate()

public hasSubscribedAudioCodecUpdate() : mixed

hasSubscribedQualityUpdate()

public hasSubscribedQualityUpdate() : mixed

hasSubscriptionPermissionUpdate()

public hasSubscriptionPermissionUpdate() : mixed

hasSubscriptionResponse()

public hasSubscriptionResponse() : mixed

hasUnpublishDataTrackResponse()

public hasUnpublishDataTrackResponse() : mixed

setDataTrackSubscriberHandles()

Sent to data track subscribers to provide mapping from track SIDs to handles.

public setDataTrackSubscriberHandles(DataTrackSubscriberHandles $var) : $this

Generated from protobuf field .livekit.DataTrackSubscriberHandles data_track_subscriber_handles = 29;

Parameters
$var : DataTrackSubscriberHandles
Return values
$this

setJoin()

sent when join is accepted

public setJoin(JoinResponse $var) : $this

Generated from protobuf field .livekit.JoinResponse join = 1;

Parameters
$var : JoinResponse
Return values
$this

setLeave()

Immediately terminate session

public setLeave(LeaveRequest $var) : $this

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

Parameters
$var : LeaveRequest
Return values
$this

setMediaSectionsRequirement()

notify number of required media sections to satisfy subscribed tracks

public setMediaSectionsRequirement(MediaSectionsRequirement $var) : $this

Generated from protobuf field .livekit.MediaSectionsRequirement media_sections_requirement = 25;

Parameters
$var : MediaSectionsRequirement
Return values
$this

setPong()

respond to ping

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

Generated from protobuf field int64 pong = 18;

Parameters
$var : int|string
Return values
$this

setPongResp()

respond to Ping

public setPongResp(Pong $var) : $this

Generated from protobuf field .livekit.Pong pong_resp = 20;

Parameters
$var : Pong
Return values
$this

setPublishDataTrackResponse()

Sent in response to `PublishDataTrackRequest`.

public setPublishDataTrackResponse(PublishDataTrackResponse $var) : $this

Generated from protobuf field .livekit.PublishDataTrackResponse publish_data_track_response = 27;

Parameters
$var : PublishDataTrackResponse
Return values
$this

setRefreshToken()

update the token the client was using, to prevent an active client from using an expired token

public setRefreshToken(string $var) : $this

Generated from protobuf field string refresh_token = 16;

Parameters
$var : string
Return values
$this

setRequestResponse()

Response relating to user inititated requests that carry a `request_id`

public setRequestResponse(RequestResponse $var) : $this

Generated from protobuf field .livekit.RequestResponse request_response = 22;

Parameters
$var : RequestResponse
Return values
$this

setRoomMoved()

notify to the participant when they have been moved to a new room

public setRoomMoved(RoomMovedResponse $var) : $this

Generated from protobuf field .livekit.RoomMovedResponse room_moved = 24;

Parameters
$var : RoomMovedResponse
Return values
$this

setRoomUpdate()

sent when metadata of the room has changed

public setRoomUpdate(RoomUpdate $var) : $this

Generated from protobuf field .livekit.RoomUpdate room_update = 11;

Parameters
$var : RoomUpdate
Return values
$this

setSpeakersChanged()

indicates changes to speaker status, including when they've gone to not speaking

public setSpeakersChanged(SpeakersChanged $var) : $this

Generated from protobuf field .livekit.SpeakersChanged speakers_changed = 10;

Parameters
$var : SpeakersChanged
Return values
$this

setStreamStateUpdate()

when streamed tracks state changed, used to notify when any of the streams were paused due to congestion

public setStreamStateUpdate(StreamStateUpdate $var) : $this

Generated from protobuf field .livekit.StreamStateUpdate stream_state_update = 13;

Parameters
$var : StreamStateUpdate
Return values
$this

setSubscribedAudioCodecUpdate()

when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions

public setSubscribedAudioCodecUpdate(SubscribedAudioCodecUpdate $var) : $this

Generated from protobuf field .livekit.SubscribedAudioCodecUpdate subscribed_audio_codec_update = 26;

Parameters
$var : SubscribedAudioCodecUpdate
Return values
$this

setSubscribedQualityUpdate()

when max subscribe quality changed, used by dynamic broadcasting to disable unused layers

public setSubscribedQualityUpdate(SubscribedQualityUpdate $var) : $this

Generated from protobuf field .livekit.SubscribedQualityUpdate subscribed_quality_update = 14;

Parameters
$var : SubscribedQualityUpdate
Return values
$this

setSubscriptionResponse()

Subscription response, client should not expect any media from this subscription if it fails

public setSubscriptionResponse(SubscriptionResponse $var) : $this

Generated from protobuf field .livekit.SubscriptionResponse subscription_response = 21;

Parameters
$var : SubscriptionResponse
Return values
$this

setTrackPublished()

sent to the participant when their track has been published

public setTrackPublished(TrackPublishedResponse $var) : $this

Generated from protobuf field .livekit.TrackPublishedResponse track_published = 6;

Parameters
$var : TrackPublishedResponse
Return values
$this

setTrackSubscribed()

notify to the publisher when a published track has been subscribed for the first time

public setTrackSubscribed(TrackSubscribed $var) : $this

Generated from protobuf field .livekit.TrackSubscribed track_subscribed = 23;

Parameters
$var : TrackSubscribed
Return values
$this

setTrickle()

sent when an ICE candidate is available

public setTrickle(TrickleRequest $var) : $this

Generated from protobuf field .livekit.TrickleRequest trickle = 4;

Parameters
$var : TrickleRequest
Return values
$this

setUnpublishDataTrackResponse()

Sent in response to `UnpublishDataTrackRequest` or SFU-initiated unpublish.

public setUnpublishDataTrackResponse(UnpublishDataTrackResponse $var) : $this

Generated from protobuf field .livekit.UnpublishDataTrackResponse unpublish_data_track_response = 28;

Parameters
$var : UnpublishDataTrackResponse
Return values
$this

setUpdate()

sent when participants in the room has changed

public setUpdate(ParticipantUpdate $var) : $this

Generated from protobuf field .livekit.ParticipantUpdate update = 5;

Parameters
$var : ParticipantUpdate
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results