Documentation

AddTrackRequest extends Message
in package

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

Table of Contents

Properties

$backup_codec_policy  : mixed
Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 16;</code>
$cid  : mixed
client ID of track, to match it when RTC track is received
$disable_dtx  : mixed
true if DTX (Discontinuous Transmission) is disabled for audio
$disable_red  : mixed
true if RED (Redundant Encoding) is disabled for audio
$encryption  : mixed
Generated from protobuf field <code>.livekit.Encryption.Type encryption = 14;</code>
$height  : mixed
Generated from protobuf field <code>uint32 height = 5;</code>
$muted  : mixed
true to add track and initialize to muted
$name  : mixed
Generated from protobuf field <code>string name = 2;</code>
$sid  : mixed
server ID of track, publish new codec to exist track
$source  : mixed
Generated from protobuf field <code>.livekit.TrackSource source = 8;</code>
$stereo  : mixed
deprecated in favor of audio_features
$stream  : mixed
which stream the track belongs to, used to group tracks together.
$type  : mixed
Generated from protobuf field <code>.livekit.TrackType type = 3;</code>
$width  : mixed
Generated from protobuf field <code>uint32 width = 4;</code>
$audio_features  : mixed
Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 17;</code>
$layers  : mixed
Generated from protobuf field <code>repeated .livekit.VideoLayer layers = 9;</code>
$simulcast_codecs  : mixed
Generated from protobuf field <code>repeated .livekit.SimulcastCodec simulcast_codecs = 10;</code>

Methods

__construct()  : mixed
Constructor.
getAudioFeatures()  : RepeatedField<string|int, int>
Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 17;</code>
getBackupCodecPolicy()  : int
Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 16;</code>
getCid()  : string
client ID of track, to match it when RTC track is received
getDisableDtx()  : bool
true if DTX (Discontinuous Transmission) is disabled for audio
getDisableRed()  : bool
true if RED (Redundant Encoding) is disabled for audio
getEncryption()  : int
Generated from protobuf field <code>.livekit.Encryption.Type encryption = 14;</code>
getHeight()  : int
Generated from protobuf field <code>uint32 height = 5;</code>
getLayers()  : RepeatedField<string|int, VideoLayer>
Generated from protobuf field <code>repeated .livekit.VideoLayer layers = 9;</code>
getMuted()  : bool
true to add track and initialize to muted
getName()  : string
Generated from protobuf field <code>string name = 2;</code>
getSid()  : string
server ID of track, publish new codec to exist track
getSimulcastCodecs()  : RepeatedField<string|int, SimulcastCodec>
Generated from protobuf field <code>repeated .livekit.SimulcastCodec simulcast_codecs = 10;</code>
getSource()  : int
Generated from protobuf field <code>.livekit.TrackSource source = 8;</code>
getStereo()  : bool
deprecated in favor of audio_features
getStream()  : string
which stream the track belongs to, used to group tracks together.
getType()  : int
Generated from protobuf field <code>.livekit.TrackType type = 3;</code>
getWidth()  : int
Generated from protobuf field <code>uint32 width = 4;</code>
setAudioFeatures()  : $this
Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 17;</code>
setBackupCodecPolicy()  : $this
Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 16;</code>
setCid()  : $this
client ID of track, to match it when RTC track is received
setDisableDtx()  : $this
true if DTX (Discontinuous Transmission) is disabled for audio
setDisableRed()  : $this
true if RED (Redundant Encoding) is disabled for audio
setEncryption()  : $this
Generated from protobuf field <code>.livekit.Encryption.Type encryption = 14;</code>
setHeight()  : $this
Generated from protobuf field <code>uint32 height = 5;</code>
setLayers()  : $this
Generated from protobuf field <code>repeated .livekit.VideoLayer layers = 9;</code>
setMuted()  : $this
true to add track and initialize to muted
setName()  : $this
Generated from protobuf field <code>string name = 2;</code>
setSid()  : $this
server ID of track, publish new codec to exist track
setSimulcastCodecs()  : $this
Generated from protobuf field <code>repeated .livekit.SimulcastCodec simulcast_codecs = 10;</code>
setSource()  : $this
Generated from protobuf field <code>.livekit.TrackSource source = 8;</code>
setStereo()  : $this
deprecated in favor of audio_features
setStream()  : $this
which stream the track belongs to, used to group tracks together.
setType()  : $this
Generated from protobuf field <code>.livekit.TrackType type = 3;</code>
setWidth()  : $this
Generated from protobuf field <code>uint32 width = 4;</code>

Properties

$backup_codec_policy

Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 16;</code>

protected mixed $backup_codec_policy = 0

$cid

client ID of track, to match it when RTC track is received

protected mixed $cid = ''

Generated from protobuf field string cid = 1;

$disable_dtx

true if DTX (Discontinuous Transmission) is disabled for audio

protected mixed $disable_dtx = false

Generated from protobuf field bool disable_dtx = 7 [deprecated = true];

$disable_red

true if RED (Redundant Encoding) is disabled for audio

protected mixed $disable_red = false

Generated from protobuf field bool disable_red = 13;

$encryption

Generated from protobuf field <code>.livekit.Encryption.Type encryption = 14;</code>

protected mixed $encryption = 0

$height

Generated from protobuf field <code>uint32 height = 5;</code>

protected mixed $height = 0

$muted

true to add track and initialize to muted

protected mixed $muted = false

Generated from protobuf field bool muted = 6;

$name

Generated from protobuf field <code>string name = 2;</code>

protected mixed $name = ''

$sid

server ID of track, publish new codec to exist track

protected mixed $sid = ''

Generated from protobuf field string sid = 11;

$source

Generated from protobuf field <code>.livekit.TrackSource source = 8;</code>

protected mixed $source = 0

$stereo

deprecated in favor of audio_features

protected mixed $stereo = false

Generated from protobuf field bool stereo = 12 [deprecated = true];

$stream

which stream the track belongs to, used to group tracks together.

protected mixed $stream = ''

if not specified, server will infer it from track source to bundle camera/microphone, screenshare/audio together

Generated from protobuf field string stream = 15;

$type

Generated from protobuf field <code>.livekit.TrackType type = 3;</code>

protected mixed $type = 0

$width

Generated from protobuf field <code>uint32 width = 4;</code>

protected mixed $width = 0

$audio_features

Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 17;</code>

private mixed $audio_features

$layers

Generated from protobuf field <code>repeated .livekit.VideoLayer layers = 9;</code>

private mixed $layers

$simulcast_codecs

Generated from protobuf field <code>repeated .livekit.SimulcastCodec simulcast_codecs = 10;</code>

private mixed $simulcast_codecs

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 $cid
      client ID of track, to match it when RTC track is received
@type string $name
@type int $type
@type int $width
@type int $height
@type bool $muted
      true to add track and initialize to muted
@type bool $disable_dtx
      true if DTX (Discontinuous Transmission) is disabled for audio
@type int $source
@type \Livekit\VideoLayer[] $layers
@type \Livekit\SimulcastCodec[] $simulcast_codecs
@type string $sid
      server ID of track, publish new codec to exist track
@type bool $stereo
      deprecated in favor of audio_features
@type bool $disable_red
      true if RED (Redundant Encoding) is disabled for audio
@type int $encryption
@type string $stream
      which stream the track belongs to, used to group tracks together.
      if not specified, server will infer it from track source to bundle camera/microphone, screenshare/audio together
@type int $backup_codec_policy
@type int[] $audio_features

}

getAudioFeatures()

Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 17;</code>

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

getBackupCodecPolicy()

Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 16;</code>

public getBackupCodecPolicy() : int
Return values
int

getCid()

client ID of track, to match it when RTC track is received

public getCid() : string

Generated from protobuf field string cid = 1;

Return values
string

getDisableDtx()

true if DTX (Discontinuous Transmission) is disabled for audio

public getDisableDtx() : bool

Generated from protobuf field bool disable_dtx = 7 [deprecated = true];

Return values
bool

getDisableRed()

true if RED (Redundant Encoding) is disabled for audio

public getDisableRed() : bool

Generated from protobuf field bool disable_red = 13;

Return values
bool

getEncryption()

Generated from protobuf field <code>.livekit.Encryption.Type encryption = 14;</code>

public getEncryption() : int
Return values
int

getHeight()

Generated from protobuf field <code>uint32 height = 5;</code>

public getHeight() : int
Return values
int

getLayers()

Generated from protobuf field <code>repeated .livekit.VideoLayer layers = 9;</code>

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

getMuted()

true to add track and initialize to muted

public getMuted() : bool

Generated from protobuf field bool muted = 6;

Return values
bool

getName()

Generated from protobuf field <code>string name = 2;</code>

public getName() : string
Return values
string

getSid()

server ID of track, publish new codec to exist track

public getSid() : string

Generated from protobuf field string sid = 11;

Return values
string

getSimulcastCodecs()

Generated from protobuf field <code>repeated .livekit.SimulcastCodec simulcast_codecs = 10;</code>

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

getSource()

Generated from protobuf field <code>.livekit.TrackSource source = 8;</code>

public getSource() : int
Return values
int

getStereo()

deprecated in favor of audio_features

public getStereo() : bool

Generated from protobuf field bool stereo = 12 [deprecated = true];

Return values
bool

getStream()

which stream the track belongs to, used to group tracks together.

public getStream() : string

if not specified, server will infer it from track source to bundle camera/microphone, screenshare/audio together

Generated from protobuf field string stream = 15;

Return values
string

getType()

Generated from protobuf field <code>.livekit.TrackType type = 3;</code>

public getType() : int
Return values
int

getWidth()

Generated from protobuf field <code>uint32 width = 4;</code>

public getWidth() : int
Return values
int

setAudioFeatures()

Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 17;</code>

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

setBackupCodecPolicy()

Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 16;</code>

public setBackupCodecPolicy(int $var) : $this
Parameters
$var : int
Return values
$this

setCid()

client ID of track, to match it when RTC track is received

public setCid(string $var) : $this

Generated from protobuf field string cid = 1;

Parameters
$var : string
Return values
$this

setDisableDtx()

true if DTX (Discontinuous Transmission) is disabled for audio

public setDisableDtx(bool $var) : $this

Generated from protobuf field bool disable_dtx = 7 [deprecated = true];

Parameters
$var : bool
Return values
$this

setDisableRed()

true if RED (Redundant Encoding) is disabled for audio

public setDisableRed(bool $var) : $this

Generated from protobuf field bool disable_red = 13;

Parameters
$var : bool
Return values
$this

setEncryption()

Generated from protobuf field <code>.livekit.Encryption.Type encryption = 14;</code>

public setEncryption(int $var) : $this
Parameters
$var : int
Return values
$this

setHeight()

Generated from protobuf field <code>uint32 height = 5;</code>

public setHeight(int $var) : $this
Parameters
$var : int
Return values
$this

setLayers()

Generated from protobuf field <code>repeated .livekit.VideoLayer layers = 9;</code>

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

setMuted()

true to add track and initialize to muted

public setMuted(bool $var) : $this

Generated from protobuf field bool muted = 6;

Parameters
$var : bool
Return values
$this

setName()

Generated from protobuf field <code>string name = 2;</code>

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

setSid()

server ID of track, publish new codec to exist track

public setSid(string $var) : $this

Generated from protobuf field string sid = 11;

Parameters
$var : string
Return values
$this

setSimulcastCodecs()

Generated from protobuf field <code>repeated .livekit.SimulcastCodec simulcast_codecs = 10;</code>

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

setSource()

Generated from protobuf field <code>.livekit.TrackSource source = 8;</code>

public setSource(int $var) : $this
Parameters
$var : int
Return values
$this

setStereo()

deprecated in favor of audio_features

public setStereo(bool $var) : $this

Generated from protobuf field bool stereo = 12 [deprecated = true];

Parameters
$var : bool
Return values
$this

setStream()

which stream the track belongs to, used to group tracks together.

public setStream(string $var) : $this

if not specified, server will infer it from track source to bundle camera/microphone, screenshare/audio together

Generated from protobuf field string stream = 15;

Parameters
$var : string
Return values
$this

setType()

Generated from protobuf field <code>.livekit.TrackType type = 3;</code>

public setType(int $var) : $this
Parameters
$var : int
Return values
$this

setWidth()

Generated from protobuf field <code>uint32 width = 4;</code>

public setWidth(int $var) : $this
Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results