Metadata Configuration Guide for SDK Integration
Configure metadata fields with your SDK to enable accurate segmentation, filtering, and analysis of video performance metrics across your platform.
Config Metadata
Customer ID
Unique identifier assigned by MediaMelon to your organization. If unknown, contact MediaMelon Support.
Subscriber ID
Unique identifier of the subscriber or user consuming the video content.
Subscriber Type
Type of the subscriber. Common values include "Free", "Trial", or "Paid".
Subscriber Tag
Additional string metadata about the subscriber. Do not include sensitive data. Used for segmentation or custom tagging.
Hash Subscriber ID
Boolean value that determines whether the subscriber ID should be hashed before sending. Set to true to hash the value.
Domain Name
Logical partition to group your users, streams, or assets (e.g., regional or brand-specific domain name). This field is used for channel ID by many customers.
Player Metadata
Player Name
Name of the custom player or application-level player wrapper used in your app (e.g., "MyCustomPlayer"). If you don’t use a custom wrapper, use the native/base player name (e.g., "ExoPlayer", "AVPlayer").
Player ID
A unique identifier for the player instance or integration. This can be used to distinguish between different player implementations or configurations within the same application.
Player Brand
Brand or organization maintaining the custom player. This could be your company name or the name of a third-party SDK vendor. Use the native player brand if no custom wrapper exists.
Player Model
Model or variant name of your custom player (e.g., "MyCustomPlayerV2", "PlayerAlpha"). If not applicable, use a relevant descriptive value or copy the native player model (e.g., "AVPlayer-iOS").
Player Version
Version of your custom player or wrapper. Helps distinguish between changes/releases. If no custom wrapper exists, specify the base player version (e.g., "2.18.3" for ExoPlayer).
Base Player Name
Native/base player used for actual playback (e.g., "ExoPlayer", "AVPlayer"). This should always reflect the core media engine even if you have a custom player wrapper.
Base Player Version
Version of the underlying base player (e.g., "2.18.3" for ExoPlayer, or iOS system version for AVPlayer). If you don’t have a custom wrapper, this value will be the same as Player Version.
Content Metadata
Asset ID
Unique identifier for the video asset.
Asset Name
Human-readable name or title of the video asset.
Video ID
Unique identifier for the video content. It can be the same as Asset ID or a different logical ID used in your system.
Content Type
The category or type of content, e.g., "Movie", "Episode", "Clip", "LiveStream".
Genre
Genre of the content, such as "Drama", "Comedy", "Documentary", etc.
is Live
A boolean value that determines whether the content is live or on-demand. Set to true for live content (e.g., live events or broadcasts), and false for VOD content (e.g., movies, episodes).
Episode Number
Episode number within a season. Useful for TV series or episodic content.
Season
Name or number of the season (e.g., "Season 1", "S2").
Series Title
Title of the series to which the episode belongs.
Playback Metadata
Stream URL
The URL of the current playing video stream (HLS or DASH). This is used for playback tracking and analytics.
DRM Type/Protection
DRM technology used (e.g., “Widevine”, “FairPlay”, “PlayReady”). Use “Unknown” if the content is protected, but the DRM type is unknown. Leave blank for clear (non-DRM) content.
DRM Level
Specifies the security level of DRM playback supported or enforced on the device (e.g., L1, L2, L3 for Widevine). This helps assess content protection strength and playback capabilities.
Experiment Name
Label used to segment views under different test experiments for analytics or A/B testing.
Sub Property ID
An identifier for sub-grouping under a single customer account. Useful for multi-brand or multi-service setups under the same customer.
View Session ID
Unique session identifier to correlate video playback with logs from other systems (e.g., CDN logs, backend services). Some customers put the application session ID to have a consolidated view.
Preload
Indicates whether the video content was preloaded before playback started. Typically a boolean value (true/false) used to analyze startup performance and buffering behavior.
Media Type
The type of video stream (e.g., live or on-demand)
Source Type
Indicates the streaming protocol used for playback. Common values include HLS or DASH, based on the stream URL type.
Stream Format
Describes the encoding variant or encoder configuration. Useful for comparing performance between different encoding settings. Examples: x264, hevc, av1-0, av1-4, av1-8
Encoding Service
Specifies the service or platform used to encode the video content (e.g., AWS Elemental, Bitmovin, MediaConvert). Useful for analyzing performance variations across encoding providers.
CDN
Name or identifier of the Content Delivery Network (CDN) used to deliver the content (e.g., Akamai, CloudFront, Fastly)
Player Width
Integer value representing the width (in pixels) of the video player on the screen.
Player Height
Integer value representing the height (in pixels) of the video player on the screen.
Ad Metadata
Ad Title
Title or name of the ad, usually provided in the VAST metadata or by the ad server.
Ad ID
Unique identifier for the ad creative, often defined by the ad server or DSP.
Ad Creative ID
Creative ID associated with the specific ad asset (video, image, etc.). Helps in tracking and reporting creative-level performance.
Ad Creative Type
Format or type of the ad creative. For example, video/mp4, image/jpeg, etc., or linear, non-linear.
Ad Client
SDK or client library responsible for requesting and playing the ad. Example: Google IMA, Freewheel, SpotX.
Ad Position
Timing of the ad in relation to the main content: "pre" (before), "mid" (during), or "post" (after).
Ad Server
Ad server or source that delivered the ad. Example: Google Ad Manager, Freewheel, etc.
Ad Resolution
Resolution of the ad video (e.g., 1920x1080), useful for reporting and quality monitoring.
Ad URL
URL from which the ad video is fetched. Typically a media file or stream URL.
Ad Duration
Total duration of the ad, in milliseconds. Example: 30000 = 30 seconds.
Ad Pod Index
Index of the ad pod within the stream. Ad pods are groups of ads played together (like a commercial break).
Ad Position in Pod
Position of the ad within its pod (e.g., 1st ad, 2nd ad in the group).
Ad Pod Length
Total number of ads in the current pod. Useful for showing “Ad 2 of 5” type of UI.
Is Ad Bumper
Boolean (true/false) indicating whether the ad is a bumper ad (short ad, usually <6s, played at the start or end of ad breaks).
Device Metadata
Device Name
Name of the playback device (e.g., "iPhone 14", "Living Room TV").
Device Brand
Manufacturer of the playback device (e.g., "Apple", "Samsung", "Roku").
Device Model
Specific model of the playback device (e.g., "SM-G991U", "Fire TV Stick 4K").
Device ID
Unique identifier representing the user's playback device. This may be an anonymized or hashed string, depending on your privacy policy.
Device Type
Category or form factor of the device (e.g., "Mobile", "Tablet", "TV", "Desktop").
Device OS
Operating system running on the device (e.g., "iOS", "Android", "tvOS", "Roku OS").
Device OS Version
Version of the device's operating system (e.g., "17.4", "13").
Screen Width
Width of the device's screen, in pixels.
Screen Height
Height of the device's screen, in pixels.
Device Capabilities
Playback features supported by the device (e.g., HDR, HLG, supported codecs, max resolution).
Application Metadata
Application Name
Name of the application or service through which the user is consuming the video content. This helps distinguish traffic and analytics across multiple apps or platforms under the same customer account (e.g., "MyOTTApp", "MyStreamingTV").
Application Version
Version of the application that the end user is using. This is useful for tracking analytics across different app releases, troubleshooting regressions, and correlating performance or playback issues to specific app builds (e.g., "1.2.3", "2025.07.15").
App Session ID
A unique identifier representing a single application lifecycle session (from app launch to termination). This helps correlate multiple playback sessions within the same app usage window.
Last updated