thePlatform Module

Class Reference

class thePlatform.thePlatformObject(entityID=0)

This class provides an interface for publishing to thePlatform, used for writing compliant XML and uploading it to thePlatform via FTP. Media delivery can be handled directly in FCS.

deleteSupportFiles()

Delete Registered support files (media and xml)

loadConfiguration(parser)

Load from configuration file, expects a ConfigParser type object. If you subclass, you should call this function. If we return false then you should abort. or do your own sanity checks

setFCSXMLFile(filePath)

import FCS XML file and set relevant member vars

upload(dirPath='')

Calls xmlOut and uploads the resulting file via FTP

xmlOut(filePath='')

Output our thePlatform compliant XML. If passed a filepath for the second Parameter, we write to that file, otherwise we print to stdout

Configuration

The thePlatform module has a number of configuration options that will define it’s behavior. The thePlatform module will inherent the same configuration file that transmogrifier.py is provided at runtime; by default this file is located at /usr/local/etc/transmogrifier.conf. This file can be usurped with a separate configuration file by providing transmogrifier.py with the --configFile= parameter.

Options utilized by the thePlatform module are designated under the [thePlatform] config section, as seen in the transmogrifier.conf file shown below:

[thePlatform]

host=38.113.27.171
username=demo
password=mypassword

host

Specify the server address for uploading your thePlatform content.

username

Specify the username used for connecting to thePlatform servers.

password

Specify the password used for connecting to thePlatform servers.

now).

Example Usage

In the following example, we’ll call the thePlatform with it’s only action, ‘upload’. In this example, we have multiplebitrate set to False, and we have setup FCS Copy responses to output 3 renditions of our file, a 1100kbps rendition at half rez, and 1500kbps and 3000kbps renditions at native resolution. We have also configured and fired an XML response to output an XML file, using the asset’s title, ‘myasset’, to our support file at /FCSSupport/thePlatform/xmlin/myasset.xml

>>> transmogrifier.py -a upload -m thePlatform -t bars-1
DEBUG: Running older Codebase!
DEBUG: Running for module: thePlatform validModules: BrightCove,YouTube,thePlatform
thePlatform: Loading FCSXML from path: '/FCSSupport/fcsvr_xmlout/bars-1.xml'
thePlatform: Reporting to Final Cut Server: '/FCSSupport/fcsvr_xmlin/thePlatform_23456.xml'
thePlatform: Uploading XML to thePlatform!
thePlatform: Writing XML file to path: /FCSSupport/thePlatform/xmlout/042011.xml
thePlatform: upload() uploading file: '042011.xml'
thePlatform: Successfully published assets to thePlatform.
thePlatform: Reporting to Final Cut Server: '/FCSSupport/fcsvr_xmlin/thePlatform_23456.xml'

This action will generate and upload an XML file to BrightCove, delivery of can should be handled by standard FCS copy responses.

For more information about working with Transmogrifier modules, click here