Documentation

ParticipantInfo extends Message
in package

Application

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

Properties

$disconnect_reason : mixed: Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 16;</code>
$identity : mixed: Generated from protobuf field <code>string identity = 2;</code>
$is_publisher : mixed: indicates the participant has an active publisher connection and can publish to the server
$joined_at : mixed: timestamp when participant joined room, in seconds
$joined_at_ms : mixed: timestamp when participant joined room, in milliseconds
$kind : mixed: Generated from protobuf field <code>.livekit.ParticipantInfo.Kind kind = 14;</code>
$metadata : mixed: Generated from protobuf field <code>string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
$name : mixed: Generated from protobuf field <code>string name = 9 [(.logger.redact) = true];</code>
$permission : mixed: Generated from protobuf field <code>.livekit.ParticipantPermission permission = 11;</code>
$region : mixed: Generated from protobuf field <code>string region = 12;</code>
$sid : mixed: Generated from protobuf field <code>string sid = 1;</code>
$state : mixed: Generated from protobuf field <code>.livekit.ParticipantInfo.State state = 3;</code>
$version : mixed: Generated from protobuf field <code>uint32 version = 10;</code>
$attributes : mixed: Generated from protobuf field <code>map<string, string> attributes = 15 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
$data_tracks : mixed: Generated from protobuf field <code>repeated .livekit.DataTrackInfo data_tracks = 19;</code>
$kind_details : mixed: Generated from protobuf field <code>repeated .livekit.ParticipantInfo.KindDetail kind_details = 18;</code>
$tracks : mixed: Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 4;</code>

Methods

__construct() : mixed: Constructor.
clearPermission() : mixed
getAttributes() : MapField: Generated from protobuf field <code>map<string, string> attributes = 15 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
getDataTracks() : RepeatedField<string|int, DataTrackInfo>: Generated from protobuf field <code>repeated .livekit.DataTrackInfo data_tracks = 19;</code>
getDisconnectReason() : int: Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 16;</code>
getIdentity() : string: Generated from protobuf field <code>string identity = 2;</code>
getIsPublisher() : bool: indicates the participant has an active publisher connection and can publish to the server
getJoinedAt() : int|string: timestamp when participant joined room, in seconds
getJoinedAtMs() : int|string: timestamp when participant joined room, in milliseconds
getKind() : int: Generated from protobuf field <code>.livekit.ParticipantInfo.Kind kind = 14;</code>
getKindDetails() : RepeatedField<string|int, int>: Generated from protobuf field <code>repeated .livekit.ParticipantInfo.KindDetail kind_details = 18;</code>
getMetadata() : string: Generated from protobuf field <code>string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
getName() : string: Generated from protobuf field <code>string name = 9 [(.logger.redact) = true];</code>
getPermission() : ParticipantPermission|null: Generated from protobuf field <code>.livekit.ParticipantPermission permission = 11;</code>
getRegion() : string: Generated from protobuf field <code>string region = 12;</code>
getSid() : string: Generated from protobuf field <code>string sid = 1;</code>
getState() : int: Generated from protobuf field <code>.livekit.ParticipantInfo.State state = 3;</code>
getTracks() : RepeatedField<string|int, TrackInfo>: Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 4;</code>
getVersion() : int: Generated from protobuf field <code>uint32 version = 10;</code>
hasPermission() : mixed
setAttributes() : $this: Generated from protobuf field <code>map<string, string> attributes = 15 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setDataTracks() : $this: Generated from protobuf field <code>repeated .livekit.DataTrackInfo data_tracks = 19;</code>
setDisconnectReason() : $this: Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 16;</code>
setIdentity() : $this: Generated from protobuf field <code>string identity = 2;</code>
setIsPublisher() : $this: indicates the participant has an active publisher connection and can publish to the server
setJoinedAt() : $this: timestamp when participant joined room, in seconds
setJoinedAtMs() : $this: timestamp when participant joined room, in milliseconds
setKind() : $this: Generated from protobuf field <code>.livekit.ParticipantInfo.Kind kind = 14;</code>
setKindDetails() : $this: Generated from protobuf field <code>repeated .livekit.ParticipantInfo.KindDetail kind_details = 18;</code>
setMetadata() : $this: Generated from protobuf field <code>string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setName() : $this: Generated from protobuf field <code>string name = 9 [(.logger.redact) = true];</code>
setPermission() : $this: Generated from protobuf field <code>.livekit.ParticipantPermission permission = 11;</code>
setRegion() : $this: Generated from protobuf field <code>string region = 12;</code>
setSid() : $this: Generated from protobuf field <code>string sid = 1;</code>
setState() : $this: Generated from protobuf field <code>.livekit.ParticipantInfo.State state = 3;</code>
setTracks() : $this: Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 4;</code>
setVersion() : $this: Generated from protobuf field <code>uint32 version = 10;</code>

$disconnect_reason

Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 16;</code>


        protected
            mixed
    $disconnect_reason
     = 0

$identity

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


        protected
            mixed
    $identity
     = ''

$is_publisher

indicates the participant has an active publisher connection and can publish to the server


        protected
            mixed
    $is_publisher
     = false

Generated from protobuf field bool is_publisher = 13;

$joined_at

timestamp when participant joined room, in seconds


        protected
            mixed
    $joined_at
     = 0

Generated from protobuf field int64 joined_at = 6;

$joined_at_ms

timestamp when participant joined room, in milliseconds


        protected
            mixed
    $joined_at_ms
     = 0

Generated from protobuf field int64 joined_at_ms = 17;

$kind

Generated from protobuf field <code>.livekit.ParticipantInfo.Kind kind = 14;</code>


        protected
            mixed
    $kind
     = 0

$metadata

Generated from protobuf field <code>string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>


        protected
            mixed
    $metadata
     = ''

$name

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


        protected
            mixed
    $name
     = ''

$permission

Generated from protobuf field <code>.livekit.ParticipantPermission permission = 11;</code>


        protected
            mixed
    $permission
     = null

$region

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


        protected
            mixed
    $region
     = ''

$sid

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


        protected
            mixed
    $sid
     = ''

$state

Generated from protobuf field <code>.livekit.ParticipantInfo.State state = 3;</code>


        protected
            mixed
    $state
     = 0

$version

Generated from protobuf field <code>uint32 version = 10;</code>


        protected
            mixed
    $version
     = 0

$attributes

Generated from protobuf field <code>map<string, string> attributes = 15 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>


        private
            mixed
    $attributes

$data_tracks

Generated from protobuf field <code>repeated .livekit.DataTrackInfo data_tracks = 19;</code>


        private
            mixed
    $data_tracks

$kind_details

Generated from protobuf field <code>repeated .livekit.ParticipantInfo.KindDetail kind_details = 18;</code>


        private
            mixed
    $kind_details

$tracks

Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 4;</code>


        private
            mixed
    $tracks

__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 string $identity
@type int $state
@type \Livekit\TrackInfo[] $tracks
@type string $metadata
@type int|string $joined_at
      timestamp when participant joined room, in seconds
@type int|string $joined_at_ms
      timestamp when participant joined room, in milliseconds
@type string $name
@type int $version
@type \Livekit\ParticipantPermission $permission
@type string $region
@type bool $is_publisher
      indicates the participant has an active publisher connection
      and can publish to the server
@type int $kind
@type array|\Google\Protobuf\Internal\MapField $attributes
@type int $disconnect_reason
@type int[] $kind_details
@type \Livekit\DataTrackInfo[] $data_tracks

}

clearPermission()


    public
                    clearPermission() : mixed

getAttributes()

Generated from protobuf field <code>map<string, string> attributes = 15 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>


    public
                    getAttributes() : MapField

Return values

MapField

getDataTracks()

Generated from protobuf field <code>repeated .livekit.DataTrackInfo data_tracks = 19;</code>


    public
                    getDataTracks() : RepeatedField<string|int, DataTrackInfo>

Return values

RepeatedField<string|int, DataTrackInfo>

getDisconnectReason()

Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 16;</code>


    public
                    getDisconnectReason() : int

Return values

int

getIdentity()

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


    public
                    getIdentity() : string

Return values

string

getIsPublisher()

indicates the participant has an active publisher connection and can publish to the server


    public
                    getIsPublisher() : bool

Generated from protobuf field bool is_publisher = 13;

Return values

bool

getJoinedAt()

timestamp when participant joined room, in seconds


    public
                    getJoinedAt() : int|string

Generated from protobuf field int64 joined_at = 6;

Return values

int|string

getJoinedAtMs()

timestamp when participant joined room, in milliseconds


    public
                    getJoinedAtMs() : int|string

Generated from protobuf field int64 joined_at_ms = 17;

Return values

int|string

getKind()

Generated from protobuf field <code>.livekit.ParticipantInfo.Kind kind = 14;</code>


    public
                    getKind() : int

Return values

int

getKindDetails()

Generated from protobuf field <code>repeated .livekit.ParticipantInfo.KindDetail kind_details = 18;</code>


    public
                    getKindDetails() : RepeatedField<string|int, int>

Return values

RepeatedField<string|int, int>

getMetadata()

Generated from protobuf field <code>string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>


    public
                    getMetadata() : string

Return values

string

getName()

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


    public
                    getName() : string

Return values

string

getPermission()

Generated from protobuf field <code>.livekit.ParticipantPermission permission = 11;</code>


    public
                    getPermission() : ParticipantPermission|null

Return values

ParticipantPermission|null

getRegion()

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


    public
                    getRegion() : string

Return values

string

getSid()

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


    public
                    getSid() : string

Return values

string

getState()

Generated from protobuf field <code>.livekit.ParticipantInfo.State state = 3;</code>


    public
                    getState() : int

Return values

int

getTracks()

Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 4;</code>


    public
                    getTracks() : RepeatedField<string|int, TrackInfo>

Return values

RepeatedField<string|int, TrackInfo>

getVersion()

Generated from protobuf field <code>uint32 version = 10;</code>


    public
                    getVersion() : int

Return values

int

hasPermission()


    public
                    hasPermission() : mixed

setAttributes()

Generated from protobuf field <code>map<string, string> attributes = 15 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>


    public
                    setAttributes(array<string|int, mixed>|MapField $var) : $this

Parameters

$var : array<string|int, mixed>|MapField

Return values

$this

setDataTracks()

Generated from protobuf field <code>repeated .livekit.DataTrackInfo data_tracks = 19;</code>


    public
                    setDataTracks(array<string|int, DataTrackInfo> $var) : $this

Parameters

$var : array<string|int, DataTrackInfo>

Return values

$this

setDisconnectReason()

Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 16;</code>


    public
                    setDisconnectReason(int $var) : $this

Parameters

$var : int

Return values

$this

setIdentity()

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


    public
                    setIdentity(string $var) : $this

Parameters

$var : string

Return values

$this

setIsPublisher()

indicates the participant has an active publisher connection and can publish to the server


    public
                    setIsPublisher(bool $var) : $this

Generated from protobuf field bool is_publisher = 13;

Parameters

$var : bool

Return values

$this

setJoinedAt()

timestamp when participant joined room, in seconds


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

Generated from protobuf field int64 joined_at = 6;

Parameters

$var : int|string

Return values

$this

setJoinedAtMs()

timestamp when participant joined room, in milliseconds


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

Generated from protobuf field int64 joined_at_ms = 17;

Parameters

$var : int|string

Return values

$this

setKind()

Generated from protobuf field <code>.livekit.ParticipantInfo.Kind kind = 14;</code>


    public
                    setKind(int $var) : $this

Parameters

$var : int

Return values

$this

setKindDetails()

Generated from protobuf field <code>repeated .livekit.ParticipantInfo.KindDetail kind_details = 18;</code>


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

Parameters

$var : array<string|int, int>

Return values

$this

setMetadata()

Generated from protobuf field <code>string metadata = 5 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>


    public
                    setMetadata(string $var) : $this

Parameters

$var : string

Return values

$this

setName()

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


    public
                    setName(string $var) : $this

Parameters

$var : string

Return values

$this

setPermission()

Generated from protobuf field <code>.livekit.ParticipantPermission permission = 11;</code>


    public
                    setPermission(ParticipantPermission $var) : $this

Parameters

$var : ParticipantPermission

Return values

$this

setRegion()

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


    public
                    setRegion(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

setState()

Generated from protobuf field <code>.livekit.ParticipantInfo.State state = 3;</code>


    public
                    setState(int $var) : $this

Parameters

$var : int

Return values

$this

setTracks()

Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 4;</code>


    public
                    setTracks(array<string|int, TrackInfo> $var) : $this

Parameters

$var : array<string|int, TrackInfo>

Return values

$this

setVersion()

Generated from protobuf field <code>uint32 version = 10;</code>


    public
                    setVersion(int $var) : $this

Parameters

$var : int

Return values

$this

ParticipantInfo extends Message in package Application

Table of Contents

Properties

Methods

Properties

$disconnect_reason

$identity

$is_publisher

$joined_at

$joined_at_ms

$kind

$metadata

$name

$permission

$region

$sid

$state

$version

$attributes

$data_tracks

$kind_details

$tracks

Methods

__construct()

Parameters

clearPermission()

getAttributes()

Return values

getDataTracks()

Return values

getDisconnectReason()

Return values

getIdentity()

Return values

getIsPublisher()

Return values

getJoinedAt()

Return values

getJoinedAtMs()

Return values

getKind()

Return values

getKindDetails()

Return values

getMetadata()

Return values

getName()

Return values

getPermission()

Return values

getRegion()

Return values

getSid()

Return values

getState()

Return values

getTracks()

Return values

getVersion()

Return values

hasPermission()

setAttributes()

Parameters

Return values

setDataTracks()

Parameters

Return values

setDisconnectReason()

Parameters

Return values

setIdentity()

Parameters

Return values

setIsPublisher()

Parameters

Return values

setJoinedAt()

Parameters

Return values

setJoinedAtMs()

ParticipantInfo extends Message
in package

Application