Version: 5.x

vm-vimeo

Enables loading, playing and controlling videos from Vimeo.

You don't interact with this component for passing player properties, controlling playback, listening to player events and so on, that is all done through the vime-player component.

Quirks#

  • Only Vimeo PRO members can set/change the playbackRate.

  • playbackQuality and playbackQualities are not supported because there is no API for it.

Usage#

<vm-player controls>
<vm-vimeo video-id="411652396"></vm-vimeo>
<!-- ... -->
</vm-player>

Properties#

PropertyDescriptionTypeDefault
bylineWhether to display the video owner's name.booleantrue
colorThe hexadecimal color value of the playback controls. The embed settings of the video might override this value.string ∣ undefinedundefined
noAutoAspectRatioTurns off automatically determining the aspect ratio of the current video.booleanfalse
portraitWhether to display the video owner's portrait.booleantrue
posterThe absolute URL of a custom poster to be used for the current video.string ∣ undefinedundefined
videoId (required)The Vimeo resource ID of the video to load.stringundefined

Events#

EventDescriptionType
vmErrorEmitted when an error has occurred.CustomEvent<any>

Dependencies#

Depends on#