Player integration
- Lucas CORSINI
Analytics
A share or embed url of a given player can be found within the DAM. To control the behavior of this shared or embed player, some parameters can be added to the given url.
List of Supported Parameters:
Parameter | Description | Default Value | Possible Values | Target Component |
|---|---|---|---|---|
autostart | If true, the video or audio will start playing on load. If this option is enabled, the volume will necessarily be muted by browsers. | Value set in mediacloud / player manager config. | true / false | audio / video |
backgroundColor | Changes the background color of the element encapsulating the player. | None | Any CSS3-supported color. | all |
canLogPlaying | If true, sends playback events (play and playfinish) to analytics. | true | true / false | audio / video |
canLogView | If true, sends view events to analytics. | true | true / false | 3D / audio / document / image / video |
chapterCode | Starts the video or audio at a specified chapter (indexed from 1). | None - optional parameter | From 1 to the last chapter | audio / video |
chromeless | If true, disables the player action bar. | Empty (thus false) | true / false | audio / image / video |
dnt | If true, XHR calls for stats (analytics) will have the option withCredentials: false MDN documentation | Empty (thus false) | true / false | 3D / audio / document / image / video |
defaultLanguage | Default language if the browser language is not supported (supported languages = en / fr / de). Impacts the player's interface language. | en | en / fr / de | all |
disableShare | If true, the sharing feature is disabled. | Value set in mediacloud / player manager config. | true / false | 3D / audio / document / image / video |
disableScroll | If true, scrolling is disabled. | false | true / false | document |
enableDownload | Enables or disables the download function in the action bar. | Value set in mediacloud config. | true / false | audio / image / video |
forcedLanguage | Prioritized language regardless of the browser language. Must be a supported language (supported languages = en / fr / de). Impacts the player's interface language. | None | en / fr / de | all |
height | Player height, expressed as an absolute value (converted to pixels) or a relative value (percentage, e.g., 70%25 will result in a height of 70%). | 600 (i.e., 600px) | 0 to infinity | all |
loop | If true, enables looping playback for a video or audio. | Value set in mediacloud / player manager config. | true / false | audio / video |
nomagnifier | If true, disables the magnifier on an image player startup. | Empty (thus false) | true / false | image |
If true, displays the print icon even if the player config says otherwise. | false | true / false | document | |
scale | Determines the initial zoom level of a document player. | page-fit | auto: Automatically adjusts scaling to fit the entire page within the container, considering both height and width. page-actual: Displays the page at its actual size, without scaling. Each unit of the PDF page corresponds to one screen pixel. page-fit: Adjusts scaling so the entire page is visible within the container. The page is scaled to fit both the width and height of the container. page-width: Adjusts scaling so that the page width matches the container width. The page height may exceed the container. page-height: Adjusts scaling so that the page height matches the container height. The page width may exceed the container. | document |
share | Enables or disables asset sharing. Available only via embed code. For integration via /api/wedia/dam/player/, use disableShare. | Value set in mediacloud / player manager config. | true / false | 3D / audio / document / image / video |
skin (or playerUid) | Allows the use of a player other than the default one. | None | A valid player UID. | audio / video |
subtitleLanguage | Enables subtitles when the video starts. The subtitle must exist to be activated. | Empty, so no default subtitle. | Subtitle language code of the video (fi, fr, en, etc.) | audio / video |
timeCode | Starts the video or audio from a specific timecode (expressed in seconds). | None - optional parameter | 0 to the end of the video or audio. | audio / video |
volume | Initial volume when launching a video or audio. Note: If autostart is true, the browser will automatically mute the volume regardless of the requested value. | Value set in mediacloud / player manager config. | 0 to 100 | audio / video |
wediastatEnabled | Enables or disables the WediaStat plugin, which logs actions on the player (play, pause, playfinish, etc.). | Value set in mediacloud config. | true / false | audio / video |
width | Player width, expressed as an absolute value (converted to pixels) or a relative value (percentage, e.g., 70%25 will result in a width of 70%). | 800 (i.e., 800px) | 0 to infinity | all |