Zelfstudie voor Viewer SDK viewer-sdk-tutorial
De Viewer SDK biedt een set op JavaScript gebaseerde componenten voor de ontwikkeling van aangepaste viewers. De viewers zijn webtoepassingen waarmee rijke media-inhoud die door Adobe Dynamic Media wordt aangeboden, kan worden ingesloten in webpagina's.
De SDK biedt bijvoorbeeld interactief zoomen en pannen. De klasse biedt ook een weergave van 360 graden en het afspelen van video's van elementen die via de backend-toepassing Dynamic Media Classic naar Adobe Dynamic Media zijn geüpload.
Hoewel de componenten afhankelijk zijn van de HTML5-functionaliteit, zijn ze ontworpen voor gebruik op Android™- en Apple iOS-apparaten en desktops, waaronder Internet Explorer en hoger. Dit soort ervaring betekent dat u één workflow kunt bieden voor alle ondersteunde platforms.
De SDK bestaat uit UI-componenten die viewerinhoud vormen. U kunt deze componenten opmaken via CSS en niet-UI-componenten die een ondersteunende rol hebben, zoals het ophalen en parseren of bijhouden van definities. Alle componentgedragingen zijn aanpasbaar via wijzigingstoetsen die u op verschillende manieren kunt opgeven, bijvoorbeeld als name=value paren in de URL.
Deze zelfstudie bevat de volgende taakvolgorde om u te helpen een standaardzoomviewer te maken:
Download de nieuwste Viewer SDK van Adobe Developer Connection section-84dc74c9d8e24a2380b6cf8fc28d7127
-
Download de nieuwste Viewer SDK van Adobe Developer Connection .
note note NOTE U kunt deze zelfstudie voltooien zonder dat u het pakket Viewer SDK hoeft te downloaden omdat de SDK op afstand is geladen. Het Viewer-pakket bevat echter aanvullende voorbeelden en een API-naslaggids die u kan helpen uw eigen viewers te maken.
De viewer-SDK laden section-98596c276faf4cf79ccf558a9f4432c6
-
Maak eerst een nieuwe pagina voor de ontwikkeling van de standaardzoomviewer die u gaat maken.
Bekijk deze nieuwe pagina met de Bootstrap- of loader-code waarmee u een lege SDK-toepassing instelt. Open uw favoriete teksteditor en plak de volgende HTML-opmaakcode in deze editor:
code language-html <!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="user-scalable=no, height=device-height, width=device-width, initial-scale=1.0, maximum-scale=1.0"/> <!-- Hiding the Safari on iPhone OS UI components --> <meta name="apple-mobile-web-app-capable" content="yes"/> <meta name="apple-mobile-web-app-status-bar-style" content="black"/> <meta name="apple-touch-fullscreen" content="no"/> <title>Custom Viewer</title> <!-- Include Utils.js before you use any of the SDK components. This file contains SDK utilities and global functions that are used to initialize the viewer and load viewer components. The path to the Utils.js determines which version of the SDK that the viewer uses. You can use a relative path if the viewer is deployed on one of the Adobe Dynamic Media servers and it is served from the same domain. Otherwise, specify a full path to one of Adobe Dynamic Media servers that have the SDK installed. --> <script language="javascript" type="text/javascript" src="http://s7d1.scene7.com/s7sdk/2.8/js/s7sdk/utils/Utils.js"></script> </head> <body> <script language="javascript" type="text/javascript"> </script> </body> </html>Voeg de volgende JavaScript-code toe aan de tag
script, zodat de tagParameterManagerwordt geïnitialiseerd. Zo kunt u zich voorbereiden op het maken en instantiëren van SDK-componenten binnen de functieinitViewer:code language-javascript /* We create a self-running anonymous function to encapsulate variable scope. Placing code inside such a function is optional, but this prevents variables from polluting the global object. */ (function () { // Initialize the SDK s7sdk.Util.init(); /* Create an instance of the ParameterManager component to collect components' configuration that can come from a viewer preset, URL, or the HTML page itself. The ParameterManager component also sends a notification s7sdk.Event.SDK_READY when all needed files are loaded and the configuration parameters are processed. The other components should never be initialized outside this handler. After defining the handler for the s7sdk.Event.SDK_READY event, it is safe to initiate configuration initialization by calling ParameterManager.init(). */ var params = new s7sdk.ParameterManager(); /* Event handler for s7sdk.Event.SDK_READY dispatched by ParameterManager to initialize various components of this viewer. */ function initViewer() { } /* Add event handler for the s7sdk.Event.SDK_READY event dispatched by the ParameterManager when all modifiers are processed and it is safe to initialize the viewer. */ params.addEventListener(s7sdk.Event.SDK_READY, initViewer, false); /* Initiate configuration initialization of ParameterManager. */ params.init(); }()); -
Sla het bestand op als een lege sjabloon. U kunt elke gewenste bestandsnaam gebruiken.
U kunt dit lege sjabloonbestand als referentie gebruiken wanneer u in de toekomst viewers maakt. Deze sjabloon werkt lokaal en vanaf een webserver.
Voeg nu stijl toe aan uw viewer.
Stijl toevoegen aan uw viewer section-3783125360a1425eae5a5a334867cc32
-
Voor deze viewer voor volledige pagina's die u maakt, kunt u enkele basisstijlen toevoegen.
Voeg het volgende
styleblok aan de bodem vanheadtoe:code language-html <style> html, body { width: 100%; height: 100%; } body { /* Remove any padding and margin around the edges of the browser window */ padding: 0; margin: 0; /* We set overflow to hidden so that scroll bars do not flicker when resizing the window */ overflow: hidden; } </style>
Neem nu de componenten Container en ZoomView op.
Inclusief container en ZoomView section-1a01730663154a508b88cc40c6f35539
-
Maak een werkelijke viewer door de componenten
ContainerenZoomViewop te nemen.Voeg de volgende
includeinstructies onder aan het<head>-element in, nadat het Utils.js -script is geladen:code language-javascript <!-- Add an "include" statement with a related module for each component that is needed for that particular viewer. Check API documentation to see a complete list of components and their modules. --> <script language="javascript" type="text/javascript"> s7sdk.Util.lib.include('s7sdk.common.Container'); s7sdk.Util.lib.include('s7sdk.image.ZoomView'); </script> -
Maak nu variabelen om te verwijzen naar de verschillende SDK-componenten.
Voeg de volgende variabelen toe boven aan de belangrijkste anonieme functie, net boven
s7sdk.Util.init():code language-javascript var container, zoomView; -
Voeg het volgende in de functie
initViewerin, zodat u enkele modifiers kunt definiëren en de respectievelijke componenten kunt instantiëren:code language-javascript /* Modifiers can be added directly to ParameterManager instance */ params.push("serverurl", "http://s7d1.scene7.com/is/image"); params.push("asset", "Scene7SharedAssets/ImageSet-Views-Sample"); /* Create a viewer container as a parent component for other user interface components that are part of the viewer application and associate event handlers for resize and full-screen notification. The advantage of using Container as the parent is the component's ability to resize and bring itself and its children to full-screen. */ container = new s7sdk.common.Container(null, params, "s7container"); container.addEventListener(s7sdk.event.ResizeEvent.COMPONENT_RESIZE, containerResize, false); /* Create ZoomView component */ zoomView = new s7sdk.image.ZoomView("s7container", params, "myZoomView"); /* We call this to ensure all SDK components are scaled to initial conditions when viewer loads */ resizeViewer(container.getWidth(), container.getHeight()); -
Voeg een gebeurtenishandler
containerResizeen een hulplijnfunctie toe voor een correcte uitvoering van de bovenstaande code:code language-javascript /* Event handler for s7sdk.event.ResizeEvent.COMPONENT_RESIZE events dispatched by Container to resize various view components included in this viewer. */ function containerResize(event) { resizeViewer(event.s7event.w, event.s7event.h); } /* Resize viewer components */ function resizeViewer(width, height) { zoomView.resize(width, height); } -
Geef een voorvertoning van de pagina weer, zodat u kunt zien wat u hebt gemaakt. De pagina moet er als volgt uitzien:
Voeg nu de componenten MediaSet en Swatches toe aan uw viewer.
Componenten MediaSet en Stalen toevoegen aan uw viewer section-02b8c21dd842400e83eae2a48ec265b7
-
Als u gebruikers de mogelijkheid wilt geven afbeeldingen uit een set te selecteren, kunt u de componenten
MediaSetenSwatchestoevoegen.Voeg de volgende SDK-code toe:
code language-javascript s7sdk.Util.lib.include('s7sdk.set.MediaSet'); s7sdk.Util.lib.include('s7sdk.set.Swatches'); -
Werk de lijst met variabelen als volgt bij:
code language-javascript var mediaSet, container, zoomView, swatches; -
Instantieer
MediaSet- enSwatches-componenten binnen de functieinitViewer.Instantieer de
Swatches-instantie na deZoomView- enContainer-componenten, anders verbergt de stapelvolgorde deSwatches:code language-javascript // Create MediaSet to manage assets and add event listener to the NOTF_SET_PARSED event mediaSet = new s7sdk.set.MediaSet(null, params, "mediaSet"); // Add MediaSet event listener mediaSet.addEventListener(s7sdk.event.AssetEvent.NOTF_SET_PARSED, onSetParsed, false); /* create Swatches component and associate event handler for swatch selection notification */ swatches = new s7sdk.set.Swatches("s7container", params, "mySwatches"); swatches.addEventListener(s7sdk.event.AssetEvent.SWATCH_SELECTED_EVENT, swatchSelected, false); -
Voeg nu de volgende gebeurtenishandlerfuncties toe:
code language-javascript /* Event handler for the s7sdk.event.AssetEvent.NOTF_SET_PARSED event dispatched by MediaSet to assign the asset to the Swatches when parsing is complete. */ function onSetParsed(e) { // set media set for Swatches to display var mediasetDesc = e.s7event.asset; swatches.setMediaSet(mediasetDesc); // select the first swatch by default swatches.selectSwatch(0, true); } /* Event handler for s7sdk.event.AssetEvent.SWATCH_SELECTED_EVENT events dispatched by Swatches to switch the image in the ZoomView when a different swatch is selected. */ function swatchSelected(event) { zoomView.setItem(event.s7event.asset); } -
Plaats de stalen onder aan de viewer door de volgende CSS toe te voegen aan het element
style:code language-css /* Align swatches to bottom of viewer */ .s7swatches { bottom: 0; left: 0; right: 0; height: 150px; } -
Geef een voorvertoning van uw viewer weer.
De stalen bevinden zich linksonder in de viewer. Als u wilt dat de stalen de volledige viewerbreedte beslaan, voegt u een aanroep toe om de stalen handmatig te vergroten of te verkleinen wanneer de gebruiker de grootte van de browser wijzigt. Voeg het volgende toe aan de functie
resizeViewer:code language-javascript swatches.resize(width, swatches.getHeight());De viewer ziet er nu uit als de volgende afbeelding. Probeer het browservenster van de viewer aan te passen en bekijk het gedrag.
Voeg nu knoppen voor inzoomen, uitzoomen en het opnieuw instellen van zoomen toe aan uw viewer.
Knoppen toevoegen aan uw viewer section-1fc334fa0d2b47eb9cdad461725c07be
-
Op dit moment kan de gebruiker alleen zoomen met klik- of aanraakbewegingen. Voeg daarom enkele standaardknoppen voor zoomknoppen toe aan de viewer.
Voeg de volgende knopcomponenten toe:
code language-css s7sdk.Util.lib.include('s7sdk.common.Button'); -
Werk de lijst met variabelen als volgt bij:
code language-javascript var mediaSet, container, zoomView, swatches, zoomInButton, zoomOutButton, zoomResetButton; -
Instantiëren van knoppen onder aan functie
initViewer.Onthoud dat de volgorde van belang is, tenzij u de instructie
z-indexin CSS opgeeft:code language-css /* Create Zoom In, Zoom Out and Zoom Reset buttons */ zoomInButton = new s7sdk.common.ZoomInButton("s7container", params, "zoomInBtn"); zoomOutButton = new s7sdk.common.ZoomOutButton("s7container", params, "zoomOutBtn"); zoomResetButton = new s7sdk.common.ZoomResetButton("s7container", params, "zoomResetBtn"); /* Add handlers for zoom in, zoom out and zoom reset buttons inline. */ zoomInButton.addEventListener("click", function() { zoomView.zoomIn(); }); zoomOutButton.addEventListener("click", function() { zoomView.zoomOut(); }); zoomResetButton.addEventListener("click", function() { zoomView.zoomReset(); }); -
Definieer nu enkele basisstijlen voor de knoppen door het volgende toe te voegen aan het blok
styleboven aan het bestand:code language-css /* define styles common to all button components and their sub-classes */ .s7button { position:absolute; width: 28px; height: 28px; z-index:100; } /* position individual buttons*/ .s7zoominbutton { top: 50px; left: 50px; } .s7zoomoutbutton { top: 50px; left: 80px; } .s7zoomresetbutton { top: 50px; left: 110px; } -
Geef een voorvertoning van uw viewer weer. Het zou als het volgende moeten kijken:
Configureer nu de stalen, zodat deze verticaal aan de rechterkant worden uitgelijnd.
De stalen verticaal configureren section-91a8829d5b5a4d45a35b7faeb097fcc9
-
U kunt modifiers rechtstreeks op de
ParameterManagerinstantie vormen.Voeg het volgende toe boven aan de functie
initViewerzodat u deSwatchesduimlay-out als één rij kunt configureren:code language-javascript params.push("Swatches.tmblayout", "1,0"); -
Werk de volgende formaatvraag bij
resizeViewer:code language-javascript swatches.resize(swatches.getWidth(), height); -
Bewerk de volgende
s7swatches-regel inZoomViewer.css:code language-css .s7swatches { top:0 ; bottom: 0; right: 0; width: 150px; } -
Geef een voorvertoning van uw viewer weer. Het ziet er als volgt uit:
Uw standaardzoomviewer is nu voltooid.
Deze viewerzelfstudie behandelt de grondbeginselen van wat de Dynamic Media Viewer SDK biedt. Als u met de SDK werkt, kunt u de verschillende standaardcomponenten gebruiken om eenvoudig rijke kijkervaringen voor uw doelpubliek te maken en te verbeteren.