General Configuration - Storm JavaScript Player

In this guide, you will learn about the basic configuration parameters of the Storm Player. Please remember that this configuration pertains solely to the appearance and behavior of the user interface.

Code Example

                        
/**
 * Standard stream configuration object
 */
const streamConfig = {
    stream: {
        ... // Stream & Server Settings
    },
};

/**
 * Standard player configuration object
 */
const playerConfig = {
    containerID: "container",
    width: "100%",
    height: "100%",
    aspectRatio: "16:9",
    title: "My first broadcast",
    subtitle: "Epic live streaming",
    waitingRoom: {
        ... // Waiting Room Settings
    },
    interface: {
        ... // Interface & Styling Settings
    },
    style: {
        ... // Interface & Styling Settings
    },
    translations: {
        ... // Translations
    }
};

/**
 * Each player instance must be provided with both player (gui) and library configs
 */
const player = stormPlayer(playerConfig, streamConfig);
                    

Basic Player Configuration Object

The second configuration object of the player, known as playerConfig, defines the appearance and behavior of the user interface of the player itself. Basic fields, for example, allow for defining its size, while various sub-objects also define aspects like styles and translations. However, we will now focus on the basic settings.

Code Example:

                        
const playerConfig = {
    containerID: "container",
    width: 640,
    height: 360,
    title: "Awesome live stream",
    subtitle: "This is going to be epic!",
};
                    

The above code represents only the basic parameters of the player.

Explanation and description of individual fields