telegram.MaskPosition

class telegram.MaskPosition(point: str, x_shift: float, y_shift: float, scale: float, **_kwargs)

Bases: telegram.base.TelegramObject

This object describes the position on faces where a mask should be placed by default.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their point, x_shift, y_shift and, scale are equal.

point

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

Type:str
x_shift

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

Type:float
y_shift

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

Type:float
scale

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

Type:float

Note

type should be one of the following: forehead, eyes, mouth or chin. You can use the class constants for those.

Parameters:
  • point (str) – The part of the face relative to which the mask should be placed. One of 'forehead', 'eyes', 'mouth', or 'chin'.
  • x_shift (float) – Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.
  • y_shift (float) – Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.
  • scale (float) – Mask scaling coefficient. For example, 2.0 means double size.
CHIN = 'chin'

telegram.constants.STICKER_CHIN

EYES = 'eyes'

telegram.constants.STICKER_EYES

FOREHEAD = 'forehead'

telegram.constants.STICKER_FOREHEAD

MOUTH = 'mouth'

telegram.constants.STICKER_MOUTH