vm-dash

Enables loading, playing and controlling MPEG DASH based media. It uses dashjs under the hood.

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.

Usage

HTML

<vm-player controls>

<vm-dash

src="/media/manifest.mpd"

version="latest"

poster="/media/poster.png"

></vm-dash>

<!-- ... -->

</vm-player>

React

import React from 'react';

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

function Example() {

/**

* @see https://github.com/Dash-Industry-Forum/dash.js.

*/

const dashConfig = {

// ...

};

return (

<Player controls>

<Dash

src="/media/manifest.mpd"

version="latest"

config={dashConfig}

poster="/media/poster.png"

/>

{/* ... */}

</Player>

);

}

Vue

example.vue

<template>

<Player controls>

<Dash

src="/media/manifest.mpd"

:config="dashConfig"

version="latest"

poster="/media/poster.png"

/>

<!-- ... -->

</Player>

</template>

<script>

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

export default {

components: {

Player,

Dash,

},

data: {

/**

* @see https://github.com/Dash-Industry-Forum/dash.js.

*/

dashConfig: {

// ...

},

},

};

</script>

Svelte

example.svelte

<Player controls>

<Dash

src="/media/manifest.mpd"

version="latest"

config="{dashConfig}"

poster="/media/poster.png"

/>

<!-- ... -->

</Player>

<script lang="ts">

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

/**

* @see https://github.com/Dash-Industry-Forum/dash.js.

*/

const dashConfig = {

// ...

};

</script>

Stencil

class Example {

render() {

return (

<vm-player controls>

<vm-dash

src="/media/manifest.mpd"

version="latest"

poster="/media/poster.png"

/>

{/* ... */}

</vm-player>

);

}

}

Angular

example.html

<vm-player controls>

<vm-dash

[config]="dashConfig"

src="/media/manifest.mpd"

version="latest"

poster="/media/poster.png"

></vm-dash>

<!-- ... -->

</vm-player>

example.ts

class Example {

/**

* @see https://github.com/Dash-Industry-Forum/dash.js.

*/

dashConfig = {

// ...

};

}

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
config	The dashjs configuration.	{ [x: string]: any; }	{}
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
enableTextTracksByDefault	Are text tracks enabled by default.	boolean	true
libSrc	The URL where the dashjs library source can be found. If this property is used, then the version property is ignored.	string ∣ undefined	undefined
mediaTitle	The title of the current media.	string ∣ undefined	undefined
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'
src (required)	The URL of the manifest.mpd file to use.	string	undefined
version	The NPM package version of the dashjs library to download and use.	string	'latest'

Events

Event	Description	Type
vmError	Emitted when an error has occurred.	CustomEvent<any>

Dependencies

Depends on

• vm-video