Documentation

UpdateIngressRequest extends Message
in package

Generated from protobuf message <code>livekit.UpdateIngressRequest</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>optional bool bypass_transcoding = 8 [deprecated = true];</code>
$enable_transcoding  : mixed
Generated from protobuf field <code>optional bool enable_transcoding = 10;</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>
$name  : mixed
Generated from protobuf field <code>string name = 2;</code>
$participant_identity  : mixed
Generated from protobuf field <code>string participant_identity = 4;</code>
$participant_metadata  : mixed
Generated from protobuf field <code>string participant_metadata = 9;</code>
$participant_name  : mixed
Generated from protobuf field <code>string participant_name = 5;</code>
$room_name  : mixed
Generated from protobuf field <code>string room_name = 3;</code>
$video  : mixed
Generated from protobuf field <code>.livekit.IngressVideoOptions video = 7;</code>

Methods

__construct()  : mixed
Constructor.
clearAudio()  : mixed
clearBypassTranscoding()  : mixed
clearEnabled()  : mixed
clearEnableTranscoding()  : mixed
clearVideo()  : mixed
getAudio()  : IngressAudioOptions|null
Generated from protobuf field <code>.livekit.IngressAudioOptions audio = 6;</code>
getBypassTranscoding()  : bool
Generated from protobuf field <code>optional bool bypass_transcoding = 8 [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 = 10;</code>
getIngressId()  : string
Generated from protobuf field <code>string ingress_id = 1;</code>
getName()  : string
Generated from protobuf field <code>string name = 2;</code>
getParticipantIdentity()  : string
Generated from protobuf field <code>string participant_identity = 4;</code>
getParticipantMetadata()  : string
Generated from protobuf field <code>string participant_metadata = 9;</code>
getParticipantName()  : string
Generated from protobuf field <code>string participant_name = 5;</code>
getRoomName()  : string
Generated from protobuf field <code>string room_name = 3;</code>
getVideo()  : IngressVideoOptions|null
Generated from protobuf field <code>.livekit.IngressVideoOptions video = 7;</code>
hasAudio()  : mixed
hasBypassTranscoding()  : mixed
hasEnabled()  : mixed
hasEnableTranscoding()  : mixed
hasVideo()  : mixed
setAudio()  : $this
Generated from protobuf field <code>.livekit.IngressAudioOptions audio = 6;</code>
setBypassTranscoding()  : $this
Generated from protobuf field <code>optional bool bypass_transcoding = 8 [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 = 10;</code>
setIngressId()  : $this
Generated from protobuf field <code>string ingress_id = 1;</code>
setName()  : $this
Generated from protobuf field <code>string name = 2;</code>
setParticipantIdentity()  : $this
Generated from protobuf field <code>string participant_identity = 4;</code>
setParticipantMetadata()  : $this
Generated from protobuf field <code>string participant_metadata = 9;</code>
setParticipantName()  : $this
Generated from protobuf field <code>string participant_name = 5;</code>
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 3;</code>
setVideo()  : $this
Generated from protobuf field <code>.livekit.IngressVideoOptions video = 7;</code>

Properties

$audio

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

protected mixed $audio = null

$bypass_transcoding

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

protected mixed $bypass_transcoding = null

$enable_transcoding

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

protected mixed $enable_transcoding = null

$enabled

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

protected mixed $enabled = null

Generated from protobuf field optional bool enabled = 11;

$ingress_id

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

protected mixed $ingress_id = ''

$name

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

protected mixed $name = ''

$participant_identity

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

protected mixed $participant_identity = ''

$participant_metadata

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

protected mixed $participant_metadata = ''

$participant_name

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

protected mixed $participant_name = ''

$room_name

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

protected mixed $room_name = ''

$video

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

protected mixed $video = null

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 $ingress_id
@type string $name
@type string $room_name
@type string $participant_identity
@type string $participant_name
@type string $participant_metadata
@type bool $bypass_transcoding
@type bool $enable_transcoding
@type \Livekit\IngressAudioOptions $audio
@type \Livekit\IngressVideoOptions $video
@type bool $enabled
      The default value is true and when set to false, the new connection attempts will be rejected

}

getBypassTranscoding()

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

public getBypassTranscoding() : bool
Return values
bool

getEnabled()

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

public getEnabled() : bool

Generated from protobuf field optional bool enabled = 11;

Return values
bool

getEnableTranscoding()

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

public getEnableTranscoding() : bool
Return values
bool

getIngressId()

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

public getIngressId() : string
Return values
string

getName()

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

public getName() : string
Return values
string

getParticipantIdentity()

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

public getParticipantIdentity() : string
Return values
string

getParticipantMetadata()

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

public getParticipantMetadata() : string
Return values
string

getParticipantName()

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

public getParticipantName() : string
Return values
string

getRoomName()

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

public getRoomName() : string
Return values
string

setBypassTranscoding()

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

public setBypassTranscoding(bool $var) : $this
Parameters
$var : bool
Return values
$this

setEnabled()

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

public setEnabled(bool $var) : $this

Generated from protobuf field optional bool enabled = 11;

Parameters
$var : bool
Return values
$this

setEnableTranscoding()

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

public setEnableTranscoding(bool $var) : $this
Parameters
$var : bool
Return values
$this

setIngressId()

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

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

setName()

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

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

setParticipantIdentity()

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

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

setParticipantMetadata()

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

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

setParticipantName()

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

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

setRoomName()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results