Yyeva NPM | npm.io

YY-EVA web 🎁

Language: 中文

📦 Install

npm i yyeva
# or
yarn add yyeva
# or
pnpm add yyeva

💿 Usage

import {yyEva,YYEvaType} from 'yyeva'
let player:YYEvaType = await yyEva({
	container,// Html Element
	videoUrl,// Video Url
	effects: {
	  //  fontStyle doc: https://www.w3schools.com/jsref/canvas_font.asp
          text1: {text: 'text example 1st', fontStyle: '18px arial', fontColor: '#ff0000'},
          text2: {text: 'text example 2nd', fontStyle: '20px arial', fontColor: 'green'},
	},
	// Events
	onStart(){},
	onStop(){},
	onEnd(){},
	onLoopCount(args){},
	onPause(){},
	onResume(){},
	onProcess(){},
	onError(){},
})
player.start() // start player
player.stop() // pause player
player.destroy() // destroy player

configuration

options	effect	defaults	required
videoUrl	mp4 address		*
hevcUrl	mp4 address hevc、h265
loop	loop or loop count	true
videoID	Adapt to containers that require prior declaration such as WeChat, otherwise you need to repeatedly click on authorization
mode	'AspectFill' / 'AspectFit' / 'contain' / 'cover'	scale proportionally according to the parent container
container	dom container		*
fps	animation frame	get from video source
usePrefetch	whether to download while playing, the material with "key" is enabled by default	true
useBitmap	use bitmaps instead of img elements	true
useAccurate	in the case of supporting requestVideoFrameCallback, use requestVideoFrameCallback first	false
useVideoDBCache	enable indexDB video caching	true
useFrameCache	number of video frame buffers	5
useOfsRender	enable multithreaded rendering	true
mute	silent playback, automatic adjustment according to the environment	true
alphaDirection	adjust alpha position for video without keys	`alphaDirection`
renderType	render mode 'webgl' / 'canvas2d'	`canvas2d`
resizeCanvas	canvas size, 'percent', 'percentW', 'percentH', 'size'	`width 100%` `height 100%`
logLevel	log level	`info`
showPlayerInfo	whether the console shows the playback status
effects	additional material content
effects.fontColor	define the font color of the effects material
effects.fontSize	define the font size of the effects material
checkTimeout	check play timeout	`fasle`
onRequestClickPlay	triggered when the video cannot be played automatically, such as WeChat or "mute=false"	type refer to clickPlayBtn