Documentation

TrackInfo extends Message
in package

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

Table of Contents

Properties

$backup_codec_policy  : mixed
Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 20;</code>
$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 = 16;</code>
$height  : mixed
original height of video (unset for audio)
$mid  : mixed
Generated from protobuf field <code>string mid = 12;</code>
$mime_type  : mixed
mime type of codec
$muted  : mixed
Generated from protobuf field <code>bool muted = 4;</code>
$name  : mixed
Generated from protobuf field <code>string name = 3 [(.logger.redact) = true];</code>
$sid  : mixed
Generated from protobuf field <code>string sid = 1;</code>
$simulcast  : mixed
true if track is simulcasted
$source  : mixed
source of media
$stereo  : mixed
deprecated in favor of `audio_features`
$stream  : mixed
Generated from protobuf field <code>string stream = 17;</code>
$type  : mixed
Generated from protobuf field <code>.livekit.TrackType type = 2;</code>
$version  : mixed
Generated from protobuf field <code>.livekit.TimedVersion version = 18;</code>
$width  : mixed
original width of video (unset for audio) clients may receive a lower resolution version with simulcast
$audio_features  : mixed
Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 19;</code>
$codecs  : mixed
Generated from protobuf field <code>repeated .livekit.SimulcastCodecInfo codecs = 13;</code>
$layers  : mixed
see `codecs` for layers of individual codec

Methods

__construct()  : mixed
Constructor.
clearVersion()  : mixed
getAudioFeatures()  : RepeatedField<string|int, int>
Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 19;</code>
getBackupCodecPolicy()  : int
Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 20;</code>
getCodecs()  : RepeatedField<string|int, SimulcastCodecInfo>
Generated from protobuf field <code>repeated .livekit.SimulcastCodecInfo codecs = 13;</code>
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 = 16;</code>
getHeight()  : int
original height of video (unset for audio)
getLayers()  : RepeatedField<string|int, VideoLayer>
see `codecs` for layers of individual codec
getMid()  : string
Generated from protobuf field <code>string mid = 12;</code>
getMimeType()  : string
mime type of codec
getMuted()  : bool
Generated from protobuf field <code>bool muted = 4;</code>
getName()  : string
Generated from protobuf field <code>string name = 3 [(.logger.redact) = true];</code>
getSid()  : string
Generated from protobuf field <code>string sid = 1;</code>
getSimulcast()  : bool
true if track is simulcasted
getSource()  : int
source of media
getStereo()  : bool
deprecated in favor of `audio_features`
getStream()  : string
Generated from protobuf field <code>string stream = 17;</code>
getType()  : int
Generated from protobuf field <code>.livekit.TrackType type = 2;</code>
getVersion()  : TimedVersion|null
Generated from protobuf field <code>.livekit.TimedVersion version = 18;</code>
getWidth()  : int
original width of video (unset for audio) clients may receive a lower resolution version with simulcast
hasVersion()  : mixed
setAudioFeatures()  : $this
Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 19;</code>
setBackupCodecPolicy()  : $this
Generated from protobuf field <code>.livekit.BackupCodecPolicy backup_codec_policy = 20;</code>
setCodecs()  : $this
Generated from protobuf field <code>repeated .livekit.SimulcastCodecInfo codecs = 13;</code>
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 = 16;</code>
setHeight()  : $this
original height of video (unset for audio)
setLayers()  : $this
see `codecs` for layers of individual codec
setMid()  : $this
Generated from protobuf field <code>string mid = 12;</code>
setMimeType()  : $this
mime type of codec
setMuted()  : $this
Generated from protobuf field <code>bool muted = 4;</code>
setName()  : $this
Generated from protobuf field <code>string name = 3 [(.logger.redact) = true];</code>
setSid()  : $this
Generated from protobuf field <code>string sid = 1;</code>
setSimulcast()  : $this
true if track is simulcasted
setSource()  : $this
source of media
setStereo()  : $this
deprecated in favor of `audio_features`
setStream()  : $this
Generated from protobuf field <code>string stream = 17;</code>
setType()  : $this
Generated from protobuf field <code>.livekit.TrackType type = 2;</code>
setVersion()  : $this
Generated from protobuf field <code>.livekit.TimedVersion version = 18;</code>
setWidth()  : $this
original width of video (unset for audio) clients may receive a lower resolution version with simulcast

Properties

$backup_codec_policy

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

protected mixed $backup_codec_policy = 0

$disable_dtx

true if DTX (Discontinuous Transmission) is disabled for audio

protected mixed $disable_dtx = false

Generated from protobuf field bool disable_dtx = 8 [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 = 15;

$encryption

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

protected mixed $encryption = 0

$height

original height of video (unset for audio)

protected mixed $height = 0

Generated from protobuf field uint32 height = 6;

$mid

Generated from protobuf field <code>string mid = 12;</code>

protected mixed $mid = ''

$mime_type

mime type of codec

protected mixed $mime_type = ''

Generated from protobuf field string mime_type = 11;

$muted

Generated from protobuf field <code>bool muted = 4;</code>

protected mixed $muted = false

$name

Generated from protobuf field <code>string name = 3 [(.logger.redact) = true];</code>

protected mixed $name = ''

$sid

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

protected mixed $sid = ''

$simulcast

true if track is simulcasted

protected mixed $simulcast = false

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

$source

source of media

protected mixed $source = 0

Generated from protobuf field .livekit.TrackSource source = 9;

$stereo

deprecated in favor of `audio_features`

protected mixed $stereo = false

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

$stream

Generated from protobuf field <code>string stream = 17;</code>

protected mixed $stream = ''

$type

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

protected mixed $type = 0

$version

Generated from protobuf field <code>.livekit.TimedVersion version = 18;</code>

protected mixed $version = null

$width

original width of video (unset for audio) clients may receive a lower resolution version with simulcast

protected mixed $width = 0

Generated from protobuf field uint32 width = 5;

$audio_features

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

private mixed $audio_features

$codecs

Generated from protobuf field <code>repeated .livekit.SimulcastCodecInfo codecs = 13;</code>

private mixed $codecs

$layers

see `codecs` for layers of individual codec

private mixed $layers

Generated from protobuf field repeated .livekit.VideoLayer layers = 10 [deprecated = true];

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 $sid
@type int $type
@type string $name
@type bool $muted
@type int $width
      original width of video (unset for audio)
      clients may receive a lower resolution version with simulcast
@type int $height
      original height of video (unset for audio)
@type bool $simulcast
      true if track is simulcasted
@type bool $disable_dtx
      true if DTX (Discontinuous Transmission) is disabled for audio
@type int $source
      source of media
@type \Livekit\VideoLayer[] $layers
      see `codecs` for layers of individual codec
@type string $mime_type
      mime type of codec
@type string $mid
@type \Livekit\SimulcastCodecInfo[] $codecs
@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
@type \Livekit\TimedVersion $version
@type int[] $audio_features
@type int $backup_codec_policy

}

clearVersion()

public clearVersion() : mixed

getAudioFeatures()

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

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

getBackupCodecPolicy()

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

public getBackupCodecPolicy() : int
Return values
int

getCodecs()

Generated from protobuf field <code>repeated .livekit.SimulcastCodecInfo codecs = 13;</code>

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

getDisableDtx()

true if DTX (Discontinuous Transmission) is disabled for audio

public getDisableDtx() : bool

Generated from protobuf field bool disable_dtx = 8 [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 = 15;

Return values
bool

getEncryption()

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

public getEncryption() : int
Return values
int

getHeight()

original height of video (unset for audio)

public getHeight() : int

Generated from protobuf field uint32 height = 6;

Return values
int

getLayers()

see `codecs` for layers of individual codec

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

Generated from protobuf field repeated .livekit.VideoLayer layers = 10 [deprecated = true];

Return values
RepeatedField<string|int, VideoLayer>

getMid()

Generated from protobuf field <code>string mid = 12;</code>

public getMid() : string
Return values
string

getMimeType()

mime type of codec

public getMimeType() : string

Generated from protobuf field string mime_type = 11;

Return values
string

getMuted()

Generated from protobuf field <code>bool muted = 4;</code>

public getMuted() : bool
Return values
bool

getName()

Generated from protobuf field <code>string name = 3 [(.logger.redact) = true];</code>

public getName() : string
Return values
string

getSid()

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

public getSid() : string
Return values
string

getSimulcast()

true if track is simulcasted

public getSimulcast() : bool

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

Return values
bool

getSource()

source of media

public getSource() : int

Generated from protobuf field .livekit.TrackSource source = 9;

Return values
int

getStereo()

deprecated in favor of `audio_features`

public getStereo() : bool

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

Return values
bool

getStream()

Generated from protobuf field <code>string stream = 17;</code>

public getStream() : string
Return values
string

getType()

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

public getType() : int
Return values
int

getVersion()

Generated from protobuf field <code>.livekit.TimedVersion version = 18;</code>

public getVersion() : TimedVersion|null
Return values
TimedVersion|null

getWidth()

original width of video (unset for audio) clients may receive a lower resolution version with simulcast

public getWidth() : int

Generated from protobuf field uint32 width = 5;

Return values
int

setAudioFeatures()

Generated from protobuf field <code>repeated .livekit.AudioTrackFeature audio_features = 19;</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 = 20;</code>

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

setCodecs()

Generated from protobuf field <code>repeated .livekit.SimulcastCodecInfo codecs = 13;</code>

public setCodecs(array<string|int, SimulcastCodecInfo> $var) : $this
Parameters
$var : array<string|int, SimulcastCodecInfo>
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 = 8 [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 = 15;

Parameters
$var : bool
Return values
$this

setEncryption()

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

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

setHeight()

original height of video (unset for audio)

public setHeight(int $var) : $this

Generated from protobuf field uint32 height = 6;

Parameters
$var : int
Return values
$this

setLayers()

see `codecs` for layers of individual codec

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

Generated from protobuf field repeated .livekit.VideoLayer layers = 10 [deprecated = true];

Parameters
$var : array<string|int, VideoLayer>
Return values
$this

setMid()

Generated from protobuf field <code>string mid = 12;</code>

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

setMimeType()

mime type of codec

public setMimeType(string $var) : $this

Generated from protobuf field string mime_type = 11;

Parameters
$var : string
Return values
$this

setMuted()

Generated from protobuf field <code>bool muted = 4;</code>

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

setName()

Generated from protobuf field <code>string name = 3 [(.logger.redact) = true];</code>

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

setSid()

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

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

setSimulcast()

true if track is simulcasted

public setSimulcast(bool $var) : $this

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

Parameters
$var : bool
Return values
$this

setSource()

source of media

public setSource(int $var) : $this

Generated from protobuf field .livekit.TrackSource source = 9;

Parameters
$var : int
Return values
$this

setStereo()

deprecated in favor of `audio_features`

public setStereo(bool $var) : $this

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

Parameters
$var : bool
Return values
$this

setStream()

Generated from protobuf field <code>string stream = 17;</code>

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

setType()

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

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

setVersion()

Generated from protobuf field <code>.livekit.TimedVersion version = 18;</code>

public setVersion(TimedVersion $var) : $this
Parameters
$var : TimedVersion
Return values
$this

setWidth()

original width of video (unset for audio) clients may receive a lower resolution version with simulcast

public setWidth(int $var) : $this

Generated from protobuf field uint32 width = 5;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results