GetEncodedAssetUrl (interface v1.0.1)

Description

The goal of this interface is to retrieve the URL of the output encoded asset once the encoding job is successfully completed (encoding job status is SUCCESS).

In the case of adaptive streaming, the encoded asset corresponds to the main playlist file.

In other cases, the encoded asset corresponds to the encoded output file itself.

If the encoder is based on JITP, the optional metadata element in the response can be used to send multiple encoded asset URLs. The metadata key must be of the format ConsumptionUrl_<PackagingFormat>. For example, ConsumptionUrl_HLS, ConsumptionUrl_DASH, etc.

Request

A snippet of the GetEncodedAssetUrl 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="GetEncodedAssetUrl">
               <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 the CreateEncodingJob method.

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

Response

A snippet of the GetEncodedAssetUrlResponse 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="GetEncodedAssetUrlResponse">
             <xs:complexType>
                      <xs:sequence>
                             <xs:element name="EncodedAssetUrl" type="xs:anyURI"/>
                             <xs:element name="Metadata" type="MetadataType" minOccurs="0" maxOccurs="unbounded"/>
                     </xs:sequence>
             </xs:complexType>
       </xs:element>
</xs:schema>

Parameters

Name	Type	Description
`EncodedAssetUrl`	`xs:anyURI`	URL of the output encoded asset.
`Metadata`	`MetadataType`	Used to add key/value parameters in the response.

Fault

A fault message will be returned in the following case:

Encoding job ID does not exist.

See Fault management for a fault response sample.

Samples

The following samples are based on the CreateEncodingJob ones.

Use case with non-JITP

Sample request

CODE

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
          <GetEncodedAssetUrl xmlns="wfm:EncoderControlAPI/v1/schemas">
               <EncodingJobId>110E8400-E29B-11D4-A716-446655449999</EncodingJobId>
         </GetEncodedAssetUrl>
     </soap:Body>
</soap:Envelope>

Sample response

The NAGRA Workflow Manager (WFM) expects the success response to be in the following format with 200 OK HTTP status code:

CODE

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
          <GetEncodedAssetUrlResponse xmlns="wfm:EncoderControlAPI/v1/schemas">
                <EncodedAssetUrl> http://CDN:80/repository2/movie_640x480.avi</EncodedAssetUrl>
          </GetEncodedAssetUrlResponse>
     </soap:Body>
</soap:Envelope>

Use case with JITP

Sample request

CODE

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
           <GetEncodedAssetUrl xmlns="wfm:EncoderControlAPI/v1/schemas">
                   <EncodingJobId>110E8400-E29B-11D4-A716-446655449999</EncodingJobId>
           </GetEncodedAssetUrl>
    </soap:Body>
</soap:Envelope>

Sample response

The NAGRA Workflow Manager (WFM) expects the success response to be in the following format with 200 OK HTTP status code:

CODE

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
        <GetEncodedAssetUrlResponse xmlns="wfm:EncoderControlAPI/v1/schemas">
               <EncodedAssetUrl>110E8400-E29B-11D4-A716-446655449999</EncodedAssetUrl>
               <metadata>
                        <key>ConsumptionUrl_HLS</key>
                        <value>http://CDN:80/repository2/movie_640x480/index.m3u8</value>
               </metadata>
               <metadata>
                        <key>ConsumptionUrl_DASH</key>
                        <value>http://CDN:80/repository2/movie_640x480/index.mpd</value>
               </metadata>
        </GetEncodedAssetUrlResponse>
   </soap:Body>
</soap:Envelope>