Documentation

WebhookEvent extends Message

in package

• Application

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

Table of Contents

Properties

$created_at  : mixed

timestamp in seconds

$egress_info  : mixed

set when event is egress_*

$event  : mixed

one of room_started, room_finished, participant_joined, participant_left, participant_connection_aborted, track_published, track_unpublished, egress_started, egress_updated, egress_ended, ingress_started, ingress_ended

$id  : mixed

unique event uuid

$ingress_info  : mixed

set when event is ingress_*

$num_dropped  : mixed

Generated from protobuf field <code>int32 num_dropped = 11 [deprecated = true];</code>

$participant  : mixed

set when event is participant_* or track_*

$room  : mixed

Generated from protobuf field <code>.livekit.Room room = 2;</code>

$track  : mixed

set when event is track_*

Methods

__construct()  : mixed

Constructor.

clearEgressInfo()  : mixed

clearIngressInfo()  : mixed

clearParticipant()  : mixed

clearRoom()  : mixed

clearTrack()  : mixed

getCreatedAt()  : int|string

timestamp in seconds

getEgressInfo()  : EgressInfo|null

set when event is egress_*

getEvent()  : string

one of room_started, room_finished, participant_joined, participant_left, participant_connection_aborted, track_published, track_unpublished, egress_started, egress_updated, egress_ended, ingress_started, ingress_ended

getId()  : string

unique event uuid

getIngressInfo()  : IngressInfo|null

set when event is ingress_*

getNumDropped()  : int

Generated from protobuf field <code>int32 num_dropped = 11 [deprecated = true];</code>

getParticipant()  : ParticipantInfo|null

set when event is participant_* or track_*

getRoom()  : Room|null

Generated from protobuf field <code>.livekit.Room room = 2;</code>

getTrack()  : TrackInfo|null

set when event is track_*

hasEgressInfo()  : mixed

hasIngressInfo()  : mixed

hasParticipant()  : mixed

hasRoom()  : mixed

hasTrack()  : mixed

setCreatedAt()  : $this

timestamp in seconds

setEgressInfo()  : $this

set when event is egress_*

setEvent()  : $this

one of room_started, room_finished, participant_joined, participant_left, participant_connection_aborted, track_published, track_unpublished, egress_started, egress_updated, egress_ended, ingress_started, ingress_ended

setId()  : $this

unique event uuid

setIngressInfo()  : $this

set when event is ingress_*

setNumDropped()  : $this

Generated from protobuf field <code>int32 num_dropped = 11 [deprecated = true];</code>

setParticipant()  : $this

set when event is participant_* or track_*

setRoom()  : $this

Generated from protobuf field <code>.livekit.Room room = 2;</code>

setTrack()  : $this

set when event is track_*