Telegram Bot Api Base
Back to top  

Class MaskPositionType.

see
package Default

 Methods

create() 

create(string $point, float $xShift, float $yShift, float $scale) : \TgBotApi\BotApiBase\Type\MaskPositionType
Static

Parameters

$point

string

$xShift

float

$yShift

float

$scale

float

Returns

\TgBotApi\BotApiBase\Type\MaskPositionType

 Properties

 

The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.

$point : string

Default

 

Mask scaling coefficient. For example, 2.0 means double size.

$scale : float

Default

 

Shift by X-axis measured in widths of the mask scaled to the face size, from left to right.

$xShift : float

Default

For example, choosing -1.0 will place mask just to the left of the default mask position.

 

Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom.

$yShift : float

Default

For example, 1.0 will place the mask just below the default mask position.

 Constants

 

MASK_POINT_CHIN

MASK_POINT_CHIN = 'chin' 
 

MASK_POINT_EYES

MASK_POINT_EYES = 'eyes' 
 

MASK_POINT_FOREHEAD

MASK_POINT_FOREHEAD = 'forehead' 
 

MASK_POINT_MOUTH

MASK_POINT_MOUTH = 'mouth'