MLSatRadio

From Cinemar Wiki
Jump to: navigation, search

About

The MLSatRadio Plugin is used to create SIRIUS or XM radio players. Although the base module supports one radio, up to 5 radios are supported by upgrading the license. Until you register the plugin, you have a 30 day trial which will have 3 radios enabled. You can have 4 independent streaming radios and 1 hardware based radio.

Requirements

This plugin uses the 2010 version of the music controls. These are the same supporting controls that are used by MusicLobby and ClientSvc. If you are an existing MusicLobby and/or ClientSvc user then you must install the latest versions of the MusicLobby and ClientSvc plugins when you install this plugin!

Installation

MLSatRadio plugin is available for purchase via the Cinemar shopping cart system. Note that with the shopping cart, you will receive your activation keys up to a day or two after you purchase it, so be patient, the plugin will work as a trial for 30 days until you complete the registration process.

To install the plugin using the Cinemar Installation Assistant, find the string "satradio" and you will see two items: one is the server plugin itself and the other is the client module.

Download and run the MLSATRadio driver on your server, it will installs the DLL.

MLSatRadio.dll

The Plugin to control SIRIUS or XM radios.

With MLServer and ClientSvc shutdown, run the MLSatRadio_Plugin_Setup.exe. This will install the MLSatRadio plugin to the MLServer Plugins directory. It is recommended to accept all installation defaults.

Once the server has been installed, download and install the Client module to your client machine(s). This executable will install the sample scenes under your CONTENT folder. Before running the scenes, configure the plugin by right clicking on it in the mlserver plugin list and then select "options".

Configuration

Radios 1 through 4 are streaming radios and utilize your Internet connection to play SIRIUS or XM radio channels. You need a permanent Internet connection and sufficient bandwidth to play a 128kb stream. Just about any existing Internet connection will do. You will also have to subscribe to the optional streaming services from SIRIUS or XM. If you plan on using the streaming services then you can define up to 4 independent radios each capable of playing their own stream.

In order to play streaming stations the plugin will need to know your username and password for accessing the streaming servers. Enter this information on the first settings tab. As the note says you only have to enter this information if you plan on using radios 1-4.


SatSettings.png


Streaming radios can either be on the MLServer PC or remote PCs using the optional ClientSvc program. The following image shows a typical remote radio setup for Radio #1


SRSettings-2.png


When you configure a streaming radio that is local to your MLServer PC then you must specify the sound card and pair of channels to use when playing the radio station. Using a typical 7.1 sound card you will be able to define the four unique radios. The following images shows a typical configuration.


SRSettings-3.png


When you choose to use a hardware based radio then you do that on Radio #5. All you need to do is specify the type of radio you have and the comm port it is connected to. Currently the XMPCR, XM Direct and Polk XRt12 radios are supported along with a special radio called “Generic Radio”. When the “Generic Radio” is used the plugin will issue special MLServer macro commands to control the radio. The Macro commands issued are:

  • SatRadio.ChannelUp
  • SatRadio.ChannelDown
  • SatRadio.Channel<<channelnumber>>
  • SatRadio.PowerOn
  • SatRadio.PowerOff
  • SatRadio.MuteOn
  • SatRadio.MuteOff
  • SatRadio.VolumeUp
  • SatRadio.VolumeDown
  • SatRadio.Volume~<<volume>>

If you use the XMPCR or XM Direct radios then you will have the additional option to collect now playing information directly from the radio for those stations that are not available online.

SatRadio5.png


FAVORITES AND THE CHANNELS DATABASE: Depending on which service you have (Sirius or XM), you can click on the tab for that service to set your Favorite stations (which can be displayed exclusively in the browse lists). The table also includes a checkbox showing which channels are available "online" (some are not offered by the Sirius/XM service). Although these checkboxes are not editable here, you can edit the database with Microsoft Access or MDBPlus by opening the Satradio.mdb file. Make sure you keep a backup before you do any editing! This allows you to effectively "censor" any channels that you would never wish to appear in your browse listing.

Sample User Interface

The first image displayed in the blue area below (0019_Media_SatRadio.mls) shows the new browsing capabilities. Everything is user customizable. The default browsing scenes will display 10 stations per page. You can change this in the startup macro for the scene (available from the MainLobby OPTIONS button then the MORE button). NOTE: After initial installation you must select one of the five radio buttons to start a radio.


UI-1a.png


Here is the default Now Playing scene (0019_Media_SatRadio_NowPlaying.mls). If no song data appears, go back to the browse scene and start one of the radios. Please note that VU effects are only available for the 4 streaming radios.


UI-2a.png


You also have the ability to filter by genres. When you click on the Genres button the pop-up will display a list of selections (0019_Media_SatRadio_Filters.mls). Pick one and your browser will only show the matching selections. The startup macro on the browsing scene is used to configure the number of items to display per page.

UI-3a.png

MLServeCmds

SetRadio

{MLServeCmd}Script Usage

MLSatRadio|SetRadio~Radio#

Parameters
Radio# = The Radio to set active 1-5

(Literal)
MLSatRadio|SetRadio~1

Description

Sets the specified radio as the active radio on the client


NextRadio

{MLServeCmd}Script Usage

MLSatRadio|NextRadio~CurrentRadio#

Parameters
CurrentRadio# = The current Radio in use

(Literal)
MLSatRadio|NextRadio~1

Description

Sets the active radio to the next one in the list


PrevRadio

{MLServeCmd}Script Usage

MLSatRadio|PrevRadio~CurrentRadio#

Parameters
CurrentRadio# = The current Radio in use

(Literal)
MLSatRadio|PrevRadio~1

Description

Sets the active radio to the previous one in the list


Browse

{MLServeCmd}Script Usage

MLSatRadio|Browse~cmd

Parameters
Cmd = The direction to browse [First,Last,Prev,Next]

(Literal)
MLSatRadio|Browse~Next

Description

Browse to the specified page of channels


BrowseGenre

{MLServeCmd}Script Usage

MLSatRadio|BrowseGenre~cmd

Parameters
Cmd = The direction to browse genres [First,Last,Prev,Next]

(Literal)
MLSatRadio|BrowseGenre~Next

Description

Browse to the specified page of genres


SetFilter

{MLServeCmd}Script Usage

MLSatRadio|setFilter~Filter

Parameters
Filter = The genre filter to apply to browsing

(Literal)
MLSatRadio|setFilter~Favorites

Description

Applies the specified filter to channel browsing


PlayChannel

{MLServeCmd}Script Usage

MLSatRadio|PlayChannel~Channel#

Parameters
Channel# = The radio channel number to play

(Literal)
MLSatRadio|PlayChannel~16

Description

Starts playing the specified channel


NextChannel

{MLServeCmd}Script Usage

MLSatRadio|NextChannel

(Literal)
MLSatRadio|NextChannel

Description

Advances to the next available channel


PrevChannel

{MLServeCmd}Script Usage

MLSatRadio|PrevChannel

(Literal)
MLSatRadio|PrevChannel

Description

Advances to the previous available channel


SetVolume

{MLServeCmd}Script Usage

MLSatRadio|SetVolume~Radio#~Volume

Parameters
Radio# = The radio # to set volume on 1..5
Volume = The volume to be applied 0..100

(Literal)
MLSatRadio|SetVolume~1~78

Description

Sets the volume on the specified radio


Mute

{MLServeCmd}Script Usage

MLSatRadio|Mute~Radio#

Parameters
Radio# = The radio # to mute/unmute 1..5

(Literal)
MLSatRadio|Mute~1

Description

Mutes/UnMutes the specified radio


Stop

{MLServeCmd}Script Usage

MLSatRadio|Stop~Radio#

Parameters
Radio# = The radio # to stop playback on 1..5

(Literal)
MLSatRadio|Stop~1

Description

Stops playback on the specified radio


SetFavorite

{MLServeCmd}Script Usage

MLSatRadio|SetFavorite~Channel#

Parameters
Channel# = The channel # to make a favorite

(Literal)
MLSatRadio|SetFavorite~16

Description

Marks the specified channel as a favorite


RemoveFavorite

{MLServeCmd}Script Usage

MLSatRadio|RemoveFavorite~Channel#

Parameters
Channel# = The channel # to remove as a favorite

(Literal)
MLSatRadio|RemoveFavorite~16

Description

Removes the specified channel as a favorite


TogglePower

{MLServeCmd}Script Usage

MLSatRadio|TogglePower

(Literal)
MLSatRadio|TogglePower

Description

Toggles Power on Radio #5.


PowerOn

{MLServeCmd}Script Usage

MLSatRadio|PowerOn

(Literal)
MLSatRadio|PowerOn

Description

Turns Radio #5 on


PowerOff

{MLServeCmd}Script Usage

MLSatRadio|PowerOff

(Literal)
MLSatRadio|PowerOff

Description

Turns Radio #5 off


MLServer Variables

MLSatRadio Server Variables

  • mlsatradio_<<List#>>_channelnum_{{Clientname}}
  • mlsatradio_activeradio_alias_{{Clientname}}
  • mlsatradio_activeradio_{{Clientname}}
  • mlsatradio_current_channel_<<Radio#>>_{{Clientname}}
  • mlsatradio_filterclass_{{Clientname}}
  • mlsatradio_filterdescr_{{Clientname}}
  • mlsatradio_filterinit_{{Clientname}}
  • mlsatradio_filter_<<List#>>_{{Clientname}}
  • mlsatradio_filter_firstpageitem_{{Clientname}}
  • mlsatradio_filter_itemsperpage_{{Clientname}}
  • mlsatradio_filter_pages_{{Clientname}}
  • mlsatradio_filter_page_{{Clientname}}
  • mlsatradio_firstpageitem_{{Clientname}}
  • mlsatradio_itemsperpage_{{Clientname}}
  • mlsatradio_pages_{{Clientname}}
  • mlsatradio_page_{{Clientname}}
  • mlsatradio_playing_<<Radio#>>
  • mlsatradio_mute_<<Radio#>>
  • mlsatradio_radio_<<Radio#>>_alias
  • mlsatradio_radio_<<Radio#>>_id
  • mlsatradio_volume_<<Radio#>>
  • mlsatradio_servicename_{{Clientname}}
  • mlsatradio_sirius_<<Channel#>>_artist
  • mlsatradio_sirius_<<Channel#>>_artistsong
  • mlsatradio_sirius_<<Channel#>>_channel
  • mlsatradio_sirius_<<Channel#>>_descr
  • mlsatradio_sirius_<<Channel#>>_favorite
  • mlsatradio_sirius_<<Channel#>>_genre
  • mlsatradio_sirius_<<Channel#>>_name
  • mlsatradio_sirius_<<Channel#>>_online
  • mlsatradio_sirius_<<Channel#>>_song
  • mlsatradio_xm_<<Channel#>>_artist
  • mlsatradio_xm_<<Channel#>>_artistsong
  • mlsatradio_xm_<<Channel#>>_channel
  • mlsatradio_xm_<<Channel#>>_descr
  • mlsatradio_xm_<<Channel#>>_favorite
  • mlsatradio_xm_<<Channel#>>_genre
  • mlsatradio_xm_<<Channel#>>_name
  • mlsatradio_xm_<<Channel#>>_online
  • mlsatradio_xm_<<Channel#>>_song
  • mlsatradio_totalitems_{{Clientname}}