Skip to content

Static Properties

Here, Static Properties refer to the top-level properties mounted on the constructor function, which are very rarely used.

instances

Returns an array of all player instances. This property can be useful when you need to manage multiple player instances simultaneously.

▶ Run Code
js
console.info([...Artplayer.instances]);

var art = new Artplayer({
    container: '.artplayer-app',
    url: '/assets/sample/video.mp4',
});

console.info([...Artplayer.instances]);

version

Returns the version information of the player.

▶ Run Code
js
console.info(Artplayer.version);

env

Returns the environment variables of the player.

▶ Run Code
js
console.info(Artplayer.env);

build

Returns the build time of the player.

▶ Run Code
js
console.info(Artplayer.build);

config

Returns the default configuration for videos.

▶ Run Code
js
console.info(Artplayer.config);

utils

Returns the collection of utility functions for the player.

▶ Run Code
js
console.info(Artplayer.utils);

For all utility functions, please refer to the following address:

artplayer/types/utils.d.ts

scheme

Returns the validation schema for player options.

▶ Run Code
js
console.info(Artplayer.scheme);

Emitter

Returns the constructor function for the event emitter.

▶ Run Code
js
console.info(Artplayer.Emitter);

validator

Returns the validation function for options.

▶ Run Code
js
console.info(Artplayer.validator);

kindOf

Returns the utility function for type detection.

▶ Run Code
js
console.info(Artplayer.kindOf);

html

Returns the html string required by the player.

▶ Run Code
js
console.info(Artplayer.html);

option

Returns the default options for the player.

▶ Run Code
js
console.info(Artplayer.option);