Player Options

10min

Please note: This documentation is currently being revised. It may therefore be incomplete in some parts.
The Player Options allow to customize the behaviour of the Media Player. 
TypeScript
type PlayerOptions = {
  currencyCode?: string;
  locale?: string;
  floatPosition?: FloatPosition;
  initialPlayerMode?: 'cover' | 'float';
  socialSharingUrlTemplate?: string;
  seekToTimeInMs?: number;
  store?: string;
};
type PlayerOptions = {
  currencyCode?: string;
  locale?: string;
  floatPosition?: FloatPosition;
  initialPlayerMode?: 'cover' | 'float';
  socialSharingUrlTemplate?: string;
  seekToTimeInMs?: number;
  store?: string;
};
﻿
currencyCode
The ISO 4217 alphabetic code (e.g. USD) representing the currency to be utilized for displaying product price information.
floatPosition
Specifies the initial position of the floating Media Player.
Allowed Values
Value
Description
MediaPlayerOption.FLOAT_POSITION_BOTTOM_LEFT
Media Player is positioned at the bottom left corner of the browser viewport.
MediaPlayerOption.FLOAT_POSITION_BOTTOM_RIGHT
(Default) Media Player is positioned at the bottom right corner of the browser viewport.
MediaPlayerOption.FLOAT_POSITION_TOP_LEFT
Media Player is positioned at the top left corner of the browser viewport.
MediaPlayerOption.FLOAT_POSITION_TOP_RIGHT
Media Player is positioned at the top right corner of the browser viewport.
{Position}
Media Player is positioned at the specified custom position.
Custom Position
Specifying a Position object allows you to position the Media Player at an individual position.
bottom — Offset in pixels to the bottom edge of the browser viewport.
left — Offset in pixels to the left edge of the browser viewport
right — Offset in pixels to the right edge of the browser viewport
top — Offset in pixels to the top edge of the browser viewport
Position Type Definition
type PlayerPosition = 
  | MediaPlayerOption.FLOAT_POSITION_BOTTOM_LEFT
  | MediaPlayerOption.FLOAT_POSITION_BOTTOM_RIGHT
  | MediaPlayerOption.FLOAT_POSITION_TOP_LEFT
  | MediaPlayerOption.FLOAT_POSITION_TOP_RIGHT
  | Position;

type Position =
  | { bottom: number; left: number }
  | { bottom: number; right: number }
  | { top: number; left: number }
  | { top: number; right: number };
type PlayerPosition = 
  | MediaPlayerOption.FLOAT_POSITION_BOTTOM_LEFT
  | MediaPlayerOption.FLOAT_POSITION_BOTTOM_RIGHT
  | MediaPlayerOption.FLOAT_POSITION_TOP_LEFT
  | MediaPlayerOption.FLOAT_POSITION_TOP_RIGHT
  | Position;

type Position =
  | { bottom: number; left: number }
  | { bottom: number; right: number }
  | { top: number; left: number }
  | { top: number; right: number };
﻿
Please note: When using an individual position for the minified Media Player, although all properties are optional, at least the specification of a horizontal and a vertical position is required.
initialPlayerMode
Indicator, whether the player should be opened in `cover` or `float` mode.
locale
The locale to be utilized for displaying translations, e.g. en-US. If not specified explicitly, translation are displayed according to the visitors browser settings, using en
seekToTimeInMs
The seek-position of the media player to start media playback of the requested media item at.
startTimeInMs only applies to 
socialSharingUrlTemplate
The designated template for generating the URL used in social sharing, with automatic inclusion of media-related parameters.
Supported Parameters
Name
Description
{locale}
The player's locale setting, if defined in the player configuration.
Default value: lsc_locale={locale}
{showId}
The show id, the social sharing option was invoked from.
Default value: lsc_show_id={showId}
{store}
The player's store setting, if defined in the player configuration.
Default value: lsc_store={store}
{storyId}
The story id, the social sharing option was invoked from.
Default value: lsc_story_id={storyId}
store
The store reference, which determines store specific product data to render.
It must match the reference of one of the Stores, specified in the LiSA console.

Value	Description
MediaPlayerOption.FLOAT_POSITION_BOTTOM_LEFT	Media Player is positioned at the bottom left corner of the browser viewport.
MediaPlayerOption.FLOAT_POSITION_BOTTOM_RIGHT	(Default) Media Player is positioned at the bottom right corner of the browser viewport.
MediaPlayerOption.FLOAT_POSITION_TOP_LEFT	Media Player is positioned at the top left corner of the browser viewport.
MediaPlayerOption.FLOAT_POSITION_TOP_RIGHT	Media Player is positioned at the top right corner of the browser viewport.
{Position}	Media Player is positioned at the specified custom position.

Name	Description
{locale}	The player's locale setting, if defined in the player configuration. Default value: lsc_locale={locale}
{showId}	The show id, the social sharing option was invoked from. Default value: lsc_show_id={showId}
{store}	The player's store setting, if defined in the player configuration. Default value: lsc_store={store}
{storyId}	The story id, the social sharing option was invoked from. Default value: lsc_story_id={storyId}

Updated 25 Mar 2024

Did this page help you?

Player Methods

Type Definition