DocumentationAEM as a Cloud ServiceUser Guide

Manage viewer presets managing-viewer-presets

Last update: Thu Feb 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

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.

See also the Dynamic Media Viewers Reference Guide.

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 Apply Viewer Presets.

NOTE
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.

Keyboard accessibility for viewers keyboard-accessibility-for-viewers

All out-of-the-box viewers support keyboard accessibility.

See also Keyboard accessibility and navigation.

Manage viewer presets managing-viewer-presets-1

You can add, edit, delete, publish, unpublish, and preview viewer presets in Adobe Experience Manager by navigating to Tools (hammer icon) > Assets > Viewer Presets.

6_5_tools-assets-viewerpresets

NOTE
By default, the system shows 15 viewer presets when you select Viewers in an asset’s detail view. You can increase this limit. See Increase the number of viewer presets that display.

Viewer support for responsive-designed web pages 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 is necessary to embed the HTML5 Viewer directly on the hosting page. In the latter case, the web page has a static layout. Or, it is “responsive” and displays 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.

See Responsive Static Image library in the Dynamic Media Image Serving and Rendering API Help for more information on how to embed responsive viewers onto your web pages.

NOTE
Publish all out-of-the-box viewers before you use them for the first them.
See Publish Viewer Presets.

Viewer Preset system compatibility viewer-preset-system-compatibility

All out-of-the-box Viewer Presets that come with Dynamic Media are fully compatible with the following systems:

  • Desktops
  • Apple iPhone
  • Apple iPad
  • Android™ Smartphone
  • Android™ Tablet

Rich media types for Viewer Presets rich-media-types-for-viewer-presets

Administrators can add and customize the following rich media types when creating 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 select a hotspot on an image for more details or for purchasing directly from a website's landing, category, or home pages.
Dimensional
Displays 3D scenes that let you turn, pan, zoom, or recenter your camera.
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 selecting 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 select for more details or for purchasing directly from a website's landing, category, or home pages.
Interactive Video
Thumbnails are added to timeline segments in a video that a customer can then select for more details or for purchasing directly from a website's landing, category, or home pages.
Mixed Media
Displays different types of media in one viewer. You can include spin sets, image set, 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.

Smart Crop Video
Use this viewer to automatically detect and crop to the focal point in any video.
Spin Set
Provides multiple views of an image so users can turn the object to examine the different sides and angles.
360 Video

Use the 360/VR Video viewer to render equirectangular video for an immersive viewing experience of a room, property, location, landscape, or medical procedure.

During playback on a flat display, the user has control of the viewing angle. Playback on mobile devices uses their built-in gyroscopic controls.

The viewer includes native support for the delivery of 360 video assets. By default, no additional configuration is necessary for viewing or playback. You deliver 360 Video using standard video extensions such as .mp4, .mkv, and .mov. The most common codec is H.264.

Video
Plays video using progressive or adaptive bitrate streaming. Adaptive bitrate streaming 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 that swatches are "above the fold".
    With horizontal swatches, depending on the user's desktop screen size, swatches are not 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 selecting it. Users can select controls to zoom in, zoom out, and reset the image to its default size.

List of out-of-the-box Viewer Presets 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.

See also Live Demos.

For information about supported web browser and operating system versions for Viewers, you can review the Viewers Release Notes.

See “Viewers release notes” in the table of contents of the Viewers Reference Guide.

NOTE
All out-of-the-box viewer presets in Dynamic Media come activated (on), but you must publish them.
See Publish viewer presets.
Any new viewer presets that you create and add must be both activated *and *published.
See Activate or Deactivate viewer presets and Publishing viewer presets.
Viewer preset title
Type
CSS file name
Carousel_Dotted_dark
Carousel_Set
html5_carouselviewer_dotted_dark.css
Carousel_Dotted_light
Carousel_Set
html5_carouselviewer_dotted_light.css
Carousel_Numeric_dark
Carousel_Set
html5_carouselviewer_numeric_dark.css
Carousel_Numeric_light
Carousel_Set
html5_carouselviewer_numeric_light.css
Flyout
Flyout_Zoom
html5_flyoutviewer.css
ImageSet_dark
Image Set
html5_zoomviewer_dark.css
ImageSet_light
Image Set
html5_zoomviewer_light.css
InlineMixedMedia_dark
Mixed_Media
html5_inlinemixedmediaviewer_dark.css
InlineMixedMedia_light
Mixed_Media
html5_inlinemixedmediaviewer_light.css
InlineZoom
Flyout_Zoom
html5_inlinezoomviewer.css
MixedMedia_dark
Mixed_Media
html5_mixedmediaviewer_dark.css
MixedMedia_light
Mixed_Media
html5_mixedmediaviewer_light.css
PanoramicImage
Panoramic_Image
html5_panoramicimage.css
PanoramicImageVR
Panoramic_Image
html5_panoramicimage.css
Shoppable_Banner
Interactive_Image
html5_interactiveimage.css
Shoppable_Video_dark
Interactive_Video
html5_interactivevideoviewer_dark.css
Shoppable_Video_light
Interactive_Video
html5_interactivevideovewer_light.css
SpinSet_dark
Spin_Set
html5_spinviewer_dark.css
SpinSet_light
Spin_Set
html5_spinviewer_light.css

Video

(Includes support for closed captioning)

Video
html5_videoviewer.css

Video360_social

(Includes basic video playback controls, video rendering is done in stereo mode, manual point-of-view control is off but gyroscopic control is on, and no social media features)

Video_360
html5_video360viewersocial.css

Video360VR

(Designed for end users who use virtual reality glasses. Includes basic video playback controls and social media features)

Video_360
html5_video360viewer.css

Video_social

(Includes support for closed captioning and social media)

Video
html5_videoviewersocial.css
Zoom_dark
Zoom
html5_basiczoomviewer_dark.css
Zoom_light
Zoom
html5_basiczoomviewer_light.css
ZoomVertical_dark
Vertical_Zoom
html5_zoomverticalviewer_dark.css
ZoomVertical_light
Vertical_Zoom
html5_zoomverticalviewer_light.css

Supported mobile viewers gestures matrix supported-mobile-viewers-gestures-matrix

The following table identifies the mobile viewer gestures that are supported on iOS, Android™ 2.x, and Android™ 3.x devices.

Gesture
Flyout Zoom
Zoom
Spin
Drag
Pans
Pans
Pans
Select
Shows flyout window
Shows or hides the user interface
Shows or hides the user interface
Double-select
Does not apply
Zooms in or resets
Zooms in or resets
Pinch open
Does not apply
Zooms in (iOS and Android™ 3x only)
Zooms in (iOS and Android™ 3x only)
Pinch close
Does not apply
Zooms out (iOS and Android™ 3x only)
Zooms out (iOS and Android™ 3x only)
Swipe
Scrolls swatch bar
Scrolls images
Spins
Flick
Scrolls swatch bar
Scrolls images
Spins

Increase the number of viewer presets that are displayed increasing-the-number-of-viewer-presets-that-display

Experience Manager shows a wide variety of viewer presets when viewing assets from Detail View > Viewers. You can increase or decrease the number of viewers that display.

To increase the number of viewer presets that are displayed:

  1. Navigate to CRXDE Lite (https://localhost:4502/crx/de).

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

    chlimage_1-221

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

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

    chlimage_1-222

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

  6. Select Save All.

Create viewer presets 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 viewer presets. If you prefer, you can use the default, out-of-the-box viewer presets that already come with Experience Manager Assets.

If you choose to create a 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 create, you want to be aware of these special considerations.

See Special considerations for creating an Interactive Viewer preset.

See Special considerations for creating a Carousel Banner Viewer preset.

To create viewer presets:

  1. In the upper-left corner of Experience Manager, select the Experience Manager logo, then in the left rail, go to Tools (hammer icon) > Assets > Viewer Presets.

    6_5_viewerpresets

  2. On the Viewer Presets page, on the toolbar, select Create.

  3. In the New Viewer Preset dialog box, in the Preset Name field, enter the name of the new preset. Choose a name carefully—they are not editable after you select Create.

    When you save the preset later in these steps, the name appears on the Viewer Presets page under the Preset Title column header.

  4. On the Rich Media Type drop-down menu, select the type of viewer preset you want to create, then in the upper-right corner of the page, select Create.

    See Rich Media Types for Viewer Presets.

  5. On the Viewer Preset Editor page, select the Appearance tab.

  6. Do one of the following:

    • In the Selected Type pull-down menu, select a component whose visual design you want to customize. Alternatively, you can select 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. 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 <viewer name> Viewer” Help topic in the Viewers Reference Guide. For example, if you are creating a viewer preset of the type Mixed_Media, see Customize 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 Experience Manager Assets. To find the uploaded CSS file and associate it with the viewer preset, select Import CSS below the Selected Type pull-down menu (if necessary, scroll the visual editor up to see it).

      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 CSS markers for a given viewer. (CSS markers are described in any “Customzing <viewer name> Viewer” Help topic in the Viewers Reference Guide. For example, if you want to read about CSS markers for the Zoom Viewer, see Customizing Zoom Viewer.) It is possible, however, that the visual editor does not understand some CSS values. In such cases, the visual editor attempts to override the errors so that the CSS can still work.

    note note
    NOTE
    If you prefer to edit the CSS directly in its raw form, select Show/Hide CSS below the Selected Type pull-down menu (if necessary, scroll the visual editor up to see it).
    Like the visual editor, when you change 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.
    note note
    NOTE
    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 various out-of-the-box hotspot buttons.

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

  8. On the Viewer Preset Editor page, select the Behavior tab. Alternatively, you can select any visual element in the viewer to select it for configuration.
    For example, for the VideoPlayer type, under Modifiers > Playback, you can select from one of three adaptive bitrate streaming options:

    • dash - Videos stream as DASH only. However, on Safari/iOS devices, you must select hls as the type, instead.

    • hls - Videos stream as HLS only.

    • auto - Best practice. The creation of DASH and HLS streams is storage optimized. Therefore, Adobe recommends that you always select auto as the playback type. Videos stream as dash, hls, or progressive, as in the following:

      • If the browser supports DASH, then DASH streaming is used, first.
      • If the browser does not support DASH, then HLS streaming is used, second.
      • If the browser does not support either DASH or HLS, then progressive playback is used, lastly.
    note note
    NOTE
    To see and use the dash option, it must first be enabled by Adobe Technical Support on your account. See Enable DASH on your account.

  9. 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.

    note note
    NOTE
    If you are using a touch device, such as a phone or tablet…
    After you type a value in the text field, select elsewhere in the user interface to submit the change and close the virtual keyboard. If you select Enter, no action occurs.

  10. Near the upper-right corner of the page, select Save.

  11. Publish your new viewer preset. It is necessary to publish the preset so you can use its resulting URL on your website.

    See Publishing Viewer Presets.

    note important
    IMPORTANT
    For old videos that use an adaptive bitrate streaming profile, the URL continues to play as usual – with HLS streaming – until you reprocess the video assets. After reprocessing, the same URL will continue to work but now with both DASH and HLS streaming enabled.

Special considerations for creating an interactive viewer preset 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. This choice occurs when you select InteractiveSwatches from the Selected Component pull-down menu under the Behavior tab. The Display mode that you choose affects how and when thumbnails appear while the video is playing. You can choose either a segmentDisplay 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, suppose that there are fewer thumbnails assigned to a video segment than the number of visible spots in the display panel. In such cases, thumbnails from the next or previous subsegments 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, suppose that the number of thumbnails in a segment is less than the number that are visible in the panel. In such cases, the viewer automatically includes the display of thumbnails from the next segment, or the previous segment, where the last thumbnail is displayed.

The video in this topic is an example of the continuous display mode.

About auto-scrolling behavior in the Interactive Video viewer:

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, select 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 subsegments. The following table shows the breakdown of which thumbnails are displayed for a given time subsegment:

Video subsegment
Subsegment 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 subsegment 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 subsegments = round up to next subsegment (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 three subsegments.

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

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

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, select ImageMapEffect. Under Icon, select Background and in the Image field navigate to the background image you want.

Activate or deactivate viewer presets activating-or-deactivating-viewer-presets

The Viewer Presets that are available in the user interface depends on which ones are active in Author mode. By default, a viewer preset is “On” after you create it. If you toggle off the preset, you do not see it in Author mode. If the preset is published, it is always published regardless of whether it is toggled on or off. Deactivate viewer presets if the list becomes too unwieldy or you do not want a viewer preset made available to use.

To activate or deactivate viewer presets:

  1. In the upper-left corner of Experience Manager, select the Experience Manager logo, then in the left rail, select Tools (hammer icon) > Assets > Viewer Presets.

  2. On the Viewer Preset page, under the State column header, select 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 gray box.

Publish viewer presets 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 deliver an 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. Activate and publish all out-of-the-box viewer presets that come with Dynamic Media. Custom viewer presets that you create and add are auto-activated, but must also be published.

See Activating or Deactivating Viewer Presets.

See also Previewing Assets.

To publish viewer presets:

  1. In the upper-left corner of Experience Manager, select the Experience Manager logo, then in the left rail, select Tools (hammer icon) > Assets > Viewer Presets.
  2. Select one or more viewer presets that you want to publish.
  3. On the toolbar, select the Publish icon.

Sort viewer presets sorting-viewer-presets

  1. In the upper-left corner of Experience Manager, select the Experience Manager logo, then in the left rail, select Tools (hammer icon) > Assets > Viewer Presets.
  2. Select Preset Title, Type, Published, or State to sort by that column heading. For example, select Type to sort the viewer preset types in alphabetical or reverse-alphabetical order.

Edit viewer presets editing-viewer-presets

Editing any predefined, out-of-the-box viewer presets is not a supported scenario. If you edit an out-of-the-box viewer preset, you are prompted to save it with a new name.

To edit viewer presets:

  1. In the upper-left corner of Experience Manager, select the Experience Manager logo, then in the left rail, select Tools (hammer icon) > Asset > Viewer Presets.

  2. Select a preset by checking the box to the left of the viewer preset title.

  3. On the toolbar, select Edit.

  4. On the Viewer Preset Editor page, make the changes you want to the viewer preset, using the options found on the Appearance and Behavior tabs.

    From the Appearance tab, near the upper-left corner of the Viewer Preset Editor page, select Desktop, Tablet, or Phone to change the asset’s presentation mode.

  5. Near the upper-right corner of the page, do one of the following:

    • Select Save to save your changes and return to the Viewer Preset page.
    • Select Cancel to void any changes you made and return to the Viewer Preset page.

Delete custom viewer presets deleting-custom-viewer-presets

You can delete Viewer Presets that you have created and added to Dynamic Media.

To delete custom viewer presets:

  1. In the upper-left corner of Experience Manager, select the Experience Manager logo, then in the left rail, select Tools (hammer icon) > Assets > Viewer Presets.
  2. On the Viewer Presets page, check a Preset Title, and then select the Trash icon.
  3. Select Delete.

Apply a viewer presets to an asset applying-a-viewer-preset-to-an-asset

If you have already published both the asset and the selected viewer, the URL and Embed buttons appear after you select a viewer preset.

To apply a viewer preset to an asset:

  1. Open the asset and near the upper-left corner of the page, select the drop-down menu, then select Viewers.

    note note
    NOTE
    If you have already published both the asset and the selected viewer, the URL and Embed buttons appear after you select a viewer preset.

  2. To apply it to the asset, select a viewer preset from the left pane.

    You can copy the URL to share with other users.

Deliver assets with viewer presets delivering-assets-with-viewer-presets

To get the URLs for Viewer Presets, see Link URLs to your Web application. See also Embed the Video Viewer on a Web Page.

If you are using Experience Manager as your WCM, you can add assets using the viewer presets directly on the page. See Add Dynamic Media Assets to Pages.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab