Yamaha MusicCast™

v0.2.2

Yamaha MusicCast™ v0.2.2 MusicCast.ExtendedControl

A module for working with Yamaha Extended Control (YXC).

YXC is Yamaha’s communication protocol sent over Ethernet and Wi-Fi to control MusicCast enabled devices. This implementation is based on the API Specification Rev. 1.00 published by Yamaha in 2016.

Instead of using this module directly, you should use MusicCast.Network and MusicCast.Network.Entity which provide a better abstraction to work with MusicCast devices.

Summary

Functions

get_account_status(host, options \\ [])

Returns account information registered on a device

get_cd_playback_info(host, options \\ [])

Returns CD playback information

get_device_info(host, options \\ [])

Returns basic information for a device

get_features(host, options \\ [])

Returns feature information for a device

get_func_status(host, options \\ [])

Returns information of overall system function

get_list_info(host, input, options \\ [])

Returns list information

get_location_info(host, options \\ [])

Returns location information

get_network_status(host, options \\ [])

Returns network related information

get_playback_info(host, options \\ [])

Returns playback information

get_playback_queue(host, options \\ [])

Returns playback queue

get_preset_info(host, options \\ [])

Returns network/usb preset information

get_service_info(host, input, type, options \\ [])

Returns account information registered on a device

get_signal_info(host, options \\ [])

Returns signal information

get_sound_program_list(host, options \\ [])

Returns a list of sound program available for the given zone

get_status(host, options \\ [])

Returns basic information for the given zone

get_tuner_playback_info(host, options \\ [])

Returns tuner playback information

get_tuner_preset_info(host, options \\ [])

Returns tuner preset information

manage_list(host, type, options \\ [])

Executes a list manage command

prepare_input_change(host, input, options \\ [])

Prepares device before changing input for a specific zone

recall_preset(host, num, options \\ [])

Recalls preset for the given zone

recall_tuner_preset(host, num, options \\ [])

Recalls tuner preset for the given zone

send_ir_code(host, code, options \\ [])

Sends the given remote IR code

set_auto_power_standby(host, enable, options \\ [])

Sets auto power standby status

set_cd_playback(host, playback, options \\ [])

Sets CD playback status

set_input(host, input, options \\ [])

Selects input for the given zone

set_list_control(host, type, options \\ [])

Executes a list control command

set_mute(host, enable, options \\ [])

Sets mute status for the given zone

set_playback(host, playback, options \\ [])

Sets playback status

set_power(host, power, options \\ [])

Sets power status for the given zone

set_search_string(host, search, options \\ [])

Search for the given string

set_sleep(host, sleep, options \\ [])

Sets sleep timer for the given zone

set_sound_program(host, program, options \\ [])

Selects sound program for the given zone

set_tuner_dab_service(host, options \\ [])

Sets tuner DAB service

set_tuner_freq(host, freq, options \\ [])

Sets tuner frequency

set_volume(host, volume, options \\ [])

Sets volume for the given zone

store_preset(host, num, options \\ [])

Stores current content to a preset

store_tuner_preset(host, num, options \\ [])

Stores current tuner station to a preset

subscription_headers()

Returns the HTTP headers required to subscribe to YXC events

subscription_timeout()

Return the timeout after a MusicCast device will stop sending YXC events

switch_account(host, input, index, options \\ [])

Returns account information registered on a device

switch_tuner_preset(host, options \\ [])

Selects tuner preset

toggle_cd_repeat(host, options \\ [])

Toggles CD repeat setting

toggle_cd_shuffle(host, options \\ [])

Toggles CD shuffle setting

toggle_cd_tray(host, options \\ [])

Toggles CD tray setting

toggle_repeat(host, options \\ [])

Toggles repeat setting

toggle_shuffle(host, options \\ [])

Toggles shuffle setting

Functions

get_account_status(host, options \\ [])

Returns account information registered on a device.

get_cd_playback_info(host, options \\ [])

Returns CD playback information.

get_device_info(host, options \\ [])

Returns basic information for a device.

get_features(host, options \\ [])

Returns feature information for a device.

get_func_status(host, options \\ [])

Returns information of overall system function.

get_list_info(host, input, options \\ [])

Returns list information.

get_location_info(host, options \\ [])

Returns location information.

get_network_status(host, options \\ [])

Returns network related information.

get_playback_info(host, options \\ [])

Returns playback information.

get_playback_queue(host, options \\ [])

Returns playback queue.

get_preset_info(host, options \\ [])

Returns network/usb preset information.

get_service_info(host, input, type, options \\ [])

Returns account information registered on a device.

get_signal_info(host, options \\ [])

Returns signal information.

get_sound_program_list(host, options \\ [])

Returns a list of sound program available for the given zone.

get_status(host, options \\ [])

Returns basic information for the given zone.

get_tuner_playback_info(host, options \\ [])

Returns tuner playback information.

get_tuner_preset_info(host, options \\ [])

Returns tuner preset information.

manage_list(host, type, options \\ [])

Executes a list manage command.

prepare_input_change(host, input, options \\ [])

Prepares device before changing input for a specific zone.

This is valid only when “prepare_input_change” exists in “func_list” found in get_func_status/1

recall_preset(host, num, options \\ [])

Recalls preset for the given zone.

recall_tuner_preset(host, num, options \\ [])

Recalls tuner preset for the given zone.

send_ir_code(host, code, options \\ [])

Sends the given remote IR code.

A device is operated same as remote IR code reception. But continuous IR code cannot be used in this command.

Refer to each device’s IR code list for details.

set_auto_power_standby(host, enable, options \\ [])

Sets auto power standby status.

Actual operations/reactions of enabling auto power standby depend on each device.

set_cd_playback(host, playback, options \\ [])

Sets CD playback status.

set_input(host, input, options \\ [])

Selects input for the given zone.

set_list_control(host, type, options \\ [])

Executes a list control command.

set_mute(host, enable, options \\ [])

Sets mute status for the given zone.

set_playback(host, playback, options \\ [])

Sets playback status.

set_power(host, power, options \\ [])

Sets power status for the given zone.

set_search_string(host, search, options \\ [])

Search for the given string.

set_sleep(host, sleep, options \\ [])

Sets sleep timer for the given zone.

set_sound_program(host, program, options \\ [])

Selects sound program for the given zone.

set_tuner_dab_service(host, options \\ [])

Sets tuner DAB service.

set_tuner_freq(host, freq, options \\ [])

Sets tuner frequency.

set_volume(host, volume, options \\ [])

Sets volume for the given zone.

store_preset(host, num, options \\ [])

Stores current content to a preset.

store_tuner_preset(host, num, options \\ [])

Stores current tuner station to a preset.

subscription_headers()

Returns the HTTP headers required to subscribe to YXC events.

subscription_timeout()

Return the timeout after a MusicCast device will stop sending YXC events.

switch_account(host, input, index, options \\ [])

Returns account information registered on a device.

switch_tuner_preset(host, options \\ [])

Selects tuner preset.

Only call this API after changing the target zone’s input to tuner.

toggle_cd_repeat(host, options \\ [])

Toggles CD repeat setting.

toggle_cd_shuffle(host, options \\ [])

Toggles CD shuffle setting.

toggle_cd_tray(host, options \\ [])

Toggles CD tray setting.

toggle_repeat(host, options \\ [])

Toggles repeat setting.

toggle_shuffle(host, options \\ [])

Toggles shuffle setting.