Documentation

ExportReplayRequest extends Message
in package

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

Table of Contents

Properties

$encoding  : mixed
$end_offset_ms  : mixed
Generated from protobuf field <code>int64 end_offset_ms = 3;</code>
$replay_id  : mixed
Generated from protobuf field <code>string replay_id = 1 [(.logger.name) = "replayID"];</code>
$source  : mixed
$start_offset_ms  : mixed
Generated from protobuf field <code>int64 start_offset_ms = 2;</code>
$storage  : mixed
Generated from protobuf field <code>.livekit.StorageConfig storage = 10;</code>
$outputs  : mixed
Generated from protobuf field <code>repeated .livekit.Output outputs = 9;</code>
$webhooks  : mixed
Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 11;</code>

Methods

__construct()  : mixed
Constructor.
clearStorage()  : mixed
getAdvanced()  : EncodingOptions|null
Generated from protobuf field <code>.livekit.EncodingOptions advanced = 8;</code>
getEncoding()  : string
getEndOffsetMs()  : int|string
Generated from protobuf field <code>int64 end_offset_ms = 3;</code>
getMedia()  : MediaSource|null
Generated from protobuf field <code>.livekit.MediaSource media = 6;</code>
getOutputs()  : RepeatedField<string|int, Output>
Generated from protobuf field <code>repeated .livekit.Output outputs = 9;</code>
getPreset()  : int
Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 7;</code>
getReplayId()  : string
Generated from protobuf field <code>string replay_id = 1 [(.logger.name) = "replayID"];</code>
getSource()  : string
getStartOffsetMs()  : int|string
Generated from protobuf field <code>int64 start_offset_ms = 2;</code>
getStorage()  : StorageConfig|null
Generated from protobuf field <code>.livekit.StorageConfig storage = 10;</code>
getTemplate()  : TemplateSource|null
Generated from protobuf field <code>.livekit.TemplateSource template = 4;</code>
getWeb()  : WebSource|null
Generated from protobuf field <code>.livekit.WebSource web = 5;</code>
getWebhooks()  : RepeatedField<string|int, WebhookConfig>
Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 11;</code>
hasAdvanced()  : mixed
hasMedia()  : mixed
hasPreset()  : mixed
hasStorage()  : mixed
hasTemplate()  : mixed
hasWeb()  : mixed
setAdvanced()  : $this
Generated from protobuf field <code>.livekit.EncodingOptions advanced = 8;</code>
setEndOffsetMs()  : $this
Generated from protobuf field <code>int64 end_offset_ms = 3;</code>
setMedia()  : $this
Generated from protobuf field <code>.livekit.MediaSource media = 6;</code>
setOutputs()  : $this
Generated from protobuf field <code>repeated .livekit.Output outputs = 9;</code>
setPreset()  : $this
Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 7;</code>
setReplayId()  : $this
Generated from protobuf field <code>string replay_id = 1 [(.logger.name) = "replayID"];</code>
setStartOffsetMs()  : $this
Generated from protobuf field <code>int64 start_offset_ms = 2;</code>
setStorage()  : $this
Generated from protobuf field <code>.livekit.StorageConfig storage = 10;</code>
setTemplate()  : $this
Generated from protobuf field <code>.livekit.TemplateSource template = 4;</code>
setWeb()  : $this
Generated from protobuf field <code>.livekit.WebSource web = 5;</code>
setWebhooks()  : $this
Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 11;</code>

Properties

$end_offset_ms

Generated from protobuf field <code>int64 end_offset_ms = 3;</code>

protected mixed $end_offset_ms = 0

$replay_id

Generated from protobuf field <code>string replay_id = 1 [(.logger.name) = "replayID"];</code>

protected mixed $replay_id = ''

$start_offset_ms

Generated from protobuf field <code>int64 start_offset_ms = 2;</code>

protected mixed $start_offset_ms = 0

$storage

Generated from protobuf field <code>.livekit.StorageConfig storage = 10;</code>

protected mixed $storage = null

$outputs

Generated from protobuf field <code>repeated .livekit.Output outputs = 9;</code>

private mixed $outputs

$webhooks

Generated from protobuf field <code>repeated .livekit.WebhookConfig webhooks = 11;</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 $replay_id
@type int|string $start_offset_ms
@type int|string $end_offset_ms
@type \Livekit\TemplateSource $template
@type \Livekit\WebSource $web
@type \Livekit\MediaSource $media
@type int $preset
@type \Livekit\EncodingOptions $advanced
@type \Livekit\Output[] $outputs
@type \Livekit\StorageConfig $storage
@type \Livekit\WebhookConfig[] $webhooks

}

getEndOffsetMs()

Generated from protobuf field <code>int64 end_offset_ms = 3;</code>

public getEndOffsetMs() : int|string
Return values
int|string

getOutputs()

Generated from protobuf field <code>repeated .livekit.Output outputs = 9;</code>

public getOutputs() : RepeatedField<string|int, Output>
Return values
RepeatedField<string|int, Output>

getPreset()

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

public getPreset() : int
Return values
int

getReplayId()

Generated from protobuf field <code>string replay_id = 1 [(.logger.name) = "replayID"];</code>

public getReplayId() : string
Return values
string

getStartOffsetMs()

Generated from protobuf field <code>int64 start_offset_ms = 2;</code>

public getStartOffsetMs() : int|string
Return values
int|string

getWebhooks()

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

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

setEndOffsetMs()

Generated from protobuf field <code>int64 end_offset_ms = 3;</code>

public setEndOffsetMs(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setOutputs()

Generated from protobuf field <code>repeated .livekit.Output outputs = 9;</code>

public setOutputs(array<string|int, Output$var) : $this
Parameters
$var : array<string|int, Output>
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

setReplayId()

Generated from protobuf field <code>string replay_id = 1 [(.logger.name) = "replayID"];</code>

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

setStartOffsetMs()

Generated from protobuf field <code>int64 start_offset_ms = 2;</code>

public setStartOffsetMs(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setWebhooks()

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

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

        
On this page

Search results