0
This Quick Start will show you how to define remote video assets using FTP batch provisioning.
After completing this Quick Start you should be able to:
- Define remote video and thumbnail assets, and associate the two types of assets
Note: FTP Batch Provisioning is available only in Video Cloud Pro and Enterprise editions.
Hands-On Task 1: Defining remote video assets
In this task, you will use an XML manifest file to define a remote video asset that is served using progressive download.
Create the XML manifest file
First, you will create the XML manifest file.
- 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.
Define the remote video asset
Next, you will define the remote video asset using the <remote-asset> tag.
- Add a
<remote-asset>tag nested in the<publisher-upload-manifest>code block just below the<notify>tag. - In this tag you will use seven attributes. Read the following as an introduction to their use.
- VIDEO_FULL - a Flash Video encoded full length video
- FLV_BUMPER - A Flash Video encoded bumper video (15 second clip)
- THUMBNAIL - an image file used as a thumbnail in listings
- VIDEO_STILL - a still image from the video
- BACKGROUND - a background image to use in video players, etc.
- LOGO - a publisher logo image
- LOGO_OVERLAY - An image used for branding over video
- OTHER_IMAGE - miscellaneous image type
- H264
- ON2
- SORENSON
- In this example, we are defining a remote, full length MP4 video asset that is served using progressive download. Enter the following attribute/value pairs in the tag:
- refid: Your refid goes here
- display-name: Your name goes here
- type: VIDEO_FULL
- remote-url: The URL to the video on your server
- size: The size of your video in milliseconds
- video-duration: The length of your video in milliseconds
- video-codec: H264
- Your code should appear as follows, but with your respective values.
<remote-asset refid="titmouse_asset_refid" display-name="Bird Titmouse" type="VIDEO_FULL" remote-url="http://solutions.brightcove.com/bcls/ftpbpQuickStart/Bird_Titmouse_Remote.mp4" size="1678000" video-duration="8000" video-codec="H264"/>
| Attribute | Required | Description |
|---|---|---|
| refid | Required | A unique identifier for the asset, so that title elements can reference it from within the manifest file. |
| display-name | Required | A name for the file. Not more than 100 characters. |
| type | Required | The Video Cloud file type. This field must be exactly one of the following strings:
|
| remote-url | Required | The complete path to the file hosted on the remote server. If the file is served using progressive download, then you must include the file name and extension for the file. You can also use a URL that re-directs to a URL that includes the file name and extension. If the file is served using Flash streaming, use the remote-stream-name attribute to provide the stream name. |
| size | Required | The size of the file in bytes (not kilobytes nor megabytes, just bytes). Note that while the size attribute is optional for assets you upload, it is required for remote assets. |
| video-duration | Required for video assets only | The length of the remote video asset in milliseconds. This must be a whole number with no decimal places. |
| video-codec | Required for video assets only | This field must be exactly one of the following strings:
|
Convert the size of your video to bytes (I.e. 1.6 MB = 1678000 bytes) and convert the duration of your video to milliseconds (I.e. 8 seconds = 8000 ms).
Your remote asset files must be available at a public URL, without any requirements for authentication or access control.
Add a title to your video asset
Next, you will add a title to your video asset using the <title> tag.
- Add a
<title>tag nested in the<publisher-upload-manifest>code block, and just below the<remote-asset>tag. - In this tag you will use four attributes. Read the following as an introduction to their use.
- Enter the following attribute/value pairs in the tag:
- name: Your name goes here
- refid: Your title refid goes here
- active: TRUE
- video-full-refid: Your asset refid goes here
- Your code should appear as follows, but with your respective values.
<title name="Bird Titmouse"
refid="titmouse_title_refid"
active="TRUE"
video-full-refid="titmouse_asset_refid"> - Nested in the
<title>tag block, enter a child tag block of<short-description>. - In the
<short-description>tag block enter a short description. - The
<title>tag is now complete. Check to be sure your manifest file appears as follows, but, with your respective values.
| Attribute | Required | Description |
|---|---|---|
| name | Required | Name you wish to appear in the player |
| refid | Required | Unique identifier so the asset can be referenced later in the manifest file AND if you wish to update the asset at a later time using batch provisioning |
| active | Optional | TRUE or FALSE; specifies if a video should be active immediately on upload |
| video-full-refid | Optional | Reference to the asset's refid (in essence, points to the asset) |
<short-description>
Short description for bird titmouse.
</short-description><?xml version="1.0" encoding="utf-8" ?>
<publisher-upload-manifest publisher-id="1234567800001" preparer="MB FTP" report-success="true"
<notify email="bclftp@gmail.com" />
<remote-asset refid="titmouse_asset_refid"
display-name="Bird Titmouse"
type="VIDEO_FULL" remote-url="http://solutions.brightcove.com/bcls/ftpbpQuickStart/Bird_Titmouse_Remote.mp4"
size="1678000"
video-duration="8000" video-codec="H264"/>
<title name="Bird Titmouse"
refid="titmouse_title_refid"
active="TRUE"
video-full-refid="titmouse_asset_refid">
<short-description>
Short description for bird titmouse.
</short-description>
</title>
</publisher-upload-manifest>Submit the XML manifest file to the Video Cloud server
Now, you will submit the XML manifest file to define your remote video asset.
- 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 video in the All Videos list.
If there is an error processing the manifest you will, by default, receive email notification. You can also receive success messages if you set the report-success attribute in the <publisher-upload-manifest> tag to a value of true.
Define the remote thumbnail image
Next, you will define the remote thumbnail image using the <remote-asset> tag.
- Add a
<remote-asset>tag nested in the<publisher-upload-manifest>code block just below the last<notify>tag. - In this tag you will use seven attributes. Read the following as an introduction to their use.
- VIDEO_FULL - a Flash Video encoded full length video
- FLV_BUMPER - A Flash Video encoded bumper video (15 second clip)
- THUMBNAIL - an image file used as a thumbnail in listings
- VIDEO_STILL - a still image from the video
- BACKGROUND - a background image to use in video players, etc.
- LOGO - a publisher logo image
- LOGO_OVERLAY - An image used for branding over video
- OTHER_IMAGE - miscellaneous image type
- In this example, we are defining a remote remote thumbnail asset. Enter the following attribute/value pairs in the tag:
- refid: Your refid goes here
- display-name: Your name goes here
- type: THUMBNAIL
- remote-url: The URL to the video on your server
- size: The size of your video in milliseconds
- Next associate the thumbnail remote asset with a video using the
<title>tag. Enter the following attribute/value pairs in the tag.- refid: The refid of the video remote asset
- thumbnail-refid: The refid of the remote thumbnail
- overlay-update: TRUE (add to the video asset properties, not overwrite them)
- The
<remote-asset>tag is now complete. Check to be sure your manifest file appears as follows, but, with your respective values.
| Attribute | Required | Description |
|---|---|---|
| refid | Required | A unique identifier for the asset, so that title elements can reference it from within the manifest file. |
| display-name | Required | A name for the file. Not more than 100 characters. |
| type | Required | The Video Cloud file type. This field must be exactly one of the following strings:
|
| remote-url | Required | The complete path to the file hosted on the remote server. If the file is served using progressive download, then you must include the file name and extension for the file. You can also use a URL that re-directs to a URL that includes the file name and extension. If the file is served using Flash streaming, use the remote-stream-name attribute to provide the stream name. |
| size | Required | The size of the file in bytes (not kilobytes nor megabytes, just bytes). Note that while the size attribute is optional for assets you upload, it is required for remote assets. |
Convert the size of your asset to bytes (i.e. 171 KB = 175104 bytes).
<title refid="titmouse_title_refid"
thumbnail-refid="thumbnail_asset_refid"
overlay-update="TRUE"/><?xml version="1.0" encoding="utf-8" ?>
<publisher-upload-manifest publisher-id="1234567800001" preparer="MB FTP" report-success="true"
<notify email="bclftp@gmail.com" />
<remote-asset refid="thumbnail_asset_refid"
display-name="Thumbnail remote image"
type="THUMBNAIL"
remote-url="http://solutions.brightcove.com/bcls/ftpbpQuickStart/Video_Thumbnail.png"
size="175104"/>
<title refid="titmouse_title_refid"
thumbnail-refid="thumbnail_asset_refid"
overlay-update="TRUE"/> </publisher-upload-manifest>Your remote asset files must be available at a public URL, without any requirements for authentication or access control.
Submit the XML manifest file to the Video Cloud server
Now, you will submit the XML manifest file to define your remote thumbnail image.
- 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. Select a video in the list and open the Basic Edit properties. In the Images section, for the Thumbnail, select the Manage button to see your remote thumbnail image.
If there is an error processing the manifest you will, by default, receive email notification. You can also receive success messages if you set the report-success attribute in the <publisher-upload-manifest> tag to a value of true.