Version: 5.x
vm-file
Enables loading, playing and controlling media files via the
HTML5 MediaElement API.
This is used internally by the vime-audio and vime-video components,
which are the preferred components to use for loading file-based media.
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-playercomponent.
Properties#
| Property | Description | Type | Default |
|---|---|---|---|
autoPiP | EXPERIMENTAL: Whether the browser should automatically toggle picture-in-picture mode as the user switches back and forth between this document and another document or application. | boolean ∣ undefined | undefined |
controlsList | Determines what controls to show on the media element whenever the browser shows its own set of controls (e.g. when the controls attribute is specified). | string ∣ undefined | undefined |
crossOrigin | Whether to use CORS to fetch the related image. See MDN for more information. | "" ∣ "anonymous" ∣ "use-credentials" ∣ undefined | undefined |
disablePiP | EXPERIMENTAL: Prevents the browser from suggesting a picture-in-picture context menu or to request picture-in-picture automatically in some cases. | boolean ∣ undefined | undefined |
disableRemotePlayback | EXPERIMENTAL: Whether to disable the capability of remote playback in devices that are attached using wired (HDMI, DVI, etc.) and wireless technologies (Miracast, Chromecast, DLNA, AirPlay, etc). | boolean ∣ undefined | undefined |
mediaTitle | The title of the current media. | string ∣ undefined | undefined |
playbackRates | The playback rates that are available for this media. | number[] | [0.25, 0.5, 0.75, 1, 1.25, 1.5, 2] |
poster | A URL for an image to be shown while the video is downloading. If this attribute isn't specified, nothing is displayed until the first frame is available, then the first frame is shown as the poster frame. | string ∣ undefined | undefined |
preload | Provides a hint to the browser about what the author thinks will lead to the best user experience with regards to what content is loaded before the video is played. See MDN for more information. | "" ∣ "auto" ∣ "metadata" ∣ "none" ∣ undefined | 'metadata' |
viewType | Whether to use an audio or video element to play the media. | ViewType.Audio ∣ ViewType.Video ∣ undefined | undefined |
Events#
| Event | Description | Type |
|---|---|---|
vmError | Emitted when an error has occurred. | CustomEvent<any> |
vmMediaElChange | Emitted when the underlying media element changes. | CustomEvent<HTMLAudioElement ∣ HTMLVideoElement ∣ undefined> |
vmSrcSetChange | Emitted when the child <source /> elements are modified. | CustomEvent<MediaResource[]> |
Slots#
| Slot | Description |
|---|---|
Pass <source> and <track> elements to the underlying HTML5 media player. |