Skip to main content

Initialization Configuration

During initialization, parameters such as autoplay, muted, volume, and loop attributes can be configured. However, it is also possible to modify the volume and muted attributes at a later time, as per requirements.

Media Initialization Configuration

The initialization configuration can set preferred video, caption, and audio behavior when playback starts. These preferences are applied on supported platforms.

AttributeTypeDescription
videoobjectInitial ABR, bitrate, and latency settings.
captionobjectInitial caption display, language, and source settings.
audioobjectInitial audio language settings.
Media Initialization Example
const config = {
...
initialization: {
video: {
abrEnabled: true,
preferredBitrate: 1000000,
latencyMode: "def",
},
caption: {
enabled: true,
preferredLanguage: "en",
source: ["manifest", "embedded"],
},
audio: {
preferredLanguage: "en",
},
},
...
};
const player = new lura.Player(document.getElementById("player"));
player.setConfig(config);
AttributeTypeDescription
initialization.video.abrEnabledbooleanEnables or disables ABR on supported platforms.
initialization.video.preferredBitratenumberPreferred starting bitrate on supported platforms.
initialization.video.latencyModeLatencyModePreferred latency mode on initialization. Supported values are def and low.
initialization.caption.enabledbooleanShows or hides captions on initialization.
initialization.caption.preferredLanguagestringPreferred caption language on supported platforms.
initialization.caption.source("manifest" \| "sidecar" \| "embedded")[]Caption sources to use. Defaults to ["manifest", "embedded"].
initialization.audio.preferredLanguagestringPreferred audio language on supported platforms.

Autoplay Configuration

The implementation of autoplay attribute can be done in Lura Player using the following configuration.

AttributeTypeDescription
autoplaybooleanAutoplay attribute of the player. Defaults to false
Autoplay Example
const config = {
...
controls: {
autoplay: true,
},
...
};
const player = new lura.Player(document.getElementById("player"));
player.setConfig(config);

Mute Configuration

The implementation of initially muted attribute can be done in Lura Player using the following configuration.

AttributeTypeDescription
mutedbooleanWhether to start muted when the player autoplays. Defaults to false.
info

Some platforms doesn't support unmuted autoplay. So if autoplay attribute is set to true, muted attribute will be overwritten to true in platforms that doesn't support unmuted autoplay.

Mute Example
const config = {
...
controls: {
muted: true,
},
...
};
const player = new lura.Player(document.getElementById("player"));
player.setConfig(config);

Volume Configuration

The implementation of initial volume attribute can be done in Lura Player using the following configuration.

AttributeTypeDescription
volumenumberInitial volume of the player between 0.0 and 1.0. Defaults to 1.0
Volume Example
const config = {
...
controls: {
volume: 1.0,
},
...
};
const player = new lura.Player(document.getElementById("player"));
player.setConfig(config);

Loop Configuration

The implementation of loop attribute can be done in Lura Player using the following configuration.

AttributeTypeDescription
loopbooleanLoop the video when it ends. Defaults to false.
Loop Example
const config = {
...
controls: {
loop: true,
},
...
};
const player = new lura.Player(document.getElementById("player"));
player.setConfig(config);
Combined Example
const config = {
...
controls: {
autoplay: true,
muted: true,
volume: 1.0,
loop: true
},
...
};
const player = new lura.Player(document.getElementById("player"));
player.setConfig(config);