Documentation

RoomCompositeEgressRequest extends Message
in package

composite using a web browser

Generated from protobuf message livekit.RoomCompositeEgressRequest

Table of Contents

Properties

$audio_mixing  : mixed
only applies to audio_only egress (default DEFAULT_MIXING)
$audio_only  : mixed
(default false)
$custom_base_url  : mixed
template base url (default https://recorder.livekit.io)
$layout  : mixed
(optional)
$options  : mixed
$output  : mixed
$room_name  : mixed
required
$video_only  : mixed
(default false)
$file_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 11;</code>
$image_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 14;</code>
$segment_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 13;</code>
$stream_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 12;</code>
$webhooks  : mixed
extra webhooks to call for this request

Methods

__construct()  : mixed
Constructor.
getAdvanced()  : EncodingOptions|null
(optional)
getAudioMixing()  : int
only applies to audio_only egress (default DEFAULT_MIXING)
getAudioOnly()  : bool
(default false)
getCustomBaseUrl()  : string
template base url (default https://recorder.livekit.io)
getFile()  : EncodedFileOutput|null
Generated from protobuf field <code>.livekit.EncodedFileOutput file = 6 [deprecated = true];</code>
getFileOutputs()  : RepeatedField<string|int, EncodedFileOutput>
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 11;</code>
getImageOutputs()  : RepeatedField<string|int, ImageOutput>
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 14;</code>
getLayout()  : string
(optional)
getOptions()  : string
getOutput()  : string
getPreset()  : int
(default H264_720P_30)
getRoomName()  : string
required
getSegmentOutputs()  : RepeatedField<string|int, SegmentedFileOutput>
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 13;</code>
getSegments()  : SegmentedFileOutput|null
Generated from protobuf field <code>.livekit.SegmentedFileOutput segments = 10 [deprecated = true];</code>
getStream()  : StreamOutput|null
Generated from protobuf field <code>.livekit.StreamOutput stream = 7 [deprecated = true];</code>
getStreamOutputs()  : RepeatedField<string|int, StreamOutput>
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 12;</code>
getVideoOnly()  : bool
(default false)
getWebhooks()  : RepeatedField<string|int, WebhookConfig>
extra webhooks to call for this request
hasAdvanced()  : mixed
hasFile()  : mixed
hasPreset()  : mixed
hasSegments()  : mixed
hasStream()  : mixed
setAdvanced()  : $this
(optional)
setAudioMixing()  : $this
only applies to audio_only egress (default DEFAULT_MIXING)
setAudioOnly()  : $this
(default false)
setCustomBaseUrl()  : $this
template base url (default https://recorder.livekit.io)
setFile()  : $this
Generated from protobuf field <code>.livekit.EncodedFileOutput file = 6 [deprecated = true];</code>
setFileOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 11;</code>
setImageOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 14;</code>
setLayout()  : $this
(optional)
setPreset()  : $this
(default H264_720P_30)
setRoomName()  : $this
required
setSegmentOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 13;</code>
setSegments()  : $this
Generated from protobuf field <code>.livekit.SegmentedFileOutput segments = 10 [deprecated = true];</code>
setStream()  : $this
Generated from protobuf field <code>.livekit.StreamOutput stream = 7 [deprecated = true];</code>
setStreamOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 12;</code>
setVideoOnly()  : $this
(default false)
setWebhooks()  : $this
extra webhooks to call for this request

Properties

$audio_mixing

only applies to audio_only egress (default DEFAULT_MIXING)

protected mixed $audio_mixing = 0

Generated from protobuf field .livekit.AudioMixing audio_mixing = 15;

$audio_only

(default false)

protected mixed $audio_only = false

Generated from protobuf field bool audio_only = 3;

$custom_base_url

template base url (default https://recorder.livekit.io)

protected mixed $custom_base_url = ''

Generated from protobuf field string custom_base_url = 5;

$video_only

(default false)

protected mixed $video_only = false

Generated from protobuf field bool video_only = 4;

$file_outputs

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

private mixed $file_outputs

$image_outputs

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

private mixed $image_outputs

$segment_outputs

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

private mixed $segment_outputs

$stream_outputs

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

private mixed $stream_outputs

$webhooks

extra webhooks to call for this request

private mixed $webhooks

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

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
      required
@type string $layout
      (optional)
@type bool $audio_only
      (default false)
@type int $audio_mixing
      only applies to audio_only egress (default DEFAULT_MIXING)
@type bool $video_only
      (default false)
@type string $custom_base_url
      template base url (default https://recorder.livekit.io)
@type \Livekit\EncodedFileOutput $file
@type \Livekit\StreamOutput $stream
@type \Livekit\SegmentedFileOutput $segments
@type int $preset
      (default H264_720P_30)
@type \Livekit\EncodingOptions $advanced
      (optional)
@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

}

getAudioMixing()

only applies to audio_only egress (default DEFAULT_MIXING)

public getAudioMixing() : int

Generated from protobuf field .livekit.AudioMixing audio_mixing = 15;

Return values
int

getAudioOnly()

(default false)

public getAudioOnly() : bool

Generated from protobuf field bool audio_only = 3;

Return values
bool

getCustomBaseUrl()

template base url (default https://recorder.livekit.io)

public getCustomBaseUrl() : string

Generated from protobuf field string custom_base_url = 5;

Return values
string

getImageOutputs()

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

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

getLayout()

(optional)

public getLayout() : string

Generated from protobuf field string layout = 2;

Return values
string

getPreset()

(default H264_720P_30)

public getPreset() : int

Generated from protobuf field .livekit.EncodingOptionsPreset preset = 8;

Return values
int

getRoomName()

required

public getRoomName() : string

Generated from protobuf field string room_name = 1;

Return values
string

getStreamOutputs()

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

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

getVideoOnly()

(default false)

public getVideoOnly() : bool

Generated from protobuf field bool video_only = 4;

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 = 16;

Return values
RepeatedField<string|int, WebhookConfig>

setAudioMixing()

only applies to audio_only egress (default DEFAULT_MIXING)

public setAudioMixing(int $var) : $this

Generated from protobuf field .livekit.AudioMixing audio_mixing = 15;

Parameters
$var : int
Return values
$this

setAudioOnly()

(default false)

public setAudioOnly(bool $var) : $this

Generated from protobuf field bool audio_only = 3;

Parameters
$var : bool
Return values
$this

setCustomBaseUrl()

template base url (default https://recorder.livekit.io)

public setCustomBaseUrl(string $var) : $this

Generated from protobuf field string custom_base_url = 5;

Parameters
$var : string
Return values
$this

setImageOutputs()

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

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

setLayout()

(optional)

public setLayout(string $var) : $this

Generated from protobuf field string layout = 2;

Parameters
$var : string
Return values
$this

setPreset()

(default H264_720P_30)

public setPreset(int $var) : $this

Generated from protobuf field .livekit.EncodingOptionsPreset preset = 8;

Parameters
$var : int
Return values
$this

setRoomName()

required

public setRoomName(string $var) : $this

Generated from protobuf field string room_name = 1;

Parameters
$var : string
Return values
$this

setStreamOutputs()

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

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

setVideoOnly()

(default false)

public setVideoOnly(bool $var) : $this

Generated from protobuf field bool video_only = 4;

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 = 16;

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results