THEOplayer React Native Connectors
    Preparing search index...

    Interface MuxData

    interface MuxData {
        ad_config_variant?: string;
        custom_1?: string;
        custom_2?: string;
        custom_3?: string;
        custom_4?: string;
        custom_5?: string;
        env_key?: string;
        experiment_name?: string;
        page_type?: string;
        player_init_time?: number;
        player_name?: string;
        player_version?: string;
        property_key?: string;
        sub_property_id?: string;
        video_cdn?: string;
        video_content_type?: string;
        video_duration?: number;
        video_encoding_variant?: string;
        video_experiments?: string;
        video_id?: string;
        video_is_live?: boolean;
        video_language_code?: string;
        video_producer?: string;
        video_series?: string;
        video_source_url?: string;
        video_stream_type?: string;
        video_title?: string;
        video_variant_id?: string;
        video_variant_name?: string;
        view_drm_type?: string;
        view_session_id?: string;
        viewer_application_name?: string;
        viewer_user_id?: string;
    }
    Index

    Properties

    ad_config_variant? custom_1? custom_2? custom_3? custom_4? custom_5? env_key? experiment_name? page_type? player_init_time? player_name? player_version? property_key? sub_property_id? video_cdn? video_content_type? video_duration? video_encoding_variant? video_experiments? video_id? video_is_live? video_language_code? video_producer? video_series? video_source_url? video_stream_type? video_title? video_variant_id? video_variant_name? view_drm_type? view_session_id? viewer_application_name? viewer_user_id?

    Properties

    ad_config_variant?: string
    custom_1?: string

    Customer-defined metadata.

    custom_2?: string

    Customer-defined metadata.

    custom_3?: string

    Customer-defined metadata.

    custom_4?: string

    Customer-defined metadata.

    custom_5?: string

    Customer-defined metadata.

    env_key?: string

    Your env key from the Mux dashboard. Note this was previously named property_key

    experiment_name?: string

    You can use this field to separate views into different experiments, if you would like to filter by this dimension later. This should be a string value, but your account is limited to a total of 10 unique experiment names, so be sure that this value is not generated dynamically or randomly.

    Optionalpage_type

    page_type?: string

    Provide the context of the page for more specific analysis. Values include watchpage, iframe, or leave empty. watchpage — A web page that is dedicated to playing a specific video (for example youtube.com/watch/ID or hulu.com/watch/ID) iframe — An iframe specifically used to embed a player on different sites/pages.

    player_init_time?: number

    If you are explicitly loading your player in page (perhaps as a response to a user interaction), include the timestamp (milliseconds since Jan 1 1970) when you initialize the player (or for HTML5 video, when right before you add the element to the DOM) in order to accurately track page load time and player startup time.

    player_name?: string

    You can provide a name for the player if you want to compare different configurations or types of players around your site or application. This is different from the player software (e.g. Video.js), which is tracked automatically by the SDK.

    player_version?: string

    As you make changes to your player you can compare how new versions of your player perform. This is not the player software version (e.g. THEOplayer 5.6.0), which is tracked automatically by the SDK.

    property_key?: string

    Your env key from the Mux dashboard.

    Use env_key.

    sub_property_id?: string

    A sub property is an optional way to group data within a property. For example, sub properties may be used by a video platform to group data by its own customers, or a media company might use them to distinguish between its many websites.

    video_cdn?: string

    The Content Delivery Network used to deliver the video. If using an SDK that supports CDN header extraction, this value will be auto-populated.

    Optionalvideo_content_type

    video_content_type?: string

    The type of content: 'short', 'movie', 'episode', 'clip', 'trailer', or 'event'.

    video_duration?: number

    The length of the video in milliseconds.

    video_encoding_variant?: string

    Allows you to compare different encoders or encoding settings. This could designate the encoder used (e.g. x264, hevc, or av1), the preset used (e.g. 'av1-0', 'av1-4', or 'av1-8'), or other properties of the encoding you want to track.

    video_experiments?: string
    video_id?: string

    Your internal ID for the video.

    video_is_live?: boolean
    video_language_code?: string

    The audio language of the video, assuming it's unchangeable after playing.

    video_producer?: string

    The producer of the video title.

    video_series?: string

    The series of the video (e.g.: 'Season 1').

    video_source_url?: string
    video_stream_type?: string

    The type of video stream (e.g: 'live' or 'on-demand').

    video_title?: string

    Title of the video player (e.g.: 'Awesome Show: Pilot').

    video_variant_id?: string

    Your internal ID for a video variant.

    video_variant_name?: string

    Allows you to monitor issues with the files of specific versions of the content, for example different audio translations or versions with hard-coded/burned-in subtitles.

    view_drm_type?: string

    The DRM SDK or service that is used for the video playback, such as 'widevine' or 'playready'.

    view_session_id?: string

    An ID that can be used to correlate the view with platform services upstream such as CDN or origin logs.

    viewer_application_name?: string
    viewer_user_id?: string

    An ID representing the viewer who is watching the stream. Use this to look up video views for an individual viewer. If no value is specified, a unique ID will be generated by the SDK. Note: You should not use any value that is personally identifiable on its own (such as email address, username, etc). Instead, you should supply an anonymized viewer ID which you have stored within your own system.

    Settings

    Member Visibility

    On This Page

    Properties