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. Log in 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 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 fields

The following table displays the standard Video Cloud fields, meaning they exist by default, and are used by Brightcove Beacon to properly import the video with which the metadata is associated.

Just a quick reminder from step 6 above about character limits:

  • String - Can contain up to 1024 single-byte characters (or 512 double-byte characters).
  • List - Can have no more than 150 possible values and each value in the list can be no more than 100 characters long.
Video Cloud Field Description Where/How
Populated
Required
duration Used by Brightcove Beacon to show percentage watched and duration in details screens Automatically populated by Video Cloud Yes
images.poster.src Landscape image (16:9):
Minimum Width: 1000px Height: 563px
Maximum Width: 4000px Height: 2250px
Edit the IMAGES > Poster section of the video's properties and browse for the location of locally saved image. Yes
images.thumbnail.src Poster image (2:3)
Minimum Width: 1000px Height: 563px
Maximum Width: 4000px Height: 2250px
Edit the IMAGES > Thumbnail section of the video's properties and browse for the location of locally saved image. Yes
images.wideBanner.src Coming soon - In the meantime defaults to images.poster.src
images.portraitPoster.src Coming soon - In the meantime defaults to images.poster.src
name Used by Brightcove Beacon as the title of the asset Edit the VIDEO INFORMATION section of the video's properties and enter a Name Yes
tags Not displayed in applications, but rather used by Brightcove Beacon to create playlists Edit the VIDEO INFORMATION section of the video's properties and enter Tags 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 Data Type and/or
Example
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 Data type: String;
One of the genres as defined in Brightcove Beacon, e.g. Action or Adventure for movies
beacon.
productionYear
beacon_
productionyear
Year of production of the asset - will show up in details pages No Data type: String;
A four digit integer
beacon.cast.
director
beacon_cast_
director
Comma separated list of names of directors No Data type: List;
Director(s) name(s), e.g. Jane Smith, Santiago Almada
beacon.cast.singer beacon_cast_singer Comma separated list of names of singers No Data type: List;
Singer(s) name(s), e.g. Jane Smith, Santiago Almada
beacon.cast.actor beacon_cast_actor Comma separated list of names of actors No Data type: List;
Actor(s) name(s), e.g. Jane Smith, Santiago Almada
beacon.cast.
composer
beacon_cast_
composer
Comma separated list of names of composers No Data type: List;
Composer(s) name(s), e.g. Jane Smith, Santiago Almada
beacon.cast.
songWriter
beacon_cast_
songwriter
Comma separated list of names of songwriters No Data type: List;
Songwriter(s) name(s), e.g. Jane Smith, Santiago Almada
beacon.cast.writer beacon_cast_writer Comma separated list of names of writers No Data type: List;
Writer(s) name(s), e.g. Jane Smith, Santiago Almada
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 Brightcove Beacon . If this value is not set, the most permissive rating for the default country age rating system set in Brightcove Beacon will be used. No Data type: List;
key=value,key=value, e.g. us=TV-Y, us=TV-M)
beacon.
shortDescription
beacon_
shortdescription
Allows to provide a short description tailored for Brightcove Beacon - if this value is not set it uses the text set in the video short description field No Data type: String;
Text
beacon.
longDescription
beacon_
longdescription
Allows to provide a long description tailored for Brightcove Beacon - if this value is not set it uses the text set in the video long description field No Data type: String;
Text
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 Brightcove Beacon and will be ignored for any subsequent updates of this asset in Brightcove Beacon - this so that the values set by users in Brightcove Beacon are not overridden. Possible values are from 0 to 100. No Data type: String;
Integer value 0-100
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 Data type: String;
A Video Cloud video ID, e.g. 6140603191001
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 Data type: String;
Add this field and set the value to No if you do not want the video synced with Brightcove Beacon

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.

For an example of using rights management fields, specifically when using a subscription package, see the Understanding the rights management custom fields section of the Using a Subscription Package document.

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
Data Type and/or
Example
beacon.rights.<counter>.type beacon_rights_
<counter>_type
Identifies if the type of monetization for the asset No FREE Data type: String;
One of:
  • FREE
  • AVOD
  • SVOD
  • INHERIT

Note: INHERIT is only applicable to Episode assets

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 Data type: String;
Date
(yyyy-mm-dd)
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 Data type: String;
Date
(yyyy-mm-dd)
beacon.rights.<counter>.devices beacon_rights_
<counter>_devices
Comma separated list of devices supported in Brightcove 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 devices supported in Brightcove Beacon Data type: List;
Comma separated list of:
  • iOS
  • Android
  • web
  • Roku
  • STV
  • Firetv
  • LGTV
  • Samsung
  • appletv
  • androidtv
  • panasonic
beacon.rights.
<counter>.
locationsPermit
beacon_rights_
<counter>_
locationspermit
Comma separated list of locations defined in Brightcove 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 Brightcove Beacon Data type: List;
Comma separated list of geographies
beacon.rights.<counter>.
locationsDeny
beacon_rights_
<counter>_
locationsdeny
Comma separated list of locations defined in Brightcove Beacon to which the asset should NOT be exposed under the access restrictions and monetization options in this particular set No None Data type: List;
Comma separated list of geographies
beacon.rights.
<counter>.
packageName
beacon_rights_
<counter>_
packagename
A comma separated list of package names, as defined in Brightcove Beacon Yes, if the type is set to SVOD None Data type: List;
Names of the subscription packages, e.g. Premium Sports,Action Movies,Christmas Movies; required for SVOD Type
beacon.rights.
<counter>.
adConfiguration
beacon_rights_
<counter>_
adconfiguration
Identifier of an ad configuration in Brightcove Beacon Yes, if the type is set as AVOD None Data type: String;
Name of advertising configuration, e.g. Google Ad Manager; required for AVOD Type

Episode fields

The following will need to be completed for videos that are episodes of a series. The following diagram shows the relationship between a series and its seasons and episodes.

Based on the diagram, the following would be the required fields for the six videos in the series.

  • Video 1
    • beacon.episode.serieName: Adventures on the Oregon Coast
    • beacon.episode.seasonNumber: 1
    • beacon.episode.number: 1
  • Video 2
    • beacon.episode.serieName: Adventures on the Oregon Coast
    • beacon.episode.seasonNumber: 1
    • beacon.episode.number: 2
  • Video 3
    • beacon.episode.serieName: Adventures on the Oregon Coast
    • beacon.episode.seasonNumber: 1
    • beacon.episode.number: 3
  • Video 4
    • beacon.episode.serieName: Adventures on the Oregon Coast
    • beacon.episode.seasonNumber: 2
    • beacon.episode.number: 1
  • Video 5
    • beacon.episode.serieName: Adventures on the Oregon Coast
    • beacon.episode.seasonNumber: 2
    • beacon.episode.number: 2
  • Video 6
    • beacon.episode.serieName: Adventures on the Oregon Coast
    • beacon.episode.seasonNumber: 2
    • beacon.episode.number: 3
Video Cloud Field Internal
Name
Notes Required Data Type and/or
Example
beacon.episode.
serieName
beacon_episode_
seriename
Should point to the series identifier in Brightcove Beacon under which an episode belongs (series need to be created directly in Brightcove Beacon ) Yes for episode assets; No otherwise Data type: String;
Name of the Series, e.g. using the example Adventures on the Oregon Coast
beacon.episode.
seasonNumber
beacon_episode_
seasonnumber
Should point to the series number in Brightcove Beacon under which an episode belongs (seasons need to be created directly in Brightcove Beacon) Yes for episode assets; No otherwise Data type: String;
The integer number referring to the season number to which the video belongs
beacon.episode.
number
beacon_episode_
number
Identifies the episode number within the season Yes for episode assets; No otherwise Data type: String;
The integer number referring to the video's episode number

Page last updated on 28 Mar 2020