Documentation

EgressInfo extends Message
in package

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

Table of Contents

Properties

$backup_storage_used  : mixed
next ID: 27
$details  : mixed
Generated from protobuf field <code>string details = 21;</code>
$egress_id  : mixed
Generated from protobuf field <code>string egress_id = 1;</code>
$ended_at  : mixed
Generated from protobuf field <code>int64 ended_at = 11;</code>
$error  : mixed
Generated from protobuf field <code>string error = 9;</code>
$error_code  : mixed
Generated from protobuf field <code>int32 error_code = 22;</code>
$manifest_location  : mixed
Generated from protobuf field <code>string manifest_location = 23;</code>
$request  : mixed
$result  : mixed
$room_id  : mixed
Generated from protobuf field <code>string room_id = 2;</code>
$room_name  : mixed
Generated from protobuf field <code>string room_name = 13;</code>
$source_type  : mixed
Generated from protobuf field <code>.livekit.EgressSourceType source_type = 26;</code>
$started_at  : mixed
Generated from protobuf field <code>int64 started_at = 10;</code>
$status  : mixed
Generated from protobuf field <code>.livekit.EgressStatus status = 3;</code>
$updated_at  : mixed
Generated from protobuf field <code>int64 updated_at = 18;</code>
$file_results  : mixed
Generated from protobuf field <code>repeated .livekit.FileInfo file_results = 16;</code>
$image_results  : mixed
Generated from protobuf field <code>repeated .livekit.ImagesInfo image_results = 20;</code>
$segment_results  : mixed
Generated from protobuf field <code>repeated .livekit.SegmentsInfo segment_results = 17;</code>
$stream_results  : mixed
Generated from protobuf field <code>repeated .livekit.StreamInfo stream_results = 15;</code>

Methods

__construct()  : mixed
Constructor.
getBackupStorageUsed()  : bool
next ID: 27
getDetails()  : string
Generated from protobuf field <code>string details = 21;</code>
getEgressId()  : string
Generated from protobuf field <code>string egress_id = 1;</code>
getEndedAt()  : int|string
Generated from protobuf field <code>int64 ended_at = 11;</code>
getError()  : string
Generated from protobuf field <code>string error = 9;</code>
getErrorCode()  : int
Generated from protobuf field <code>int32 error_code = 22;</code>
getFile()  : FileInfo|null
Generated from protobuf field <code>.livekit.FileInfo file = 8 [deprecated = true];</code>
getFileResults()  : RepeatedField<string|int, FileInfo>
Generated from protobuf field <code>repeated .livekit.FileInfo file_results = 16;</code>
getImageResults()  : RepeatedField<string|int, ImagesInfo>
Generated from protobuf field <code>repeated .livekit.ImagesInfo image_results = 20;</code>
getManifestLocation()  : string
Generated from protobuf field <code>string manifest_location = 23;</code>
getParticipant()  : ParticipantEgressRequest|null
Generated from protobuf field <code>.livekit.ParticipantEgressRequest participant = 19;</code>
getRequest()  : string
getResult()  : string
getRoomComposite()  : RoomCompositeEgressRequest|null
Generated from protobuf field <code>.livekit.RoomCompositeEgressRequest room_composite = 4;</code>
getRoomId()  : string
Generated from protobuf field <code>string room_id = 2;</code>
getRoomName()  : string
Generated from protobuf field <code>string room_name = 13;</code>
getSegmentResults()  : RepeatedField<string|int, SegmentsInfo>
Generated from protobuf field <code>repeated .livekit.SegmentsInfo segment_results = 17;</code>
getSegments()  : SegmentsInfo|null
Generated from protobuf field <code>.livekit.SegmentsInfo segments = 12 [deprecated = true];</code>
getSourceType()  : int
Generated from protobuf field <code>.livekit.EgressSourceType source_type = 26;</code>
getStartedAt()  : int|string
Generated from protobuf field <code>int64 started_at = 10;</code>
getStatus()  : int
Generated from protobuf field <code>.livekit.EgressStatus status = 3;</code>
getStream()  : StreamInfoList|null
Generated from protobuf field <code>.livekit.StreamInfoList stream = 7 [deprecated = true];</code>
getStreamResults()  : RepeatedField<string|int, StreamInfo>
Generated from protobuf field <code>repeated .livekit.StreamInfo stream_results = 15;</code>
getTrack()  : TrackEgressRequest|null
Generated from protobuf field <code>.livekit.TrackEgressRequest track = 6;</code>
getTrackComposite()  : TrackCompositeEgressRequest|null
Generated from protobuf field <code>.livekit.TrackCompositeEgressRequest track_composite = 5;</code>
getUpdatedAt()  : int|string
Generated from protobuf field <code>int64 updated_at = 18;</code>
getWeb()  : WebEgressRequest|null
Generated from protobuf field <code>.livekit.WebEgressRequest web = 14;</code>
hasFile()  : mixed
hasParticipant()  : mixed
hasRoomComposite()  : mixed
hasSegments()  : mixed
hasStream()  : mixed
hasTrack()  : mixed
hasTrackComposite()  : mixed
hasWeb()  : mixed
setBackupStorageUsed()  : $this
next ID: 27
setDetails()  : $this
Generated from protobuf field <code>string details = 21;</code>
setEgressId()  : $this
Generated from protobuf field <code>string egress_id = 1;</code>
setEndedAt()  : $this
Generated from protobuf field <code>int64 ended_at = 11;</code>
setError()  : $this
Generated from protobuf field <code>string error = 9;</code>
setErrorCode()  : $this
Generated from protobuf field <code>int32 error_code = 22;</code>
setFile()  : $this
Generated from protobuf field <code>.livekit.FileInfo file = 8 [deprecated = true];</code>
setFileResults()  : $this
Generated from protobuf field <code>repeated .livekit.FileInfo file_results = 16;</code>
setImageResults()  : $this
Generated from protobuf field <code>repeated .livekit.ImagesInfo image_results = 20;</code>
setManifestLocation()  : $this
Generated from protobuf field <code>string manifest_location = 23;</code>
setParticipant()  : $this
Generated from protobuf field <code>.livekit.ParticipantEgressRequest participant = 19;</code>
setRoomComposite()  : $this
Generated from protobuf field <code>.livekit.RoomCompositeEgressRequest room_composite = 4;</code>
setRoomId()  : $this
Generated from protobuf field <code>string room_id = 2;</code>
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 13;</code>
setSegmentResults()  : $this
Generated from protobuf field <code>repeated .livekit.SegmentsInfo segment_results = 17;</code>
setSegments()  : $this
Generated from protobuf field <code>.livekit.SegmentsInfo segments = 12 [deprecated = true];</code>
setSourceType()  : $this
Generated from protobuf field <code>.livekit.EgressSourceType source_type = 26;</code>
setStartedAt()  : $this
Generated from protobuf field <code>int64 started_at = 10;</code>
setStatus()  : $this
Generated from protobuf field <code>.livekit.EgressStatus status = 3;</code>
setStream()  : $this
Generated from protobuf field <code>.livekit.StreamInfoList stream = 7 [deprecated = true];</code>
setStreamResults()  : $this
Generated from protobuf field <code>repeated .livekit.StreamInfo stream_results = 15;</code>
setTrack()  : $this
Generated from protobuf field <code>.livekit.TrackEgressRequest track = 6;</code>
setTrackComposite()  : $this
Generated from protobuf field <code>.livekit.TrackCompositeEgressRequest track_composite = 5;</code>
setUpdatedAt()  : $this
Generated from protobuf field <code>int64 updated_at = 18;</code>
setWeb()  : $this
Generated from protobuf field <code>.livekit.WebEgressRequest web = 14;</code>

Properties

$backup_storage_used

next ID: 27

protected mixed $backup_storage_used = false

Generated from protobuf field bool backup_storage_used = 25;

$details

Generated from protobuf field <code>string details = 21;</code>

protected mixed $details = ''

$egress_id

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

protected mixed $egress_id = ''

$ended_at

Generated from protobuf field <code>int64 ended_at = 11;</code>

protected mixed $ended_at = 0

$error

Generated from protobuf field <code>string error = 9;</code>

protected mixed $error = ''

$error_code

Generated from protobuf field <code>int32 error_code = 22;</code>

protected mixed $error_code = 0

$manifest_location

Generated from protobuf field <code>string manifest_location = 23;</code>

protected mixed $manifest_location = ''

$room_id

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

protected mixed $room_id = ''

$room_name

Generated from protobuf field <code>string room_name = 13;</code>

protected mixed $room_name = ''

$source_type

Generated from protobuf field <code>.livekit.EgressSourceType source_type = 26;</code>

protected mixed $source_type = 0

$started_at

Generated from protobuf field <code>int64 started_at = 10;</code>

protected mixed $started_at = 0

$status

Generated from protobuf field <code>.livekit.EgressStatus status = 3;</code>

protected mixed $status = 0

$updated_at

Generated from protobuf field <code>int64 updated_at = 18;</code>

protected mixed $updated_at = 0

$file_results

Generated from protobuf field <code>repeated .livekit.FileInfo file_results = 16;</code>

private mixed $file_results

$image_results

Generated from protobuf field <code>repeated .livekit.ImagesInfo image_results = 20;</code>

private mixed $image_results

$segment_results

Generated from protobuf field <code>repeated .livekit.SegmentsInfo segment_results = 17;</code>

private mixed $segment_results

$stream_results

Generated from protobuf field <code>repeated .livekit.StreamInfo stream_results = 15;</code>

private mixed $stream_results

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 $egress_id
@type string $room_id
@type string $room_name
@type int $source_type
@type int $status
@type int|string $started_at
@type int|string $ended_at
@type int|string $updated_at
@type string $details
@type string $error
@type int $error_code
@type \Livekit\RoomCompositeEgressRequest $room_composite
@type \Livekit\WebEgressRequest $web
@type \Livekit\ParticipantEgressRequest $participant
@type \Livekit\TrackCompositeEgressRequest $track_composite
@type \Livekit\TrackEgressRequest $track
@type \Livekit\StreamInfoList $stream
@type \Livekit\FileInfo $file
@type \Livekit\SegmentsInfo $segments
@type \Livekit\StreamInfo[] $stream_results
@type \Livekit\FileInfo[] $file_results
@type \Livekit\SegmentsInfo[] $segment_results
@type \Livekit\ImagesInfo[] $image_results
@type string $manifest_location
@type bool $backup_storage_used
      next ID: 27

}

getBackupStorageUsed()

next ID: 27

public getBackupStorageUsed() : bool

Generated from protobuf field bool backup_storage_used = 25;

Return values
bool

getDetails()

Generated from protobuf field <code>string details = 21;</code>

public getDetails() : string
Return values
string

getEgressId()

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

public getEgressId() : string
Return values
string

getEndedAt()

Generated from protobuf field <code>int64 ended_at = 11;</code>

public getEndedAt() : int|string
Return values
int|string

getError()

Generated from protobuf field <code>string error = 9;</code>

public getError() : string
Return values
string

getErrorCode()

Generated from protobuf field <code>int32 error_code = 22;</code>

public getErrorCode() : int
Return values
int

getFile()

Generated from protobuf field <code>.livekit.FileInfo file = 8 [deprecated = true];</code>

public getFile() : FileInfo|null
Return values
FileInfo|null

getFileResults()

Generated from protobuf field <code>repeated .livekit.FileInfo file_results = 16;</code>

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

getImageResults()

Generated from protobuf field <code>repeated .livekit.ImagesInfo image_results = 20;</code>

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

getManifestLocation()

Generated from protobuf field <code>string manifest_location = 23;</code>

public getManifestLocation() : string
Return values
string

getRequest()

public getRequest() : string
Return values
string

getResult()

public getResult() : string
Return values
string

getRoomId()

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

public getRoomId() : string
Return values
string

getRoomName()

Generated from protobuf field <code>string room_name = 13;</code>

public getRoomName() : string
Return values
string

getSegmentResults()

Generated from protobuf field <code>repeated .livekit.SegmentsInfo segment_results = 17;</code>

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

getSegments()

Generated from protobuf field <code>.livekit.SegmentsInfo segments = 12 [deprecated = true];</code>

public getSegments() : SegmentsInfo|null
Return values
SegmentsInfo|null

getSourceType()

Generated from protobuf field <code>.livekit.EgressSourceType source_type = 26;</code>

public getSourceType() : int
Return values
int

getStartedAt()

Generated from protobuf field <code>int64 started_at = 10;</code>

public getStartedAt() : int|string
Return values
int|string

getStatus()

Generated from protobuf field <code>.livekit.EgressStatus status = 3;</code>

public getStatus() : int
Return values
int

getStreamResults()

Generated from protobuf field <code>repeated .livekit.StreamInfo stream_results = 15;</code>

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

getUpdatedAt()

Generated from protobuf field <code>int64 updated_at = 18;</code>

public getUpdatedAt() : int|string
Return values
int|string

hasParticipant()

public hasParticipant() : mixed

hasRoomComposite()

public hasRoomComposite() : mixed

hasTrackComposite()

public hasTrackComposite() : mixed

setBackupStorageUsed()

next ID: 27

public setBackupStorageUsed(bool $var) : $this

Generated from protobuf field bool backup_storage_used = 25;

Parameters
$var : bool
Return values
$this

setDetails()

Generated from protobuf field <code>string details = 21;</code>

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

setEgressId()

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

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

setEndedAt()

Generated from protobuf field <code>int64 ended_at = 11;</code>

public setEndedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setError()

Generated from protobuf field <code>string error = 9;</code>

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

setErrorCode()

Generated from protobuf field <code>int32 error_code = 22;</code>

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

setFile()

Generated from protobuf field <code>.livekit.FileInfo file = 8 [deprecated = true];</code>

public setFile(FileInfo $var) : $this
Parameters
$var : FileInfo
Return values
$this

setFileResults()

Generated from protobuf field <code>repeated .livekit.FileInfo file_results = 16;</code>

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

setImageResults()

Generated from protobuf field <code>repeated .livekit.ImagesInfo image_results = 20;</code>

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

setManifestLocation()

Generated from protobuf field <code>string manifest_location = 23;</code>

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

setRoomId()

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

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

setRoomName()

Generated from protobuf field <code>string room_name = 13;</code>

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

setSegmentResults()

Generated from protobuf field <code>repeated .livekit.SegmentsInfo segment_results = 17;</code>

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

setSegments()

Generated from protobuf field <code>.livekit.SegmentsInfo segments = 12 [deprecated = true];</code>

public setSegments(SegmentsInfo $var) : $this
Parameters
$var : SegmentsInfo
Return values
$this

setSourceType()

Generated from protobuf field <code>.livekit.EgressSourceType source_type = 26;</code>

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

setStartedAt()

Generated from protobuf field <code>int64 started_at = 10;</code>

public setStartedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setStatus()

Generated from protobuf field <code>.livekit.EgressStatus status = 3;</code>

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

setStream()

Generated from protobuf field <code>.livekit.StreamInfoList stream = 7 [deprecated = true];</code>

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

setStreamResults()

Generated from protobuf field <code>repeated .livekit.StreamInfo stream_results = 15;</code>

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

setUpdatedAt()

Generated from protobuf field <code>int64 updated_at = 18;</code>

public setUpdatedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results