Hide navigation sidebar
Hide table of contents sidebar
PTB has undergone significant changes in v20. Please read the documentation carefully and also check out the transition guide in the wiki.
Back to top
Toggle table of contents sidebar

# MaskPosition

class telegram.MaskPosition(point, x_shift, y_shift, scale, *, api_kwargs=None)

  Bases: `telegram.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.

  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.

  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. For example, choosing `-1.0` will place mask just to the left of the default mask position.

    Type:

      `float`

  y_shift

    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.

    Type:

      `float`

  scale

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

    Type:

      `float`

  Use In

  `telegram.Bot.set_sticker_mask_position()`

  Available In

  `telegram.Sticker.mask_position`

  CHIN = 'chin'

    `telegram.constants.MaskPosition.CHIN`

  EYES = 'eyes'

    `telegram.constants.MaskPosition.EYES`

  FOREHEAD = 'forehead'

    `telegram.constants.MaskPosition.FOREHEAD`

  MOUTH = 'mouth'

    `telegram.constants.MaskPosition.MOUTH`