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.

Variable	Description	Mandatory/ Optional
Customer ID	Unique identifier assigned by MediaMelon to your organization. If unknown, contact MediaMelon Support.	Mandatory
Subscriber ID	Unique identifier of the subscriber or user consuming the video content.	Mandatory
Subscriber Type	Type of the subscriber. Common values include "Free", "Trial", or "Paid".	Mandatory
Subscriber Tag	Additional string metadata about the subscriber. Do not include sensitive data. Used for segmentation or custom tagging.	Optional
Hash Subscriber ID	Boolean value that determines whether the subscriber ID should be hashed before sending. Set to true to hash the value.	Mandatory
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.	Mandatory
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).	Mandatory
Stream URL	The URL of the current playing video stream (HLS or DASH). This is used for playback tracking and analytics.	Mandatory
Asset ID	Unique identifier for the video asset.	Mandatory
Asset Name	Human-readable name or title of the video asset.	Mandatory
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.	Mandatory
Content Type	The category or type of content, e.g., "Movie", "Episode", "Clip", "LiveStream".	Mandatory
Genre	Genre of the content, such as "Drama", "Comedy", "Documentary", etc.	Optional
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.	Mandatory
Episode Number	Episode number within a season. Useful for TV series or episodic content.	Mandatory
Season	Name or number of the season (e.g., "Season 1", "S2").	Mandatory
Series Title	Title of the series to which the episode belongs.	Mandatory
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").	Mandatory
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.	Mandatory
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").	Mandatory
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).	Mandatory
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.	Mandatory
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.	Mandatory
Experiment Name	Label used to segment views under different test experiments for analytics or A/B testing.	Mandatory
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.	Mandatory
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.	Mandatory
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").	Mandatory
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").	Mandatory
Device ID	A unique identifier representing the user's playback device. This may be an anonymized or hashed string, depending on your privacy policy.	Optional
Media Type	The type of video stream (e.g., live or on-demand)	Mandatory
Source Type	Indicates the streaming protocol used for playback. Common values include HLS or DASH, based on the stream URL type.	Mandatory
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	Mandatory
CDN	Name or identifier of the Content Delivery Network (CDN) used to deliver the content (e.g., Akamai, CloudFront, Fastly)	Mandatory
Player Width	Integer value representing the width (in pixels) of the video player on the screen.	Mandatory
Player Height	Integer value representing the height (in pixels) of the video player on the screen.	Mandatory