Documentation

CreateIngressRequest extends Message

in package

• Application

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

Table of Contents

Properties

$audio  : mixed

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

$bypass_transcoding  : mixed

[depreacted ] whether to pass through the incoming media without transcoding, only compatible with some input types. Use `enable_transcoding` instead.

$enable_transcoding  : mixed

Whether to transcode the ingested media. Only WHIP supports disabling transcoding currently. WHIP will default to transcoding disabled. Replaces `bypass_transcoding.

$enabled  : mixed

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

$input_type  : mixed

Generated from protobuf field <code>.livekit.IngressInput input_type = 1;</code>

$name  : mixed

User provided identifier for the ingress

$participant_identity  : mixed

publish as participant

$participant_metadata  : mixed

metadata associated with the publishing participant

$participant_name  : mixed

name of publishing participant (used for display only)

$room_name  : mixed

room to publish to

$url  : mixed

Where to pull media from, only for URL input type

$video  : mixed

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

Methods

__construct()  : mixed

Constructor.

clearAudio()  : mixed

clearEnabled()  : mixed

clearEnableTranscoding()  : mixed

clearVideo()  : mixed

getAudio()  : IngressAudioOptions|null

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

getBypassTranscoding()  : bool

[depreacted ] whether to pass through the incoming media without transcoding, only compatible with some input types. Use `enable_transcoding` instead.

getEnabled()  : bool

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

getEnableTranscoding()  : bool

Whether to transcode the ingested media. Only WHIP supports disabling transcoding currently. WHIP will default to transcoding disabled. Replaces `bypass_transcoding.

getInputType()  : int

Generated from protobuf field <code>.livekit.IngressInput input_type = 1;</code>

getName()  : string

User provided identifier for the ingress

getParticipantIdentity()  : string

publish as participant

getParticipantMetadata()  : string

metadata associated with the publishing participant

getParticipantName()  : string

name of publishing participant (used for display only)

getRoomName()  : string

room to publish to

getUrl()  : string

Where to pull media from, only for URL input type

getVideo()  : IngressVideoOptions|null

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

hasAudio()  : mixed

hasEnabled()  : mixed

hasEnableTranscoding()  : mixed

hasVideo()  : mixed

setAudio()  : $this

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

setBypassTranscoding()  : $this

[depreacted ] whether to pass through the incoming media without transcoding, only compatible with some input types. Use `enable_transcoding` instead.

setEnabled()  : $this

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

setEnableTranscoding()  : $this

Whether to transcode the ingested media. Only WHIP supports disabling transcoding currently. WHIP will default to transcoding disabled. Replaces `bypass_transcoding.

setInputType()  : $this

Generated from protobuf field <code>.livekit.IngressInput input_type = 1;</code>

setName()  : $this

User provided identifier for the ingress

setParticipantIdentity()  : $this

publish as participant

setParticipantMetadata()  : $this

metadata associated with the publishing participant

setParticipantName()  : $this

name of publishing participant (used for display only)

setRoomName()  : $this

room to publish to

setUrl()  : $this

Where to pull media from, only for URL input type

setVideo()  : $this

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