Documentation

Update extends Message
in package

Generated from protobuf message <code>livekit.UpdateDataSubscription.Update</code>

Table of Contents

Properties

$options  : mixed
Options to apply when initially subscribing or updating an existing subscription.
$subscribe  : mixed
Generated from protobuf field <code>bool subscribe = 2;</code>
$track_sid  : mixed
Generated from protobuf field <code>string track_sid = 1;</code>

Methods

__construct()  : mixed
Constructor.
clearOptions()  : mixed
getOptions()  : DataTrackSubscriptionOptions|null
Options to apply when initially subscribing or updating an existing subscription.
getSubscribe()  : bool
Generated from protobuf field <code>bool subscribe = 2;</code>
getTrackSid()  : string
Generated from protobuf field <code>string track_sid = 1;</code>
hasOptions()  : mixed
setOptions()  : $this
Options to apply when initially subscribing or updating an existing subscription.
setSubscribe()  : $this
Generated from protobuf field <code>bool subscribe = 2;</code>
setTrackSid()  : $this
Generated from protobuf field <code>string track_sid = 1;</code>

Properties

$options

Options to apply when initially subscribing or updating an existing subscription.

protected mixed $options = null

When unsubscribing, this field is ignored.

Generated from protobuf field .livekit.DataTrackSubscriptionOptions options = 3;

$subscribe

Generated from protobuf field <code>bool subscribe = 2;</code>

protected mixed $subscribe = false

$track_sid

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

protected mixed $track_sid = ''

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 $track_sid
@type bool $subscribe
@type \Livekit\DataTrackSubscriptionOptions $options
      Options to apply when initially subscribing or updating an existing subscription.
      When unsubscribing, this field is ignored.

}

clearOptions()

public clearOptions() : mixed

getOptions()

Options to apply when initially subscribing or updating an existing subscription.

public getOptions() : DataTrackSubscriptionOptions|null

When unsubscribing, this field is ignored.

Generated from protobuf field .livekit.DataTrackSubscriptionOptions options = 3;

Return values
DataTrackSubscriptionOptions|null

getSubscribe()

Generated from protobuf field <code>bool subscribe = 2;</code>

public getSubscribe() : bool
Return values
bool

getTrackSid()

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

public getTrackSid() : string
Return values
string

hasOptions()

public hasOptions() : mixed

setOptions()

Options to apply when initially subscribing or updating an existing subscription.

public setOptions(DataTrackSubscriptionOptions $var) : $this

When unsubscribing, this field is ignored.

Generated from protobuf field .livekit.DataTrackSubscriptionOptions options = 3;

Parameters
$var : DataTrackSubscriptionOptions
Return values
$this

setSubscribe()

Generated from protobuf field <code>bool subscribe = 2;</code>

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

setTrackSid()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results