Tutorial del SDK de visor

Última actualización: 2023-11-04

Temas:
Dynamic Media Classic
Ver más sobre este tema
Viewers
Ver más sobre este tema
SDK/API
Ver más sobre este tema

Creado para:
Developer

User

El SDK de Viewer proporciona un conjunto de componentes basados en JavaScript para el desarrollo de visualizadores personalizados. Los visores son aplicaciones basadas en la web que permiten incrustar en páginas web contenido multimedia enriquecido proporcionado por Adobe Dynamic Media.

Por ejemplo, el SDK proporciona funciones interactivas de zoom y desplazamiento. También proporciona una vista de 360° y una reproducción de vídeo de los recursos cargados en Adobe Dynamic Media a través de la aplicación back-end denominada Dynamic Media Classic.

Aunque los componentes dependen de la funcionalidad de HTML5, están diseñados para funcionar en dispositivos y escritorios Android™ y Apple iOS, incluido Internet Explorer y posterior. Este tipo de experiencia significa que puede proporcionar un solo flujo de trabajo para todas las plataformas admitidas.

El SDK consta de componentes de interfaz de usuario que conforman el contenido del visor. Puede aplicar estilo a estos componentes a través de CSS y a componentes que no sean de interfaz de usuario y que tengan algún tipo de función de soporte, como recuperar definiciones de conjunto y analizar o rastrear. Todos los comportamientos de los componentes se pueden personalizar mediante modificadores que se pueden especificar de varias formas, por ejemplo, name=value pares en la dirección URL.

Este tutorial incluye el siguiente orden de tareas para ayudarle a crear un visor de zoom básico:

Descargue el SDK de visor más reciente de Adobe Developer Connection

Descargue el SDK de visor más reciente de Adobe Developer Connection .

NOTA

Puede completar este tutorial sin necesidad de descargar el paquete del SDK de Viewer, ya que el SDK se carga de forma remota. Sin embargo, el paquete Visualizador incluye ejemplos adicionales y una guía de referencia de API que pueden ayudarle a crear sus propios visualizadores.

Cargar el SDK del visor

Comience por configurar una nueva página para desarrollar el visor de zoom básico que va a crear.

Considere esta nueva página como el código del Bootstrap (o cargador) que utiliza para configurar una aplicación vacía del SDK. Abra su editor de texto favorito y pegue el siguiente marcado de HTML en él:

<!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>

Agregue el siguiente código JavaScript dentro de la variable script para que inicialice el ParameterManager. Esto le ayudará a prepararse para crear y crear instancias de los componentes del SDK dentro de initViewer función:

/* 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();

}());

Guarde el archivo como una plantilla vacía. Puede utilizar cualquier nombre de archivo que desee.

Puede utilizar este archivo de plantilla vacío como referencia cuando cree visualizadores en el futuro. Esta plantilla funciona localmente y cuando se sirve desde un servidor web.

Ahora, agregue estilo al visor.

Adición de estilo al visor

Para este visor de página completa que está creando, puede agregar algunos estilos básicos.

Añada lo siguiente style bloque hasta la parte inferior del head:

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

Ahora, incluya los componentes Container y ZoomView.

Incluyendo contenedor y vista de zoom

Crear un visor real incluyendo los componentes Container y ZoomView.

Inserte lo siguiente include instrucciones al final de la <head> element: después de Utils.js se ha cargado el script:

<!--
    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>

Ahora cree variables para hacer referencia a los distintos componentes del SDK.

Agregue las siguientes variables a la parte superior de la función anónima principal, justo encima s7sdk.Util.init():
```
var container, zoomView;
```

Inserte lo siguiente dentro de initViewer para que pueda definir algunos modificadores y crear instancias de los componentes respectivos:

/* 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());

Para que el código anterior se ejecute correctamente, agregue un containerResize controlador de eventos y una función de ayuda:

/* 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);
}

Previsualice la página para poder ver lo que ha creado. La página debe tener el aspecto siguiente:

Ahora añada los componentes MediaSet y Swatches a su visor.

Adición de los componentes MediaSet y Swatches al visor

Para que los usuarios puedan seleccionar imágenes de un conjunto, puede añadir los componentes MediaSet y Swatches.

Añadir las siguientes inclusiones de SDK:
```
s7sdk.Util.lib.include('s7sdk.set.MediaSet');
s7sdk.Util.lib.include('s7sdk.set.Swatches');
```
Actualice la lista de variables con lo siguiente:
```
var mediaSet, container, zoomView, swatches;
```

Instanciar MediaSet y Swatches componentes dentro de initViewer función.

Asegúrese de crear una instancia de Swatches después de la ZoomView y Container componentes; de lo contrario, el orden de apilamiento oculta la variable Swatches:

// 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);

Ahora agregue las siguientes funciones de controlador de eventos:

/* 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);
}

Coloque las muestras en la parte inferior del visor agregando el siguiente CSS al style elemento:

/* Align swatches to bottom of viewer */
.s7swatches {
    bottom: 0;
    left: 0;
    right: 0;
    height: 150px;
}

Previsualice el visor.

Observe que las muestras están en la parte inferior izquierda del visor. Para que las muestras tengan toda la anchura del visor, agregue una llamada para cambiar manualmente el tamaño de las muestras cada vez que el usuario cambie el tamaño del explorador. Añada lo siguiente a resizeViewer función:
```
swatches.resize(width, swatches.getHeight());
```
Ahora, el visualizador se parece a la siguiente imagen. Intente cambiar el tamaño de la ventana del explorador del visor y observe el comportamiento resultante.

Ahora, agregue los botones de ampliar, alejar y restablecer el zoom al visor.

Adición de botones al visor

Actualmente, el usuario solo puede hacer zoom mediante gestos táctiles o de clic. Por lo tanto, añada algunos botones básicos de control de zoom al visor.

Agregue los siguientes componentes de botón:
```
s7sdk.Util.lib.include('s7sdk.common.Button');
```

Actualice la lista de variables con lo siguiente:

var mediaSet, container, zoomView, swatches, zoomInButton, zoomOutButton, zoomResetButton;

Botones Instanciar en la parte inferior de initViewer función.

Recuerde que el orden importa, a menos que especifique el z-index en 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(); });

Ahora defina algunos estilos básicos para los botones agregando lo siguiente a style bloquear en la parte superior del archivo:

/* 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;
 }

Previsualice el visor. Debe tener el siguiente aspecto:

Ahora configure las Muestras para que se alineen verticalmente a la derecha.

Configuración vertical de las muestras

Puede configurar modificadores directamente en ParameterManager ejemplo.

Agregue lo siguiente a la parte superior de la initViewer para que pueda configurar la función Swatches diseño de la miniatura como una sola fila:
```
params.push("Swatches.tmblayout", "1,0");
```
Actualice la siguiente llamada de cambio de tamaño dentro de resizeViewer:
```
swatches.resize(swatches.getWidth(), height);
```

Edite lo siguiente s7swatches regla en ZoomViewer.css:

.s7swatches {
    top:0 ;
    bottom: 0;
    right: 0;
    width: 150px;
}

Previsualice el visor. Tiene el siguiente aspecto:

Se ha completado el visor de zoom básico.

Este tutorial del visor toca los aspectos básicos de lo que proporciona el SDK del visor de Dynamic Media. A medida que trabaja con el SDK, puede utilizar los distintos componentes estándar para crear y diseñar fácilmente experiencias de visualización enriquecidas para las audiencias de destino.

Página anterior

Tutorial del SDK de visor

Descargue el SDK de visor más reciente de Adobe Developer Connection

Cargar el SDK del visor

Adición de estilo al visor

Incluyendo contenedor y vista de zoom

Adición de los componentes MediaSet y Swatches al visor

Adición de botones al visor

Configuración vertical de las muestras

En esta página

Ver siguiente:

Aprender

Documentación

Comunidad

Asistencia

Recursos

Cuenta de Adobe

Adobe