Documentation

ParticipantEgressRequest extends Message
in package

record audio and video from a single participant

Generated from protobuf message livekit.ParticipantEgressRequest

Table of Contents

Properties

$identity  : mixed
required
$options  : mixed
$room_name  : mixed
required
$screen_share  : mixed
(default false)
$file_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 6;</code>
$image_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 9;</code>
$segment_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 8;</code>
$stream_outputs  : mixed
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 7;</code>
$webhooks  : mixed
extra webhooks to call for this request

Methods

__construct()  : mixed
Constructor.
getAdvanced()  : EncodingOptions|null
(optional)
getFileOutputs()  : RepeatedField<string|int, EncodedFileOutput>
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 6;</code>
getIdentity()  : string
required
getImageOutputs()  : RepeatedField<string|int, ImageOutput>
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 9;</code>
getOptions()  : string
getPreset()  : int
(default H264_720P_30)
getRoomName()  : string
required
getScreenShare()  : bool
(default false)
getSegmentOutputs()  : RepeatedField<string|int, SegmentedFileOutput>
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 8;</code>
getStreamOutputs()  : RepeatedField<string|int, StreamOutput>
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 7;</code>
getWebhooks()  : RepeatedField<string|int, WebhookConfig>
extra webhooks to call for this request
hasAdvanced()  : mixed
hasPreset()  : mixed
setAdvanced()  : $this
(optional)
setFileOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 6;</code>
setIdentity()  : $this
required
setImageOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.ImageOutput image_outputs = 9;</code>
setPreset()  : $this
(default H264_720P_30)
setRoomName()  : $this
required
setScreenShare()  : $this
(default false)
setSegmentOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 8;</code>
setStreamOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.StreamOutput stream_outputs = 7;</code>
setWebhooks()  : $this
extra webhooks to call for this request

Properties

$screen_share

(default false)

protected mixed $screen_share = false

Generated from protobuf field bool screen_share = 3;

$file_outputs

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

private mixed $file_outputs

$image_outputs

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

private mixed $image_outputs

$segment_outputs

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

private mixed $segment_outputs

$stream_outputs

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

private mixed $stream_outputs

$webhooks

extra webhooks to call for this request

private mixed $webhooks

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

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 $identity
      required
@type bool $screen_share
      (default false)
@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

}

getIdentity()

required

public getIdentity() : string

Generated from protobuf field string identity = 2;

Return values
string

getImageOutputs()

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

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

getPreset()

(default H264_720P_30)

public getPreset() : int

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

Return values
int

getRoomName()

required

public getRoomName() : string

Generated from protobuf field string room_name = 1;

Return values
string

getScreenShare()

(default false)

public getScreenShare() : bool

Generated from protobuf field bool screen_share = 3;

Return values
bool

getStreamOutputs()

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

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

getWebhooks()

extra webhooks to call for this request

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

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

Return values
RepeatedField<string|int, WebhookConfig>

setIdentity()

required

public setIdentity(string $var) : $this

Generated from protobuf field string identity = 2;

Parameters
$var : string
Return values
$this

setImageOutputs()

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

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

setPreset()

(default H264_720P_30)

public setPreset(int $var) : $this

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

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

setScreenShare()

(default false)

public setScreenShare(bool $var) : $this

Generated from protobuf field bool screen_share = 3;

Parameters
$var : bool
Return values
$this

setStreamOutputs()

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

public setStreamOutputs(array<string|int, StreamOutput> $var) : $this
Parameters
$var : array<string|int, StreamOutput>
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 = 10;

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results