About
Custom metadata lets you control banner messages per entry, instead of displaying the same banner on all videos in a player.
By mapping metadata fields to banner settings, you can show different notices, alerts, or disclaimers for each video without updating the player configuration every time.
This approach is especially useful when managing large content libraries where banner messages vary by entry.
Step 1: Create a custom metadata schema
Access the Custom Data page
- Log into your Rich Media CMS.
- Click the Settings gear icon at the right of the navigation menu.
- Click the Custom Data tab at the top of the page.
The 'Account' page displays.
The 'Custom Data' page displays.
Create a custom metadata schema
- Click Add Custom Schema.
- Complete the following fields:
The Add Custom Schema window displays.
- Custom Schema Title - Add a title (for example, Banner metadata)
- Description - (optional) Enter a relevant description.
- System name - (optional) This field is required if you plan to use the schema with bulk XML uploads or APIs.
- Apply to - Select Entries (default).
The 'Add Custom Field' window displays.
4. Complete the fields:
You must create metadata fields that correspond to the banner settings used by the player. See Enable a banner on the player.
- Field Type - Select Text.
- Max No. of Values - Choose Single (default).
- Field Label - BannerText (You must type BannerText exactly as shown in these instructions. The player only reads metadata fields with this exact name.)
- Short description - optional
- Description - optional
- Searchable - Enable if you want to allow search by this field.
5. Click Add.
The field displays in your custom schema list.
Optional fields
Click +Add Custom Field and repeat the steps above to add any of the following optional fields. If these fields are not set, the player uses its default banner behavior.
BannerWrap
- Field Type – Text
- Field label – BannerWrap
BannerAlignment
- Field Type – Text
- Field label - BannerAlignment
- Supported values:
- top
- bottom
- top-left
- top-right
- bottom-left
- bottom-right
- BannerDisplayDuration
- Field Type –Text
- Field label - BannerDisplayDuration
- Enter a number in seconds when filling in metadata (for example, 5)
- BannerShowCloseButton
- Field Type – Text
- Field label - BannerShowCloseButton
- Values – true / false
Use the exact field labels shown above. The player only reads metadata fields with these exact names.
5. Click Add to save the custom field.
Example of a completed custom metadata schema with all required and optional banner fields.6. Click Save in the top-right corner to finalize the schema.
Your new metadata schema appears under the Custom Data tab.
Step 2: Complete banner metadata for an entry
- Access the entry details page by clicking the Content tab in the navigation menu.
- Click on the desired entry's title or thumbnail.
- Scroll down to the banner metadata section.
- Complete the fields as needed:
The Entries page displays by default.
- BannerText - Enter the banner message
- BannerWrap - True or False
- BannerAlignment - Enter one of the supported values
- BannerDisplayDuration - Enter a duration in seconds
- BannerShowCloseButton - True or False
5. Click Save.
The banner appears when the entry is played using a player with Metadata-based banner enabled.
If BannerText is empty or not set, the banner is not displayed and the player falls back to the global banner settings.
