Documentation

TrackEgressRequest extends Message
in package

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

Table of Contents

Properties

$output  : mixed
$room_name  : mixed
Generated from protobuf field <code>string room_name = 1;</code>
$track_id  : mixed
Generated from protobuf field <code>string track_id = 2 [(.logger.name) = "trackID"];</code>
$webhooks  : mixed
Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 5;</code>

Methods

__construct()  : mixed
Constructor.
getFile()  : DirectFileOutput|null
Generated from protobuf field <code>.livekit.DirectFileOutput file = 3;</code>
getOutput()  : string
getRoomName()  : string
Generated from protobuf field <code>string room_name = 1;</code>
getTrackId()  : string
Generated from protobuf field <code>string track_id = 2 [(.logger.name) = "trackID"];</code>
getWebhooks()  : RepeatedField<string|int, WebhookConfig>
Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 5;</code>
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
Generated from protobuf field <code>string room_name = 1;</code>
setTrackId()  : $this
Generated from protobuf field <code>string track_id = 2 [(.logger.name) = "trackID"];</code>
setWebhooks()  : $this
Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 5;</code>
setWebsocketUrl()  : $this
Generated from protobuf field <code>string websocket_url = 4;</code>

Properties

$room_name

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

protected mixed $room_name = ''

$track_id

Generated from protobuf field <code>string track_id = 2 [(.logger.name) = "trackID"];</code>

protected mixed $track_id = ''

$webhooks

Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 5;</code>

private mixed $webhooks

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 string $track_id
@type \Livekit\DirectFileOutput $file
@type string $websocket_url
@type \Livekit\WebhookConfig[] $webhooks

}

getRoomName()

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

public getRoomName() : string
Return values
string

getTrackId()

Generated from protobuf field <code>string track_id = 2 [(.logger.name) = "trackID"];</code>

public getTrackId() : string
Return values
string

getWebhooks()

Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 5;</code>

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

getWebsocketUrl()

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

public getWebsocketUrl() : string
Return values
string

setRoomName()

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

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

setTrackId()

Generated from protobuf field <code>string track_id = 2 [(.logger.name) = "trackID"];</code>

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

setWebhooks()

Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 5;</code>

public setWebhooks(array<string|int, WebhookConfig$var) : $this
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