Skip to content

Google Cast (Chromecast)

If your media device can be Cast to using this button Chromecast Icon on your phone/computer then multi-scrobbler can monitor it in order to scrobble music you play.

Cast devices can be manually configured using file-based configuration OR automatically discovered using mDNS.

Add each device’s name and IP address to devices in the file-based config. This works with every installation method, including Docker with default (bridge) networking. When devices is set, mDNS discovery is disabled unless useAutoDiscovery is explicitly set to true.

chromecast.json
[
{
"name": "MyCast",
"type": "chromecast",
"data": {
"devices": [
{"name": "Living Room TV", "address": "192.168.0.115"}
]
}
}
]

MS can also discover cast devices by listening for mDNS traffic on port 5353/UDP. The machine running MS must be able to send and receive multicast traffic on the same network as your cast devices.

  • Local installation: no additional setup is required, other than allowing 5353/UDP through the host’s firewall.
  • Docker with host networking (network_mode: host): no additional setup is required.
  • Docker with default (bridge) networking: containers can’t see multicast traffic from the host’s network. Configure devices manually or add an mDNS reflector to your stack as described below.
mDNS Reflector with Docker

dockurr/mdns runs on the host’s network and copies mDNS traffic between your LAN and the Docker network MS uses, so MS can discover devices while staying on a bridge network.

Add it to the same compose stack as MS and give MS’s network a fixed bridge name:

docker-compose.yml
services:
multi-scrobbler:
image: foxxmd/multi-scrobbler
# ...your existing environment, volumes, ports, etc.
networks:
- ms
mdns:
image: dockurr/mdns
network_mode: host1
environment:
INTERFACES: "LAN_INTERFACE br-ms"23
restart: on-failure:34
networks:
ms:
driver_opts:
com.docker.network.bridge.name: br-ms5
  1. 1.The host's firewall must allow 5353/UDP on both interfaces.
  2. 2.Replace LAN_INTERFACE with the name of the host's network interface on your LAN, such as eth0, enp3s0 or wlan0.
  3. 3.The second interface name must match com.docker.network.bridge.name. If MS already uses a network you created, add the same driver_opts to it and recreate the network.
  4. 4.The reflector exits if the LAN interface is not connected, for example while Wi-Fi is still connecting at boot. restart: on-failure:3 retries a few times instead of restarting forever.
  5. 5.Be aware that all mDNS traffic is copied between your LAN and the ms network, not only Google Cast traffic.

Cast devices report what type of media the current activity is (see metadata property here). The reported type is dependent on the application playing the media to correctly report it, the cast device does not magically know what the media is. If an application does not report a type it is always classified as unknown.

By default, MS will only track media that is reported as MusicTrack.

Media with an Unknown (Generic) media type can be explicitly allowed by setting "allowUnknownMedia": true in the file-based configuration. This can also be configured to only allow unknown media types for specific applications by using a list of application names.

Example
chromecast.json
[
{
"name": "MyCast",
"type": "chromecast",
"data": {
"allowUnknownMedia": ["smarttube", "default media receiver"]1
},
}
]
  1. 1.only allow unknown if app name contains any of these phrases

MS can be forced to track media from an application regardless of media type. This is useful if an application incorrectly reports a media type you are sure should be music. Set "forceMediaRecognitionOn" in the file-based configuration to a list of application names that should always be tracked.

Example
chromecast.json
[
{
"name": "MyCast",
"type": "chromecast",
"data": {
"forceMediaRecognitionOn": ["smarttube", "default media receiver"]1
},
}
]
  1. 1.media from applications that contains these phrases will always be tracked, regardless of media type reported

Please include any/all logs with raw output if there are any errors encountered as this is critical to diagnosing issues.

To diagnose bad/incomplete track information or strange MS player behavior please turn on payload logging and include log output of the source running to help diagnose this issue. Either enable in config using the below example OR enable Debug Mode.

Example
chromecast.json
[
{
"name": "MyCast",
"type": "chromecast",
"data": {
//...
},
"options": {
"logPayload": true
}
}
]

Configuration Type

This is configuration for the ENV Config Type.

Environmental Variable Type Default Description
CC_ID string A globally unique ID EX myComponentId
CC_NAME string Value of CC_ID A vanity name EX My Cool Component
CC_ENABLE boolean true Should this component be used?
CC_BLACKLIST_DEVICES string DO NOT scrobble from any cast devices on this comma-delimited list that START WITH these values
CC_WHITELIST_DEVICES string ONLY scrobble from any cast device on this comma-delimited list that START WITH these values
CC_BLACKLIST_APPS string DO NOT scrobble from any application on this comma-delimited list that START WITH these values
CC_WHITELIST_APPS string ONLY scrobble from any application on this comma-delimited list that START WITH these values

Bold/Italic = Required