vm-poster

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

Visual

Usage

HTML

<vm-player>

<!-- ... -->

<vm-ui>

<!-- ... -->

<vm-poster></vm-poster>

</vm-ui>

</vm-player>

React

import React from 'react';

import { Player, Ui, Poster } from '@vime/react';

function Example() {

return (

<Player>

{/* ... */}

<Ui>

{/* ... */}

<Poster />

</Ui>

</Player>

);

}

Vue

example.vue

<template>

<Player>

<!-- ... -->

<Ui>

<!-- ... -->

<Poster />

</Ui>

</Player>

</template>

<script>

import { Player, Ui, Poster } from '@vime/vue';

export default {

components: {

Player,

Ui,

Poster,

},

};

</script>

Svelte

example.svelte

<Player>

<!-- ... -->

<Ui>

<!-- ... -->

<Poster />

</Ui>

</Player>

<script lang="ts">

import { Player, Ui, Poster } from '@vime/svelte';

</script>

Stencil

class Example {

render() {

return (

<vm-player>

{/* ... */}

<vm-ui>

{/* ... */}

<vm-poster />

</vm-ui>

</vm-player>

);

}

}

Angular

example.html

<vm-player>

<!-- ... -->

<vm-ui>

<!-- ... -->

<vm-poster></vm-poster>

</vm-ui>

</vm-player>

Properties

Property	Description	Type	Default
fit	How the poster image should be resized to fit the container (sets the object-fit property).	"contain" ∣ "cover" ∣ "fill" ∣ "none" ∣ "scale-down" ∣ undefined	'cover'

Events

Event	Description	Type
vmLoaded	Emitted when the poster has loaded.	CustomEvent<void>
vmWillHide	Emitted when the poster will be hidden.	CustomEvent<void>
vmWillShow	Emitted when the poster will be shown.	CustomEvent<void>

CSS Custom Properties

Name	Description
--vm-poster-z-index	The position in the UI z-axis stack inside the player.

Dependencies

Used by

• vm-default-ui