support Contact Support | system status System Status

Creating Video Cloud Custom Fields

In this topic, you will see the Video Cloud custom fields needed for synchronization into Brightcove Beacon.

Introduction

Videos that will be imported into Brightcove Beacon from Video Cloud must have an enriched set of metadata defined for proper use in Brightcove Beacon. In this document you will see how to create new custom fields in Studio. In addition, the needed fields for Brightcove Beacon are defined.

Creating custom fields

To create custom fields, follow these steps.

  1. Login to Video Cloud Studio.
  2. In the navigation header, click ADMIN and then Video Fields. Note that you must be an account administrator to access to the ADMIN menu.
  3. The Video Fields page will display your custom fields and all the standard video metadata fields, as shown in the following screenshot:
  4. Click Add Custom Field.
  5. Enter a Display Name. This will appear as the label for the field in the Upload and Media modules. An Internal Name will automatically be created for the field based on the display name.

  6. Select a Type for the field.
    • String - The user can type anything into the field up to 1024 single-byte characters (or 512 double-byte characters).
    • List - The user will select from a list of values. Lists can have no more than 150 possible values and each value in the list can be no more than 100 characters long.
  7. Enter a Description. The description field will appear as a hint in the Studio interface.
  8. If the custom field will be required, check Make this Field Required.
  9. If your field type is List, enter a comma-separated list of values and then click Add to List, as shown in the following screenshot.

  10. Click Save Field to save the changes. Click Save and Add Another to save the field and begin creating another field.

Custom fields you create are available immediately and will be visible in the Media module.

Up to 10 custom fields can be created. If you need more than 10 fields, click the Need more fields? link in the Video Fields page to contact Brightcove Customer Support with a request for more. Publishers are limited to 50 custom fields.

Editing list values

You can add additional values to a List type custom field. Click the custom field name link, add the values and then click Add to List. When done, click Save Field.

Deleting list values

You can add remove existing values from a List type custom field. Click the custom field name link, click the delete icon () associated with the value and then click Save Field.

When a list value is removed, any videos that were previously assigned that value will keep the value. However, if a video with the deleted value is edited, the value will be cleared and a new value will have to be selected.

Removing custom fields from an account

In order to remove a custom field from your account, you must contact Brightcove Support. Note that if you have Brightcove Support delete custom fields, the modified date will change for any videos where a value was present.

Using list values for Brightcove Beacon metadata

In the table below you find a number of customer fields you must create. As shown above, when creating a custom field you choose the data type to be either String or List. It may ease the burden on video content curators if they can select from a list rather than having to enter a string. Also, it will invariably help to keep data entry more consistent if values can be selected from a list rather than typed in.

Of course, the choice is yours, but you may find for some customer fields a list is a good selection for the data type. For instance, you may wish to consider the following, among others, for lists:

  • beacon.genre
  • beacon.ageRating
  • beacon.viewerScore
  • beacon.rights.<counter>.type

Standard, required fields

The following table displays the standard Video Cloud fields, meaning they exist by default, that require a value for Brightcove Beacon to properly import the video with which the metadata is associated.

Video Cloud Field Notes Required
duration Used by Beacon to show percentage watched and duration in details screens Yes
images.poster.src Landscape image Yes
images.thumbnail.src Thumbnail to be used Yes
images.wideBanner.src Coming soon - In the meantime defaults to images.poster.src Yes
images.portraitPoster.src Coming soon - In the meantime defaults to images.poster.src Yes
name Used by Beacon as the title of the asset Yes
tags Not displayed in applications, but rather used by Beacon to create playlists No

Custom field names

The next three sections of this document cover custom fields that you may need to create based on your particular implementation use case. Each custom field has both a Display Name and an Internal Name. If you feel you have a more meaningful name for the Display Name option you can use that, but the Internal Name MUST match exactly

General, custom fields

The following table displays custom Video Cloud fields that you MAY have to create based on your implementation.

Video Cloud Field Internal
Name
Notes Required Type
beacon.genre beacon_genre Genre for the asset - will show up in details page and will be used to organize assets in different screens. If this value is not set, then “No Genre” will be shown in the user interface. Not setting this value will have an impact on Related Content functionality. No Custom field
beacon.productionYear beacon_productionyear Year of production of the asset - will show up in details pages No Custom field
beacon.cast.director beacon_cast_director Comma separated list of names of directors No Custom field
beacon.cast.singer beacon_cast_singer Comma separated list of names of singers No Custom field
beacon.cast.actor beacon_cast_actor Comma separated list of names of actors No Custom field
beacon.cast.composer beacon_cast_composer Comma separated list of names of composers No Custom field
beacon.cast.songWriter beacon_cast_songwriter Comma separated list of names of song writers No Custom field
beacon.cast.writer beacon_cast_writer Comma separated list of names of writers No Custom field
beacon.ageRating beacon_agerating Provides the age rating for the asset. The value in this field should be in the form of key=value pairs separated by commas, where the key is the country code (like us) and the value is the age rating appropriate for that country code supported by Beacon. If this value is not set, the most permissive rating for the default country age rating system set in Beacon will be used. No Custom field
beacon.shortDescription beacon_shortdescription Allows to provide a short description tailored for Beacon - if this value is not set it uses the text set in the video short description field No Custom field
beacon.longDescription beacon_longdescription Allows to provide a long description tailored for Beacon - if this value is not set it uses the text set in the video long description field No Custom field
beacon.viewerScore beacon_viewerscore Allow to set an initial score for the viewer ratings (either coming from some other system or to set the initial value). This will only be used if the video asset is new in Beacon and will be ignored for any subsequent updates of this asset in Beacon - this so that we do not override the values that are set by users in Beacon. Possible values are from 0 to 100. No Custom field
beacon.trailer.id beacon_trailer_id Points to another video asset in video cloud that will be used as a trailer for the asset where this field is set. The asset being pointed to will be discarded as a Movie or Episode No Custom field
beacon.ingest beacon_ingest If this field is not present, then it will default to ingest. If you do not want some specific asset to not be synched, then this should be set to No No Custom field

Rights Management fields

To support the monetization and access restrictions for assets, a set of custom fields should be used. As you can have multiples instances of rights management configurations, the suggested approach is to create multiple sets of customer fields. In each instance's name a counter is used to differentiate between them. The first instance should use the counter to 0.

The following table displays custom Video Cloud fields that you MAY have to create based on your implementation.

Video Cloud Field Internal
Name
Notes Required Default Value Type
beacon.rights.<counter>.type beacon_rights_
<counter>_type
Identifies if the type of monetization for the asset - possible values are: FREE, AVOD, SVOD and INHERIT; INHERIT is only applicable to Episode assets No FREE Custom field
beacon.rights.<counter>.startDate beacon_rights_
<counter>_startdate
Date when the asset should be exposed under the access restrictions and monetization options in this particular set No If not set, defaults to video availability start date Custom field
beacon.rights.<counter>.endDate beacon_rights_
<counter>_enddate
Date when the asset should be no longer exposed under the access restrictions and monetization options in this particular set No If not set defaults to video Availability end date Custom field
beacon.rights.<counter>.devices beacon_rights_
<counter>_devices
Comma separated list of devices supported in Beacon to which the asset should be exposed under the access restrictions and monetization options in this particular set.Possible values are: iOS, Android, web, Roku, STV, Fire TV, LGTV, Samsung, Apple TV, Android TV and Panasonic No If not set defaults to all devices supported in Beacon Custom field
beacon.rights.<counter>.locationsPermit beacon_rights_
<counter>_locationspermit
Comma separated list of locations defined in Beacon to which the asset should be exposed under the access restrictions and monetization options in this particular set No If not set defaults to all locations supported in Beacon Custom field
beacon.rights.<counter>.locationsDeny beacon_rights_
<counter>_locationsdeny
No Custom field
beacon.rights.<counter>.packageName beacon_rights_
<counter>_packagename
Yes if the type is set to SVOD Custom field
beacon.rights.<counter>.adConfiguration beacon_rights_
<counter>_adconfiguration
Identifier of an ad configuration in Beacon Yes if the type is set as AVOD Custom field

Episode fields

The following will need to be completed for videos that are episodes of a series.

Video Cloud Field Internal
Name
Notes Required Type
beacon.episode.
seriesName
beacon_episode_
seriesname
Should point to the series identifier in Beacon under which an episode belongs (series need to be created directly in Beacon) Yes for episode assets; No otherwise Custom field
beacon.episode.
seasonNumber
beacon_episode_
seasonnumber
Should point to the series number in Beacon under which an episode belongs (seasons need to be created directly in Beacon) Yes for episode assets; No otherwise Custom field
beacon.episode.
number
beacon_episode_
number
Identifies the episode number within the season Yes for episode assets; No otherwise Custom field

Page last updated on 25 Nov 2019