Documentation

WebEgressRequest extends Message
in package

record any website

Generated from protobuf message livekit.WebEgressRequest

Table of Contents

Properties

$audio_only  : mixed
Generated from protobuf field <code>bool audio_only = 2;</code>
$await_start_signal  : mixed
Generated from protobuf field <code>bool await_start_signal = 12;</code>
$options  : mixed
$output  : mixed
$url  : mixed
Generated from protobuf field <code>string url = 1;</code>
$video_only  : mixed
Generated from protobuf field <code>bool video_only = 3;</code>
$file_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 9;</code>
$image_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 13;</code>
$segment_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 11;</code>
$stream_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 10;</code>
$webhooks  : mixed
extra webhooks to call for this request

Methods

__construct()  : mixed
Constructor.
getAdvanced()  : EncodingOptions|null
Generated from protobuf field <code>.livekit.EncodingOptions advanced = 8;</code>
getAudioOnly()  : bool
Generated from protobuf field <code>bool audio_only = 2;</code>
getAwaitStartSignal()  : bool
Generated from protobuf field <code>bool await_start_signal = 12;</code>
getFile()  : EncodedFileOutput|null
Generated from protobuf field <code>.livekit.EncodedFileOutput file = 4 [deprecated = true];</code>
getFileOutputs()  : RepeatedField<string|int, EncodedFileOutput>
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 9;</code>
getImageOutputs()  : RepeatedField<string|int, ImageOutput>
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 13;</code>
getOptions()  : string
getOutput()  : string
getPreset()  : int
Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 7;</code>
getSegmentOutputs()  : RepeatedField<string|int, SegmentedFileOutput>
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 11;</code>
getSegments()  : SegmentedFileOutput|null
Generated from protobuf field <code>.livekit.SegmentedFileOutput segments = 6 [deprecated = true];</code>
getStream()  : StreamOutput|null
Generated from protobuf field <code>.livekit.StreamOutput stream = 5 [deprecated = true];</code>
getStreamOutputs()  : RepeatedField<string|int, StreamOutput>
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 10;</code>
getUrl()  : string
Generated from protobuf field <code>string url = 1;</code>
getVideoOnly()  : bool
Generated from protobuf field <code>bool video_only = 3;</code>
getWebhooks()  : RepeatedField<string|int, WebhookConfig>
extra webhooks to call for this request
hasAdvanced()  : mixed
hasFile()  : mixed
hasPreset()  : mixed
hasSegments()  : mixed
hasStream()  : mixed
setAdvanced()  : $this
Generated from protobuf field <code>.livekit.EncodingOptions advanced = 8;</code>
setAudioOnly()  : $this
Generated from protobuf field <code>bool audio_only = 2;</code>
setAwaitStartSignal()  : $this
Generated from protobuf field <code>bool await_start_signal = 12;</code>
setFile()  : $this
Generated from protobuf field <code>.livekit.EncodedFileOutput file = 4 [deprecated = true];</code>
setFileOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 9;</code>
setImageOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 13;</code>
setPreset()  : $this
Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 7;</code>
setSegmentOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 11;</code>
setSegments()  : $this
Generated from protobuf field <code>.livekit.SegmentedFileOutput segments = 6 [deprecated = true];</code>
setStream()  : $this
Generated from protobuf field <code>.livekit.StreamOutput stream = 5 [deprecated = true];</code>
setStreamOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 10;</code>
setUrl()  : $this
Generated from protobuf field <code>string url = 1;</code>
setVideoOnly()  : $this
Generated from protobuf field <code>bool video_only = 3;</code>
setWebhooks()  : $this
extra webhooks to call for this request

Properties

$audio_only

Generated from protobuf field <code>bool audio_only = 2;</code>

protected mixed $audio_only = false

$await_start_signal

Generated from protobuf field <code>bool await_start_signal = 12;</code>

protected mixed $await_start_signal = false

$url

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

protected mixed $url = ''

$video_only

Generated from protobuf field <code>bool video_only = 3;</code>

protected mixed $video_only = false

$file_outputs

Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 9;</code>

private mixed $file_outputs

$image_outputs

Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 13;</code>

private mixed $image_outputs

$segment_outputs

Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 11;</code>

private mixed $segment_outputs

$stream_outputs

Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 10;</code>

private mixed $stream_outputs

$webhooks

extra webhooks to call for this request

private mixed $webhooks

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

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 $url
@type bool $audio_only
@type bool $video_only
@type bool $await_start_signal
@type \Livekit\EncodedFileOutput $file
@type \Livekit\StreamOutput $stream
@type \Livekit\SegmentedFileOutput $segments
@type int $preset
@type \Livekit\EncodingOptions $advanced
@type \Livekit\EncodedFileOutput[] $file_outputs
@type \Livekit\StreamOutput[] $stream_outputs
@type \Livekit\SegmentedFileOutput[] $segment_outputs
@type \Livekit\ImageOutput[] $image_outputs
@type \Livekit\WebhookConfig[] $webhooks
      extra webhooks to call for this request

}

getAudioOnly()

Generated from protobuf field <code>bool audio_only = 2;</code>

public getAudioOnly() : bool
Return values
bool

getAwaitStartSignal()

Generated from protobuf field <code>bool await_start_signal = 12;</code>

public getAwaitStartSignal() : bool
Return values
bool

getFileOutputs()

Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 9;</code>

public getFileOutputs() : RepeatedField<string|int, EncodedFileOutput>
Return values
RepeatedField<string|int, EncodedFileOutput>

getImageOutputs()

Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 13;</code>

public getImageOutputs() : RepeatedField<string|int, ImageOutput>
Return values
RepeatedField<string|int, ImageOutput>

getPreset()

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

public getPreset() : int
Return values
int

getStreamOutputs()

Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 10;</code>

public getStreamOutputs() : RepeatedField<string|int, StreamOutput>
Return values
RepeatedField<string|int, StreamOutput>

getUrl()

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

public getUrl() : string
Return values
string

getVideoOnly()

Generated from protobuf field <code>bool video_only = 3;</code>

public getVideoOnly() : bool
Return values
bool

getWebhooks()

extra webhooks to call for this request

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

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

Return values
RepeatedField<string|int, WebhookConfig>

setAudioOnly()

Generated from protobuf field <code>bool audio_only = 2;</code>

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

setAwaitStartSignal()

Generated from protobuf field <code>bool await_start_signal = 12;</code>

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

setFileOutputs()

Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 9;</code>

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

setImageOutputs()

Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 13;</code>

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

setPreset()

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

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

setSegmentOutputs()

Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 11;</code>

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

setStream()

Generated from protobuf field <code>.livekit.StreamOutput stream = 5 [deprecated = true];</code>

public setStream(StreamOutput $var) : $this
Parameters
$var : StreamOutput
Return values
$this

setStreamOutputs()

Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 10;</code>

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

setUrl()

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

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

setVideoOnly()

Generated from protobuf field <code>bool video_only = 3;</code>

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

setWebhooks()

extra webhooks to call for this request

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

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results