Apple TV Docs

Media Commands

The commands below are related to the playback of media within the app.

Note

  You cannot play YouTube content in an Apple TV application. (Why?)  

Notes

Both of the media commands below share some common functionality as it relates to working with MediaElements. Here are some things you should know.

  1. To set the resume location from an existing interaction provide the map from the interaction using the rockWatchMap property.
  2. To append to the watch map of an existing interaction provide both the rockInteractionGuid as well as the rockWatchMap property.
  3. If you provide a rockWatchMap without a rockInteractionGuid property the watch map will be used for determining the resume location, but a new interaction will be written with a fresh watch map (so the watch map will start where they last left off).

Play Video

Plays the video file using the provided configuration.

<buttonLockup rockCommand="playVideo" 
     rockVideoUrl="https://rockrms.blob.core.windows.net/videos/rock-sample-video.mp4">
    <badge src="resource://button-preview" />
    <title>Play</title>
</buttonLockup>

Additional configuration options include the following:

ParameterTypeDescription
rockVideoUrlstringThe URL to the video file to play. Should be MP4 or HLS file.
rockVideoMediaElementGuidstringThe GUID of the Rock media file. This is only needed if the audio/video is a Rock Media Element. This will be used to track watches.
rockVideoRelatedEntityTypeIdintThe Entity Type ID that the media file is related to.
rockVideoRelatedEntityIdintThe Entity ID that the media file is related to.
rockVideoEnableResumebooleanDetermines if the enabled resume feature is enabled. This allows the individual to start the playing of the media file where they last left off. Defaults to true.
rockVideoTitlestringThe title of the media file. This will show as meta data when the file is in the player.
rockVideoSubtitlestringThe subtitle of the media file. This shows as meta data when the file is in the player.
rockVideoArtworkImageURLstringThe URL where the media file's artwork can be loaded. This will show as meta data when the file is in the player.
rockVideoDescriptionstringThe description of the media file. This will show as meta data when the file is in the player.
rockInteractionGuidstringThe GUID of the interaction that should be used to append to.
rockWatchMapstringThe existing watch map that, when provided, will be used to append to.

Play Audio

Plays the audio file using the provided configuration.

<buttonLockup rockCommand="playAudio" 
    rockAudioUrl="https://rockrms.blob.core.windows.net/videos/rock-sample-audio.mp3">
    <badge src="resource://button-preview" />
    <title>Play</title>
</buttonLockup>

Additional configuration options include the following:

rockAudioUrlstringThe URL to the video file to play. Should be MP3 file.
rockVideoMediaElementGuidintThe GUID of the Rock media file. This is only needed if the audio/video is a Rock Media Element. This will be used to track watches.
rockAudioRelatedEntityTypeIdintThe Entity Type ID that the media file is related to.
rockAudioRelatedEntityIdintThe Entity ID that the media file is related to.
rockAudioEnableResumebooleanDetermines if the enabled resume feature is enabled. This allows the individual to start the playing of the media file where they last left off.
rockAudioTitlestringThe title of the media file. This will show as meta data when the file is in the player.
rockAudioSubtitlestringThe subtitle of the media file. This shows as meta data when the file is in the player.
rockAudioArtworkImageURLstringThe URL where the media file's artwork can be loaded. This will show as meta data when the file is in the player.
rockAudioDescriptionstringThe description of the media file. This will show as meta data when the file is in the player.
rockInteractionGuidstringThe GUID of the interaction that should be used to append to.
rockWatchMapstringThe existing watch map that, when provided, will be used to append to.