Defining an External Audio Content Type

An audio content type must at least have the following:

• A parameter called com.escenic.audio that is set to true

• A parameter called com.escenic.article.staging that is set to false

• A basic field with:

  • mime-type set to application/json

  • an audio sub-element with a value attribute set to true. This element must belong to the namespace http://xmlns.escenic.com/2013/audio.

• A decorator called audioArticleDecorator

The following example shows such a minimal content-type:

<content-type name="external-audio">
  <parameter name="com.escenic.audio" value="true"/>
  <parameter name="com.escenic.article.staging" value="false"/>
  <ui:decorator name="audioArticleDecorator"/>
  <panel name="main">
    <field name="audio" type="basic" mime-type="application/json">
      <ui:hidden/>
      <audio xmlns="http://xmlns.escenic.com/2013/audio" enabled="true"/>
    </field>
  </panel>
</content-type>

Here is a more realistic version of the same example, this time including a title field, label and so on, but with the important parts highlighted.

<content-type name="external-audio">
  <parameter name="com.escenic.audio" value="true"/>
  <parameter name="com.escenic.article.staging" value="false"/>
  <ui:icon>graphic</ui:icon>
  <ui:label>External audio</ui:label>
  <ui:title-field>title</ui:title-field>
  <ui:decorator name="audioArticleDecorator"/>
  <panel name="main">
    <field name="title" type="basic" mime-type="text/plain"/>
    <field name="audio" type="basic" mime-type="application/json">
      <ui:hidden/>
      <audio xmlns="http://xmlns.escenic.com/2013/audio" enabled="true"/>
    </field>
  </panel>
</content-type>

The com.escenic.audio parameter identifies the content type as an audio content type managed by the Video plug-in. The com.escenic.article.staging parameter specifies that content item staging must be disabled for this content type. If content item staging is disabled generally at your installation or for the whole publication, then you can omit this parameter. (For general information about content item staging, see the Escenic Content Engine Advanced Developer Guide.)