Replacing Media

This facility allows you to specify a new content source which will be ingested by yospaceCDS and will automatically replace the existing item but only once the new item as completed its ingestion process.

The reingestMediaRequest accepts the following parameters:

Standard Parameters

Account Name (username)
The username you use to log in to the yospaceCDS Content Management Console
Password (password)
The password associated with the username you use to log in to the yospaceCDS Content Management Console
URL to Asset to Upload (contentUrl)
the URL of the video content that you wish to replace the existing item. This URL must be accessible by yospaceCDS. Supported video formats are described in our Quick Start Guide.
MIME type (mimeType)
the MIME type of the uploaded content (if different from the MIME type given by the server)
Media Item ID (mediaItemId)
The Media Item ID of the item that you wish to replace.
Usage Profile ID - optional - (usageProfileId)
Use this parameter if you want the replacement video to be ingested under a Usage Profile.
HQ Processing Required (mobileHq)
specify true or false depending on whether you want H.264 processing on your video content. H.264 processing improves the quality of video for modern SmartPhone devices.  It is recommended that you set this value to 'true'.
Large Format Required - optional - (mobileLargeFormat)
specify true or false depending on whether you want the video available in a large format suitable for the iPad. This option makes the content available in 640x360 (or 512x384 for 4:3) subject to the source content being available in the same or higher resolution.  This parameter is optional, and defaults to false if not supplied.
Usage Profile ID - optional - (usageProfileId)
If you want the content to be ingested under a specific Usage Profile, then specify the ID of the Usage Profile using this parameter. You will need to obtain the ID of your Usage Profile from Yospace Support.
Cue Points - optional - (cuePoints)
Specify a comma separated list of cue points (defined as floating point numbers in seconds). For example:
23.4, 102.3, 201.42
yospaceCDS will ingest the content and make cut points at the specified times in the video. These cut points can then be used for mid-roll dynamic insertion of advertising.
Status Update Callback - optional - (URLstateChangeUrl)
The URL to use for status callbacks. If omitted, no callbacks are made.
MD5 checksum - optional - (checksum)
yospaceCDS will compute an MD5 checksum of the content it acquires and compare this against this parameter, if it supplied. If the checksums do not match, the content ingestion fails.

Optional Content Adjustment Settings

The following optional parameters can be set to apply adjustments to the content before it is ingested into the yospaceCDS. To use this settings, we recommend reading the separate article on Content Adjustment Settings.

Aspect Switch Policy (aspectSwitchMethod)
How the frame size will be adjusted to fit a target different aspect ratio. Valid values are BOX, CROP, CROPNBOX and STRETCH. If not specified, the default value is CROP
Min and Max Aspect Ratio (minAspectRatio and maxAspectRatio)
When using the Aspect Switch Policy "Crop and Box" these values determine the emphasis on crop versus box to achieve the target aspect. Floating point numbers allowed.
Deinterlace Content (deinterlaceContent)
Whether or not to apply a deinterlacing filter. Valid values are true or false.
End Crop (endCutSeconds)
Allows you to specify a number of seconds from the end of the video to cut, thus making video shorter by the number of seconds you specify. Floating point numbers allowed.
Start Crop (startCutSeconds)
Allows you to specify a number of seconds of video to chop from the beginning. Floating point numbers allowed.
Horizontal and Vertical Crop (horizontalCropPercentage and verticalCropPercentage)
Crops the specified percentage from the vertical or horizontal dimension of the frame. Floating point numbers allowed.
Thumbnail Snapshot Position (thumbnailPointSeconds)
Determines the number of seconds into the video where the default thumbnail snapshot will be taken. Floating point numbers allowed.
Volume Multiplier(volumeMultiplier)
Determins the volume adjustment made to the audio track. Floating point numbers allowed.

An example MediaItem creation request:

<soap:Envelope
         xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns2:reingestMediaRequest
       xmlns:ns2="http://www.yospace.com/tundra/MediaItemManagement/">
    
      <username>petshow</username>
      <password>Wf</password>
      <contentUrl>http://www.petshow.com/content/new-video.mov</contentUrl>
      <mediaItemId>28192328</mediaItemId>
      <mobileHq>true</mobileHq>
      <mobileLargeFormat>false</mobileLargeFormat>
    </ns2:reingestMediaRequest>
  </soap:Body>
</soap:Envelope>

In the response, you will receive status code of your request. Possible status code (with descriptions) are as follows:

  • 200, OK
  • 500, FAIL

An example successful response is given below:

<soap:Envelope
   xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
     
    <ns2:reingestMediaResponse
         xmlns:ns2="http://www.yospace.com/tundra/MediaItemManagement/">
       
      <statusCode>200</statusCode>
      <statusDescription>OK</statusDescription>
       
    </ns2:reingestMediaResponse>
  </soap:Body>
</soap:Envelope>