KONtx.remotedevice.publishMediaLaunchMessage

publishes a message to remote devices identifying media to be launched

Synopsis

Boolean publishMediaLaunchMessage(Object data, [Array<String> InstanceIds])

Parameters

The Object data parameter is the payload sent to remote device(s). The data object has the following properties:

  • mimetype – A String representing the MIME type of the media.
  • name – A String for the name or title of the media.
  • url – A String for the URL of the media.

If the optional parameter instanceIds is specified, the message should only be sent to the remote devices identified. No other devices receive the message. This parameter can be a String for a single instanceId, an Array<String> of instanceIds or null. If null, the message is sent to all connected remote devices that are subscribed to media launch messages.

Returns

Returns true if sending the message is successful. Returns false otherwise.

Description

Helper method to publish a message to devices indicating a media type to be launched. Send the media's metadata to subscribed (or identified) devices so they can display the media.

Table of Contents