Version: 5.x

vm-poster

Loads the poster set in the player prop currentPoster and displays it. The poster will automatically dissapear once playback starts.

Visual#

Vime poster component

Usage#

<vm-player>
<!-- ... -->
<vm-ui>
<!-- ... -->
<vm-poster></vm-poster>
</vm-ui>
</vm-player>

Properties#

PropertyDescriptionTypeDefault
fitHow the poster image should be resized to fit the container (sets the object-fit property)."contain" ∣ "cover" ∣ "fill" ∣ "none" ∣ "scale-down" ∣ undefined'cover'

Events#

EventDescriptionType
vmLoadedEmitted when the poster has loaded.CustomEvent<void>
vmWillHideEmitted when the poster will be hidden.CustomEvent<void>
vmWillShowEmitted when the poster will be shown.CustomEvent<void>

CSS Custom Properties#

NameDescription
--vm-poster-z-indexThe position in the UI z-axis stack inside the player.

Dependencies#

Used by#