A Viewer Preset is a collection of settings that determine how users view rich-media assets on their computer screens and mobile devices. If you are an administrator, you can create Viewer Presets. Settings are available for an array of viewer configuration options. For example, you can change the viewer display size or zoom behavior.

For instructions on creating and customizing your own HTML5 viewer presets, see the Adobe Scene7 HTML5 Viewer SDK available as a download from Adobe Developer Connection.

This section describes how to create, edit, and manage viewer presets. You can apply a viewer preset to an asset anytime you preview it. See Applying Viewer Presets.

Huomautus:

Be aware that editing any predefined, out-of-the-box viewer presets is not a supported scenario. If you attempt to edit an out-of-the-box viewer preset, you are prompted to save the viewer preset using a new name.

Viewer support for responsive designed web pages

Different web pages have different needs. For example, sometimes you want a web page that provides a link that opens the HTML5 Viewer in a separate browser window. In other cases, it may be necessary to embed the HTML5 Viewer directly on the hosting page. In the latter case, the web page may have a static layout. Or, it may be "responsive" and display differently on different devices or for different browser window sizes. To accommodate these needs, all the pre-defined, out-of-the-box HTML5 Viewers that come with Dynamic Media support both static web pages and responsive designed web pages.

Rich Media Types for Viewer Presets

Administrators can add and customize the following rich media types when creating new viewer presets.

Carousel Set

Hotspots, or image maps, or both are added to a series of two or more images. A customer can pan the images left or right and then click a hotspot on an image for additional details or for purchasing directly from a website's category, home, or landing pages.

Flyout Zoom

Displays a second image of the zoomed area next to the original image. There are no controls to use - users move the selection over the area they want to view.

When determining the complete bandwidth usage for this viewer, consider that both the main image and the flyout image are served in the viewer. The main image size (Stage Width and Height) and the Zoom Factor determine the flyout image size. To keep the flyout file size from becoming too large, balance these two values: if you have a large main image size, lower the Zoom Factor value. (The Flyout Width and Flyout Height determine the size of the flyout window, but not the size of the flyout image that is served into the viewer.)

For example, if your main image size is 350 by 350 pixels, with a Zoom Factor of 3, the resulting flyout image is 1050 by 1050 pixels. If your main image size is 300 by 300 pixels, with a Zoom Factor of 4, the flyout image is 1200 by 1200 pixels. Depending on the JPEG quality setting (recommended settings are between 80-90), you can decrease the file size significantly. Recommended zoom factors are 2.5 to 4, depending on the size of your main image.

Inline Zoom

Displays an image of the zoomed area within the original viewer. There are no controls to use. That is, users move the selection over the area they want to view.

Image Set

In the Image Set viewer, users can see different views or color variations of an item by clicking a thumbnail image. This viewer also offers zooming tools for examining images closely.

Interactive Image

Hotspots are added to portions of an image that a customer can then click for additional details or for purchasing directly from a website's category, home, or landing pages.

Interactive Video

Thumbnails are added to timeline segments in a video that a customer can then click for additional details or for purchasing directly from a website's category, home, or landing pages.

Mixed Media

Displays different types of media in one viewer. You can include spin sets, images, and videos.

Panoramic Image

The Panoramic Image and PanoramicVR viewers render spherical panoramic images to immerse users in a 360° viewing experience of a room, property, location, or landscape.

For an uploaded image to qualify as a spherical panorama, it must have either one or both of the following:

An aspect ratio of 2:1.

Tagged with the keywords equirectangular, or spherical and panorama, or spherical and panoramic. See Using Tags.

Both the aspect ratio and keyword criteria apply to panoramic assets for the asset details page and the "Panoramic Media" WCM component.

Spin Set

Provides multiple views of an image so users can turn the object to examine the different sides and angles.

Video

Plays video using adaptive bitrate streaming, which automatically performs device and bandwidth detection to serve the right quality video in the right format.

Vertical Zoom

The Vertical Zoom viewer lets you maximize a product imagery viewing experience to give your users the best representation of a product. The vertical location of swatches does the following:

Ensures swatches are “above the fold”.
With horizontal swatches, depending on the user’s desktop screen size, swatches were not be visible until the user scrolled down the page. By placing the swatches vertically in the viewer, it ensures that they are visible no matter the user's screen size.

Maximizes main image size.
With horizontal swatches, it is necessary to reserve space on the page to ensure that they are visible. This positioning decreased the size of the main image. With a vertical swatch layout, however, you do not need to allocate this space. As such, you can maximize the main image size.

Zoom

Lets users zoom into the area by clicking it. Users can click controls to zoom in, zoom out, and reset the image to its default size.

List of out-of-the-box Viewer Presets

The following table identifies all pre-defined, out-of-box Viewer Presets that come with Dynamic Media.

Navigate to the viewer preset listing node at /libs/dam/gui/coral/content/commons/sidepanels/viewerpresets/viewerpresetslist

In the limit property, change the Value, which is set to 15 by default, to the desired number.

Navigate to the viewer preset datasource at /libs/dam/gui/coral/content/commons/sidepanels/viewerpresets/viewerpresetslist/datasource

In the limit property, change the number to the desired number, for example {empty requestPathInfo.selectors[1] ? "20" : requestPathInfo.selectors[1]}

Tap or click Save All.

Creating a New Viewer Preset

Creating viewer presets lets you apply various settings to view and interact with assets. However, you do not need to create new viewer presets. If you prefer, you can use the default, out-of-the-box viewer presets that already come with AEM Assets.

If you choose to create a new viewer preset, after you save it, the viewer's state is automatically activated (set to On) in the Viewer Presets page. This state means that it is visible in the Dynamic Media component and the Interactive Media component and whenever you preview an image or video.

Some viewer presets have exclusive settings that can affect the use and overall behavior of the viewer. Depending on the viewer preset you are creating, you may want to be aware of these special considerations.

In the Selected Type pull-down menu, select a component whose visual design you want to customize. Alternatively, you can tap or click any visual element in the viewer to select it for configuration.

The visual editor lets you see what effect a certain property has on a style. Just set or adjust any property to instantly see what effect it has on the viewer using the sample to the left of the editor.

The CSS styling properties for each type of viewer preset are described in the "Customizing HTML5..." section of each HTML5 viewer in the Viewers Reference Guide. For example, if you are creating a viewer preset of the type Mixed_Media, see Customizing HTML5 Mixed Media Viewer for a list and description of each property.

If you have defined style settings in a separate CSS file, you can upload the CSS file to AEM Assets. Tap Import CSS below the Selected Type pull-down menu (you may need to scroll the visual editor up to see it) to find the uploaded CSS file and associate it with the viewer preset.

When you import a CSS file, the visual editor checks to see if the CSS uses the correct viewer markers. For example, if you are creating a Zoom viewer, all the CSS rules you import must be defined using its viewer class name .s7mixedmediaviewer defined on a parent viewer element.

You can import arbitrary, handmade CSS as long as it properly defines the viewer markers described in the Viewers Reference Guide. It is possible, however, that the visual editor may not understand some CSS values. In such cases, the visual editor attempts to override the errors so that the CSS can still work.

Huomautus:

If you prefer to edit the CSS directly in its raw form, tap Show/Hide CSS below the Selected Type pull-down menu (you may need to scroll the visual editor up to see it).

Like the visual editor, when you make a change to a property directly in the CSS, you can instantly see what effect it has on the viewer sample. And, that same property is automatically updated at the same time in the visual editor. As such, you can use the raw CSS editor, or the visual editor, or use both interchangeably.

Huomautus:

For button artwork, choose the 2x image and upload high resolution art work. When working with interactive images and shoppable banners, you can also select from a variety of out-of-the-box hotspot buttons.

(Optional) Near the top of the Edit Viewer Preset page, tap Desktop, Tablet, or Phone to uniquely define visual styles for different device and screen types.

On the Edit Viewer Preset page, tap the Behavior tab. Alternatively, you can tap or click any visual element in the viewer to select it for configuration.

From the Selected Type pull-down menu, select a component whose behaviors you want to change.

Many components in the visual editor have a detailed description associated with it. These descriptions appear within blue boxes when you expand a component to reveal its associated parameters.

Some Viewer types have components that let you specify Image Serving commands in an IS Command text field. For a list of commands you can use, see the Image Serving API Reference.

Huomautus:

If you are using a touch device, such as a phone or tablet...

After you type a value in the text field, tap elsewhere in the user interface to submit the change and close the virtual keyboard. If you tap Enter, no action occurs.

Near the upper-right corner of the page, tap Save.

Publish your new viewer preset. You must publish the preset before you can use it on your website.

Special considerations for creating an Interactive Viewer preset

About Display Modes for image thumbnails in the panel

When you create or edit an Interactive Video viewer preset, you have the choice of which Display Mode setting to use when you select InteractiveSwatches from the Selected Component pull-down menu under the Behavior tab. The display mode you choose affects how and when thumbnails appear while the video is playing. You can choose either a segment display mode (default) or a continuous display mode.

Display Mode

Description

Segment

Segment is the default display mode for the out-of-box Interactive Video Viewer presets Shoppable_Video_light and Shoppable_Video_dark and any Interactive Video Viewer presets that you create yourself.

In this mode, when there are fewer thumbnails assigned to a video segment than the number of visible spots in the display panel, thumbnails from the next or previous sub-segments are not pulled in to fill any empty spots in the panel. That is, it preserves the display of swatches that were assigned to the particular video segment.

Continuous

In continuous display mode, if the number of thumbnails in a segment is less than the number that are visible in the panel, the viewer automatically includes the display of thumbnails from the next segment, or the previous segment, in cases where the last thumbnail is displayed.

The auto scroll behavior of thumbnails in the Interactive Video viewer functions independently of the display mode that you chose.

When you create or edit an interactive video viewer preset, you access Auto Scroll from the Behavior tab. In the Behavior tab, from the Selected Components drop-down menu, tap InteractiveSwatches. The Auto Scroll check box is listed below the IS Command text field.

If you disable Auto Scroll (clear the check box) in the viewer preset, during video playback by the user, the panel only displays the first thumbnail image for the entire length of the video. However, a user can manually scroll through the thumbnails using the up and down arrow icons, if desired.

When you enable (select) Auto Scroll in the viewer preset, during video playback, thumbnail images assigned to a video segment scroll into view at the start of a segment. There are instances, however, where certain thumbnails within a segment display twice as long as other thumbnails before or after it. This behavior occurs because the number of thumbnails in a segment is greater than the number that are visible in the panel, and are not evenly divisible.

To illustrate, suppose you have one 30 second video segment. And, there are a total of nine thumbnails to display over the 30 seconds. Your browser is sized in such a way that there are four visible thumbnail positions in the display panel. The 30 second video time segment is divided into three sub-segments. The following table shows the breakdown of which thumbnails are displayed for a given time sub-segment:

Video sub-segment

Sub-segment time in seconds

Thumbnails that are visible in the panel

1

0-10

1, 2, 3, 4

2

10-20

4, 5, 6, 7

3

20-30

6, 7, 8, 9

Video sub-segment 3 does not extend beyond the thumbnails that are assigned to it. Notice also that thumbnails 4, 6, and 7 are visible in the panel twice as long as the other thumbnails.

The logic that the viewer uses for how many thumbnails are displayed in the panel based on the number of available positions is as follows:

Number of sub-segments = round up to next sub-segment (number of thumbnails / number of visible slots in the thumbnail panel, based on browser window size).
Using the example in the table above, 9 thumbnails / 4 slots = 2.25; the viewer logic rounds it up to 3 sub-segments.

Number of thumbnails = round up to next thumbnail (number of thumbnails / number of video sub-segments).
Using the example in the table above, 9 thumbnails / 3 video sub-segments = 3 thumbnails.

Duration of sub-segment = total video duration / number of video sub-segments.
Using the example in the table above, 30 seconds / 3 video sub-segments = 10 second display of each video sub-segment.

Special considerations for creating a Carousel Banner Viewer preset

When creating Carousel Banner viewer presets, changing the style of hotspots can be accessed as follows:

Description

Actions

Hotspot Icon

Change the icon used for hotspot

To change the hotspot icon image, in the Appearance tab, in Selected Component, click or tap ImageMapEffect.Under Icon, select Background and in the Image field navigate to the background image you want.

Activating or Deactivating Viewer Presets

The Viewer Presets that are available in the user interface depends on which one are active. By default, a viewer preset is "On" after you create it. You may want to deactivate viewer presets if the list becomes too crowded or you do not want a viewer preset made available to use.

To activate or deactivate viewer presets:

In the upper-left corner of AEM, tap the AEM logo, then in the left rail, tap Tools (hammer icon) > Assets > Viewer Presets.

On the Viewer Preset page, under the State column header, tap the toggle to activate or deactivate a viewer preset.

Viewer presets that are activated have the toggle appear on the right, inside a blue box; deactivated viewer presets have the toggle appear on the left, inside a light grey box.

Publishing Viewer Presets

Activating (or turning "On") the state of a viewer preset means that it is visible in the Dynamic Media component, the Interactive Media component, and whenever you view an asset.

However, to deliveran asset with a viewer preset, the viewer preset must be published as well. All viewer presets must be activated and published to obtain URL or embed code for an asset. All out-of-the-box viewer presets are auto-activated and auto-published. Custom viewer presets that you create are auto-activated, but must be published.