Documentation

StartEgressRequest extends Message
in package

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

Table of Contents

Properties

$encoding  : mixed
$room_name  : mixed
Generated from protobuf field <code>string room_name = 1;</code>
$source  : mixed
$storage  : mixed
Request-level storage default
$outputs  : mixed
At least one required
$webhooks  : mixed
Optional additional webhook config

Methods

__construct()  : mixed
Constructor.
clearStorage()  : mixed
getAdvanced()  : EncodingOptions|null
Generated from protobuf field <code>.livekit.EncodingOptions advanced = 6;</code>
getEncoding()  : string
getMedia()  : MediaSource|null
Generated from protobuf field <code>.livekit.MediaSource media = 4;</code>
getOutputs()  : RepeatedField<string|int, Output>
At least one required
getPreset()  : int
Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 5;</code>
getRoomName()  : string
Generated from protobuf field <code>string room_name = 1;</code>
getSource()  : string
getStorage()  : StorageConfig|null
Request-level storage default
getTemplate()  : TemplateSource|null
Generated from protobuf field <code>.livekit.TemplateSource template = 2;</code>
getWeb()  : WebSource|null
Generated from protobuf field <code>.livekit.WebSource web = 3;</code>
getWebhooks()  : RepeatedField<string|int, WebhookConfig>
Optional additional webhook config
hasAdvanced()  : mixed
hasMedia()  : mixed
hasPreset()  : mixed
hasStorage()  : mixed
hasTemplate()  : mixed
hasWeb()  : mixed
setAdvanced()  : $this
Generated from protobuf field <code>.livekit.EncodingOptions advanced = 6;</code>
setMedia()  : $this
Generated from protobuf field <code>.livekit.MediaSource media = 4;</code>
setOutputs()  : $this
At least one required
setPreset()  : $this
Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 5;</code>
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 1;</code>
setStorage()  : $this
Request-level storage default
setTemplate()  : $this
Generated from protobuf field <code>.livekit.TemplateSource template = 2;</code>
setWeb()  : $this
Generated from protobuf field <code>.livekit.WebSource web = 3;</code>
setWebhooks()  : $this
Optional additional webhook config

Properties

$room_name

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

protected mixed $room_name = ''

$storage

Request-level storage default

protected mixed $storage = null

Generated from protobuf field .livekit.StorageConfig storage = 8;

$outputs

At least one required

private mixed $outputs

Generated from protobuf field repeated .livekit.Output outputs = 7;

$webhooks

Optional additional webhook config

private mixed $webhooks

Generated from protobuf field repeated .livekit.WebhookConfig webhooks = 9;

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 $room_name
@type \Livekit\TemplateSource $template
@type \Livekit\WebSource $web
@type \Livekit\MediaSource $media
@type int $preset
@type \Livekit\EncodingOptions $advanced
@type \Livekit\Output[] $outputs
      At least one required
@type \Livekit\StorageConfig $storage
      Request-level storage default
@type \Livekit\WebhookConfig[] $webhooks
      Optional additional webhook config

}

getOutputs()

At least one required

public getOutputs() : RepeatedField<string|int, Output>

Generated from protobuf field repeated .livekit.Output outputs = 7;

Return values
RepeatedField<string|int, Output>

getPreset()

Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 5;</code>

public getPreset() : int
Return values
int

getRoomName()

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

public getRoomName() : string
Return values
string

getWebhooks()

Optional additional webhook config

public getWebhooks() : RepeatedField<string|int, WebhookConfig>

Generated from protobuf field repeated .livekit.WebhookConfig webhooks = 9;

Return values
RepeatedField<string|int, WebhookConfig>

setOutputs()

At least one required

public setOutputs(array<string|int, Output> $var) : $this

Generated from protobuf field repeated .livekit.Output outputs = 7;

Parameters
$var : array<string|int, Output>
Return values
$this

setPreset()

Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 5;</code>

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

setRoomName()

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

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

setWebhooks()

Optional additional webhook config

public setWebhooks(array<string|int, WebhookConfig> $var) : $this

Generated from protobuf field repeated .livekit.WebhookConfig webhooks = 9;

Parameters
$var : array<string|int, WebhookConfig>
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results