Class: Embed

GoBrain.Dtos.Settings. Embed

new GoBrain.Dtos.Settings.Embed()

GoBrain.Core/src/dtos/settings/embed.js, line 1
Properties:
Name Type Argument Default Description
autoplay Boolean <optional>
true

Whether or not to autoplay. Will always default to false on mobile devices.

baseUrl String <optional>

Location of the framework. If not provided, will default to location from where the main framework script is loaded.

config String <optional>

Url to configuration JSON. If not provided then configuration must be provided through embed parameters (controllers, extensions & modules).

controllers Array.<GoBrain.Dtos.Settings.Controller> <optional>
[]

Used to provide alternative implementations of framework controllers.

controllerSettings Object <optional>
{}

Used to provide settings for loaded controllers.

data String <optional>

Url to location of data for playback.

extensions Array.<GoBrain.Dtos.Settings.Extension> <optional>
[]

Used to provide implementations of extensions to framework classes.

extensionSettings Object <optional>
{}

Used to provide settings for loaded extensions.

height Number <optional>
360

Sets the height (in px) of the Widget instance.

language String <optional>
en

Sets initial language for applicable modules, like Subtitles.

logLevel Number <optional>
2

Available values 0..5 (5 highest).

modules Array.<GoBrain.Dtos.Settings.Module> <optional>
[]

Used to provide modules to be loaded.

moduleSettings Object <optional>
{}

Used to provide settings for loaded modules.

protection Object.<String, Object> <optional>

Protection settings per protection type.

repeat Boolean <optional>
true

Whether or not to repeat the playback queue once the last item has finished.

volume Number <optional>
0.5

Available values 0..1.

widgetId String <optional>
gobrain-widget-[SerialNumber]

Unique identifier for the Widget instance.

width Number <optional>
640

Sets the width (in px) of the Widget instance.