Configure The Video Plug-in

The Video plug-in needs information about how to access the videos to be published and how to access the Viz One Publisher system responsible for transcoding. You provide this information by adding a configuration file to one of your configuration layers as follows:

  1. Create the configuration file by copying /opt/escenic/engine/plugins/video/misc/siteconfig/com/escenic/video/Configuration.properties to your common configuration layer. For example:

    $ mkdir -p /etc/escenic/engine/common/com/escenic/video/ $ cp /opt/escenic/engine/plugins/video/misc/siteconfig/com/escenic/video/Configuration.properties \ /etc/escenic/engine/common/com/escenic/video/Configuration.properties

  2. Open your configuration file for editing.

  3. Define values for some or all of the properties in the file. Precisely which properties need to be set depends upon the workflows your installation will need to support. See the property descriptions below for details.

The properties that may be defined in Configuration.properties are:

webServiceUri

The URI of your Content Engine web service, including a valid user name and password. For example:

webServiceUri=http://user-name:password@host/webservice/

where:

  • user-name is the name of an Escenic user with access to all video content items

  • password is the password of this user

  • host is the Content Engine's host name or IP address

Any special characters in the URI must be URI-encoded.

This URI is used by the Viz One Publisher system when transcoding to access video content items in the Content Engine. Viz One Publisher needs full read/write access to these video content items. Before transcoding, it reads the URI of the actual video content to be transcoded plus any meta-information it needs from a video content item. During transcoding it updates the content item with status information. When transcoding is complete it updates the content item with the URIs of the published transcoded versions of the video, keyframes and so on.

adactusServiceUri

The URI of your Viz One Publisher service, including a valid user name and password. For example:

adactusServiceUri=http://user-name:password@host/

where:

  • user-name is the name of a Viz One Publisher user

  • password is the password of this user

  • host is the Viz One Publisher service's host name or IP address

Any special characters in the URI must be URI-encoded. If, for example, the user name contains an @ character, this must be escaped as follows:

adactusServiceUri=http://post%40my-company.com:very_secret@10.211.10.8/
provider

The name of the Viz One Publisher provider that is to own the transcoded videos. The named provider must be defined in the Viz One Publisher system. For further information about what a Viz One Publisher provider is, see the Viz One User's Guide.

group

The name of the Viz One Publisher group to which the transcoded videos are to belong. The named group must:

  • Be defined in the Viz One Publisher system.

  • Belong to the specified provider.

  • Not have a default publish point.

For further information about what a Viz One Publisher group is, see the Viz One User's Guide.

publishPoint

The number of the Viz One Publisher publish point at which the transcoded videos are to be published. The specified publish point must:

  • Be defined in the Viz One Publisher system.

  • Belong to the specified provider.

For further information about what a Viz One Publisher publish point is, see the Viz One User's Guide.

binaryPrefix

This property only needs to be set if your system is required to support a local upload workflow (see Local Upload Workflow).

The video items uploaded to the Content Engine must be made accessible to the Viz One Publisher server by means of HTTP, FTP, SMB or some other network protocol. So before you can set this property you must make sure that an appropriate server is installed for serving the files to Viz One Publisher. You can then set this property to the appropriate URI.

If, for example you have set up an HTTP server to provide access to the files, you would need to specify:

binaryPrefix=http://host-name/

where host-name is the host name or IP address of the server you have set up.

If your system is not required to support local upload of videos, then you do not need to set this property.

adactusXslFile

The path of an XSL transformation that will applied to video content items when they are retrieved by Viz One Publisher. The transformation modifies the content items to ensure that they contain the information Viz One Publisher needs in order to perform the required transcoding successfully. A sample XSL file is supplied with the plug-in, and you should set the property to reference this file unless you have special requirements:

adactusXslFile=/opt/escenic/plugins/video/misc/example/add-adaptation.xsl

You must also edit the referenced file to specify the correct Quality of Service (QoS) value. Replace the uri attribute value in the following line:

<dia:Reference uri="Video Web Download 4-3"/>

with the name of the Viz One Publisher adaptation QoS scheme that is to be used when transcoding the videos. For information about adaptation QoS schemes, see Adaptation of Content.

externalReferencePrefix

A prefix used by Viz One Publisher when accessing the Content Engine. The default value is escenic:, and if the Viz One Publisher system is only required to interact with one Escenic system, then you do not need to set this property. If, however, you have several parallel Escenic installations (a production system and a test or staging system, for example), all of which use the same Viz One Publisher system, then you must set this property to a different value in each Escenic installation. For example:

externalReferencePrefix=escenic-staging:

Copyright © 2008-2013 Escenic