Documentation

SyncState extends Message
in package

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

Table of Contents

Properties

$answer  : mixed
last subscribe/publish answer before reconnecting subscribe answer if using dual peer connection publish answer if using single peer connection
$offer  : mixed
last received server side offer/sent client side offer before reconnecting received server side offer if using dual peer connection sent client side offer if using single peer connection
$subscription  : mixed
Generated from protobuf field <code>.livekit.UpdateSubscription subscription = 2;</code>
$data_channels  : mixed
Generated from protobuf field <code>repeated .livekit.DataChannelInfo data_channels = 4;</code>
$datachannel_receive_states  : mixed
Generated from protobuf field <code>repeated .livekit.DataChannelReceiveState datachannel_receive_states = 7;</code>
$publish_data_tracks  : mixed
Generated from protobuf field <code>repeated .livekit.PublishDataTrackResponse publish_data_tracks = 8;</code>
$publish_tracks  : mixed
Generated from protobuf field <code>repeated .livekit.TrackPublishedResponse publish_tracks = 3;</code>
$track_sids_disabled  : mixed
Generated from protobuf field <code>repeated string track_sids_disabled = 6;</code>

Methods

__construct()  : mixed
Constructor.
clearAnswer()  : mixed
clearOffer()  : mixed
clearSubscription()  : mixed
getAnswer()  : SessionDescription|null
last subscribe/publish answer before reconnecting subscribe answer if using dual peer connection publish answer if using single peer connection
getDatachannelReceiveStates()  : RepeatedField<string|int, DataChannelReceiveState>
Generated from protobuf field <code>repeated .livekit.DataChannelReceiveState datachannel_receive_states = 7;</code>
getDataChannels()  : RepeatedField<string|int, DataChannelInfo>
Generated from protobuf field <code>repeated .livekit.DataChannelInfo data_channels = 4;</code>
getOffer()  : SessionDescription|null
last received server side offer/sent client side offer before reconnecting received server side offer if using dual peer connection sent client side offer if using single peer connection
getPublishDataTracks()  : RepeatedField<string|int, PublishDataTrackResponse>
Generated from protobuf field <code>repeated .livekit.PublishDataTrackResponse publish_data_tracks = 8;</code>
getPublishTracks()  : RepeatedField<string|int, TrackPublishedResponse>
Generated from protobuf field <code>repeated .livekit.TrackPublishedResponse publish_tracks = 3;</code>
getSubscription()  : UpdateSubscription|null
Generated from protobuf field <code>.livekit.UpdateSubscription subscription = 2;</code>
getTrackSidsDisabled()  : RepeatedField<string|int, string>
Generated from protobuf field <code>repeated string track_sids_disabled = 6;</code>
hasAnswer()  : mixed
hasOffer()  : mixed
hasSubscription()  : mixed
setAnswer()  : $this
last subscribe/publish answer before reconnecting subscribe answer if using dual peer connection publish answer if using single peer connection
setDatachannelReceiveStates()  : $this
Generated from protobuf field <code>repeated .livekit.DataChannelReceiveState datachannel_receive_states = 7;</code>
setDataChannels()  : $this
Generated from protobuf field <code>repeated .livekit.DataChannelInfo data_channels = 4;</code>
setOffer()  : $this
last received server side offer/sent client side offer before reconnecting received server side offer if using dual peer connection sent client side offer if using single peer connection
setPublishDataTracks()  : $this
Generated from protobuf field <code>repeated .livekit.PublishDataTrackResponse publish_data_tracks = 8;</code>
setPublishTracks()  : $this
Generated from protobuf field <code>repeated .livekit.TrackPublishedResponse publish_tracks = 3;</code>
setSubscription()  : $this
Generated from protobuf field <code>.livekit.UpdateSubscription subscription = 2;</code>
setTrackSidsDisabled()  : $this
Generated from protobuf field <code>repeated string track_sids_disabled = 6;</code>

Properties

$answer

last subscribe/publish answer before reconnecting subscribe answer if using dual peer connection publish answer if using single peer connection

protected mixed $answer = null

Generated from protobuf field .livekit.SessionDescription answer = 1;

$offer

last received server side offer/sent client side offer before reconnecting received server side offer if using dual peer connection sent client side offer if using single peer connection

protected mixed $offer = null

Generated from protobuf field .livekit.SessionDescription offer = 5;

$subscription

Generated from protobuf field <code>.livekit.UpdateSubscription subscription = 2;</code>

protected mixed $subscription = null

$data_channels

Generated from protobuf field <code>repeated .livekit.DataChannelInfo data_channels = 4;</code>

private mixed $data_channels

$datachannel_receive_states

Generated from protobuf field <code>repeated .livekit.DataChannelReceiveState datachannel_receive_states = 7;</code>

private mixed $datachannel_receive_states

$publish_data_tracks

Generated from protobuf field <code>repeated .livekit.PublishDataTrackResponse publish_data_tracks = 8;</code>

private mixed $publish_data_tracks

$publish_tracks

Generated from protobuf field <code>repeated .livekit.TrackPublishedResponse publish_tracks = 3;</code>

private mixed $publish_tracks

$track_sids_disabled

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

private mixed $track_sids_disabled

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 $answer
      last subscribe/publish answer before reconnecting
      subscribe answer if using dual peer connection
      publish answer if using single peer connection
@type \Livekit\UpdateSubscription $subscription
@type \Livekit\TrackPublishedResponse[] $publish_tracks
@type \Livekit\DataChannelInfo[] $data_channels
@type \Livekit\SessionDescription $offer
      last received server side offer/sent client side offer before reconnecting
      received server side offer if using dual peer connection
      sent client side offer if using single peer connection
@type string[] $track_sids_disabled
@type \Livekit\DataChannelReceiveState[] $datachannel_receive_states
@type \Livekit\PublishDataTrackResponse[] $publish_data_tracks

}

clearSubscription()

public clearSubscription() : mixed

getAnswer()

last subscribe/publish answer before reconnecting subscribe answer if using dual peer connection publish answer if using single peer connection

public getAnswer() : SessionDescription|null

Generated from protobuf field .livekit.SessionDescription answer = 1;

Return values
SessionDescription|null

getDatachannelReceiveStates()

Generated from protobuf field <code>repeated .livekit.DataChannelReceiveState datachannel_receive_states = 7;</code>

public getDatachannelReceiveStates() : RepeatedField<string|int, DataChannelReceiveState>
Return values
RepeatedField<string|int, DataChannelReceiveState>

getDataChannels()

Generated from protobuf field <code>repeated .livekit.DataChannelInfo data_channels = 4;</code>

public getDataChannels() : RepeatedField<string|int, DataChannelInfo>
Return values
RepeatedField<string|int, DataChannelInfo>

getOffer()

last received server side offer/sent client side offer before reconnecting received server side offer if using dual peer connection sent client side offer if using single peer connection

public getOffer() : SessionDescription|null

Generated from protobuf field .livekit.SessionDescription offer = 5;

Return values
SessionDescription|null

getPublishDataTracks()

Generated from protobuf field <code>repeated .livekit.PublishDataTrackResponse publish_data_tracks = 8;</code>

public getPublishDataTracks() : RepeatedField<string|int, PublishDataTrackResponse>
Return values
RepeatedField<string|int, PublishDataTrackResponse>

getPublishTracks()

Generated from protobuf field <code>repeated .livekit.TrackPublishedResponse publish_tracks = 3;</code>

public getPublishTracks() : RepeatedField<string|int, TrackPublishedResponse>
Return values
RepeatedField<string|int, TrackPublishedResponse>

getTrackSidsDisabled()

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

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

hasSubscription()

public hasSubscription() : mixed

setAnswer()

last subscribe/publish answer before reconnecting subscribe answer if using dual peer connection publish answer if using single peer connection

public setAnswer(SessionDescription $var) : $this

Generated from protobuf field .livekit.SessionDescription answer = 1;

Parameters
$var : SessionDescription
Return values
$this

setDatachannelReceiveStates()

Generated from protobuf field <code>repeated .livekit.DataChannelReceiveState datachannel_receive_states = 7;</code>

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

setDataChannels()

Generated from protobuf field <code>repeated .livekit.DataChannelInfo data_channels = 4;</code>

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

setOffer()

last received server side offer/sent client side offer before reconnecting received server side offer if using dual peer connection sent client side offer if using single peer connection

public setOffer(SessionDescription $var) : $this

Generated from protobuf field .livekit.SessionDescription offer = 5;

Parameters
$var : SessionDescription
Return values
$this

setPublishDataTracks()

Generated from protobuf field <code>repeated .livekit.PublishDataTrackResponse publish_data_tracks = 8;</code>

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

setPublishTracks()

Generated from protobuf field <code>repeated .livekit.TrackPublishedResponse publish_tracks = 3;</code>

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

setTrackSidsDisabled()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results