Skip to Content
Mux Docs: Home

Monitor Roku

This guide walks through integration with Roku to collect video performance metrics with Mux data.

Mux's Roku integration supports Roku SceneGraph applications, in conjunction with standard Video nodes. Mux runs as a Task alongside the Video node, and supports instances where the Video nodes are reused with additional content as well as when the Video nodes are reset between content.


The following data can be collected by the Mux Data SDK when you use the Roku SDK, as described below.

Supported Features:

  • Engagement metrics
  • Quality of Experience Metrics
  • Custom Dimensions

Video Quality metrics are not available.

1Include the Mux Data SDK

Place the SDK file in your libs folder. The latest version of the SDK can be found here:

2Setup a new Mux Task

Create a new Task XML named MuxTask.xml inside your components folder and give it the following interface. This is used to link the mux-analytics.brs file into your application.

<component name="MuxTask" extends="Task">
<field id="video" type="node" alwaysNotify="true"/>
<field id="config" type="assocarray" alwaysNotify="true"/>
<field id="rafEvent" type="assocarray" alwaysNotify="true"/>
<field id="error" type="assocarray" alwaysNotify="true"/>
<field id="view" type="String" alwaysNotify="true"/>
<field id="exit" type="Boolean" alwaysNotify="true"/>
<field id="exitType" type="String" alwaysNotify="true" value="hard" />
<field id="useRenderStitchedStream" type="String" alwaysNotify="true" value="false"/>
<script type="text/brightscript" uri="pkg:/libs/mux-analytics.brs"/>

3Setup the task to respond to video events

Within your main application, create the Mux Task node, and pass the Video node that you are tracking to it. This should be done before the content is set into the Video node so that Mux can track the load process.

Get your ENV_KEY from the Mux environments dashboard.

Env Key is different than your API token

ENV_KEY is a client-side key used for Mux Data monitoring. These are not to be confused with API tokens which are created in the admin settings dashboard and meant to access the Mux API from a trusted server.

m.mux ="mux")
muxConfig = {
env_key: "ENV_KEY",
m.mux.setField("config", muxConfig)
m.mux.control = "RUN"
' Load the video into the Video node

After you've integrated, start playing a video in the player you've integrated with. A few minutes after you stop watching, you'll see the results in your Mux account. We'll also email you when your first video view has been recorded.

You can also test that Mux is receiving data in the Mux Data dashboard. Login to the dashboard and find the environment that corresponds to your ENV_KEY and look for video views.

Note that it may take a few minutes for views to show up in the Mux Data dashboard.


To help you with the integration process and ensure you have successfully incorporated the SDK within your player, we have provided a number of optional manifest attributes. These attributes can help you better understand how the MUX SDK event tracking works as well as show you the actual data being collected. Some of the benefits of using some of the debugging attributes (mentioned below) are that you will be able to see the SDK events and data collected as it occurs.

NOTE: The outputs illustrated below are printed on a single line within the terminal to reduce clutter.



full, partial or none


Outputs the event at the time it occurs. Default value is none

Example output

Property set to partial:

[mux-analytics] EVENT playerready

Property set to full:

[mux-analytics] EVENT playing
player_name:Reset Player,



full, partial or none


Outputs the data (full) or event(s) (partial) that is being sent (at the time of sending). Default value is none.

Example output

Property set to partial:

[mux-analytics] BEACON (2) [ playerready viewstart ]

Property set to full:

[mux-analytics] BEACON (2)
player_name:Reset Player,
}, {
player_name:Reset Player,



Protocol + domain name. Eg.


Controls to which domain the data should be sent. Useful for environmental builds of your project

5Make your data actionable

The Roku SDK supports adding metadata via two different mechanisms.

The majority of the metadata should be passed inside the muxConfig object that is passed to the Mux Task. You can read detailed information about the fields that are supported in Metadata. To update any field, update this within muxConfig and then call m.mux.setField("config", muxConfig).

Some other underlying information is mapped from standard Roku content metadata, most of which you probably already set when creating your video. In particular, the metadata fields that you should set (if you do not already) are:

  • ContentType
  • URL
  • Live
  • StreamFormat
  • Length

6Advertising configuration

If advertising is to be used, you must send the appropriate events to the Mux Task, as shown below.

function setUpRokuAdFramework
adIface.SetTrackingCallback(adTrackingCallback, adIface)
end function
function adTrackingCallback(obj = Invalid as Dynamic, eventType = Invalid as Dynamic, ctx = Invalid as Dynamic)
m.mux = GetGlobalAA().global.findNode("mux")
m.mux.setField("rafEvent", {obj:obj, eventType:eventType, ctx:ctx})
end function

If you are utilizing RAF's renderStitchedStream method to stitch ads and content together client-side, then you must tell the Mux SDK that this is in use. This is set via useRenderStitchedStream on the Mux Task, set to "true", such as:

mux.setField("useRenderStitchedStream", "true")

If you are not utilizing renderStitchedStream but instead controlling ad and content playback directly, then you need to set useRenderStitchedStream to "false".

7Additional configuration

In some situations, it is necessary to directly signal the beginning or ending of a view to Mux. This is necessary when the Video Node is recycled (i.e. more pieces of content are loaded into the same Node), or when using advertising, as the ads run outside of the lifecycle of the Video.

Note: A view is defined as the user watching a single piece of content, which includes any advertising.

mux = GetGlobalAA().global.findNode("mux")
' To signal the start of a view:
mux.setField("view", "start")
' To signal the end of a view:
mux.setField("view", "end")

The exitType setting controls the behavior of the task when a request to exit/terminate the thread is invoked (via mux.exit=true). The default value of exitType is hard.

If the value is set to hard then the thread terminates immediately and any data that has not propagated already to the MUX servers is lost.

If the value is set to soft then the thread sends all the remaining data to the MUX servers and terminates afterward.

To change value to soft call m.mux.setField("exitType", "soft")

NOTE: This means that there might be a time difference between you calling mux.exit=true and the task thread actually terminating. Please ensure you have a single MUX Task running at any given time.

Release notes

Current Release


  • Fix an issue where views were not tracked correctly when playing with advertisements via renderStitchedStream
  • Fix an issue where player_init_time was expected as a string but would not work correctly
  • Performance improvements
  • Update sample app to have option for renderStitchedStream

Previous Releases


  • Add support for collecting dropped frame counts automatically where possible


  • Add support for beaconCollectionDomain
  • Add support for setting env_key instead of property_key


  • Fix a syntax issue causing compilation problems


  • Fix a misnamed ad event (adpause was incorrectly sent as adpaused)
  • Add support for a few more ad events
  • Fix an issue where ad play count was attributed at ad completion, rather than ads beginning to play


  • Fix an issue where certain env keys were not handled correctly


  • Fix an issue where hostname extraction did not work correctly for hostnames with -s


  • Fixes an issue where certain Roku devices would not correctly expose the model number



  • Add drmType property to the Mux node. This value is automatically reported from the player if available (#44)
  • Add droppedFrames property to the Mux node. This value is must be reported from your player. (#44)
  • Add errorContext field to Error Events. This value is automatically reported from the player if available (#44)


  • Fixes an issue that could cause incorrect playback reporting when seeking occurs during a view and updated the SDK testing infrastructure.


  • Remove auto-generated video_id value; applications should pass their own video_id in the metadata.


  • Fix an issue where an invalid value provided for player_init_time could cause the application to crash.


  • Add support for custom dimensions


  • Fix an issue where properties from the Roku application (such as Director) that are not string types crash the application
  • Fix an issue with the sample application running ads


  • Fix an issue where viewer_device_model was not populated correctly.


  • Fix an issue where the player playhead position was not reported. This has no impact on collected metrics, but fixes a display issue within the dashboard when viewing individual views.


  • Fix an issue where viewer_user_id was overwritten unintentionally.
  • Fix an issue where player_mux_plugin_name and device type were set incorrectly.
  • Fix an issue where the seeked event was incorrectly named.
  • Provide updated device information to match the intended uses for each field.
  • Fix an issue where certain metrics (large numbers) were sent in scientific notation, causing incorrect values to be stored.
  • Fix an issue where error code and message were incorrectly sent with aderror events.


  • Remove the debug option of mux_minification. If you set this, it will have no action. Instead, all events and beacons will be logged in an un-minified version, while everything will be sent to the Mux backend minified.
  • Update such that player_instance_id (controlled by the Mux SDK) is sent as a GUID rather than a different format of ID.


  • Add exitType configuration option
  • Fix an issue where source duration is reported incorrectly
  • Fix an issue where, on certain devices, the rebuffer percentage could be reported incorrectly (e.g. extremely high)
  • Fix an issue where watch_time may have been calculated incorrectly in certain situations
  • Fix an issue to allow correctly tracking exits before video start

Was this page helpful?