Documentation

IngressInfo extends Message

in package

• Application

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

Table of Contents

Properties

$audio  : mixed

Generated from protobuf field <code>.livekit.IngressAudioOptions audio = 6;</code>

$bypass_transcoding  : mixed

Generated from protobuf field <code>bool bypass_transcoding = 13 [deprecated = true];</code>

$enable_transcoding  : mixed

Generated from protobuf field <code>optional bool enable_transcoding = 15;</code>

$enabled  : mixed

The default value is true and when set to false, the new connection attempts will be rejected

$ingress_id  : mixed

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

$input_type  : mixed

for RTMP input, it'll be a rtmp:// URL for FILE input, it'll be a http:// URL for SRT input, it'll be a srt:// URL

$name  : mixed

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

$participant_identity  : mixed

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

$participant_metadata  : mixed

Generated from protobuf field <code>string participant_metadata = 14;</code>

$participant_name  : mixed

Generated from protobuf field <code>string participant_name = 10;</code>

$reusable  : mixed

Generated from protobuf field <code>bool reusable = 11;</code>

$room_name  : mixed

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

$state  : mixed

Description of error/stream non compliance and debug info for publisher otherwise (received bitrate, resolution, bandwidth)

$stream_key  : mixed

Generated from protobuf field <code>string stream_key = 3;</code>

$url  : mixed

URL to point the encoder to for push (RTMP, WHIP), or location to pull media from for pull (URL)

$video  : mixed

Generated from protobuf field <code>.livekit.IngressVideoOptions video = 7;</code>

Methods

__construct()  : mixed

Constructor.

clearAudio()  : mixed

clearEnabled()  : mixed

clearEnableTranscoding()  : mixed

clearState()  : mixed

clearVideo()  : mixed

getAudio()  : IngressAudioOptions|null

Generated from protobuf field <code>.livekit.IngressAudioOptions audio = 6;</code>

getBypassTranscoding()  : bool

Generated from protobuf field <code>bool bypass_transcoding = 13 [deprecated = true];</code>

getEnabled()  : bool

The default value is true and when set to false, the new connection attempts will be rejected

getEnableTranscoding()  : bool

Generated from protobuf field <code>optional bool enable_transcoding = 15;</code>

getIngressId()  : string

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

getInputType()  : int

for RTMP input, it'll be a rtmp:// URL for FILE input, it'll be a http:// URL for SRT input, it'll be a srt:// URL

getName()  : string

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

getParticipantIdentity()  : string

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

getParticipantMetadata()  : string

Generated from protobuf field <code>string participant_metadata = 14;</code>

getParticipantName()  : string

Generated from protobuf field <code>string participant_name = 10;</code>

getReusable()  : bool

Generated from protobuf field <code>bool reusable = 11;</code>

getRoomName()  : string

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

getState()  : IngressState|null

Description of error/stream non compliance and debug info for publisher otherwise (received bitrate, resolution, bandwidth)

getStreamKey()  : string

Generated from protobuf field <code>string stream_key = 3;</code>

getUrl()  : string

URL to point the encoder to for push (RTMP, WHIP), or location to pull media from for pull (URL)

getVideo()  : IngressVideoOptions|null

Generated from protobuf field <code>.livekit.IngressVideoOptions video = 7;</code>

hasAudio()  : mixed

hasEnabled()  : mixed

hasEnableTranscoding()  : mixed

hasState()  : mixed

hasVideo()  : mixed

setAudio()  : $this

Generated from protobuf field <code>.livekit.IngressAudioOptions audio = 6;</code>

setBypassTranscoding()  : $this

Generated from protobuf field <code>bool bypass_transcoding = 13 [deprecated = true];</code>

setEnabled()  : $this

The default value is true and when set to false, the new connection attempts will be rejected

setEnableTranscoding()  : $this

Generated from protobuf field <code>optional bool enable_transcoding = 15;</code>

setIngressId()  : $this

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

setInputType()  : $this

for RTMP input, it'll be a rtmp:// URL for FILE input, it'll be a http:// URL for SRT input, it'll be a srt:// URL

setName()  : $this

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

setParticipantIdentity()  : $this

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

setParticipantMetadata()  : $this

Generated from protobuf field <code>string participant_metadata = 14;</code>

setParticipantName()  : $this

Generated from protobuf field <code>string participant_name = 10;</code>

setReusable()  : $this

Generated from protobuf field <code>bool reusable = 11;</code>

setRoomName()  : $this

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

setState()  : $this

Description of error/stream non compliance and debug info for publisher otherwise (received bitrate, resolution, bandwidth)

setStreamKey()  : $this

Generated from protobuf field <code>string stream_key = 3;</code>

setUrl()  : $this

URL to point the encoder to for push (RTMP, WHIP), or location to pull media from for pull (URL)

setVideo()  : $this

Generated from protobuf field <code>.livekit.IngressVideoOptions video = 7;</code>