Copyright 2013 Video Storm LLC. All rights reserved.Video Storm LLC12Video Storm LLC5/14/2013 12:30 PM3/24/2014 3:30 PMNBXNBXdevices_sm/receiver.gifdevices_lg/receiver.gifipodDriverWorkslua_genvideostorm:ipod:NBX
Audio/Video
100%100%
false
NBX/NAB source driver for NetPlay audio 1.6.1+ (1.6.3 for Metadata save)
This driver is a single source for Squeezebox and mobile streaming.
This driver is free for use on Video Storm products. Any other use is not allowed. Please contact Video Storm if you have any questions.
Please see the documentation on our web site for instructions on how to use and setup this driver.
www.video-storm.com/Downloads/NAB_setup.htm
Version 12
------------------
1. Added option to play/delete songs in playlist
2. Added commands to adjust LMS player volume from the driver
Version 11
------------------
1. Fix for rare conflict on NCON event
Version 10
------------------
1. Fix for NBX100 network connected/disconnect with multiple streams (only affects NBX100)
Version 9
------------------
5: Added "stop streaming" list command
6: Added "now playing", Added "play all", Added Playlist add modes, Corrected bugs in Spotify app, pause timer in squeeze
7: Added music folder browsing
8: Added support for NetPlay App w/ searching. Added menu custimization.
9: Fixed critical issue of loosing connection after controller reboot. Added cover art timer property. Fixed playlist modes on touchscreen/gui. Play all now starts playing also.
Driver supports
------------------
1. Squeezebox full functionality (1 active stream per driver instance)
2. Mobile streaming via Bonjour or Upnp/DLNA (1 active stream per driver instance)
3. NBX010 will use a single instance of this driver. NBX100 will use multiple instances. NAB100 will use multiple instances of this driver PLUS the CMX-A2 matrix driver.
4. Supports default "source mode" publishing and NetPlay "room mode" publishing
5. Supports serial output
6. Supports default "source volume", remote volume bypass, and remote volume forwarded to endpoints modes
7. Metadata and coverart in all modes
8. Transport controls in all modes
9. Events to allow autoswitching and volume forwarding via director code
10. Save to favorites command
11. Save metadata command
12. Fetch URL / Play URL command/properties
13. Now Playing list. View the current playlist queue. Select Clear all or a song title to remove from queue.
14. Customized root menu
15. Text parameters via event/command
Not supported
------------------
1. Automatic "Artist mixes" in spotify do not currently work due to a plug in limitation
NOTE: When you "stop" a mobile streaming connection via C4, you cannot restart it with "play". It can only be started again from the mobile device. Also, IOS devices will automatically "stop" if paused for more than 60 seconds. The "pause" command can be restarted for up to 5 minutes (less if phone sleeps). Use the "Stop streaming" list item to exit streaming immediately if the stop button is not available.
IMPORTANT:
The network bindings for this driver should use UUID mode. Drag the uuid for the detection panal on the right to the connections.
There are two network bindings. The first is always the NBX/NAB. The second is for your squeeze server. Usually this is also the NBX/NAB, but if you are using an external server enter it's IP address here. If you are NOT using squeeze leave this blank (unbound).
Properties
-----------------------
Squeeze Player MAC: Enter the specific MAC of the squeeze player for this virtual or physical channel (if using squeeze, otherwise leave blank)
Output Channel: Enter the physical (1-8) or virtual (1-48) channel for this driver instance here as described in the setup instructions. NBX010 will always use 1.
Virtual Channel: If using NAB and this is connected to a virtual channel input of CMX-A2, set this to true.
Root menu items: Used to show or hide root menu items. All apps will still be in the "apps" folder which is configured by enabling/disabling apps in LMS setup.
Cover art timer: Time to wait for coverart to be ready before loading. Defualts to 10 seconds. Set higher if art is not always loading correctly.
Playlist select: Controls if playlist selection deletes selected item or jumps to selected item.
Variables (read-only)
-----------------------
List_select: Controls the behavior of list select. "play" mode means selected song will replace the current playlist (and play immediately). If set to "add", it puts the new song at the end of the list. If set to "insert", the new song will play next. This allows you to build a custom playlist on the fly.
Search_string: The current search string used when a search list item is selected.
Network_stream_x: The current renderer channel selected on output X.
Network_Vol: The remote/mobile volume
Current_app: The current playing app
Commands
-----------------------
Pandora_rate_good and Pandora_rate_bad will apply rating to the currently playing song (in in Pandora).
Send announcement will trigger the announcement engine (8 possible announcements).
Save_favorite: This will save the current song/channel to your favorites. The name of the favorite will be the current song title. If you want to change this go to IP_ADDRESS:9000 and edit the favorite names there.
Save_metadata: This will save the current song to the NBX internal metadata list. You can access this list via the web interface to retrieve songs for purchase via iTunes, Amazon, etc.
Fetch_url: This will fetch the URL of the current song/channel to the URL property. You can use this with the Play_url command to manually start any channel via director code.
Play_url: This will play the given URL directly
Disconnect: This will force the remote device to disconnect and will NOT trigger the Network NDCN event
Set_list_mode: This will set the list select variable above
Search_string: This will set the current search query string. This string will be used on the next search parameter.
Events
---------------------
NetworkEventNCONx : This event triggers when NBX registers a new connection to the corresponding virtual channel
The dynamic mapping of physical network input channel to virtual channel is captured in the network_stream_x variables.
NetworkEventNDCNx : This event triggers when NBX registers a disconnection from the corresponding virtual channel
NetworkEventVOL : This event triggers when NBX registers a remote volume change
The actual volume is captured in the NetworkVOL variable
Searching : This event will trigger when a "search" field is selected in the list menu. You need to send a "Search_string" command back to complete the search.
Use the NBX UUID from the tab at the right. The second connection is for squeeze server. Use either the NBX or an external server for that one.
Squeeze Player MAC
STRING
false
Output channel
RANGED_INTEGER
1
48
1
false
Virtual channel
LIST
- false
- true
false
false
Coverart timer
RANGED_INTEGER
1
100
10
false
Current Server
STRING
true
Current Player
STRING
true
Current URL
STRING
false
Current Title
STRING
true
Connection
LIST
- Online
- Offline
Offline
true
Connection Squeeze
LIST
- Online
- Offline
Offline
true
Show My Music
LIST
- Off
- On
On
false
Show Favorites
LIST
- Off
- On
On
false
Show Playlists
LIST
- Off
- On
On
false
Show Radio
LIST
- Off
- On
On
false
Show Apps
LIST
- Off
- On
On
false
Show Now Playing
LIST
- Off
- On
On
false
Show Pandora
LIST
- Off
- On
Off
false
Show Sirius
LIST
- Off
- On
Off
false
Show Spotify
LIST
- Off
- On
Off
false
Playlist Mode
LIST
- Delete
- Jump
Delete
false
Debug Mode
LIST
- Off
- Print
- Log
- Print and Log
Off
false
Send_announcement
Starts announcement number PARAM1. State will return after complete
Number
RANGED_INTEGER
1
8
Rate_Pandora_good
Sends a thumbs up on the current song
Rate_Pandora_bad
Sends a thumbs down on the current song
Save_favorites
Saves the current song/channel to your favorites
Save_metadata
Saves the current song to the web metadata list
Fetch_URL
Captures the current song/channel URL in the Current_URL property
Play_URL
Plays the given URL PARAM1
URL
STRING
Disconnect
Forces the remote device to disconnect without send NDCN event
Set_list_mode
Sets the behavior of list selection to PARAM1
Value
LIST
- play
- add
- insert
Play
Set_lms_volume
Sets the current player volume to level PARAM1
Volume
RANGED_INTEGER
0
100
Pulse_lms_volume
Ramps the current player volume up or down by PARAM1
Inc
RANGED_INTEGER
-100
100
5
Search_string
Sets a search string for the next search selected
Search
STRING
1
NetworkEventNCON_1
Virtual channel 1 connected
2
NetworkEventNCON_2
Virtual channel 2 connected
3
NetworkEventNCON_3
Virtual channel 3 connected
4
NetworkEventNCON_4
Virtual channel 4 connected
5
NetworkEventNCON_5
Virtual channel 5 connected
6
NetworkEventNCON_6
Virtual channel 6 connected
7
NetworkEventNCON_7
Virtual channel 7 connected
8
NetworkEventNCON_8
Virtual channel 8 connected
9
NetworkEventNCON_9
Virtual channel 9 connected
10
NetworkEventNCON_10
Virtual channel 10 connected
11
NetworkEventNCON_11
Virtual channel 11 connected
12
NetworkEventNCON_12
Virtual channel 12 connected
13
NetworkEventNCON_13
Virtual channel 13 connected
14
NetworkEventNCON_14
Virtual channel 14 connected
15
NetworkEventNCON_15
Virtual channel 15 connected
16
NetworkEventNCON_16
Virtual channel 16 connected
17
NetworkEventNCON_17
Virtual channel 17 connected
18
NetworkEventNCON_18
Virtual channel 18 connected
19
NetworkEventNCON_19
Virtual channel 19 connected
20
NetworkEventNCON_20
Virtual channel 20 connected
21
NetworkEventNCON_21
Virtual channel 21 connected
22
NetworkEventNCON_22
Virtual channel 22 connected
23
NetworkEventNCON_23
Virtual channel 23 connected
24
NetworkEventNCON_24
Virtual channel 24 connected
25
NetworkEventNCON_25
Virtual channel 25 connected
26
NetworkEventNCON_26
Virtual channel 26 connected
27
NetworkEventNCON_27
Virtual channel 27 connected
28
NetworkEventNCON_28
Virtual channel 28 connected
29
NetworkEventNCON_29
Virtual channel 29 connected
30
NetworkEventNCON_30
Virtual channel 30 connected
31
NetworkEventNCON_31
Virtual channel 31 connected
32
NetworkEventNCON_32
Virtual channel 32 connected
33
NetworkEventNCON_33
Virtual channel 33 connected
34
NetworkEventNCON_34
Virtual channel 34 connected
35
NetworkEventNCON_35
Virtual channel 35 connected
36
NetworkEventNCON_36
Virtual channel 36 connected
37
NetworkEventNCON_37
Virtual channel 37 connected
38
NetworkEventNCON_38
Virtual channel 38 connected
39
NetworkEventNCON_39
Virtual channel 39 connected
40
NetworkEventNCON_40
Virtual channel 40 connected
41
NetworkEventNCON_41
Virtual channel 41 connected
42
NetworkEventNCON_42
Virtual channel 42 connected
43
NetworkEventNCON_43
Virtual channel 43 connected
44
NetworkEventNCON_44
Virtual channel 44 connected
45
NetworkEventNCON_45
Virtual channel 45 connected
46
NetworkEventNCON_46
Virtual channel 46 connected
47
NetworkEventNCON_47
Virtual channel 47 connected
48
NetworkEventNCON_48
Virtual channel 48 connected
51
NetworkEventNDCN_1
Virtual channel 1 disconnected
52
NetworkEventNDCN_2
Virtual channel 2 disconnected
53
NetworkEventNDCN_3
Virtual channel 3 disconnected
54
NetworkEventNDCN_4
Virtual channel 4 disconnected
55
NetworkEventNDCN_5
Virtual channel 5 disconnected
56
NetworkEventNDCN_6
Virtual channel 6 disconnected
57
NetworkEventNDCN_7
Virtual channel 7 disconnected
58
NetworkEventNDCN_8
Virtual channel 8 disconnected
59
NetworkEventNDCN_9
Virtual channel 9 disconnected
60
NetworkEventNDCN_10
Virtual channel 10 disconnected
61
NetworkEventNDCN_11
Virtual channel 11 disconnected
62
NetworkEventNDCN_12
Virtual channel 12 disconnected
63
NetworkEventNDCN_13
Virtual channel 13 disconnected
64
NetworkEventNDCN_14
Virtual channel 14 disconnected
65
NetworkEventNDCN_15
Virtual channel 15 disconnected
66
NetworkEventNDCN_16
Virtual channel 16 disconnected
67
NetworkEventNDCN_17
Virtual channel 17 disconnected
68
NetworkEventNDCN_18
Virtual channel 18 disconnected
69
NetworkEventNDCN_19
Virtual channel 19 disconnected
70
NetworkEventNDCN_20
Virtual channel 20 disconnected
71
NetworkEventNDCN_21
Virtual channel 21 disconnected
72
NetworkEventNDCN_22
Virtual channel 22 disconnected
73
NetworkEventNDCN_23
Virtual channel 23 disconnected
74
NetworkEventNDCN_24
Virtual channel 24 disconnected
75
NetworkEventNDCN_25
Virtual channel 25 disconnected
76
NetworkEventNDCN_26
Virtual channel 26 disconnected
77
NetworkEventNDCN_27
Virtual channel 27 disconnected
78
NetworkEventNDCN_28
Virtual channel 28 disconnected
79
NetworkEventNDCN_29
Virtual channel 29 disconnected
80
NetworkEventNDCN_30
Virtual channel 30 disconnected
81
NetworkEventNDCN_31
Virtual channel 31 disconnected
82
NetworkEventNDCN_32
Virtual channel 32 disconnected
83
NetworkEventNDCN_33
Virtual channel 33 disconnected
84
NetworkEventNDCN_34
Virtual channel 34 disconnected
85
NetworkEventNDCN_35
Virtual channel 35 disconnected
86
NetworkEventNDCN_36
Virtual channel 36 disconnected
87
NetworkEventNDCN_37
Virtual channel 37 disconnected
88
NetworkEventNDCN_38
Virtual channel 38 disconnected
89
NetworkEventNDCN_39
Virtual channel 39 disconnected
90
NetworkEventNDCN_40
Virtual channel 40 disconnected
91
NetworkEventNDCN_41
Virtual channel 41 disconnected
92
NetworkEventNDCN_42
Virtual channel 42 disconnected
93
NetworkEventNDCN_43
Virtual channel 43 disconnected
94
NetworkEventNDCN_44
Virtual channel 44 disconnected
95
NetworkEventNDCN_45
Virtual channel 45 disconnected
96
NetworkEventNDCN_46
Virtual channel 46 disconnected
97
NetworkEventNDCN_47
Virtual channel 47 disconnected
98
NetworkEventNDCN_48
Virtual channel 48 disconnected
49
NetworkEventVOL
Output Volume changed (variable updated)
99
Searching
Search field triggered (must send Search_string command to complete)
5001
6
NBX
2
False
False
False
False
True
IPOD
6001
6
Network Connection
4
True
False
False
True
TCP
9091
True
True
True
True
6002
6
Squeeze Server connection
4
True
False
False
True
TCP
9090
True
True
True
True
4000
6
Audio Output
6
False
True
False
True
STEREO
DIGITAL_COAX
DIGITAL_OPTICAL
2000
6
Video Output
5
False
True
True
True
HDMI
7000
6
Room Selection
7
False
True
True
True
AUDIO_SELECTION
VIDEO_SELECTION