CancelEncodingJob (interface v1.0.1)

Description

The goal of this interface is to cancel an IN_PROGRESS encoding job. This is triggered within the CMS workflow when the encoding job remains in progress for a time period exceeding the encoding timeout. The workflow in CMS will be marked as FAILED after triggering the cancel operation. The encoders may or may not implement this interface.

Request

A snippet of the CancelEncodingJob schema:

CODE

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="wfm:EncoderControlAPI/v1/schemas" targetNamespace="wfm:EncoderControlAPI/v1/schemas" elementFormDefault="qualified"
      attributeFormDefault="unqualified">
         <xs:element name="CancelEncodingJob">
               <xs:complexType>
                     <xs:sequence>
                            <xs:element name="EncodingJobId" type="xs:string"/>
                     </xs:sequence>
               </xs:complexType>
        </xs:element>
 </xs:schema>

Parameters

Name

Type

Description

EncodingJobId

xs:string

ID of the encoding job returned by CreateEncodingJob method.

The format of the EncodingJobId parameter is dependent on the encoding system.

Response

Parameters

No value is returned for this call.

Fault

A fault message will be returned in the following cases:

Encoding job ID does not exist.
Encoder has not implemented this interface.

See Fault management for a fault response sample.

Sample

Sample request

CODE

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>    
<CancelEncodingJob>
         <EncodingJobId>110E8400-E29B-11D4-A716-446655440000</EncodingJobId>
      </CancelEncodingJob>
   </soap:Body>
</soap:Envelope>

Sample response

No response body is returned for this call.