MusicCast virtual object configuration
TutorialNOTE!
The described virtual object is available for GATE HTTP INT-211-E-01 with firmware 1.3.1 or higher!
The described virtual object is available for GATE HTTP INT-211-E-01 with firmware 1.3.1 or higher!
The MusicCast object is used to integrate Yamaha speaker with the Grenton system using the GATE module.
Before integrating Yamaha speakers with the system, the speaker should be configured in the local network using dedicated application and read its assigned IP address.
To connect Yamaha speaker to system, create a new MusicCast virtual object:
Set the parameters in the Embedded features tab:
- Host: e.g. - 192.168.20.105 (speaker IP address)
- UpdatePeriod: 1000
After sending the configuration, the Status feature should take the value 1. This is information about the correct connection of the speaker to the system.
NOTE!
If more objects are used, there may be issues due to limited network and/or device bandwidth. In such a situation, as the number of created objects continues to increase, it is recommended to increase the value of the UpdatePeriod feature.
If more objects are used, there may be issues due to limited network and/or device bandwidth. In such a situation, as the number of created objects continues to increase, it is recommended to increase the value of the UpdatePeriod feature.
Configuration parameters
FEATURES
| Name | Description |
|---|---|
Host | MusicCast IP Address |
UpdatePeriod | State update period |
Status | Communication status: 0 - no connection, 1 - connected |
ErrorCode | Last error code: 0 - no error, negative values - negative HTTP status codes, positive values - Yamaha Extended Control error codes |
Volume | Volume level ranging from 0% to 100% |
Mute | Mute state: 0 - Off, 1 - On |
Artist | Artist |
Title | Title |
State | Playback state: 1 - playing, 2 - stopped, 3 - paused |
Shuffle | Shuffle mode: 1 - off, 2 - on, 3 - songs, 4 - albums |
Repeat | Repeat mode: 1 - off, 2 - one, 3 - all |
Power | Power state: 0 - standby, 1 - on |
AlbumArt | Album art address |
ObjectID | Object ID |
ServerID | Server object ID |
Name | Speaker name |
Role | Grouped speaker role: 1 - not part of any group, 2 - client, 3 - server |
Input | Input source |
AutoPowerStandby | AutoPowerStandby state: 0 - off, 1 - on |
METHODS
| Name | Description |
|---|---|
SetUpdatePeriod | Sets the state update period |
SetVolume | Sets the volume level, ranging from 0% to 100% |
SetMute | Sets the mute state |
SetShuffle | Sets the shuffle mode |
SetRepeat | Sets the repeat mode |
SetPower | Sets the power state |
SetAutoPowerStandby | Sets the AutoPowerStandby state |
Play | Starts playback |
Pause | Pauses playback |
Stop | Stops playback |
Next | Switches to the next track |
Prev | Switches to the previous track |
VolumeUp | Increases the volume by a specified percentage |
VolumeDown | Decreases the volume by a specified percentage |
SwitchMute | Switches the mute state |
SwitchPlay | Switches the playback state between paused and playing |
DestroyGroup | Destroys the current speaker group |
JoinGroup | Joins the speaker group specified by the ServerID |
LeaveGroup | Leaves the current speaker group |
SetInput | Sets the input source |
EVENTS
| Name | Description |
|---|---|
OnConnected | Event executed after successful speaker connection establishment |
OnDisconnected | Event executed after the speaker connection has been lost |
OnError | Event executed after an error has been detected |
OnChange | Event executed after a Volume, Mute, Artist, Title, State, Shuffle, Repeat, Power, AlbumArt, Input, AutoPowerStandby, ServerID, Role change occurs |
OnMuteChange | Event executed after a Mute change occurs |
OnVolumeChange | Event executed after a Volume change occurs |
OnTitleChange | Event executed after a Title change occurs |
OnArtistChange | Event executed after an Artist change occurs |
OnStateChange | Event executed after a State change occurs |
OnShuffleChange | Event executed after a Shuffle change occurs |
OnRepeatChange | Event executed after a Repeat change occurs |
OnPowerChange | Event executed after a Power change occurs |
OnAlbumArtChange | Event executed after an AlbumArt change occurs |
OnInputChange | Event executed after an Input change occurs |
OnAutoPowerStandbyChange | Event executed after an AutoPowerStandby change occurs |
OnGroupChange | Event executed after a group related state change occurs (ServerID, Role) |