BARIX Streaming Client User Manual Download Page 48

Page: 48 / 51

User Manual “Streaming Client“ - V1.31 - 8. Jan. 2007

7.2 Control API (CGI)

For integration of the Barix device into various control

applications and home automation systems, Barix has

developed a control API (Application Protocol Interface)

for the control using CGI in a web browser.

For a detailed list of the CGI API commands refer to the

“Streaming Client Technical Documentation” available on

the Barix website

www.barix.com

Advanced user section

Summary of Contents for Streaming Client

Page 1: ...rmware for WMA and MP3 streaming HTTP UDP RTP with automatic failover and USB playback User Manual Firmware V1 31 Released 8 Jan 2007 Supports EXSTREAMER legacy EXSTREAMER 100 EXSTREAMER 200 IP Audio Module IP Audio Module 200 STREAMING CLIENT ...

Page 2: ......

Page 3: ... Chapter overview 10 2 Standalone Player Mode 11 3 Device Configuration 13 3 1 Network settings 14 Use SonicIP 14 IP Address 14 Netmask 15 Gateway IP Address 15 Primary DNS 16 Alternative DNS 16 DHCP Host Name 17 Web Server Port 17 HTTP Proxy URL 17 3 2 Streaming settings 18 General Streaming URL Syntax 19 Supported protocols vs audio formats 19 M3U playlist URL syntax 20 http URL syntax 21 mms UR...

Page 4: ... MTELL UDP Port 27 MTELL Report Period 28 SNMP Trap Receiver 28 3 6 Advanced settings 28 Reset 28 Factory Defaults 28 IR Input 29 User Agent 29 3 7 Security settings 29 Set Password 29 Old Password New Password 31 3 8 APPLY and CANCEL buttons 32 APPLY 32 CANCEL 32 4 Updating the Firmware 33 4 1 Downloading the latest firmware 33 4 2 Serial Rescue 34 4 3 Web Update 34 5 Step by step How To 39 5 1 H...

Page 5: ...o receive a RTP stream from an Barix Instreamer 41 Instreamer Configuration 41 Exstreamer Configuration 41 6 IR Remote control 43 6 1 IR key functions 43 6 2 Serial IR receiver 44 7 Advanced user section 45 7 1 Network configuration using supplied serial cable 45 7 2 Control API CGI 48 8 Dictionary 49 9 Legal Information 51 ...

Page 6: ......

Page 7: ...ming Client firmware can be used on Barix devices to build a manageable distributed audio network The standalone capability playing from external USB or internal flash memory without network connection allows the use of the Barix Exstreamer 100 or the Barix Exstreamer 200 as a simple MP3 WMA player with automatic start on power up 1 2 Features Plays MP3 streams from network HTTP BRTP RTP and M3U p...

Page 8: ...for legacy devices Exstreamer Exstreamer Wireless Exstreamer Digital and Exstreamer Gold as the USB port is missing 1 3 Installing the device For the installation of the Barix Exstreamer 100 or the Barix Exstreamer 200 please refer to the corresponding Quick Install Guide A printed version is included in the box and can also be downloaded from our site www barix com For the installation of the Bar...

Page 9: ...4 Updating the Firmware 1 6 About this manual Links to chapters References to chapters e g X Chapter name are red and underlined and serve as direct links when viewed in Adobe Acrobat Viewer Click on the link to jump to the referenced chapter click on the left arrow icon to jump back to where you came from Links to the Dictionary Some technical terms e g DHCP are underlined and red Click on them t...

Page 10: ...tion parameters Updating the Firmware explaining how to update or how to change from standard firmware Step by step How To explaining configuration for external services and devices IR Remote control explaining the functionality of the Barix IR Remote control Advanced User section explaining configuration via Serial cable and reference to the CGI API Dictionary explaining technical names and expre...

Page 11: ...WMA files found on the USB media using the Autoplay function For further details about supported USB media supported playlist formats and the Autoplay function please refer to chapters 3 2 Streaming settings file URL syntax 3 2 Streaming settings M3U playlist URL syntax 3 4 Play settings USB Autoplay With factory default settings the Autoplay is switched on after approx two minutes The device trie...

Page 12: ...User Manual Streaming Client V1 31 8 Jan 2007 12 Standalone Player Mode ...

Page 13: ...r Open your web browser and type in the IP address of the Barix device in the URL field and hit the Enter key Example 192 168 0 12 You will see the following window content To store changed settings click on Apply button at the end of the page The device will restart with the new settings To obtain a quick insight into the configuration parameters click on the icon red question mark next to the se...

Page 14: ...ver the audio output during start up IP Address Enter the 4 values of the desired static IP address e g 192 168 0 12 for an internal LAN Attention Make sure that you enter a free IP address The device will check this and will not be available until the device using the same IP is disconnected or switched off The command Ping can be used to ensure that a specific IP address is unused i e No reply T...

Page 15: ...functions which locks you out unless you reset the device to factory defaults by pressing the reset button for about 10 seconds Netmask Enter the 4 values of the desired Netmask e g 0 0 0 0 for a default Netmask depending on the IP Address used 255 255 255 0 for a C class network Note Try first the Netmask your PC is set to or ask your Network Administrator Gateway IP Address A correct setting of ...

Page 16: ...lues for the primary DNS e g 0 0 0 0 for no DNS 192 168 0 111 for a DNS Note If you have set the devices IP address to automatic discovery and your server or router has issued an IP address then most probably it also has supplied a valid DNS address 0 0 0 0 will then work fine If you have set a static IP address then you will need to configure a valid DNS address manually Try first the same DNS IP...

Page 17: ...0 is already installed in the LAN you can change the Web Server Port of the Barix device to a different port e g 8080 Attention During an update using a web browser this port has to be set to 0 see chapter 4 3 Web Update HTTP Proxy URL The HTTP Proxy Server is a server that acts as a broker between the Web browser and the HTTP Server It is used on many networks as it can provide caching and or con...

Page 18: ...3 2 Streaming settings This chapter explains how to adjust the way the Barix device gets its streams files and playlists Up to three independent audio sources URLs can be set Each may contain a full address of a playlist file or a stream The three entries have different priorities the first one has the highest priority and the last one has the lowest priority The device processes the sources in a ...

Page 19: ... variables in the URL is explained in the Technical Documentation Supported protocols vs audio formats Depending on the protocol some parts of the above mentioned general URL syntax are not used User password and port parts are optional for most protocols Supported protocols are HTTP MMS MMST RTP BRTP and FILE These can be combined with supported audio formats as shown in the following table HTTP ...

Page 20: ...p to 2000 entries are supported Allowed line separators are the ASCII characters CR LF hex 0D 0A and LF hex 0A The content of the Playlist will be shuffled if Shuffle is enabled in the configuration or if the playlist is on a local USB media and there is a file shuffle txt in the root directory of the USB media If Autoplay is enabled in the Web Interface and source URL is pointing to a nonexistent...

Page 21: ...system is connected http URL syntax Both MP3 and WMA files as well as MP3 streams can be played using the HTTP protocol e g http host com topten song1 mp3 http host com topten song1 wma http host com topten stream Full URL is supported the file to be played can be on a remote server running on an arbitrary port e g http host com 12345 topten song1 mp3 To support authentication username and passwor...

Page 22: ...ream asf Notes There is no HTTP Proxy server support for this protocol If the WMA stream is not played you should change the protocol to mmst see description below to try if the stream is delivered as MMS over TCP mmst URL syntax The MMST protocol is the Microsoft TCP Streaming Protocol MMS over TCP and is used by some Internet radio stations broadcasting in ASF Only WMA ASF streaming is supported...

Page 23: ...tax For the file protocol only protocol and path parts can be used to play a M3U playlist a MP3 or WMA file e g file folder1 playlist m3u file folder1 song1 mp3 file folder1 song1 wma When the protocol part is omitted then the file protocol is assumed automatically e g folder1 song1 mp3 song1 wma Path should determine a file stored on a USB media connected to the Client Filenames and directory nam...

Page 24: ...tiplied by 4 on every further drop out up to the value of Check Period Limit see below Check Period Limit To prevent frequent switching between URLs due to network drop outs the Stream Check Period value is increased multiplied by 4 on every drop out up to the Stream Check Limit value in seconds Every time the higher priority URL becomes available the current value is decreased divided by 4 until ...

Page 25: ... the priority stream stops forcing the device to switch back to the previously played stream Default 0 disabled Buffer For smooth playing the priority stream is buffered in memory up to 64kB The Buffer value sets the period of time stored before starting the playback Increase this value to prevent sound interruptions caused by network problems Decrease the value to shorten the playback start delay...

Page 26: ...his feature enables the automatic creation and playback of a playlist containing all MP3 and WMA songs on a connected USB media in case the active URL is pointing to a missing playlist The songs found are stored in the playlist named __exstr m3u and a file called shuffle txt is created to enable the shuffled play back of the songs To prevent the play back of the same song after a power failure the...

Page 27: ... of the web server http containing the configuration meta file which can be used to remotely change the configuration and or to update the firmware Remote Update Period Enter the time interval in minutes for the periodic update check Default 720 minutes MTELL URL Devices can be monitored using the MTELL technology see www mtell de Enter the URL of the MTELL server MTELL UDP Port Enter the port on ...

Page 28: ... a specific receiver 3 6 Advanced settings This chapter explains how to adjust advanced functions Reset Enable or disable the Reset function on the Reset button In order to restart the device press the Reset button once Default enabled Factory Defaults Enable or disable the Factory Defaults function on the Reset button To reset the configuration to factory defaults keep the Reset button pressed un...

Page 29: ...onnecting to a HTTP Icecast Shoutcast server a so called User Agent identifier string is sent If left empty the string Barix Streaming Client is sent instead Default empty automatic Barix Streaming Client 3 7 Security settings This chapter explains how to configure and to use the security features of the Streaming Client firmware Set Password This is visible as long as no password is set Enter a p...

Page 30: ...nfiguration Once logged in you will see the Logout button at the top of the configuration frame Click on it to log out Note that only one user at a time can be logged in Any further request will be refused Note that you have to enter the password in the field above the Apply button before hitting the Apply button 30 Device Configuration ...

Page 31: ...word empty Enter the old password in the password field above the Apply button as well and then hit the Apply button After the restart you will not be asked for user name and password any more To change the password enter the old password and enter the new password in the field New Password Enter the old password in the password field above the Apply button as well and then hit the Apply button De...

Page 32: ...ied in order to see the web configuration 3 8 APPLY and CANCEL buttons APPLY To store changed settings click on Apply The device will restart with the new settings Exception When security is enabled a password has to be entered See previous chapter for details CANCEL To disregard changes click on Cancel The page will reload with the current settings 32 Device Configuration ...

Page 33: ... during the process power or network loss the device might become unreachable In that case the Serial Rescue procedure is the only remedy Please keep that in mind when planning a remote update 4 1 Downloading the latest firmware To download the latest Streaming Client firmware version please visit www barix com In the menu on the left side click on downloads In the center column select one of the ...

Page 34: ...ng Windows 2000 Windows XP or Linux Follow the steps in the _readme1st txt carefully as there are several different applications batch files to be started depending on the Barix hardware new or legacy and the PCs COM port number used Calculate approximately 2 minutes to complete the Serial Rescue procedure After a successful rescue the device is ready for configuration according to your needs see ...

Page 35: ...ou are already running Streaming Client firmware on your device proceed to step 4 STEP 4 Click on the UPDATE button to enter the update page You will see the following screen STEP 5 Click on Please click here to continue to launch the update process The device will restart in a special mode called Boot loader and the following screen appears showing a number counting down from 4 to 0 Updating the ...

Page 36: ...007 Upon start up the following screen appears STEP 6 Click on Browse to select the file you want to update The file is named compound bin located in the folder update_rescue Select the file and click on the Open button 36 Updating the Firmware ...

Page 37: ...proximately 2 minutes Warning If the web update is interrupted during the process power or network loss the device might become unreachable In that case the Serial Rescue procedure is the only remedy Please keep that in mind when planning a remote update After a successful upload the following window appears STEP 8 Click on the update link and then click on the Reboot button in the following windo...

Page 38: ...pdate procedure does not change the current configuration Barix recommends nevertheless checking for correct parameters in the configuration as well as to set parameters for newly added features If you observe strange behavior after an update Barix recommends resetting the configuration to factory defaults by keeping the Reset button pressed until the red LED starts blinking approx 10 seconds and ...

Page 39: ...0 0 0 0 Automatic discovery you can proceed to step 6 further below STEP 4 Enter the Gateway IP address Example 192 168 0 1 STEP 5 Enter the primary DNS IP address Example 192 168 0 1 STEP 6 Scroll to the section STREAMING SETTINGS In the 1 URL field enter the following mms dms cl 017 skypro tv virus STEP 7 Select 2s for two seconds in the Buffer selection STEP 8 Click on APPLY button at the end o...

Page 40: ...e Streaming configuration tab STEP 2 Configure your Router Modem Firewall to pass UDP port 4040 from outside to the IP of your Instreamer STEP 3 Check in your Router what public IP address you have or configure Dynamic DNS if you plan to use a URL name instead of an IP number Exstreamer Configuration STEP 1 Open your Web Browser STEP 2 Enter the IP address of the Exstreamer as announced over the a...

Page 41: ...l In this example we will use port 4040 but you are not restricted to this port number Instreamer Configuration STEP 1 Configure your Instreamer to RTP 0 0 0 0 4040 in the first stream to entry only the first supports BRTP in the Streaming configuration tab Exstreamer Configuration STEP 1 Open your Web Browser STEP 2 Enter the IP address of the Exstreamer as announced over the audio outputs by Son...

Page 42: ...User Manual Streaming Client V1 31 8 Jan 2007 42 Step by step How To ...

Page 43: ...its for Channel selection No function yet Confirmation of entered digits No function yet No function yet Toggles the Shuffle Play Mode No function yet No function yet To prepare the IR Remote Control for usage open the battery compartment and check the signs of polarity Insert the two batteries accordingly into the IR remote control The IR Remote Control is now ready to operate For details on how ...

Page 44: ...tor of the IR Serial receiver into the serial port of the Barix Exstreamer Make sure you have line of sight with the IR receiver from where you want to use the IR remote control On power up the red LED will be on until the Barix Exstreamer has set the network and announced the IP Address Configure the IR input for the Serial Dongle see chapter 3 6 Advanced settings Note On the Exstreamer 100 the o...

Page 45: ...t the following settings Speed 9600 bit sec 8 Data Bits no Parity and 1 Stop Bit STEP 3 Unplug the power supply of the Barix Exstreamer STEP 4 Connect the supplied serial cable to your PC s COM port and to the serial port of the Barix Exstreamer STEP 5 Keep the Reset button pushed and plug in the power supply Release the Reset button as soon as you see following screen Advanced user section 45 ...

Page 46: ... Streaming Client V1 31 8 Jan 2007 STEP 6 Hit s to skip network discovery if not connected to a network and the following screen appears STEP 7 Hit s to get to the Barix Exstreamer s setup 46 Advanced user section ...

Page 47: ...07 STEP 8 Hit enter to enter the Barix Exstreamer setup mode STEP 9 Type in 0 and hit enter to enter the network configuration Enter all requested values STEP 10 Type in 9 and hit enter to save the network configuration Advanced user section 47 ...

Page 48: ...rol applications and home automation systems Barix has developed a control API Application Protocol Interface for the control using CGI in a web browser For a detailed list of the CGI API commands refer to the Streaming Client Technical Documentation available on the Barix website www barix com 48 Advanced user section ...

Page 49: ... MAC address Abbreviation for Medium Access Control a MAC is a unique address number formatted in hexadecimal format and given to each computer and or network device on a computer network Because a MAC address is a unique address a computer network will not have the same MAC address assigned to more than one computer or network device Example A1 B2 C3 D4 E5 F6 Netmask A number used to identify a s...

Page 50: ...s right after power up Static IP A Static IP is a fixed IP address that you assign manually to a device on the network It remains valid until you disable it Telnet Telnet is a user command and an underlying TCP IP protocol for accessing remote computers On the Web HTTP and FTP protocols allow you to request specific files from remote computers but not to actually be logged on as a user of that com...

Page 51: ...used for reference only Barix Exstreamer Instreamer SonicIP and IPzator are trademarks of Barix AG Switzerland and are registered in certain countries For information about our devices and the latest version of this manual please visit www barix com Barix AG Seefeldstrasse 303 8008 Zurich SWITZERLAND Phone 41 43 433 22 11 Fax 41 44 274 28 49 Internet web www barix com email sales barix com support...

Search results

Summary of Contents for Streaming Client

Reviews:

Related manuals for Streaming Client

Brands by name

Popular brands

BARIX Streaming Client, User Manual

Search results

Summary of Contents for Streaming Client

Reviews:

Related manuals for Streaming Client

Brands by name

Popular brands