ArtPlayer/packages/artplayer-vitepress/docs/en/advanced/class.md

Static Properties

Here, static properties refer to the first-level properties attached to the constructor, which are rarely used.

instances

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

▶ Run Code

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

console.info(Artplayer.version);

env

Returns the environment variables of the player.

▶ Run Code

console.info(Artplayer.env);

build

Returns the build timestamp of the player.

▶ Run Code

console.info(Artplayer.build);

config

Returns the default configuration for videos.

▶ Run Code

console.info(Artplayer.config);

utils

Returns the collection of utility functions for the player.

▶ Run Code

console.info(Artplayer.utils);

:::warning 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

console.info(Artplayer.scheme);

Emitter

Returns the constructor of the event emitter.

▶ Run Code

console.info(Artplayer.Emitter);

validator

Returns the validation function for options.

▶ Run Code

console.info(Artplayer.validator);

kindOf

Returns the type detection utility function.

▶ Run Code

console.info(Artplayer.kindOf);

html

Returns the html string required by the player.

▶ Run Code

console.info(Artplayer.html);

This is the current version's static base markup, including required classes and media/control nodes, not a snapshot of an instance's current DOM. When reusing preinserted markup through useSSR: true, keep its complete structure and version aligned. The option does not make construction work outside a browser. Actual template instances have no html member; the historical root type retains that member for compatibility, but it does not replace the static entry.

option

Returns the default options of the player.

▶ Run Code

console.info(Artplayer.option);