adobe viewers reference guide

Adobe Experience Cloud

Adobe Viewers Reference Guide

Contents

System requirements.......................................................................................................7

Compatibility notes..........................................................................................................8

Viewer release notes......................................................................................................10Release notes archive....................................................................................................................................................11

Scene7 Viewers 5.5.2 Release Notes..................................................................................................................................................11


Scene7 Viewers 5.2.3 Release Notes .................................................................................................................................................15





Viewers for AEM Assets and Scene7..............................................................................27HTML5 Basic Zoom Viewer..........................................................................................................................................27

Command reference Configuration attributes...........................................................................................................................33

Javascript API reference for Basic Zoom Viewer............................................................................................................................40

Event callbacks...........................................................................................................................................................................................45

Customizing Basic Zoom Viewer.........................................................................................................................................................46

Support for Adobe Analytics tracking...............................................................................................................................................58

Localization of user interface elements............................................................................................................................................59

Full Screen Support..................................................................................................................................................................................60

Viewer SDK namespace..........................................................................................................................................................................60

eCatalog..............................................................................................................................................................................61

Command reference Configuration attributes...........................................................................................................................68

Javascript API reference for eCatalog Viewer.................................................................................................................................90

Event callbacks...........................................................................................................................................................................................98

Customizing eCatalog Viewer..............................................................................................................................................................98

Support for Adobe Analytics tracking............................................................................................................................................196

Adobe Viewers Reference GuideLast updated 1/25/2018

Localization of user interface elements.........................................................................................................................................197

Image map support...............................................................................................................................................................................202

Managing page labels..........................................................................................................................................................................203

Full screen support................................................................................................................................................................................204

Print feature..............................................................................................................................................................................................204

Download..................................................................................................................................................................................................204

Favorites feature.....................................................................................................................................................................................204

Viewer SDK namespace........................................................................................................................................................................205

eCatalog Search.............................................................................................................................................................205

Command reference Configuration attributes........................................................................................................................212

Javascript API reference for eCatalog Search Viewer................................................................................................................237

Event callbacks........................................................................................................................................................................................245

Customizing eCatalog Search Viewer.............................................................................................................................................245



Image map support...............................................................................................................................................................................356

Managing page labels..........................................................................................................................................................................357

Print feature..............................................................................................................................................................................................357


Download..................................................................................................................................................................................................358

Favorites feature.....................................................................................................................................................................................358


Flyout................................................................................................................................................................................359


JavaScript API reference for Flyout Viewer...................................................................................................................................375

Event callbacks........................................................................................................................................................................................381

Customizing Flyout Viewer.................................................................................................................................................................382




Inline Zoom.....................................................................................................................................................................395


JavaScript API reference for Inline Zoom Viewer........................................................................................................................411

Event callbacks........................................................................................................................................................................................417


Contents

Customizing Inline Zoom Viewer.....................................................................................................................................................417




Mixed Media...................................................................................................................................................................429


Javascript API reference for Mixed Media Viewer.......................................................................................................................464

Event callbacks........................................................................................................................................................................................471

Customizing Mixed Media Viewer....................................................................................................................................................472


HTTPS video delivery............................................................................................................................................................................509


Full Screen Support...............................................................................................................................................................................512


HTML5 Spin Viewer......................................................................................................................................................513


Javascript API reference for Spin Viewer.......................................................................................................................................527

Event callbacks........................................................................................................................................................................................533

Customizing Spin Viewer ...................................................................................................................................................................534





Video..................................................................................................................................................................................551


Command reference URL.................................................................................................................................................................569

JavaScript API reference for Video Viewer....................................................................................................................................572

Event callbacks........................................................................................................................................................................................579

Customizing Video Viewer..................................................................................................................................................................579


HTTP video delivery...............................................................................................................................................................................643



External video support.........................................................................................................................................................................648



Zoom.................................................................................................................................................................................649


Javascript API reference for Zoom Viewer....................................................................................................................................667

Event callbacks........................................................................................................................................................................................673

Customizing Zoom Viewer.................................................................................................................................................................674



Full Screen Support...............................................................................................................................................................................692


Viewers for AEM Assets only .......................................................................................694Interactive Images........................................................................................................................................................694



JavaScript API reference for Interactive Image Viewer.............................................................................................................702

Event callbacks........................................................................................................................................................................................707

Customizing Interactive Image Viewer..........................................................................................................................................708

Support for analytics tracking............................................................................................................................................................714

Hotspot support.....................................................................................................................................................................................714

Preload image..........................................................................................................................................................................................715


Interactive Video...........................................................................................................................................................716



JavaScript API reference for Interactive Image Viewer.............................................................................................................742

Event callbacks........................................................................................................................................................................................749

Customizing Interactive Video Viewer...........................................................................................................................................750


HTTPS video delivery............................................................................................................................................................................794

Interactive data support......................................................................................................................................................................796





Contents

Command reference common to all viewers Configuration attributes................800stageSize..........................................................................................................................................................................800

style....................................................................................................................................................................................800

title.....................................................................................................................................................................................801

Command reference common to all viewers URL...................................................802asset...................................................................................................................................................................................802

caption..............................................................................................................................................................................805

config................................................................................................................................................................................806

config2..............................................................................................................................................................................808

contentUrl........................................................................................................................................................................808

initialFrame.....................................................................................................................................................................809

serverUrl...........................................................................................................................................................................809

videoServerUrl...............................................................................................................................................................810

Keyboard accessibility and navigation......................................................................811

Viewer SDK Tutorial.....................................................................................................812


System requirementsSystem requirements for viewers.

Server hardware and software

Scene7 Image Serving 6.3.1 or later. Viewers require SDK JavaScript server-side libraries 3.3.2 or later. "Email a Friend" social features require s7ondemand 4.8.1 or later. eCatalog Viewer Info panel support requires info server 2.1.5 or later. Search feature components require s7search 2.2.0 or later.

Viewers system requirements

Client browser minimum requirements for component viewers

Color monitor and video card that supports 16-bit High Color at 1024x768 resolution or higher. Microsoft Windows 7 or later; Mac OS X 10.9 or later. Firefox 52, Safari 10, Chrome 55 (or latest version; Chrome updates automatically to the latest version), Internet Explorer 9.0

or later, Edge. iOS6 or later. Certified on iPhone 3GS or later, and iPad 2 or later (Safari and Chrome browsers only). Android OS 4.x or later. BlackBerry 10 or later; native browsers only. Video playback is only supported at this time. Internet Explorer on mobile devices is not supported at this time.

Note: FLASH VIEWERS END-OF-LIFEEffective January 31, 2017, Adobe Scene7 Publishing System officially endedsupport for the Flash viewer platform. For more information about this important change, see the following FAQ website:

https://docs.adobe.com/content/docs/en/aem/6-1/administer/integration/marketing-cloud/scene7/flash-eol.html.

7System requirements

https://docs.adobe.com/content/docs/en/aem/6-1/administer/integration/marketing-cloud/scene7/flash-eol.html

Compatibility notesCompatibility notes for operating systems, browsers, and mobile devices.

Blackberry

Incompatibility with older Adaptive Video Sets. You may need to re-upload Adaptive Video Sets to allow playback.

General

Browser side scaling may cause UI and images to become blurry as user zooms into page. UI formatting may also displayincorrectly depending upon zoom. This will carry over to full screen.

Due to the size limitation on mobile devices the Mixed Media Viewer uses slide gesture to swap frames in embedded imagesets instead of tapping the embedded swatches component. Component is there as a visual indicator.

In Internet Explorer browsers and some touch devices, full-screen mode does not occupy the entire device screen. Instead, itresizes the application to the size of the browser window.

Close button does not work under iOS 8.0 and iOS 8.1 but works under iOS 8.2.

Galaxy SIII

Memory leak seen with Zoom and eCatalog viewers. Repeated navigation through frames may cause browser to crash.

Double-tapping on a viewer may cause the entire page to zoom instead of just the viewer with browser-side scaling enabled.

Galaxy S4

Device detected as tablet in portrait mode with Full Screen checked in browser settings.

Galaxy Nexus

Double-tapping on a viewer may cause the entire page to zoom instead of just the viewer, with browser-side scaling enabled.

Galaxy Nexus 10 and Galaxy Tablet

eCatalog shows incorrect page spread with portrait and landscape orientations.

HTC Mobile Devices

Inability to disable native pinch-zoom is a "feature" of HTC UI wrapper (HTC Sense). This feature can cause an entire pageto zoom when using "pinch to zoom" gesture on the viewer. Use a double-tap gesture instead.

Image map icons may overlap if image maps are small and close together.

Video Viewer

Internet Explorer 9 Custom Poster images do not display.

IntialBitRate modifier is only supported with software HLS and flash HDS playback. It does not work when playback isusing the native player.

OGG and WebM progressive playback not supported.

Browser scaling may cause the video player to display at an incorrect size (include Windows OS control panel Display settings).

8Compatibility notes

Video seek using HLS streaming on Safari may be inconsistent.

Internet Explorer

Quirks mode is not supported.

Compatibility mode is not supported.

Internet Explorer on mobile is not supported.

iOS

Large eCatalogs may cause the browser to crash on iPad 2.

Safari

Safari 6.1 or later: Internet Plug-in settings may prevent Flash video playback.

Video seek using HLS streaming on Safari may be inconsistent.

Unable to seek to end of video on Safari 6 using HLS streaming.

9Compatibility notes

Viewer release notes

Adobe Scene7 Viewers

Bug fixes for 5.8.2

User was unable to turn a page using mouse if frametransition=turn. ImageMapEffect.mapTips=1 mouse click was generating a script error on touch-enabled devices.

New features and enhancements for 5.8.1

Keyboard accessibility in Basic Zoom, Flyout, Mixed Media, Spin, Zoom, Video, Carousel, Interactive Image, and InteractiveVideo.

Added video buffering icon to Video viewer, Mixed Media viewer, and Interactive Video viewer. The value native of playback modifier is deprecated; use the new value progressive instead. Added support for HTTPS streaming playback for Dynamic Media video. Added support for inline video playback on iPhone devices. Added support for external video playback to Video viewer. Improved swatches scroll behavior on touch devices. Added support for devices with both mouse and touch input running Internet Explorer 11 and Edge browser. Added ability to specify both left and right page with initialframe parameter in portrait mode on mobile devices in eCatalog

viewer.

Bug fixes for 5.8.1

User was unable to get focus on video controls by way of keyboard tabbing. In eCatalog viewer, single/double page layouts displayed incorrectly on some devices.

Known issues and restrictions for 5.8.2

The Image Serving modifiers from IS commands are not added to the req=set request by design. However, modifiers thatonly affect image display work fine. Modifiers affecting size must be used in a complex asset. For example:

https://s7d9.scene7.com/s7viewers/html5/BasicZoomViewer.html?asset=

{Scene7SharedAssets/Backpack_B?extendn=0.5%252C0.5%252C0.5%252C0.5}

Flyout viewer Internet Explorer 9 sometimes remains onscreen after mouse off. Scaling the browser window leads to incorrect resizing. iPad 2 A large eCatalog asset crashes Safari on iOS.

All viewers

Watermarks, obfuscation, and locking are not supported. Image presets are not supported. Adding or removing viewer from the DOM using display:none CSS or by dynamically detaching it from the parent node

is not supported. Embedding a viewer in a table may result in incorrect sizing or placement of the viewer in non-native full-screen mode. Adobe

recommends using DIVs instead.

10Viewer release notes

Parameters with explicit instance names in the code require instance names in the URL as well to be overwritten (for example,zoomView.iconfeffect=0).

Image Serving command crop is not supported. Close button only works if the viewer is open in a child window. IS commands modifier does not support Image Serving modifiers that affect image size.

eCatalog

Navigating to other HTML page and then returning occasionally causes the viewer to reset back to the first page. Page layout occasionally displays incorrectly after rotating the iOS device. Zooming into the page corrects the layout. Internal links only to left-most page in multi-page spreads. Affects mobile devices in portrait mode. Due to browser limitations, Print feature is not available in Internet Explorer 9.

Mixed Media

Soundtrack play is not supported.

Social

To render thumbnails properly in outgoing email, the serverurl modifier should have an absolute URL.

Video

The poster image may encounter a max size error. You may need to increase the limit setting for Image Serving Publish. Video captions require a company rule set if the hosting HTML page is served from an external server (not a Scene7 server).

Contact technical support for assistance. Analytics tracking may report incorrect play percentage due to buffering. On iPad or Android devices, a black frame may show instead of a poster image. On iPad or Android devices, a black frame may flash onscreen during the loading of the viewer. On iPad devices, black borders are shown on the side of the VideoPlayer component when the background is set to

white/transparent. On iPad, using iOS 7, the last frame of video may be distorted. On Chrome, Firefox, and Internet Explorer browsers, occasional macro blocking may occur during video seek in HLS streaming

mode. The poster image may not show in the Microsoft Edge browser for the first time visitor. When progressive playback is used, the poster image may hide after the video loads in Internet Explorer 9.

Release notes archive

Scene7 Viewers 5.5.2 Release Notes


Bug fixes for 5.5.2

Video failed to play in Internet Explorer 11 on Windows 7. initialframe was not affecting portrait mode on mobile devices for eCatalog.



Added Adobe Marketing Cloud Org ID support to the Adobe Analytics integration. Updated AppMeasurement JavaScript library to version 1.6.1. Search capability now added to the eCatalog viewer. Added HLS streaming video playback as a default video delivery method for the majority of desktop systems. Flash-based HDS

video streaming is still available as an alternative playback option. Added support for both mouse and touch input running under Chrome browser. Microsoft Surface devices fall under this

category however, Microsoft Edge does not work with touch input with 5.5 viewers.

Bug fixes for 5.5.1

Support for right-to-left orientation in eCatalog viewer. tip=0,-1,0 was causing an out-of-range error.


The Image Serving modifiers from IS commands are not added to the req=set request by design. However, modifiers thatonly affect image display work fine. Modifiers affecting size must be used in a complex asset. For example:

https://s7d9.scene7.com/s7viewers/html5/BasicZoomViewer.html?asset=

{Scene7SharedAssets/Backpack_B?extendn=0.5%252C0.5%252C0.5%252C0.5}

Flyout viewer Internet Explorer 9 sometimes remains onscreen after mouse off. Scaling the browser window leads to incorrect resizing. iPad 2 A large eCatalog asset crashes Safari on iOS.

All viewers

Watermarks, obfuscation, and locking are not supported. Image presets are not supported. Adding or removing viewer from the DOM using display:none CSS or by dynamically detaching it from the parent node

is not supported. Embedding a viewer in a table may result in incorrect sizing or placement of the viewer in non-native full-screen mode. Adobe

recommends using DIVs instead. Parameters with explicit instance names in the code require instance names in the URL as well to be overwritten (for example,zoomView.iconfeffect=0).

Image Serving command crop is not supported. Close button only works if the viewer is open in a child window. IS commands modifier does not support Image Serving modifiers that affect image size.

eCatalog viewer

Navigating to other HTML page and then returning occasionally causes the viewer to reset back to the first page. Page layout occasionally displays incorrectly after rotating the iOS device. Zooming into the page corrects the layout. Internal links only to left-most page in multi-page spreads. Affects mobile devices in portrait mode. InitalFrame links only to left-most page in multi-page spreads. Affects mobile devices in portrait mode. Due to browser limitations, Print feature is not available in Internet Explorer 9.

Mixed Media viewer



Social viewer

To render thumbnails properly in outgoing email, the serverurl modifier should have an absolute URL.

Video viewer

The poster image may encounter a max size error. You may need to increase the limit setting for Image Serving Publish. Video captions require a company rule set if the hosting HTML page is served from an external server (not a Scene7 server).

Contact technical support for assistance. Analytics tracking may report incorrect play percentage due to buffering. On iPad or Android devices, a black frame may show instead of a poster image. On iPad or Android devices, a black frame may flash onscreen during the loading of the viewer. On iPad devices, black borders are shown on the side of the VideoPlayer component when the background is set to

white/transparent. On iPad, using iOS 7, the last frame of video may be distorted. On Chrome, Firefox, and Internet Explorer browsers, occasional macro blocking may occur during video seek in HLS streaming

mode. The poster image may not show in the Microsoft Edge browser for the first time visitor. When progressive playback is used, the poster image may hide after the video loads in Internet Explorer 9.



Viewer upgrades are generally backwards compatible. With this release, a viewer change for namespace support was made. Assuch, all out-of-the-box viewer presets were updated to reflect this change. However, if you created your own custom viewerpresets, your viewers may exhibit problems and require updating your CSS based on these known issues:

Video viewer Play/Pause button does not display Replay state.

Video viewer Navigation markers do not display.

BasicZoom, Zoom, and Spin viewers IconEffect does not display or displays SDK default art.

Flyout and Zoom viewers Swatch scroll buttons do not display for large sets.

It is recommended that you test viewers on our staging environment. The following website gives instructions on how you canset up your system to access our staging server:

http://helpx.adobe.com/experience-manager/scene7/kb/base/upgrade-management/testing-scene7-viewers-upgrade.html

After you have set up your computer to access the staging server, you can check your website to test the upgrade. For customersusing out-of-the-box viewers, best practice is for you to test against our standard staging server ands7is1-preview-staging.scene7.com.


Viewer SDK is used in a namespace.

Viewer dispose() API.

Added support for Chrome browser on iOS devices.

Added support for Microsoft Edge browser.



Added "Favorites" feature to eCatalog viewer.

Added support for running a viewer in the container which is hidden with display:none CSS or is detached from the DOM.

Added ability to control horizontal and vertical spin sensitivity and lock the direction of spin.

Viewer uses consolidated JavaScript file for SDK requests.

Bug fixes for 5.4.2

Intermittent pinch-to-zoom non-functional.

Full-screen buttons do not work on Microsoft Edge browser.

Mode attribute on outer container is not reset to standard after leaving full-screen.

Text-align property in parent DIV affecting button placement on toolbar.

Flyout viewer: displaying the upper-left tile when the user scrolls the mouse over the main image.

Combination of "initialFrame, direction" is causing the image map to display incorrectly.

Unable to switch rows with an up/down gesture when a spinset contains only two rows.

Native controls do not work.

Chrome blocking flashproxy video playback.

Zoom viewer and Mixed Media viewer: Swatches have a transparent background in simulated full-screen mode

Viewers: second and subsequent call of init() should be ignored.


The Image Serving modifiers from iscommands are not added to the req=set request by design. Modifiers that only affectimage display work fine. Modifiers affecting size must be used in a complex asset. For example:

https://s7d9.scene7.com/s7viewers/html5/BasicZoomViewer.html?asset= {Scene7SharedAssets/Backpack_B?extendn=0.5%252C0.5%252C0.5%252C0.5}

Flyout Internet Explorer 9 sometimes remains onscreen after mouse off.

ZoomViewer Unable to zoom an image by mouse click (Windows 8, touch screen, Chrome).

Browser scaling leads to wrong resizing.

iPad 2 Big eCatalog asset crashes Safari on iOS.

All Viewers

Watermarks, obfuscation, and locking are not supported.

Image presets are not supported.

Adding or removing viewer from the DOM using display:none CSS or by dynamically detaching it from the parent nodeis not supported.

All viewers

Embedding the viewer in a table may result in incorrect sizing or placement of the viewer in non-native full-screen mode. UseDIVs instead.

Parameters with explicit instance names in the code require instance names in the URL to be overwritten as well. For example,zoomView.iconeffect=0.


Image Serving command crop is not supported.

Close button only works if the viewer is open in a child window.

Iscommands modifier does not support Image Serving modifiers that affect image size.

eCatalog viewer

Navigating to other HTML pages and then returning occasionally causes the viewer to reset back to the first page.

The page layout occasionally displays incorrectly after rotating the iOS device. Zooming into the page corrects the layout.

Internal links only to the leftmost page in multi-page spreads. This issue affects mobile devices in portrait mode.

InitalFrame links only to the leftmost page in multi-page spreads. This issue affects mobile devices in portrait mode.

Due to browser limitations, the Print feature is not available in Internet Explorer 9.

Mixed Media viewer


Social viewer

To render thumbnails properly in outgoing email the serverurl modifier must use an absolute URL.

Video viewer

The poster image may encounter a "max size" error. The user may need to increase the limit setting for Image Serving Publish. Video captions require a company ruleset if they are hosting an HTML page that is served from an external server that is not

a Scene7 server. Contact Adobe technical support for assistance. Analytics tracking may report incorrect Play percentage due to buffering. Black frame instead of poster image may show on iPad or Android devices. Black frame may flash on screen during viewer load on iPad or Android devices. Black borders are shown on side of VideoPlayer component when background is set to white or transparent on iPad devices. The last frame of a video may be distorted on iPad using iOS 7.



Viewer upgrades are backwards compatible and therefore, no changes are necessary to your existing web code. However, it isrecommended that you test the new viewers on our staging environment. The following website gives instructions on how youcan set up your system to access our staging server:



IMPORTANT: The latest version of Firefox now prevents the Adobe Flash plug-in from running on websites by default. If youhave deployed the Scene7 video player that uses the Adobe Flash plug-in on desktop systems, you have the following threeoptions:



Users will see a prompt at the top of the web page they are viewing in Firefox. In the prompt, they can either choose to continueblocking the plug-in or allow the plug-in to run, in which case the video plays as usual.

Set the video player to playback=native mode. Doing so plays the MP4 video progressively.

See VideoPlayer.playback.

Create an OGG version of the video which can be used as a fallback.

Adobe is investigating options to address this issue in Firefox in a future release.


Flyout Viewer incorrectly detects "legacy" sizing in case s7flyoutzoomview has padding.


Added support for Inline Zoom in the Mixed Media Viewer.

Added support for Print, Download, and Favorites in the eCatalog Viewer.

Added ability to retrieve ParameterManager using the getComponent API.

Converted Spin Viewer, Zoom Viewer, Video Viewer, and Flyout Viewer to use sprites for artwork.

Added support for Internet Explorer 11 native full-screen.

Refactored simulated (non-native) full-screen support in Container.

Increased CSS Small Marker size to support larger phones.

Removed CSS size markers for Spin, BasicZoom, Zoom, Spin, and MixedMedia viewers on desktop browsers.

Added support to allow quality configuration of preloaded frames in SpinView.

Bug fixes for 5.2.2

Galaxy S4 Portrait mode: Incorrect CSS size marker when full-screen mode enabled

Internet Explorer 9 and Internet Explorer 10 Zoom works incorrectly if the width property is defined for IMGs in the CSS.

[eCatalog] Image maps are stuck after using Javascript templates for external linking on Internet Explorer 9.




iPad Manual sets fail to display on Chrome browser

Flyout Internet Explorer 9 sometimes remains on-screen after mouse off.



iPad 2 Big eCatalog asset will crash Safari on IOS

All Scene7 viewers





All viewers






CSS style display:none on DIV container is not supported. This includes Jquery hide() method.

eCatalog viewer



Internal links only to the left-most page in multi-page spreads. This issue affects mobile devices in portrait mode.

InitalFrame links only to the left-most page in multi-page spreads. This issue affects mobile devices in portrait mode.


Mixed Media viewer

Sound track play is not supported.

Social viewer


Video viewer

The poster image may encounter "max size" error. The user may need to increase the limit setting for Image Serving Publish. Video captions require a company ruleset if they are hosting an HTML page that is served from an external server that is not

a Scene7 server. Contact Adobe technical support for assistance. Analytics tracking may report incorrect play percentage due to buffering Black frame instead of poster image may show on iPad or Android devices. Black frame may flash on screen during viewer load on iPad or Android devices. Black borders are shown on side of VideoPlayer component when background is set to white or transparent on iPad devices. Last frame of video may be distorted on iPad using iOS 7.







New features and enhancements

Added support for Inline Zoom in the Mixed Media Viewer.

Added support for Print, Download, and Favorites in the eCatalog Viewer.

Added ability to retrieve ParameterManager using the getComponent API.

Converted Spin Viewer, Zoom Viewer, Video Viewer, and Flyout Viewer to use sprites for artwork.

Added support for Internet Explorer 11 native full-screen.

Refactored simulated (non-native) full-screen support in Container.

Increased CSS Small Marker size to support larger phones.

Removed CSS size markers for Spin, BasicZoom, Zoom, Spin, and MixedMedia viewers on desktop browsers.

Added support to allow quality configuration of preloaded frames in SpinView.

Bug fixes

Galaxy S4 Portrait mode: Incorrect CSS size marker when full-screen mode enabled

Internet Explorer 9 and Internet Explorer 10 Zoom works incorrectly if the width property is defined for IMGs in the CSS.

[eCatalog] Image maps are stuck after using Javascript templates for external linking on Internet Explorer 9.

Known issues and restrictions



iPad Manual sets fail to display on Chrome browser

Flyout Internet Explorer 9 sometimes remains on-screen after mouse off.



iPad 2 Big eCatalog asset will crash Safari on IOS



All Scene7 viewers




All viewers






CSS style display:none on DIV container is not supported. This includes Jquery hide() method.

eCatalog viewer



Internal links only to the left-most page in multi-page spreads. This issue affects mobile devices in portrait mode.

InitalFrame links only to the left-most page in multi-page spreads. This issue affects mobile devices in portrait mode.


Mixed Media viewer


Social viewer


Video viewer


a Scene7 server. Contact Adobe technical support for assistance. Analytics tracking may report incorrect play percentage due to buffering Black frame instead of poster image may show on iPad or Android devices. Black frame may flash on screen during viewer load on iPad or Android devices. Black borders are shown on side of VideoPlayer component when background is set to white or transparent on iPad devices. Last frame of video may be distorted on iPad using iOS 7.







New features and enhancements

Updated support for Internet Explorer 11

Changed viewers to use Track requests instead of Page requests for Adobe Analytics tracking

Added support for responsive images using image commands and/or image presets based upon image width

Added support for passing localization text strings to JSON argument of viewers

Added support for native page scrolling in viewer swatches

Improved support for complex assets and image templates to viewers

Added support for table of contents to eCatalog viewer

Added support for image map overlays versus icons to eCatalog

Added support for page turn animation to eCatalog viewer

Added support for native page scrolling in eCatalog

Added support for displaying narrow images using highlightmode modifier to Flyout Viewer

Added support to control upscaling of images using zoomfactor modifier to Flyout Viewer

Added support for tracking events generated by Flyout Viewer

Added caption support for video (first video only) to MixedMedia viewer

Increased initial bitrate default to 1400 for Video and MixedMedia viewers

Added support for looping video playback to Video viewer

Added support for navigation chapters to Video viewer

Bug fixes

eCatalog Viewer not displaying PageIndicator on iPhone

Images fail to display if Image Serving modifier with comma is appended to asset ID

Imagesets: Image Serving modifiers appended to assetID are ignored

Internet Explorer 9: s7sdk.event: PageMouseEvent: click and double-click events triggers crash browser page

Internet Explorer 9 and Internet Explorer 10: eCatalog viewer breaks after activating image map with JavaScript template

MixedMedia viewer: Zoom button states not reset when swapping asset types



MixedMedia viewer: Viewer collapsed in responsive mode if first asset is 2dspinset

Firefox: Broken image icons briefly displayed on flyout until tile(s) are loaded

Pinch gestures do not generate zoom

eCatalog: Imagemaps: JavaScript error occurring with relative links


All Scene7 viewers



All viewers

Embedding viewer in table may result in incorrect sizing or placement of viewer in non-native fullscreen mode. Suggest usingDIVs instead.

Parameters with explicit instance names in the code must be overwritten; instance names in a URL must also be overwritten.For example, zoomView.iconeffect=0.

Image Serving command crop is not supported. Close button only works if the viewer is open in a child window. Iscommands modifier does not support Image Serving modifiers that affect image size. CSS style "display: none" on DIV container is not supported at this time. This includes Jquery hide() method.

eCatalog viewer

Navigating to another HTML page and then returning occasionally causes the viewer to reset back to the first page. Page layout occasionally displays incorrectly after rotating the iOS device. Zoom into page corrects layout. Internal links only to leftmost page in multi-page spreads. Affects mobile devices in portrait mode. InitalFrame links only to leftmost page in multi-page spreads. Affects mobile devices in portrait mode.

Mixed Media viewer


Social viewer

To render thumbnails properly in outgoing email the serverurl modifier should have an absolute URL.

Video viewer


a Scene7 server. Contact Adobe technical support for assistance. Analytics tracking may report incorrect play percentage due to buffering Black frame instead of poster image may show on iPad or Android devices. Black frame may flash on screen during viewer load on iPad or Android devices. Black borders are shown on side of VideoPlayer component when background is set to white/transparent on iPad devices. Last frame of video may be distorted on iPad using iOS 7.







New features and changes

The following were updated:

Minimum system requirement for Windows operating system is now Windows 7. Minimum system requirement for Internet Explorer is now version 9. Minimum system requirement for Mac OS is now Mac OS 10.8. Minimum system requirement for Safari is now version 6.

The following were refactored:

viewers to support responsive design. viewers to use CSS input and size markers to control display on desktop and mobile devices.

The following is now supported:

Adobe Analytics video reports to Video Viewer and Mixed Media Viewer. Event tracking of multiple viewers on the same page. Added SetIndicator to Video Viewer and Mixed Media Viewer to visually represent swatches on mobile devices. Added SetIndicator to MixedMediaViewer to visually represent swatches on mobile. Added getComponent API to allow external access to viewer components. viewers for configuration parameters to be passed as a single JSON object. WebVTT captions to be passed as JSON object, eliminating the need for ruleset configuration. JavaScript templates in eCatalog Viewer for linking image maps to external pages. Linking to pages within the eCatalog Viewer. stagesize to Flyout Viewer. initComplete handler to viewers for triggering functions after viewers. Analytics handler to viewers for supporting third-party tracking. Added "Select All" button to make it easier to obtain Link and Embed Code for social sharing. FlyoutZoomView for resize method. FlyoutZoomView for setting image reload breakpoints when used for responsive design. Added click support for adjusting volume. SpinView and ZoomView to apply gestures to embedding web page when not interacting with viewer. Added unload() API to SpinView and ZoomView to allow disposing of the component at runtime.



The Video Viewer to apply gestures to the embedding web page when not interacting with viewer. The ZoomView for initial zoom region. ZoomView to hide IconEffect component when zoom is not possible

The following bugs were fixed:

Potential Flash Fastzoom and Flyout viewers security issues. viewers not loading due to unrecognized UserAgent. eCatalog Viewer mouse drag-and-drop not working in Internet Explorer with page containing image maps. Video Viewer prevents access to unblock Flash plug-in. viewers prevent printing on Firefox browser. Video Viewer displays a slight jitter when initiating or resetting zoom. HTTPS support for HTML5 and AS3 viewers.

The following were removed:

Social features displaying in full screen mode on viewers. Close button displaying in full screen mode on viewers.


All Scene7 viewers


All viewers

Embedding viewer in table may result in incorrect sizing or placement of viewer in non-native fullscreen mode. Suggest usingDIVs instead.


Image Serving command crop is not supported. Close button only works if the viewer is open in a child window.

Adobe Analytics Training

When using Scene7 viewers with Adobe Analytics tracking based on s_code.jsp, "page" requests are sent rather than "trackrequests for all tracked events. This results in over-inflated page view metrics for pages that contain a Scene7 viewer. To fixthis issue, copy the contents of AppMeasurementBridge.jsp to a Javascript file to be served with the viewer page. In the resultantJavascript replace all calls to s.t() with s.tl() for all events other than LOAD event. This issue does not impact Scene7 videoviewers using the new Adobe Analytics Video Heartbeat reporting.

Internet Explorer: "Access is denied" JavaScript error occurs using SSL / HTTPS with Adobe Analytics tracking enabled.

eCatalog viewer

JavaScript templates in image maps are not supported. Navigating to another HTML page and then returning occasionally causes the viewer to reset back to the first page. Set ImageMapEffect rollover modifier to 1 to invoke infopanels. Frametransition set to none or fade is not supported. Page layout occasionally displays incorrectly after rotating the iOS device. Zoom into page corrects layout. Internal links only to leftmost page in multi-page spreads. Affects mobile devices in portrait mode. InitalFrame links only to leftmost page in multi-page spreads. Affects mobile devices in portrait mode.


Mixed Media viewer

Sound track play is not supported at this time.

Social viewer


Video viewer


a Scene7 server. Contact Adobe technical support for assistance. Analytics tracking may report incorrect play percentage due to buffering Black frame instead of poster image may show on iPad or Android devices. Black frame may flash on screen during viewer load on iPad or Android devices. Black borders are shown on side of VideoPlayer component when background is set to white/transparent on iPad devices. Last frame of video may be distorted on iPad using iOS 7.


Enhancements, bug fixes, and known issues in Scene7 Viewers 4.9.2

Enhancements in Scene7 Viewers 4.9.2

Viewer upgrades are backwards compatible and therefore, no changes are necessary to your existing web code. However, it isrecommended that you test the new viewers on our staging environment. Contact Technical Support for instructions on howto access the staging server so you can test your viewers. After this is done, you can check your website to test the upgrades.

Increased minimum requirements for viewers to iOS6. Added support for custom event tracking to viewers. Added support to set the initial bit rate for Video viewer. Video viewer now defaults to use HLS streaming on Safari desktop. Refactored tooltips to address various bugs. Removed social feature restrictions on Video and eCatalog viewers from mobile devices.

Bug fixes in Scene7 Viewers 4.9.2

The following bugs are now fixed:

viewers were displaying at the incorrect size after returning from full-screen and swapping assets. viewers were displaying close button in Full-screen mode. eCatalog viewer were not displaying image maps in portrait mode on mobile devices. eCatalog viewer was displaying pan buttons on mobile phones. eCatalog viewer default tool tips did not apply if the container id is not "ecatalog". eCatalog viewer Tooltips were hidden behind thumbnails in grid view. eCatalog viewer was displaying a page divider for single page. eCatalog viewer image maps failed to function on IE9. Mixed Media viewer was resetting the video scrubber position after resizing the viewer. Mixed Media viewer was using the incorrect art for spin pan buttons. Mixed Media viewer video was showing tooltips under mixed media swatches.


HTMl5 Mixed Media viewer spin buttons were displaying on tablet devices. Spin and Zoom viewer tooltips were clipped by edge in embedded viewer. Social Share tooltip position was displaced for the social buttons. Social Share tooltips format were not matching viewer tooltips. Tooltips did not display in full-screen mode on Mac OS with Safari 5. Video viewer incorrect size occurred for progressbar when rotating iPad and switching between screen modes. Video viewer was generating console logs by default.

Known issues in Scene7 Viewers 4.9.2

All Scene7 viewers


All viewers


Image Serving command crop is not supported. Close button only works if the viewer is open in a child window. To customize the tooltip format you add !IMPORTANT to the CSS declaration.

eCatalog viewer

JavaScript templates in image maps are not supported. Navigating to another HTML page and then returning occasionally causes the viewer to reset back to the first page. Set ImageMapEffect rollover modifier to 1 to invoke infopanels. Frametransition set to none or fade is not supported. Page layout occasionally displays incorrectly after rotating the iOS device. Zoom into page corrects layout.

Mixed Media viewer

Sound track play is not supported at this time.

Social viewer


Video viewer


a Scene7 server. Contact Adobe technical support for assistance.

Flash AS3all viewers

Double encode the # character in asset names. Server Support fails to load SWF animations with embedded videos. Server Support fails to load viewer skins if compiled for Flash Player 6. Workaround is to compile for Flash Player 7. Macintosh OS and Flash Player version 10,0,32,18: Workaround depends on a JavaScript bridge instead of a LocalConnection

to communicate between Flex and Flash. So, the Flex application must be imbedded in the HTML wrapper. Currently the Flash Viewers support SWFs complied for Flash 7 only.


Because of an issue with Java v.1.5.0_06 the server component is not supported with that version of Java.http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6274990.

For a skin custom URL parameter, the parameter in the Skin URL must be URL encoded. Image Sets with extended ASCII characters in the name must be URL encoded twice when sent to the viewer or the FVCTX

request fails because the Flash player decodes the name before passing it to the viewer code. If the embedding HTML page has significant content after the viewer, it is possible that the viewer may call a JavaScript function

before the page is fully loaded. This may abort page loading. A suggested workaround is to use an onLoad event handler todelay initializing the viewer until after the page load is complete.

The changes to the S7Config.setFlashParam() allow for more than one parameter/value to be passed with this syntaxS7Config.setFlashParam(, , [, ,

]), but in that case the first parameter to be passed must be the "image" parameter followed by the"currentFrame" parameter (if required), and then any other parameters.

When using the skipFrames=frameList parameter to omit images, the viewer returns an error if an omitted frame is calleddirectly either by the JavaScript change image function, InitialFrame, or in the case of a RenderSet that has two or moreswatches associated with an image - when the swatch combination referencing the omitted frame is selected.

Crop is not supported in conjunction with zoom targets or swatches in either the image= or modifier= arguments. The rgn argument is not supported for the flash viewers for image modifier. A new IE security patch requires the user to activate Flash and other ActiveX applications in IE. Please see the Microsoft site

for information about workarounds. Security issues prevent the viewer from reading from a different server on the same domain unless both URLs are fully qualified

domain names or the "cross domain policy" is specifically set to allow access from that server. With Flash 7's new security features, if the viewers attempt to read from a different server on the same domain from where

the viewers are located (that is, they are redirected by the paths in the infoServerUrl, searchEngineUrl, or the serverUrlparameters) a security alert notifies the user of this fact and asks if you want to allow this, unless the "cross domain policy"is set to allow access from that server.

For more information on how to set up a "cross domain policy" see the following article:http://kb2.adobe.com/cps/142/tn_14213.html.

Exception error generated when viewer is embedded in HTTPS page. Issue is due to communication with server logging. Formore information: http://helpx.adobe.com/flash-player/kb/flash-player-issues-secure-sockets.html


http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6274990http://kb2.adobe.com/cps/142/tn_14213.htmlhttp://helpx.adobe.com/flash-player/kb/flash-player-issues-secure-sockets.html

Viewers for AEM Assets and Scene7The following viewers work under Adobe Experience Manager Assets and also under Scene7 Publishing System.

Basic Zoom

Basic Zoom Viewer is an image viewer that displays a single zoomable image. It has zoom tools, full screen support, and anoptional close button. This viewer is the most lightweight. It is designed to work on desktops and mobile devices.

Viewer type 501.

See System requirements.

Demo URL

https://s7d9.scene7.com/s7viewers/html5/BasicZoomViewer.html?asset=Scene7SharedAssets/Backpack_B

Using Basic Zoom Viewer

Basic Zoom Viewer represents a main JavaScript file and a set of helper files (a single JavaScript include with all the Viewer SDKcomponents used by this particular viewer, assets, CSS) that the viewers downloads at runtime.

You can use Basic Zoom Viewer in pop-up mode using a production-ready HTML page provided with IS-Viewers or in embeddedmode, where it is integrated into target web page using documented API.

Configuration and skinning are similar to that of the other viewers. All skinning is achieved by way of custom CSS.

See Command reference common to all viewers Configuration attributes and Command reference common to all Viewers URL

Interacting with Basic Zoom Viewer

Basic Zoom Viewer supports the following touch gestures that are common in other mobile applications.

When the viewer cannot process a user's swipe gesture it forwards the event to the web browser to perform a native page scroll.This kind of functionality lets the user navigate through the page even if the viewer occupies most of the device's screen area.

DescriptionGesture

Hides or reveals user interface elements.Single tap

Zooms in one level until maximum magnification is reached. The next doubletap gesture resets the viewer to the initial viewing state.

Double tap

Zooms in or out.Pinch

If the image is in a reset state, the gesture performs a native page scroll.Swipe

When the image is zoomed in, it moves the image. If the image is moved to theview edge and a swipe is performed in that direction, the gesture performs a nativepage scroll.

27Viewers for AEM Assets and Scene7

https://s7d9.scene7.com/s7viewers/html5/BasicZoomViewer.html?asset=Scene7SharedAssets/Backpack_B

The viewer also supports both touch input and mouse input on Windows devices with touch screen and mouse. This support,however, is limited to Chrome, Internet Explorer 11, and Edge web browsers only.

This viewer is fully keyboard accessible.

See Keyboard accessibility and navigation.

Embedding Basic Zoom Viewer

Different web pages have different needs for viewer behavior. Sometimes a web page provides a link that, when clicked, opensthe viewer in a separate browser window. In other cases, it is necessary to embed the viewer right in the hosting page. In thelatter case, the web page may have a static page layout, or use responsive design that displays differently on different devices orfor different browser window sizes. To accommodate these needs, the viewer supports three primary operation modes: pop-up,fixed size embedding, and responsive design embedding.

About pop-up mode

In pop-up mode, the viewer is opened in a separate web browser window or tab. It takes the entire browser window area andadjusts in case the browser is resized or the device orientation is changed.

Pop-up mode is the most common for mobile devices. The web page loads the viewer using the window.open() JavaScriptcall, properly configured A HTML element, or any other suitable method.

It is recommended that you use an out-of-the-box HTML page for pop-up operation mode. In this case, it is calledBasicZoomViewer.html and is located within the html5/ subfolder of your standard IS-Viewers deployment:

/html5/BasicZoomViewer.html

You can achieve visual customization by applying custom CSS.

The following is an example of HTML code that opens the viewer in a new window:

Open popup viewer

About fixed size embedding mode and responsive design embedding mode

In the embedded mode, the viewer is added to the existing web page, which may already have some customer content not relatedto the viewer. The viewer normally occupies only a part of a web page's real estate.

The primary use cases are web pages oriented for desktops or tablet devices, and also responsive designed pages that adjustlayout automatically depending on the device type.

Fixed size embedding is used when the viewer does not change its size after initial load. This is the best choice for web pagesthat have a static layout.

Responsive design embedding assumes that the viewer may need to resize at runtime in response to the size change of its containerDIV. The most common use case is adding a viewer to a web page that uses a flexible page layout.

In responsive design embedding mode, the viewer behaves differently depending on the way web page sizes its container DIV.If the web page sets only the width of the container DIV, leaving its height unrestricted, the viewer automatically chooses itsheight according to the aspect ratio of the asset that is used. This functionality ensures that the asset fits perfectly into the viewwithout any padding on the sides. This use case is the most common for web pages using responsive web design layout frameworkslike Bootstrap, Foundation, and so on.


Otherwise, if the web page sets both the width and the height for the viewer's container DIV, the viewer fills just that area andfollows the size that the web page layout provides. A good example is embedding the viewer into a modal overlay, where theoverlay is sized according to web browser window size.

Fixed size embedding

You add the viewer to a web page by doing the following:

1. Adding the viewer JavaScript file to your web page.

2. Defining the container DIV.

3. Setting the viewer size.

4. Creating and initializing the viewer.


Creating a viewer requires that you add a script tag in the HTML head. Before you can use the viewer API, be sure that youinclude BasicZoomViewer.js. The BasicZoomViewer.js file is located under the html5/js/ subfolder of yourstandard IS-Viewers deployment:

/html5/js/BasicZoomViewer.js

You can use a relative path if the viewer is deployed on one of the Adobe Scene7 servers and it is served from the samedomain. Otherwise, you specify a full path to one of Adobe Scene7 servers that have the IS-Viewers installed.

The relative path looks like the following:

Note: You should only reference the main viewer JavaScript include file on your page. You should not reference anyadditional JavaScript files in the web page code which might be downloaded by the viewer's logic in runtime. In particular,do not directly reference HTML5 SDK Utils.js library loaded by the viewer from /s7viewers context path (so-calledconsolidated SDK include). The reason is that the location of Utils.js or similar runtime viewer libraries is fullymanaged by the viewer's logic and the location changes between viewer releases. Adobe does not keep older versions ofsecondary viewer includes on the server.

As a result, putting a direct reference to any secondary JavaScript include used by the viewer on the page breaks theviewer functionality in the future when a new product version is deployed.


Add an empty DIV element to the page where you want the viewer to appear. The DIV element must have its ID definedbecause this ID is passed later to the viewer API. The DIV has its size specified through CSS.

The placeholder DIV is a positioned element, meaning that the position CSS property is set to relative or absolute.

The following is an example of a defined placeholder DIV element:

3. Setting the viewer size

You can set the static size for the viewer by either declaring it for .s7basiczoomviewer top-level CSS class in absoluteunits, or by using stagesize modifier.


You can put sizing in CSS directly on the HTML page, or in a custom viewer CSS file, which is then later assigned to a viewerpreset record in Scene7 Publishing System, or passed explicitly using a style command.

See Customizing Basic Zoom Viewer for more information about styling the viewer with CSS.

The following is an example of defining a static viewer size in HTML page:

#s7viewer.s7basiczoomviewer { width: 640px; height: 480px;}

You can set the stagesize modifier either in the viewer preset record in Scene7 Publishing System, or pass it explicitlywith the viewer initialization code with params collection, or as an API call as described in the Command Reference section,like the following:

basicZoomViewer.setParam("stagesize", "640,480");

A CSS-based approach is recommended and is used in this example.


When you have completed the steps above, you create an instance of s7viewers.BasicZoomViewer class, pass allconfiguration information to its constructor, and call init() method on a viewer instance. Configuration information ispassed to the constructor as a JSON object. At minimum, this object should have containerId field which holds the name ofviewer container ID and nested params JSON object with configuration parameters supported by the viewer. In thiscase, the params object must have at least the Image Serving URL passed as serverUrl property, and the initial asset asasset parameter. The JSON-based initialization API lets you create and start the viewer with a single line of code.

It is important to have the viewer container added to the DOM so that the viewer code can find the container element by itsID. Some browsers delay building DOM until the end of the web page. For maximum compatibility, call the init() methodjust before the closing BODY tag, or on the body onload() event.

At the same time, the container element should not necessarily be part of the web page layout just yet. For example, it maybe hidden using display:none style assigned to it. In this case, the viewer delays its initialization process until the momentwhen the web page brings the container element back to the layout. When this occurs, the viewer load resumes automatically.

The following is an example of creating a viewer instance, passing minimum necessary configuration options to the constructorand calling the init() method. The example assumes basicZoomViewer is the viewer instance; s7viewer is the nameof placeholder DIV; http://s7d1.scene7.com/is/image/ is the Image Serving URL, andScene7SharedAssets/Backpack_B is the asset:

var basicZoomViewer = new s7viewers.BasicZoomViewer({ "containerId":"s7viewer","params":{ "asset":"Scene7SharedAssets/Backpack_B", "serverurl":"http://s7d1.scene7.com/is/image/"}}).init();

The following code is a complete example of a trivial web page that embeds the Basic Zoom Viewer with a fixed size:

#s7viewer.s7basiczoomviewer { width: 640px;


height: 480px;}

var basicZoomViewer = new s7viewers.BasicZoomViewer({ "containerId":"s7viewer", "params":{ "asset":"Scene7SharedAssets/Backpack_B", "serverurl":"http://s7d1.scene7.com/is/image/"}}).init();

Responsive design embedding with unrestricted height

With responsive design embedding, the web page normally has some kind of flexible layout in place that dictates the runtimesize of the viewer's container DIV. For the following example, assume that the web page allows the viewer's container DIV totake 40% of the web browser window size, leaving its height unrestricted. The web page HTML code would look like the following:

.holder { width: 40%;}

Adding the viewer to such a page is similar to the steps for fixed size embedding. The only difference is that you do not need toexplicitly define the viewer size.




All the steps above are the same as with the fixed size embedding. Add the container DIV to the existing "holder" DIV. Thefollowing

adobe viewers reference guide

Documents