MLMZCController Plugin

From Cinemar Wiki
Jump to: navigation, search

About

The MLSpeakerCraft MZC Control driver is to be used with the MLSpeakerCraft plugin. This driver adds support for the SpeakerCraft MZC-66 and MZC-88.

Last Revision to this Document
November 9, 2007

Software Requirements

  • MLServer 3
  • MainLobby 3
  • MLSpeakerCraft Family Plugin
  • MZC Control Driver

Supported Hardware

  • SpeakerCraft MZC-66
  • SpeakerCraft MZC-88

MLServer Commands

Zone Commands

PowerOn
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~PowerOn

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~PowerOn
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~PowerOn

Parameters:
Zone = The zone to power on.

Returns:
Nothing

Description:
This command turns the specified zone on.

Notes:

PowerOff
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~PowerOff

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~PowerOff
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~PowerOff

Parameters:
Zone = The zone to power off.

Returns:
Nothing

Description:
This command turns the specified zone off.

Notes:

MuteOn
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~MuteOn

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~MuteOn
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~MuteOn

Parameters:
Zone = The zone to mute.

Returns:
Nothing

Description:
This command mutes the specified zone.

Notes:

MuteOff
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~MuteOff

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~MuteOff
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~MuteOff

Parameters:
Zone = The zone to unmute.

Returns:
Nothing

Description:
This command unmutes the specified zone.

Notes:

MuteToggle
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~MuteToggle

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~MuteToggle
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~MuteToggle

Parameters:
Zone = The zone to toggle the mute state on.

Returns:
Nothing

Description:
This command toggles the current mute state of the specified zone.

Notes:

VolumeUp
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~VolumeUp

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~VolumeUp
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~VolumeUp

Parameters:
Zone = The zone to increase the volume on.

Returns:
Nothing

Description:
This command increases the volume of the specified zone one step.

Notes:

VolumeDown
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~VolumeDown

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~VolumeDown
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~VolumeDown

Parameters:
Zone = The zone decrease the volume on.

Returns:
Nothing

Description:
This command decreases the volume on the specified zone by one step.

Notes:

VolumeDirect
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~VolumeDirect~<<Level>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~VolumeDirect~50
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~VolumeDirect~20

Parameters:
Zone = The zone adjust the volume on. (1-24)
Level = The volume to set the zone to. (0-44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76, 78,80)

Returns:
Nothing

Description:
This command sets the volume in the specified zone to the specified level.

Notes:

BassUp
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~BassUp

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~BassUp
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~BassUp

Parameters:
Zone = The zone to increase the bass on.

Returns:
Nothing

Description:
This command increases the bass in the specified zone by one step.

Notes:

BassDown
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~BassDown

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~BassDown
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~BassDown

Parameters:
Zone = The zone to decrease the bass on.

Returns:
Nothing

Description:
This command decreases the bass in the specified zone by one step.

Notes:

BassFlat
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~BassFlat

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~BassFlat
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~BassFlat

Parameters:
Zone = The zone to adjust the bass on.

Returns:
Nothing

Description:
This command sets the bass in the specified zone to 0.

Notes:

BassDirect
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~BassDirect~<<Level>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~BassDirect~-12
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~BassDirect~12

Parameters:
Zone = The zone to adjust the bass on.
Level = The level to set the bass to.

Returns:
Nothing

Description:
This command sets the bass in the specified zone to the specified level.

Notes:

BassDirectPercent
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~BassDirectPrecent~<<Level>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~BassDirectPrecent~32
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~BassDirectPrecent~100

Parameters:
Zone = The zone to adjust the bass on.
Level = The percent level to set the bass to. 0%=-12,50%=0,100%=12

Returns:
Nothing

Description:
This command sets the bass in the specified zone to the specified level.

Notes:

TrebleUp
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~TrebleUp

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~TrebleUp
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~TrebleUp

Parameters:
Zone = The zone to increase the treble on.

Returns:
Nothing

Description:
This command increases the treble in the specified zone by one step.

Notes:

TrebleDown
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~TrebleDown

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~TrebleDown
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~TrebleDown

Parameters:
Zone = The zone to dencrease the treble on.

Returns:
Nothing

Description:
This command decreases the treble in the specified zone by one step.

Notes:

TrebleFlat
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~TrebleFlat

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~TrebleFlat
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~TrebleFlat

Parameters:
Zone = The zone to adjust the treble on.

Returns:
Nothing

Description:
This command sets the treble in the specified zone to 0.

Notes:

TrebleDirect
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~TrebleDirect~<<Zone>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~TrebleDirect~-12
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~TrebleDirect~12

Parameters:
Zone = The zone to adjust the treble on.
Level = The level to set the treble to.

Returns:
Nothing

Description:
This command increases the bass in the specified zone by one step.

Notes:

TrebleDirectPercent
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~TrebleDirectPercent~<<Level>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~TrebleDirectPrecent~0
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~TrebleDirectPrecent~75

Parameters:
Zone = The zone to adjust the treble on.
Level = The precent level to set the treble to. 0%=-12,50%=0,100%=12

Returns:
Nothing

Description:
This command increases the bass in the specified zone by one step.

Notes:

PartyOn
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~PartyOn

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~PartyOn
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~PartyOn

Parameters:
Zone = The zone to make the party master.

Returns:
Nothing

Description:
This command sets the device to party mode and makes the specified zone the party master.

Notes:

PartyOff
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~PartyOff

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~PartyOff
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~PartyOff

Parameters:
Zone = The zone to take out of party mode.

Returns:
Nothing

Description:
This command takes the specified zone out of party mode.

Notes:

TunerPreset
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~TunerPreset~<<Preset>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~TunerPreset~2
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~TunerPreset~1

Parameters:
Zone = The zone to adjust the tuner on.
Preset = The preset to set the zone to.

Returns:
Nothing

Description:
This command sets the tuner on the specified zone to the specified preset.

Notes:

VideoRouting
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~VideoRouting~<<Source>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~VideoRouting~2
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~VideoRouting~1

Parameters:
Zone = The zone to route the video to.
Source = The source to route to the zone.

Returns:
Nothing

Description:
This command routes the specified source video to the specified zone.

Notes:

AudioRouting
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~AudioRouting~<<Source>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~AudioRouting~2
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~AudioRouting~1

Parameters:
Zone = The zone to route the audio to.
Source = The source to route to the zone.

Returns:
Nothing

Description:
This command routes the specified source audio to the specified zone.

Notes:

SetSource
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~SetSource~<<Source>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~SetSource~2
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~SetSource~1

Parameters:
Zone = The zone to set the source on.
Source = The source to set the zone to.

Returns:
Nothing

Description:
This command set the specified zone to the specified source.

Notes:

ButtonPress
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Zone~<<Zone>>~ButtonPress~<<Address>>~<<Source>>~<<Button>>

Literal:
MLServeCmd.MLSpeakerCraft|1~Zone~1~ButtonPress~1~1~1
MLServeCmd.MLSpeakerCraft|MyMZC~Zone~1~ButtonPress~1~1~3

Parameters:
Zone = The zone to simulate the button press from.
Address = The address of the unit to simulate the button press from.
Source = The source to simulate the button press from.
Button = The key code of the button press to simulate

Returns:
Nothing

Description:
This command similates a keypad button press.

Notes:
At this point we do not know the exact key codes to be used for each button

Tuner Commands


SeekUp
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Tuner~<<Tuner>>~SeekUp

Literal:
MLServeCmd.MLSpeakerCraft|1~Tuner~1~SeekUp
MLServeCmd.MLSpeakerCraft|MyMZC~Tuner~1~SeekUp

Parameters:
Tuner = The tuner to seek up.

Returns:
Nothing

Description:
This command seeks the frequency on the specified tuner up.

Notes:

SeekDown
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Tuner~<<Tuner>>~SeekDown

Literal:
MLServeCmd.MLSpeakerCraft|1~Tuner~1~SeekDown
MLServeCmd.MLSpeakerCraft|MyMZC~Tuner~1~SeekDown

Parameters:
Tuner = The tuner to seek down.

Returns:
Nothing

Description:
This command seeks the frequency on the specified tuner down.

Notes:

TuneUp
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Tuner~<<Tuner>>~TuneUp

Literal:
MLServeCmd.MLSpeakerCraft|1~Tuner~1~TuneUp
MLServeCmd.MLSpeakerCraft|MyMZC~Tuner~1~TuneUp

Parameters:
Tuner = The tuner to tune up.

Returns:
Nothing

Description:
This command tunes the frequency on the specified tuner up.

Notes:

TuneDown
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Tuner~<<Tuner>>~TuneDown

Literal:
MLServeCmd.MLSpeakerCraft|1~Tuner~1~TuneDown
MLServeCmd.MLSpeakerCraft|MyMZC~Tuner~1~TuneDown

Parameters:
Tuner = The tuner to tune down.

Returns:
Nothing

Description:
This command tunes the frquency on the specified tuner down.

Notes:

NextPreset
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Tuner~<<Tuner>>~NextPreset

Literal:
MLServeCmd.MLSpeakerCraft|1~Tuner~1~NextPreset
MLServeCmd.MLSpeakerCraft|MyMZC~Tuner~1~NextPreset

Parameters:
Tuner = The tuner to change the preset on.

Returns:
Nothing

Description:
This command tunes the specified tuner to the next preset.

Notes:

PreviousPreset
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Tuner~<<Tuner>>~PreviousPreset

Literal:
MLServeCmd.MLSpeakerCraft|1~Tuner~1~PreviousPreset
MLServeCmd.MLSpeakerCraft|MyMZC~Tuner~1~PreviousPreset

Parameters:
Tuner = The tuner to change the preset on.

Returns:
Nothing

Description:
This command tunes the specified tuner to the previous preset.

Notes:

AMFM
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Tuner~<<Tuner>>~AMFM

Literal:
MLServeCmd.MLSpeakerCraft|1~Tuner~1~AMFM
MLServeCmd.MLSpeakerCraft|MyMZC~Tuner~1~AMFM

Parameters:
Tuner = The tuner to change the band on.

Returns:
Nothing

Description:
This command toggles the specified tuners band.

Notes:

MonoStereo
MLServeCmd Script Usage:
MLServeCmd.MLSpeakerCraft|<<ID/Alias>>~Tuner~<<Tuner>>~MonoStereo

Literal:
MLServeCmd.MLSpeakerCraft|1~Tuner~1~MonoStereo
MLServeCmd.MLSpeakerCraft|MyMZC~Tuner~1~MonoStereo

Parameters:
Tuner = The tuner to change mode on.

Returns:
Nothing

Description:
This command toggle the mode of the specified tuner between mono and stereo.

Notes:

MLServer Variables

MLSpeakerCraft_<<Device_Id>>_Product_Version
Description: The product version of the device.
Values: Manufacturer defined

MLSpeakerCraft_<<Device_Id>>_Firmware_Version
Description: The firmware version of the device.
Values: Manufacturer defined.

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Source
Description: The current source of the zone.
Values: 1 - 7

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Power
Description: The current power state of the zone.
Values: On,Off

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Volume
Description: The current absolute volume of the zone.
Values: 0-44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76,78,80

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Volume_Percent
Description: The current volume of the zone as a percentage.
Values: 0 - 100

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Mute
Description: The current mute state of the zone.
Values: On,Off

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Bass
Description: The current bass level of the zone.
Values: -12 - 12

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Bass_Percent
Description: The current bass level of the zone as a percentage.
Values: 0 - 100

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Treble
Description: The current treble level of the zone.
Values: -12 - 12

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Treble_Percent
Description: The current treble level of the zone as a percentage.
Values: 0 - 100

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Party_Mode
Description: The current party mode state of the zone.
Values: True,False

MLSpeakerCraft_<<Device_Id>>_Zone_<<Zone_Num>>_Party_Master
Description: The current party master state of the zone.
Values: True,False

MLSpeakerCraft_<<Device_Id>>_Tuner_<<Tuner_Num>>_Frequency
Description: The current frequency of the tuner.
Values:

USA FM 87.5 MHz – 107.9 MHz 200KHz jumps
Euro FM 87.50 MHz – 108.00 MHz 50KHz jumps
USA AM 520 KHz – 1710 KHz 10KHz jumps
Euro AM 522 KHz – 1620 KHz 9KHz jumps


MLSpeakerCraft_<<Device_Id>>_Tuner_<<Tuner_Num>>_Station
Description: The current station of the tuner.
Values: Any valid station id.

MLSpeakerCraft_<<Device_Id>>_Tuner_<<Tuner_Num>>_Flags
Description: The device local.
Values: 0 = US , 1 = Europe

Bugs

New Feature Requests