Documentation

FileOutput extends Message
in package

Unified file output — replaces v1 EncodedFileOutput and DirectFileOutput.

Whether transcoded depends on encoding options on the request.

Generated from protobuf message livekit.FileOutput

Table of Contents

Properties

$disable_manifest  : mixed
Generated from protobuf field <code>bool disable_manifest = 3;</code>
$file_type  : mixed
Generated from protobuf field <code>.livekit.EncodedFileType file_type = 1;</code>
$filepath  : mixed
Generated from protobuf field <code>string filepath = 2;</code>

Methods

__construct()  : mixed
Constructor.
getDisableManifest()  : bool
Generated from protobuf field <code>bool disable_manifest = 3;</code>
getFilepath()  : string
Generated from protobuf field <code>string filepath = 2;</code>
getFileType()  : int
Generated from protobuf field <code>.livekit.EncodedFileType file_type = 1;</code>
setDisableManifest()  : $this
Generated from protobuf field <code>bool disable_manifest = 3;</code>
setFilepath()  : $this
Generated from protobuf field <code>string filepath = 2;</code>
setFileType()  : $this
Generated from protobuf field <code>.livekit.EncodedFileType file_type = 1;</code>

Properties

$disable_manifest

Generated from protobuf field <code>bool disable_manifest = 3;</code>

protected mixed $disable_manifest = false

$file_type

Generated from protobuf field <code>.livekit.EncodedFileType file_type = 1;</code>

protected mixed $file_type = 0

$filepath

Generated from protobuf field <code>string filepath = 2;</code>

protected mixed $filepath = ''

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 int $file_type
@type string $filepath
@type bool $disable_manifest

}

getDisableManifest()

Generated from protobuf field <code>bool disable_manifest = 3;</code>

public getDisableManifest() : bool
Return values
bool

getFilepath()

Generated from protobuf field <code>string filepath = 2;</code>

public getFilepath() : string
Return values
string

getFileType()

Generated from protobuf field <code>.livekit.EncodedFileType file_type = 1;</code>

public getFileType() : int
Return values
int

setDisableManifest()

Generated from protobuf field <code>bool disable_manifest = 3;</code>

public setDisableManifest(bool $var) : $this
Parameters
$var : bool
Return values
$this

setFilepath()

Generated from protobuf field <code>string filepath = 2;</code>

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

setFileType()

Generated from protobuf field <code>.livekit.EncodedFileType file_type = 1;</code>

public setFileType(int $var) : $this
Parameters
$var : int
Return values
$this

        
On this page

Search results