Documentation

TrackEgressRequest extends Message
in package

record tracks individually, without transcoding

Generated from protobuf message livekit.TrackEgressRequest

Table of Contents

Properties

$output  : mixed
$room_name  : mixed
required
$track_id  : mixed
required
$webhooks  : mixed
extra webhooks to call for this request

Methods

__construct()  : mixed
Constructor.
getFile()  : DirectFileOutput|null
Generated from protobuf field <code>.livekit.DirectFileOutput file = 3;</code>
getOutput()  : string
getRoomName()  : string
required
getTrackId()  : string
required
getWebhooks()  : RepeatedField<string|int, WebhookConfig>
extra webhooks to call for this request
getWebsocketUrl()  : string
Generated from protobuf field <code>string websocket_url = 4;</code>
hasFile()  : mixed
hasWebsocketUrl()  : mixed
setFile()  : $this
Generated from protobuf field <code>.livekit.DirectFileOutput file = 3;</code>
setRoomName()  : $this
required
setTrackId()  : $this
required
setWebhooks()  : $this
extra webhooks to call for this request
setWebsocketUrl()  : $this
Generated from protobuf field <code>string websocket_url = 4;</code>

Properties

$room_name

required

protected mixed $room_name = ''

Generated from protobuf field string room_name = 1;

$track_id

required

protected mixed $track_id = ''

Generated from protobuf field string track_id = 2;

$webhooks

extra webhooks to call for this request

private mixed $webhooks

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

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 $track_id
      required
@type \Livekit\DirectFileOutput $file
@type string $websocket_url
@type \Livekit\WebhookConfig[] $webhooks
      extra webhooks to call for this request

}

getRoomName()

required

public getRoomName() : string

Generated from protobuf field string room_name = 1;

Return values
string

getTrackId()

required

public getTrackId() : string

Generated from protobuf field string track_id = 2;

Return values
string

getWebhooks()

extra webhooks to call for this request

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

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

Return values
RepeatedField<string|int, WebhookConfig>

getWebsocketUrl()

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

public getWebsocketUrl() : string
Return values
string

setRoomName()

required

public setRoomName(string $var) : $this

Generated from protobuf field string room_name = 1;

Parameters
$var : string
Return values
$this

setTrackId()

required

public setTrackId(string $var) : $this

Generated from protobuf field string track_id = 2;

Parameters
$var : string
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 = 5;

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

setWebsocketUrl()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results