Documentation

InputVideoState extends Message
in package

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

Table of Contents

Properties

$average_bitrate  : mixed
Generated from protobuf field <code>uint32 average_bitrate = 2;</code>
$framerate  : mixed
Generated from protobuf field <code>double framerate = 5;</code>
$height  : mixed
Generated from protobuf field <code>uint32 height = 4;</code>
$mime_type  : mixed
Generated from protobuf field <code>string mime_type = 1;</code>
$width  : mixed
Generated from protobuf field <code>uint32 width = 3;</code>

Methods

__construct()  : mixed
Constructor.
getAverageBitrate()  : int
Generated from protobuf field <code>uint32 average_bitrate = 2;</code>
getFramerate()  : float
Generated from protobuf field <code>double framerate = 5;</code>
getHeight()  : int
Generated from protobuf field <code>uint32 height = 4;</code>
getMimeType()  : string
Generated from protobuf field <code>string mime_type = 1;</code>
getWidth()  : int
Generated from protobuf field <code>uint32 width = 3;</code>
setAverageBitrate()  : $this
Generated from protobuf field <code>uint32 average_bitrate = 2;</code>
setFramerate()  : $this
Generated from protobuf field <code>double framerate = 5;</code>
setHeight()  : $this
Generated from protobuf field <code>uint32 height = 4;</code>
setMimeType()  : $this
Generated from protobuf field <code>string mime_type = 1;</code>
setWidth()  : $this
Generated from protobuf field <code>uint32 width = 3;</code>

Properties

$average_bitrate

Generated from protobuf field <code>uint32 average_bitrate = 2;</code>

protected mixed $average_bitrate = 0

$framerate

Generated from protobuf field <code>double framerate = 5;</code>

protected mixed $framerate = 0.0

$height

Generated from protobuf field <code>uint32 height = 4;</code>

protected mixed $height = 0

$mime_type

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

protected mixed $mime_type = ''

$width

Generated from protobuf field <code>uint32 width = 3;</code>

protected mixed $width = 0

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 $mime_type
@type int $average_bitrate
@type int $width
@type int $height
@type float $framerate

}

getAverageBitrate()

Generated from protobuf field <code>uint32 average_bitrate = 2;</code>

public getAverageBitrate() : int
Return values
int

getFramerate()

Generated from protobuf field <code>double framerate = 5;</code>

public getFramerate() : float
Return values
float

getHeight()

Generated from protobuf field <code>uint32 height = 4;</code>

public getHeight() : int
Return values
int

getMimeType()

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

public getMimeType() : string
Return values
string

getWidth()

Generated from protobuf field <code>uint32 width = 3;</code>

public getWidth() : int
Return values
int

setAverageBitrate()

Generated from protobuf field <code>uint32 average_bitrate = 2;</code>

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

setFramerate()

Generated from protobuf field <code>double framerate = 5;</code>

public setFramerate(float $var) : $this
Parameters
$var : float
Return values
$this

setHeight()

Generated from protobuf field <code>uint32 height = 4;</code>

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

setMimeType()

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

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

setWidth()

Generated from protobuf field <code>uint32 width = 3;</code>

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

        
On this page

Search results