Documentation

ImageOutput extends Message
in package

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

Table of Contents

Properties

$capture_interval  : mixed
in seconds (required)
$disable_manifest  : mixed
disable upload of manifest file (default false)
$filename_prefix  : mixed
(optional)
$filename_suffix  : mixed
(optional, default INDEX)
$height  : mixed
(optional, defaults to track height)
$image_codec  : mixed
(optional)
$output  : mixed
$width  : mixed
(optional, defaults to track width)

Methods

__construct()  : mixed
Constructor.
getAliOSS()  : AliOSSUpload|null
Generated from protobuf field <code>.livekit.AliOSSUpload aliOSS = 11;</code>
getAzure()  : AzureBlobUpload|null
Generated from protobuf field <code>.livekit.AzureBlobUpload azure = 10;</code>
getCaptureInterval()  : int
in seconds (required)
getDisableManifest()  : bool
disable upload of manifest file (default false)
getFilenamePrefix()  : string
(optional)
getFilenameSuffix()  : int
(optional, default INDEX)
getGcp()  : GCPUpload|null
Generated from protobuf field <code>.livekit.GCPUpload gcp = 9;</code>
getHeight()  : int
(optional, defaults to track height)
getImageCodec()  : int
(optional)
getOutput()  : string
getS3()  : S3Upload|null
Generated from protobuf field <code>.livekit.S3Upload s3 = 8;</code>
getWidth()  : int
(optional, defaults to track width)
hasAliOSS()  : mixed
hasAzure()  : mixed
hasGcp()  : mixed
hasS3()  : mixed
setAliOSS()  : $this
Generated from protobuf field <code>.livekit.AliOSSUpload aliOSS = 11;</code>
setAzure()  : $this
Generated from protobuf field <code>.livekit.AzureBlobUpload azure = 10;</code>
setCaptureInterval()  : $this
in seconds (required)
setDisableManifest()  : $this
disable upload of manifest file (default false)
setFilenamePrefix()  : $this
(optional)
setFilenameSuffix()  : $this
(optional, default INDEX)
setGcp()  : $this
Generated from protobuf field <code>.livekit.GCPUpload gcp = 9;</code>
setHeight()  : $this
(optional, defaults to track height)
setImageCodec()  : $this
(optional)
setS3()  : $this
Generated from protobuf field <code>.livekit.S3Upload s3 = 8;</code>
setWidth()  : $this
(optional, defaults to track width)

Properties

$capture_interval

in seconds (required)

protected mixed $capture_interval = 0

Generated from protobuf field uint32 capture_interval = 1;

$disable_manifest

disable upload of manifest file (default false)

protected mixed $disable_manifest = false

Generated from protobuf field bool disable_manifest = 7;

$filename_prefix

(optional)

protected mixed $filename_prefix = ''

Generated from protobuf field string filename_prefix = 4;

$filename_suffix

(optional, default INDEX)

protected mixed $filename_suffix = 0

Generated from protobuf field .livekit.ImageFileSuffix filename_suffix = 5;

$height

(optional, defaults to track height)

protected mixed $height = 0

Generated from protobuf field int32 height = 3;

$image_codec

(optional)

protected mixed $image_codec = 0

Generated from protobuf field .livekit.ImageCodec image_codec = 6;

$width

(optional, defaults to track width)

protected mixed $width = 0

Generated from protobuf field int32 width = 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 $capture_interval
      in seconds (required)
@type int $width
      (optional, defaults to track width)
@type int $height
      (optional, defaults to track height)
@type string $filename_prefix
      (optional)
@type int $filename_suffix
      (optional, default INDEX)
@type int $image_codec
      (optional)
@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

}

getCaptureInterval()

in seconds (required)

public getCaptureInterval() : int

Generated from protobuf field uint32 capture_interval = 1;

Return values
int

getDisableManifest()

disable upload of manifest file (default false)

public getDisableManifest() : bool

Generated from protobuf field bool disable_manifest = 7;

Return values
bool

getFilenamePrefix()

(optional)

public getFilenamePrefix() : string

Generated from protobuf field string filename_prefix = 4;

Return values
string

getFilenameSuffix()

(optional, default INDEX)

public getFilenameSuffix() : int

Generated from protobuf field .livekit.ImageFileSuffix filename_suffix = 5;

Return values
int

getGcp()

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

public getGcp() : GCPUpload|null
Return values
GCPUpload|null

getHeight()

(optional, defaults to track height)

public getHeight() : int

Generated from protobuf field int32 height = 3;

Return values
int

getImageCodec()

(optional)

public getImageCodec() : int

Generated from protobuf field .livekit.ImageCodec image_codec = 6;

Return values
int

getOutput()

public getOutput() : string
Return values
string

getS3()

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

public getS3() : S3Upload|null
Return values
S3Upload|null

getWidth()

(optional, defaults to track width)

public getWidth() : int

Generated from protobuf field int32 width = 2;

Return values
int

setAliOSS()

Generated from protobuf field <code>.livekit.AliOSSUpload aliOSS = 11;</code>

public setAliOSS(AliOSSUpload $var) : $this
Parameters
$var : AliOSSUpload
Return values
$this

setCaptureInterval()

in seconds (required)

public setCaptureInterval(int $var) : $this

Generated from protobuf field uint32 capture_interval = 1;

Parameters
$var : int
Return values
$this

setDisableManifest()

disable upload of manifest file (default false)

public setDisableManifest(bool $var) : $this

Generated from protobuf field bool disable_manifest = 7;

Parameters
$var : bool
Return values
$this

setFilenamePrefix()

(optional)

public setFilenamePrefix(string $var) : $this

Generated from protobuf field string filename_prefix = 4;

Parameters
$var : string
Return values
$this

setFilenameSuffix()

(optional, default INDEX)

public setFilenameSuffix(int $var) : $this

Generated from protobuf field .livekit.ImageFileSuffix filename_suffix = 5;

Parameters
$var : int
Return values
$this

setGcp()

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

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

setHeight()

(optional, defaults to track height)

public setHeight(int $var) : $this

Generated from protobuf field int32 height = 3;

Parameters
$var : int
Return values
$this

setImageCodec()

(optional)

public setImageCodec(int $var) : $this

Generated from protobuf field .livekit.ImageCodec image_codec = 6;

Parameters
$var : int
Return values
$this

setS3()

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

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

setWidth()

(optional, defaults to track width)

public setWidth(int $var) : $this

Generated from protobuf field int32 width = 2;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results