This Quick Start will show you how to update properties for you videos using FTP batch provisioning.
After completing this Quick Start you should be able to:
- Add video still and thumbnail images to your video
- Schedule videos to become active at a specified date and time
Note: FTP Batch Provisioning is available only in Video Cloud Pro and Enterprise editions.
Hands-On Task: Updating properties for your video
In this task, you will update some properties for your videos using FTP batch provisioning.
Create the XML manifest file
First, you will create the XML manifest file.
Note: You can download the completed manifest file and two images, one video still and one thumbnail, as a zip here to use for testing.
- Create an XML manifest file with the XML declaration. Include the
<publisher-upload-manifest>
root tag with a nested<notify>
tag. - Check to be sure your manifest file appears as follows, but with your respective values.
<?xml version="1.0" encoding="utf-8" ?>
<publisher-upload-manifest publisher-id="1234567800001" preparer="MB FTP" report-success="true">
<notify email="bclftp@gmail.com" />
</publisher-upload-manifest>
Note: For details on how to create the XML manifest file with the root tag, refer to Quick Start: Using FTP Batch Provisioning to Upload Videos.
Upload a video still and thumbnail
Next, you will use <asset>
tags to upload a video still image and a thumbnail image you will use in the next section to update a video.
- Just below the
<notify>
tag add an<asset>
tag. - Enter the following attribute/value pairs in the tag:
- filename: Video_Still.png
- refid: videoStill_asset_refid
- type: VIDEO_STILL
- Add another
<asset>
tag with the following attribute/value pairs:- filename: Video_Thumbnail.png
- refid: videoThumbnail_asset_refid
- type: THUMBNAIL
- Your code should appear as follows, but with your respective values.
<?xml version="1.0" encoding="utf-8" ?>
<publisher-upload-manifest publisher-id="ENTER YOUR PUBLISHER ID HERE" preparer="JD FTP" report-success="TRUE">
<notify email="ENTER YOUR FTP EMAIL ADDRESS HERE" />
<asset filename="Video_Still.png"
refid="videoStill_asset_refid"
type="VIDEO_STILL"/>
<asset filename="Video_Thumbnail.png"
refid="videoThumbnail_asset_refid"
type="THUMBNAIL"/>
</publisher-upload-manifest>
Identify the video assets to update
Next, you will identify the video assets to update using the <title>
tag.
- Add a
<title>
tag nested in the<publisher-upload-manifest>
code block, and just below the<notify>
tag. - In this tag you will use two attributes. Read the following as an introduction to their use.
- Enter the following attribute/value pairs in the tag:
- refid: seahorse_title_refid
- overlay-update: TRUE
- Your code should appear as follows, but with your respective values.
<title refid="seahorse_title_refid"
overlay-update="TRUE">
</title>
Attribute | Required | Description |
---|---|---|
refid | Required | Unique identifier of the asset to be updated. Maximum length 150 characters. This value is the refid used in the <title> tag when uploading your video assets. |
overlay-update | Optional | TRUE or FALSE. If true, and if this video already exists, only the attributes and child elements of this title that you explicitly set will be modified. If false (the default), any attributes or child elements of this title that you do not explicitly set will be set to null. |
Add a video still and thumbnail image to your video
Next, you will add a video still and thumbnail image to each of your video assets using the <title>
tag.
- In the
<title>
tag you created in the last step, you will add two additional attributes. Read the following as an introduction to their use. - Enter the following attribute/value pairs in the <
title>
tag:- video-still-refid: videoStill_asset_refid
- thumbnail-refid: videoThumbnail_asset_refid
- Your code should appear as follows, but with your respective values.
<title refid="seahorse_title_refid"
overlay-update="TRUE"
video-still-refid="videoStill_asset_refid"
thumbnail-refid="videoThumbnail_asset_refid">
Attribute | Required | Description |
---|---|---|
video-still-refid | Optional | The reference ID parameter of a video still asset. This reference ID could be either one previously entered into the system or one specified in a title tag within the same manifest file. |
thumbnail-refid | Optional | The reference ID parameter of a thumbnail asset. This reference ID could be either one previously entered into the system or one specified in a title tag within the same manifest file. |
Note: Do not use these attributes if you are also using the encode-to
attribute for the corresponding video asset. When Video Cloud transcodes a video, a video still image and thumbnail image is automatically created.
Schedule videos to become active at a specified date and time
Next, you will schedule when your video will become active and when it will expire using the <title>
tag.
- In the
<title>
tag you created in an earlier step, you will add two additional attributes. Read the following as an introduction to their use. - Enter the following attribute/value pairs in the <
title>
tag:- start-date: "04/01/2013 12:00 AM"
- end-date: "04/15/2013 12:00 AM"
- Check to be sure your manifest file appears as follows, but with your respective values.
<?xml version="1.0" encoding="utf-8" ?>
<publisher-upload-manifest publisher-id="ENTER YOUR PUBLISHER ID HERE" preparer="JD FTP" report-success="TRUE">
<notify email="ENTER YOUR FTP EMAIL ADDRESS HERE" />
<asset filename="Video_Still.png"
refid="videoStill_asset_refid"
type="VIDEO_STILL"/>
<asset filename="Video_Thumbnail.png"
refid="videoThumbnail_asset_refid"
type="THUMBNAIL"/>
<title refid="seahorse_title_refid"
overlay-update="TRUE"
video-still-refid="videoStill_asset_refid"
thumbnail-refid="videoThumbnail_asset_refid"
start-date="04/01/2013 12:00 AM"
end-date="04/15/2013 12:00 AM">
</title>
</publisher-upload-manifest>
Attribute | Required | Description |
---|---|---|
start-date | Optional | The primary scheduling start date and time for the video. The required format is MM/DD/YYYY HH:MM AM. For example: start-date="01/01/2008 12:00 AM". |
end-date | Optional | The primary scheduling end date and time for the video. The required format is MM/DD/YYYY HH:MM AM. For example: start-date="12/31/2008 12:00 AM". |
Note: The input in the upload manifest for the start date/end date is Pacific time. However, once you have completed your upload, the start date/end date displayed in the Media module will be the local time you have defined from Home > Profile > Video Scheduling Time Zone.
Submit the XML manifest file to the Video Cloud server
Now, you will submit the XML manifest file.
- Upload the XML manifest file to the Brightcove server using an FTP client.
- Wait for the processing to complete. The XML manifest file should disappear from your FTP client. You may have to refresh the view.
- You can now go into the Video Cloud Studio and navigate to the Media module to see your updated video assets.
By default, you will receive error messages in an email. You will also receive success messages if you set the report-success
attribute in the <publisher-upload-manifest>
tag to a value of true
.