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 VME Online 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 VME online system when transcoding to access video content items in the Content Engine. VME online 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 VME Online service, including a valid user name and password. For example:

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

where:

  • user-name is the name of a VME Online user

  • password is the password of this user

  • host is the VME Online 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 VME Online provider that is to own the transcoded videos. The named provider must be defined in the VME online system. For further information about what a VME Online provider is, see the Viz Media Engine User's Guide.

group

The name of the VME Online group to which the transcoded videos are to belong. The named group must:

  • Be defined in the VME online system.

  • Belong to the specified provider.

  • Not have a default publish point.

For further information about what a VME Online group is, see the Viz Media Engine User's Guide.

publishPoint

The number of the VME Online publish point at which the transcoded videos are to be published. The specified publish point must:

  • Be defined in the VME online system.

  • Belong to the specified provider.

For further information about what a VME Online group is, see the Viz Media Engine 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 VME Online 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 VME Online. 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

Under normal circumstances you should not need to specify this property. If, however, the video content items retrieved by VME online do not contain the information VME Online needs to perform the required transcoding successfully, this property provides a mechanism by which the information can be modified. The property must provide the absolute URI of an XSL transformation. This transformation is then applied to every video content item retrieved by VME online. The transformation can inject additional information into every content item, or modify existing information or remove information.

externalReferencePrefix

A prefix used by VME Online when accessing the Content Engine. The default value is escenic:, and if the VME online 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 VME online system, then you must set this property to a different value in each Escenic installation. For example:

externalReferencePrefix=escenic-staging:
ardomeFTP

This property only needs to be set if:

  • Your system is required to support a VME-based workflow (see VME-based Workflow) and

  • You are using an old VME video production system called either Ardome or VideoHub.

You must specify the URL of the Ardome/VideoHub FTP server from which videos are to be retrieved. The URL must include the user name and password required to access the FTP server. For example:

ardomeFTP=ftp://user-name:password@host/ardome

where:

  • user-name is the user name required to access the FTP server

  • password is the password required to access the FTP server

  • host is the host name or IP address of the machine on which the FTP server is running

If your video production system is based on VME ?.? or higher then you do not need to set this property.

Copyright © 2008-2014 Escenic