Documentation

EncodedFileOutput extends Message
in package

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

Table of Contents

Properties

$disable_manifest  : mixed
disable upload of manifest file (default false)
$file_type  : mixed
(optional)
$filepath  : mixed
see egress docs for templating (default {room_name}-{time})
$output  : mixed

Methods

__construct()  : mixed
Constructor.
getAliOSS()  : AliOSSUpload|null
Generated from protobuf field <code>.livekit.AliOSSUpload aliOSS = 7;</code>
getAzure()  : AzureBlobUpload|null
Generated from protobuf field <code>.livekit.AzureBlobUpload azure = 5;</code>
getDisableManifest()  : bool
disable upload of manifest file (default false)
getFilepath()  : string
see egress docs for templating (default {room_name}-{time})
getFileType()  : int
(optional)
getGcp()  : GCPUpload|null
Generated from protobuf field <code>.livekit.GCPUpload gcp = 4;</code>
getOutput()  : string
getS3()  : S3Upload|null
Generated from protobuf field <code>.livekit.S3Upload s3 = 3;</code>
hasAliOSS()  : mixed
hasAzure()  : mixed
hasGcp()  : mixed
hasS3()  : mixed
setAliOSS()  : $this
Generated from protobuf field <code>.livekit.AliOSSUpload aliOSS = 7;</code>
setAzure()  : $this
Generated from protobuf field <code>.livekit.AzureBlobUpload azure = 5;</code>
setDisableManifest()  : $this
disable upload of manifest file (default false)
setFilepath()  : $this
see egress docs for templating (default {room_name}-{time})
setFileType()  : $this
(optional)
setGcp()  : $this
Generated from protobuf field <code>.livekit.GCPUpload gcp = 4;</code>
setS3()  : $this
Generated from protobuf field <code>.livekit.S3Upload s3 = 3;</code>

Properties

$disable_manifest

disable upload of manifest file (default false)

protected mixed $disable_manifest = false

Generated from protobuf field bool disable_manifest = 6;

$file_type

(optional)

protected mixed $file_type = 0

Generated from protobuf field .livekit.EncodedFileType file_type = 1;

$filepath

see egress docs for templating (default {room_name}-{time})

protected mixed $filepath = ''

Generated from protobuf field string filepath = 2;

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
      (optional)
@type string $filepath
      see egress docs for templating (default {room_name}-{time})
@type bool $disable_manifest
      disable upload of manifest file (default false)
@type \Livekit\S3Upload $s3
@type \Livekit\GCPUpload $gcp
@type \Livekit\AzureBlobUpload $azure
@type \Livekit\AliOSSUpload $aliOSS

}

getDisableManifest()

disable upload of manifest file (default false)

public getDisableManifest() : bool

Generated from protobuf field bool disable_manifest = 6;

Return values
bool

getFilepath()

see egress docs for templating (default {room_name}-{time})

public getFilepath() : string

Generated from protobuf field string filepath = 2;

Return values
string

getFileType()

(optional)

public getFileType() : int

Generated from protobuf field .livekit.EncodedFileType file_type = 1;

Return values
int

setDisableManifest()

disable upload of manifest file (default false)

public setDisableManifest(bool $var) : $this

Generated from protobuf field bool disable_manifest = 6;

Parameters
$var : bool
Return values
$this

setFilepath()

see egress docs for templating (default {room_name}-{time})

public setFilepath(string $var) : $this

Generated from protobuf field string filepath = 2;

Parameters
$var : string
Return values
$this

setFileType()

(optional)

public setFileType(int $var) : $this

Generated from protobuf field .livekit.EncodedFileType file_type = 1;

Parameters
$var : int
Return values
$this

setGcp()

Generated from protobuf field <code>.livekit.GCPUpload gcp = 4;</code>

public setGcp(GCPUpload $var) : $this
Parameters
$var : GCPUpload
Return values
$this

setS3()

Generated from protobuf field <code>.livekit.S3Upload s3 = 3;</code>

public setS3(S3Upload $var) : $this
Parameters
$var : S3Upload
Return values
$this

        
On this page

Search results