Documentation

IngressState extends Message
in package

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

Table of Contents

Properties

$audio  : mixed
Generated from protobuf field <code>.livekit.InputAudioState audio = 4;</code>
$ended_at  : mixed
Generated from protobuf field <code>int64 ended_at = 8;</code>
$error  : mixed
Error/non compliance description if any
$resource_id  : mixed
Generated from protobuf field <code>string resource_id = 9;</code>
$room_id  : mixed
ID of the current/previous room published to
$started_at  : mixed
Generated from protobuf field <code>int64 started_at = 7;</code>
$status  : mixed
Generated from protobuf field <code>.livekit.IngressState.Status status = 1;</code>
$updated_at  : mixed
Generated from protobuf field <code>int64 updated_at = 10;</code>
$video  : mixed
Generated from protobuf field <code>.livekit.InputVideoState video = 3;</code>
$tracks  : mixed
Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 6;</code>

Methods

__construct()  : mixed
Constructor.
clearAudio()  : mixed
clearVideo()  : mixed
getAudio()  : InputAudioState|null
Generated from protobuf field <code>.livekit.InputAudioState audio = 4;</code>
getEndedAt()  : int|string
Generated from protobuf field <code>int64 ended_at = 8;</code>
getError()  : string
Error/non compliance description if any
getResourceId()  : string
Generated from protobuf field <code>string resource_id = 9;</code>
getRoomId()  : string
ID of the current/previous room published to
getStartedAt()  : int|string
Generated from protobuf field <code>int64 started_at = 7;</code>
getStatus()  : int
Generated from protobuf field <code>.livekit.IngressState.Status status = 1;</code>
getTracks()  : RepeatedField<string|int, TrackInfo>
Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 6;</code>
getUpdatedAt()  : int|string
Generated from protobuf field <code>int64 updated_at = 10;</code>
getVideo()  : InputVideoState|null
Generated from protobuf field <code>.livekit.InputVideoState video = 3;</code>
hasAudio()  : mixed
hasVideo()  : mixed
setAudio()  : $this
Generated from protobuf field <code>.livekit.InputAudioState audio = 4;</code>
setEndedAt()  : $this
Generated from protobuf field <code>int64 ended_at = 8;</code>
setError()  : $this
Error/non compliance description if any
setResourceId()  : $this
Generated from protobuf field <code>string resource_id = 9;</code>
setRoomId()  : $this
ID of the current/previous room published to
setStartedAt()  : $this
Generated from protobuf field <code>int64 started_at = 7;</code>
setStatus()  : $this
Generated from protobuf field <code>.livekit.IngressState.Status status = 1;</code>
setTracks()  : $this
Generated from protobuf field <code>repeated .livekit.TrackInfo tracks = 6;</code>
setUpdatedAt()  : $this
Generated from protobuf field <code>int64 updated_at = 10;</code>
setVideo()  : $this
Generated from protobuf field <code>.livekit.InputVideoState video = 3;</code>

Properties

$audio

Generated from protobuf field <code>.livekit.InputAudioState audio = 4;</code>

protected mixed $audio = null

$ended_at

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

protected mixed $ended_at = 0

$error

Error/non compliance description if any

protected mixed $error = ''

Generated from protobuf field string error = 2;

$resource_id

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

protected mixed $resource_id = ''

$room_id

ID of the current/previous room published to

protected mixed $room_id = ''

Generated from protobuf field string room_id = 5;

$started_at

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

protected mixed $started_at = 0

$status

Generated from protobuf field <code>.livekit.IngressState.Status status = 1;</code>

protected mixed $status = 0

$updated_at

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

protected mixed $updated_at = 0

$video

Generated from protobuf field <code>.livekit.InputVideoState video = 3;</code>

protected mixed $video = null

$tracks

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

private mixed $tracks

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 int $status
@type string $error
      Error/non compliance description if any
@type \Livekit\InputVideoState $video
@type \Livekit\InputAudioState $audio
@type string $room_id
      ID of the current/previous room published to
@type int|string $started_at
@type int|string $ended_at
@type int|string $updated_at
@type string $resource_id
@type \Livekit\TrackInfo[] $tracks

}

getEndedAt()

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

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

getError()

Error/non compliance description if any

public getError() : string

Generated from protobuf field string error = 2;

Return values
string

getResourceId()

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

public getResourceId() : string
Return values
string

getRoomId()

ID of the current/previous room published to

public getRoomId() : string

Generated from protobuf field string room_id = 5;

Return values
string

getStartedAt()

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

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

getStatus()

Generated from protobuf field <code>.livekit.IngressState.Status status = 1;</code>

public getStatus() : int
Return values
int

getTracks()

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

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

getUpdatedAt()

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

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

setEndedAt()

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

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

setError()

Error/non compliance description if any

public setError(string $var) : $this

Generated from protobuf field string error = 2;

Parameters
$var : string
Return values
$this

setResourceId()

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

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

setRoomId()

ID of the current/previous room published to

public setRoomId(string $var) : $this

Generated from protobuf field string room_id = 5;

Parameters
$var : string
Return values
$this

setStartedAt()

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

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

setStatus()

Generated from protobuf field <code>.livekit.IngressState.Status status = 1;</code>

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

setTracks()

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

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

setUpdatedAt()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results