Item conform¶
New in version 4.0.
The conform resource exposes a simple way to combine media from one or more items into a new item. It is also possible to select specific parts from the input by specifying an input interval.
This could be used when you for example want to:
- Merge spanned P2 clips.
- Render a simple sequence as defined by a user.
Conforming¶
Start a conform job¶
- POST /conform¶
Starts a new CONFORM job that creates a new item and one or more shapes that contains media according to the conform timeline.
Query Parameters: - conformMetadata –
If metadata should be copied from the source items, according to the timeline, to the resulting item. Default: true.
New in version 4.2.3.
- sourceTag – A comma-separated list of shape tags, that specify the shapes that should be used as inputs.
- tag – A comma-separated list of shape tags, that specify the desired output.
- createThumbnails –
- true - Creates thumbnails according to default transcoder rules.
- false (default) - No thumbnails will be created.
- createPosters – An optional list of Time codes to use for creating posters.
- destinationItem – An item id, to which the new new shape will be associated. (New in 4.4.)
- notification – See Notifications . (Optional)
- notificationData – See Notifications . (Optional)
- priority – The priority to assign to the job. Default is MEDIUM .
- jobmetadata – Additional information for the job task. See Special job metadata values
Accepts: - application/xml, application/json – ConformRequestDocument
Produces: - application/xml, application/json – JobDocument
Role: _job_write
- conformMetadata –
Example: joining two clips¶
In this example item VX-1 and VX-2 are the two clips that should be joined/concatenated. A shape-tag with an empty preset (here the original tag) is specified so that the output has the same format as the input.
POST /conform?tag=original
Content-Type: application/xml
<ConformRequest xmlns="http://xml.vidispine.com/schema/vidispine">
<conform>
<timeline>
<segment>
<source>
<id>VX-1</id>
</source>
</segment>
<segment>
<source>
<id>VX-2</id>
</source>
</segment>
</timeline>
</conform>
<metadata>
<timespan start="-INF" end="+INF">
<field>
<name>title</name>
<value>Joined A and B</value>
</field>
</timespan>
</metadata>
</ConformRequest>
<JobDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<jobId>VX-21527</jobId>
<user>admin</user>
<started>2013-05-14T06:56:40.868Z</started>
<status>READY</status>
<type>CONFORM</type>
<priority>MEDIUM</priority>
</JobDocument>