Вы находитесь на странице: 1из 26
User Manual Version 3.1– Freecom Edition – February 2006 ©TwonkyVision GmbH Kaiserin-Augusta-Allee 86 D-10589

User Manual

Version 3.1– Freecom Edition – February 2006

©TwonkyVision GmbH

Kaiserin-Augusta-Allee 86 D-10589 Berlin http://www.twonkyvision.com

TwonkyMedia User Manual 3.0

Table of Contents

© TwonkyVision GmbH

© T w o n k y V i s i o n G m b

1 Introduction

 

5

1.1

Installation

5

1.2

Configuration tools

5

1.3

3 rd party software

6

1.4

About this Manual

6

1.5

Feedback and Technical Support

7

2 Quick startup

 

7

3 Supported content types

8

3.1

Audio

8

3.1.1 Playlists

 

8

3.1.2 Compilations

8

3.1.3 Internet Radio

9

3.2

Pictures

9

3.3

Video

9

4 Selecting the content to be served

10

4.1

Basic content types

10

4.2

Identifying compilations

11

4.3

Internet Radio

11

4.4

Using 3rd party metadata applications

12

4.4.1 Winamp

 

12

4.4.2 iTunes

12

4.4.3 Adobe Photoshop Album

12

4.5

Rescanning for available content

13

5 Customizing the navigation tree

13

5.1

MediaServer name

13

5.2

Language

13

5.3

Configuration of the tree structure

14

5.4

Metadata adjustments

16

5.5

Auto-generated playlists

17

5.6

Folder Prefix

17

5.7

Randomizing playlists

17

6 Network settings

18

6.1

Access to web configuration page

18

6.2

MediaServer IP address and port

18

6.3

Updates

19

6.4

Restart on network changes

19

7 Finetuning the performance

20

7.1

MediaServer database

20

7.2

Disable rescale

20

7.3

Streaming buffer size

20

8 Client-specific settings

21

8.1

Music

client

21

8.2

Roku: disable server-side search

21

8.3

Noxon

21

8.4

D-Link

21

8.5

Netgear

MP101

22

8.6

Netgear

MP115

22

8.7

Homepod

22

8.8

Syabas

22

8.9

Siemens M740AV

23

9 Command line options

24

9.1

Run as Service

24

9.2

Launching as daemon

24

9.3

.ini filename

24

Page 3 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

9.4

Debugging and bug reports

24

10

Index of configuration parameters

26

Page 4 of 26

TwonkyMedia User Manual 3.0

1

Introduction

© TwonkyVision GmbH

© T w o n k y V i s i o n G m b

TwonkyMedia, the TwonkyVision UPnP MediaServer, enables you to share all your Music, Pictures and Videos with UPnP-enabled client devices (also known as media players, digital media players (DMP) or media adapters) throughout your home. For a list of supported client devices, have a look at the TwonkyVision website.

1.1 Installation

TwonkyMedia licences are available through one of the following distribution channels:

pre-installed on an embedded device like at network attached storage device or STB,

bundled with a client device,

downloaded from the TwonkyVision website.

In the first case TwonkyMedia is already installed on the device and ready to use. However, you can use the means described in this manual to customize TwonkyMedia according to your personal needs and preferences as well as to specific aspects of your home environment. In the other cases mentioned above you first have to install TwonkyMedia. How to install it is described in separate installation guides provided with the distribution package. After installing TwonkyMedia the default configuration will in most cases allow to start using TwonkyMedia right away.

1.2 Configuration tools

The individual configuration options are described in sections 4 - 8. The selected values are persistently stored in a configuration file. There are different ways to configure these options:

All options may be configured on the server's web-based configuration pages. Upon startup the MediaServer creates a twonkyvision-config.html page in its startup directory. To access this configuration page, you can simply open this page with a web browser. The page can also be accessed on Windows XP systems by just opening the presentation page of the MediaServer device. If you have not changed the default settings, this page is always found at the following location:

http://your-ip:port/configpage/index.htm

where " your-ip " is the IP address of the device where the MediaServer is running and port is the port number of the MediaServer HTTP server (9000 by default). The URL http://127.0.0.1:9000 will work on most systems.

Another way to select options is to edit the configuration file of the MediaServer directly with a text editor. Due to error-proneness, this method is recommended for experienced users only. Depending on the type of server you are using, the filename is either twonkyvision-mediaserver.ini or twonkyvision-musicserver.ini. The file is created automatically on the first startup of the MediaServer - on Windows systems in the Windows directory, on UNIX and Macintosh in the MediaServer startup directory. If you want to reset the MediaServer to the default configuration at any time, you can simply delete this file - the MediaServer will recreate it with the default settings. The same applies to resetting single configuration options - locate the option in the .ini file and delete the line from the file - on the next startup the MediaServer will re-insert the corresponding line for that option with the default value into the .ini file.

Page 5 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

Finally, options can also be specified as command line parameters when starting the MediaServer. Moreover, a few options can only be specified as command line parameters. If you want to use command line parameters on a Windows system, you can first create a shortcut to MediaServer.exe. Then under ‘properties’ you can add the command line parameters behind the name of the executable. This method of selecting options is not available when using the server in an embedded system.

Most changes to the configuration require a restart of the MediaServer. You can use the “restart” button on the web-based configuration page or simply stop the MediaServer and start it again.

1.3 3 rd party software

TwonkyMedia utilizes the following LGPL code for standalone plugins – mainly to transcode content to different formats:

Libjpeg to resize JPEG files to different sizes

Lame encoder/decoder to transcode mp3 files

FLAC encoder/decoder to transcode flac files

1.4 About this Manual

This manual will help you to configure TwonkyMedia according to your personal preferences and requirements. You should be aware of the following conventions when using this manual:

aware of the following conventions when using this manual: TwonkyMedia is available in two different versions:
aware of the following conventions when using this manual: TwonkyMedia is available in two different versions:

TwonkyMedia is available in two different versions: the MusicServer and the full MediaServer. The MusicServer is restricted with regard to supported content types. The documentation below always refers to the MediaServer, even though most of the information also applies to the MusicServer. Options which are only available for the MediaServer are marked with the icon to the left.

In case TwonkyMedia is installed on a network attached storage device, some of the

options are pre-defined by the manufacture and cannot be modified by the end-user. These options are marked with the icon to the left.

A number of options require an in-depth knowledge of the underlying platform.

Misapplication - in particular direct editing of the .ini file - might result in disfunction of the

MediaServer. These options are marked with the icon to the left and recommended for experts only.

This option is only available when TwonkyMedia is running under Windows XP.

This option is only available when TwonkyMedia is on Linux platforms.

Additional information about setup and configuration of TwonkyMedia can be found in our FAQ, our Forum and the Media Servers Forum.

Page 6 of 26

TwonkyMedia User Manual 3.0

1.5 Feedback and Technical Support

© TwonkyVision GmbH

© T w o n k y V i s i o n G m b

If you require technical support, please contact the support department at support@twonkyvision.com. At this address we would also appreciate any comments or feedback you might have regarding TwonkyMedia, e.g. additional features you would like to see in a future version.

2 Quick startup

In most cases TwonkyMedia is ready to use after installation, but you might want to specify where your content is located (see section 4) and which radio stations you want to receive (see section 3.1.3). Based on this information, TwonkyMedia provides a tree structure to client devices which allows navigating to the desired content in different ways. This tree structure is automatically generated from the metadata associated with the content and takes the user’s preferences into account. It only determines the structure of the navigation tree, not its layout. The layout of the user interface is up to the client device and as such out of control of TwonkyMedia. Example navigation trees used in this manual are just provided for explanatory purposes, their actual layout will differ at different client devices even when provided by the same instance of TwonkyMedia. Also, the user interface elements to navigate and select content will differ (e.g. different buttons on the remote control). Please refer to the user manual provided with the client device. Please note that the initial creation of the navigation tree may take several minutes – depending on the amount of content.

Page 7 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

3 Supported content types

TwonkyMedia serves audio, video and pictures. For each content type, a number of different formats are supported. The individual format is determined by the file extension. The supported formats are listed in the sections below.

3.1

Audio

TwonkyMedia supports the following audio formats:

MP3

WMA

WAV

LPCM

OGG

FLAC

WAV and LPCM files do not carry any metadata. Therefore the naming schema genre_artist_album_tracknumber_title.wav should be used to provide as much information as possible to the MediaServer. It is possible to omit unknown values from left to right, so you may also specify artist_album_tracknumber_title, album_tracknumber_title, tracknumber_title or just the title.

In addition to the audio formats listed above, playlists, compilations and Internet Radio are supported.

3.1.1 Playlists

The MediaServer supports the following playlist formats:

m3u (Winamp),

wpl (older versions of Windows Media Player),

pls (Windows Media Player).

It is possible to create playlists with these applications and the MediaServer will import them. The playlists have to be available under the directory specified with the contentdir option.

Note: Playlists can be transferred from one system to another (e.g. those created with Winamp on Windows and transferred to a Linux system), but the filenames referenced in the playlist must be valid and resolvable by the MediaServer. The MediaServer will try to resolve filenames referenced in playlists even if the playlist is copied from one OS to another (e.g. created on Windows and copied to a Linux system). If the playlist itself does not contain any information regarding the playlist title, the MediaServer will generate the title from the filename, e.g. "beatle songs.m3u" will get the title "beatle songs".

The m3u playlist format is very simple and can also be used to specify custom Shoutcast Radio Stations for the MediaServer - see Internet Radio support.

3.1.2 Compilations

Compilations are music collections like "Best of rock 2004", which contain a number of songs from different artists. If sorted by artist, one compilation CD would lead to as many artist entries as there are songs on the CD - and each of these artist entries would contain exactly one song. To prevent the cluttering of the navigation tree with many single entries, it is possible to identify compilations. When identified, the MediaServer will add these compilations to the album tree, but for artists just adds the album under the artist "various". Compilations can be identified via the iTunes library, as iTunes marks compilations with a specific flag, or they can be stored under a special folder in your content directory and then be specified with the option compilationsdir.

Page 8 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

3.1.3 Internet Radio

The MediaServer also supports Internet Radio. The current version is restricted to Shoutcast and vTuner Radio Stations. For the latter you need a vTuner licence.

There are two ways of Shoutcast Radio Station support built into the MediaServer. One

option is to create special playlist files with your preferred Shoutcast Radio Stations. This can be done with Winamp by using the "send to playlist" option when a Shoutcast Radio Station

is selected. A sample .m3u file can be found in the MediaServer distribution.

The MediaServer can also read .html files, which you can create by browsing http://www.shoutcast.com. You can select the filters available there to create a web page which shows your favourite radio stations – than save that web page under the content directory of the server – and the server will import this page. The saved filename must contain the word “Shoutcast” e.g. “My Shoutcast rock stations.html”.

The second option is that the MediaServer contacts the Shoutcast website on its own and downloads the list of top radio stations into its database. These radio stations are then available - sorted by Genre - under the Music Internet Radio node. Please note that a number of Internet Radio Stations only have a very short lifetime. When a connection to a Radio Station is refused, the MediaServer will respond with an appropriate error message to the client.

respond with an appropriate error message to the client. 3.2 Pictures The MediaServer supports pictures and

3.2 Pictures

The MediaServer supports pictures and images in JPEG format.

For JPEG images the MediaServer has integrated a complete EXIF parser, i.e. the MediaServer is capable of extracting the metadata which are stored in the header of such a

picture. In general the metadata provided by digital cameras are just the date and time when

a picture was taken, and its size and resolution. Any existing picture organizing tool may be used to include additional information into the EXIF header, which then can be used by the MediaServer.

It is quite common to organize pictures in folders, with more or less meaningful folder names

- and very rarely pictures are given meaningful names. This is reflected by the MediaServer as it mirrors the local directory tree where pictures are located on the UPnP side. You can navigate to the pictures on your client device the same way as you have organized them on

the PC.

For a more sophisticated logical view of the pictures, the MediaServer has also integrated support for the Adobe Photoshop Album library (Windows only).

For JPEG pictures the MediaServer supports server side resizing. This is used by a number of UPnP clients. Please be aware that resizing large pictures on the fly is a CPU-intensive process and that you will get some delay when the MediaServer is hosted on systems with low resources, e.g. Network Attached Storage (NAS) devices.

low resources, e.g. Network Attached Storage (NAS) devices. 3.3 Video The MediaServer supports a number of

3.3 Video

The MediaServer supports a number of video formats, but does not transcode any video from one format to another. Therefore the ability to play a certain video format depends on the client device. Currently the MediaServer serves the following video formats:

AVI

MPEG

MPEG2

MPG

MP4

WMV

Page 9 of 26

TwonkyMedia User Manual 3.0

VOB

© TwonkyVision GmbH

VOB © T w o n k y V i s i o n G m

4 Selecting the content to be served

4.1 Basic content types

The most common way for the MediaServer to locate content is to search the local hard disk for files of specific file types, like mp3 or jpg files. The locations where the MediaServer will look for such files can be set by the following options:

contentdir

ignoredir

followlinks

The initial setting of contentdir will be done during installation and should point to the folder where you have stored your audio-visual content, e.g. “My Documents”. The MediaServer will scan this directory and all subdirectories for content. The contentdir option can be set to a comma separated list of values, which each can be prepended by a M|, P| or V| to limit the added content to music (M|), pictures (P|) or videos (V|) only. To limit a directory to a specific content type is useful as sometimes applications tend to create temporary content which should not be served - for example, a number of applications create the embedded album art from music files as jpeg files under the music folders - but these jpegs should not be served by the MediaServer as pictures.

The ignoredir parameter is a comma separated list of strings which specify directories which shall be ignored while scanning for content. These may, for example, be directories for temporary files, or auto generated directories like AppleDouble which exist on apple share directories. The strings specify substrings of the path to the directories to be ignored, e.g. specifying the string AppleDouble would ignore directories like c:\content\.AppleDouble and c:\somewhere\.AppleDouble\music /home/user/content/AppleDouble/home/user/somewhere/AppleDouble/music as both paths contain the string "AppleDouble".

as both paths contain the string "AppleDouble". With followlinks you can modify the behaviour of the

With followlinks you can modify the behaviour of the file scanner on Linux systems - when it hits a symbolic link. With followlinks=1 the scanner will treat symbolic links as files or directories, with followlinks=0 it will ignore symbolic links.

Example settings

Explanation

contentdir=.

Use the current working directory including all subdirectories to scan for content. Do not ignore any directories

ignoredir=

contentdir=c:\My Content ignoredir=tempcontentdir=/home/user/My Contentignoredir=temp

Scan under c:\My Content for content. Ignore all directories which have the substring "temp" in the pathScan under /home/user/My Content for content. Ignore all directories which have the substring "temp" in the path

contentdir=M|c:\My Content\Music, P|c:\My Content\Pictures, V|c:\My Content\Videos ignoredir=AppleDouble,tempcontentdir= M|/home/user/My Content/Music, P|/home/user/My Content/Pictures, V|/home/user/My Content/Videos ignoredir=AppleDouble,temp

Scan under c:\My Content\Music for music only, under c:\My Content\Pictures for pictures only, and c:\My Content\Videos for videos only. Ignore all directories which have the substrings "AppleDouble" or "temp" in the path.Scan under /home/user/My Content/Music for music only, under /home/user/My Content/Pictures for pictures only,

Page 10 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m
and home/user/My Content/Videos for videos only. Ignore all directories which have the substrings "AppleDouble"

and home/user/My Content/Videos for videos only. Ignore all directories which have the substrings "AppleDouble" or "temp" in the path.

Default:

contentdir=.

ignoredir=AppleDouble

4.2 Identifying compilations

Set this option to a comma separated list of directory names, which are used to store compilations.

Example:

compilationsdir=Compilations,Sampler

All directories and songs located in Compilations or Sampler, e.g. "My Music\Compilations\MTV TOP 20" will be treated as part of a compilation - and as such be sorted into the database under artists various.

Default:

compilationsdir=Compilations,Sampler

4.3 Internet Radio

The following options can be used to adjust the automatic provision of the Internet Radio stations:

radio

numradiostations

radioreread

radiogenre

The radio option can be set to 0, 1 2 or 3. If set to 0 the Internet Radio support is disabled and the MediaServer does not contact any radio websites. Set to 1 the MediaServer will support Shoutcast radio only. Set to 2 the MediaServer will support vTuner radio only. Set this option to 3 to have both – Shoutcast and vTuner support in parallel.

For Shoutcast radio the numradiostations option specifies the number of stations which the MediaServer will download and import to its database. If you want to have 100 radio stations available set it to numradiostations=100.

For Shoutcast radio the radioreread option specifies how often the MediaServer reconnects to the Shoutcast website to refetch the top list of radio stations. As most of the smaller radio stations have a very short lifetime it is wise to update the list of radio stations at least once per hour. The radioreread option specifies the reread time in minutes. If this is set to 0 (zero) the radio rescan is disabled - the MediaServer will fetch the list of radio stations only once on startup.

The radiogenre option specifies the genres of the Shoutcast radio stations which shall be added to the station list. This option is represented by a comma separated list of genres which shall be substrings of the Shoutcast radio genres. If the list is empty, all stations will be added to the list. Further information regarding Shoutcast genres is provided at the Shoutcast web site.

Example:

radio=1

numradiostations=100

radioreread=30

radiogenre=metal,pop

Page 11 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

Internet Radio is set to Shoutcast only. The MediaServer will fetch the Top 100 radio stations from the Shoutcast Website which contain metal and pop in their genre. The MediaServer will provide the radio genres unfiltered. The list is updated every 30 minutes.

Defaults:

radio=3

numradiostations=50

radioreread=60

radiogenre=

4.4 Using 3rd party metadata applications

There are a number of 3 rd party products that will allow organizing your content by means of metadata. Most common are the ones dealing with MP3 content, but there are also applications which allow organizing pictures by means of user-defined tags. TwonkyMedia enables interfacing with several of these applications. That means that

metadata created with these 3 rd party applications will be utilized by TwonkyMedia to provide

a more comfortable navigation tree.

4.4.1 Winamp

If you have Winamp installed, the MediaServer can use your Winamp Library as a base for

finding music files on your system. You can also create playlists in Winamp which are then available via the MediaServer. To enable this option, the path where Winamp is installed has to be specified. The Winamp library and folders are rescanned regularly by the MediaServer - so when the Winamp library is changed the MediaServer will reflect the updates after a few

seconds.

If you want to use the Winamp library only, the contentdir should be set to an empty path, e.g. contentdir=

Option name:

winamp

Example:

winamp=C:\Program Files\Winamp

Default:

winamp=\Program Files\Winamp

4.4.2 iTunes

For iTunes Library support set the fully qualified path to the iTunes XML library file. The library will be parsed by the MediaServer to locate the songs which it serves. The iTunes Library also contains information about compilations.

Option name:

Example:

ituneslib

ituneslib=c:\My Music\iTunes\iTunes Music Library.xml Example:

ituneslib=/home/user/iTunes Music Library.xml

ituneslib=/home/user/iTunes Music Library.xml

Default:

ituneslib=

4.4.3 Adobe Photoshop Album

The MediaServer supports the Adobe Photoshop Album database file. You can use Adobe Photoshop Album (version 2) to organize your pictures by means of tags. The tagging information is used by the MediaServer to build a second logical view on your pictures, where you can navigate and locate your pictures. If you have, for example, a tag James, which is located under Friends and allocate this tag to a picture, you will find the following navigation path at the MediaServer:

Tags Friends James picture.jpg

Page 12 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

You need to find out the name and path of the database file Adobe Photoshop Album is using. The file has the extension .psa. One way to locate it is to use the "save as" menu from Adobe Photoshop Album to save the current catalogue under a new name - when the dialog box is open you can see the name and the path of the current catalogue file. Press cancel here. Set adobepath to the full qualified name to the .psa file.

If you also want to have a relative path displayed under the Folders entry of the server, you can specify for the contentdir (see contentdir option) the directory where your pictures are located. You may use the prefix P| here to specify that the sub tree contains pictures only. This is not a requirement - if you do not set the contentdir you will see the full path to your pictures under the Folders menu item - starting with the drive letter.

Option name:

adobepath

Example:

adobepath=c:\my documents\my pictures\adobe.psa

Default:

contentdir=P|c:\my documents\my pictures adobepath=

4.5 Rescanning for available content

The MediaServer scans all the folders which are specified by the contentdir parameter on

startup. With the scantime option it is possible to specify a period in minutes after which the MediaServer shall scan the content directories for updates. It will discover new files, updates

or removed files and synchronize its internal database correspondingly. The scantime can be

set to 0 to disable automatic rescans.

A rescan of the content directories can also be triggered manually by the MediaServer's

configuration web pages by selecting the "rescan now" link or on Windows systems by selecting the "Rescan content directories" menu item from the tray icon.

Example:

This will result in an automatic rescan of the content directories every 60 minutes.

Default:

scantime=60

scantime=15

Note for experts:

A rescan of a specific subdirectory can also be triggered manually by appending the subdirectory name to the "rescan now" link mentioned above.

name to the "rescan now" link mentioned above. Example: If "URL http://127.0.0.1:9000/rescan" is

Example: If "URL http://127.0.0.1:9000/rescan" is the "rescan now" link, use the URL http://127.0.0.1:9000/rescan/C:%5CMy%20Content%5CMy%20Music%5CAbba in order to rescan c:\My Content\My Music\Abba

5 Customizing the navigation tree

5.1 MediaServer name

By means of this option, the MediaServer name as displayed by the client can be changed. If the friendlyname is omitted the MediaServer will automatically generate a name which includes the current hostname, such as [HOSTNAME]TwonkyMedia.

Option name:

friendlyname

Example:

friendlyname=My MediaServer

Default:

friendlyname=

5.2 Language

This option allows selecting the language used for the configuration pages as well as for the navigation tree.

Option name:

language

Page 13 of 26

TwonkyMedia User Manual 3.0

Supportet values:

de / en / fr / es / it / nl

Example:

language=de

Default:

language=en

© TwonkyVision GmbH

© T w o n k y V i s i o n G m b

Note: When changing the language, the navigation tree will be reset to the default for the corresponding language. If you customize your navigation tree in a different language, these changes are lost!

5.3 Configuration of the tree structure

The navigation structure (tree view) of the MediaServer can be fully customized. However, please note that some clients, like the Netgear MP101 are searching for tree nodes However, please note that some clients, like the Netgear MP101 are searching for tree nodes with specific names to enable the hot keys on the remote control. The names which

need to be available for the MP101 are:

Radio.
Radio.

Playlists, Genres, Artists, All Tracks and Internet

The following nodes are predefined, but can be renamed to custom names:

Option

Default value

Tree Node

rootmusic

Music

Music

alltracks

All Tracks

Music All Tracks

playlists

Playlists

Music Playlists

internetradio

Internet Radio

Music Internet Radio

allownradiostations

Favorites

Music

Internet

Radio

Favorites

rootpicture

Pictures

Pictures

 

allpictures

All Pictures

Pictures All Pictures

rootvideo

Videos

Videos

 

allvideos

All Videos

Videos All Videos

allname

- ALL -

Combines all subentries of a particular node

Note: When a root name is set to an empty string, the MediaServer will not provide content for that sub node and suppress that content type completely. In addition, there are 20 customizable nodes of the MediaServer, 10 for the music tree, 5 for the pictures tree and 5 for the video tree:

musicnode1

musicnode10

picturenode1

picturenode5

videonode1

videonode5

Each node is defined by a comma-separated values string, which specifies the root name of the node displayed by the MediaServer and the total tree branches under this node. The tree is specified by attributes of the content (metadata) - for these attributes the following macros are available:

%TITLE

title of a song, picture or video

%ARTIST

artist of a song

%ALBUM

album of a song

%GENRE

genre of a song

%YEAR

year attribute of the item, year when the song was released, year when a picture was taken

%MONTH

month attribute of the item - month when a picture was taken

%DAY

day attribute of the item - day when a picture was taken

%DESCRIPTION

description of a picture

%DURATION

duration of a song or video

Page 14 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

%TRACK

track number of a song

%WIDTH

width of a picture

%HEIGHT

height of a picture

%PATH

complete path (relative to a content root) to the item

%KEYWORD

the keywords attached to the content item. In case of the iTunes database these contain the rating values (one to five stars)

In addition, to support alpha search on each node for devices which do not have client alpha search capability, each macro name can be prepended by square brackets with a number, to specify an alpha search auto-generated root.

Example: prepending [3] would create the following sub notes for an entry: ABC, DEF, GHI, JKL, MNO, OPQ, RST, UVW, XYZ

Note: Please note that the alpha sort criteria (square brackets) can not be combined with the %PATH macro. The whole path is always generated as one tree which should reflect the path on the device.

Music examples:

Let’s assume a song with the following metadata

Title

Let the music play Twonky Rock Greatest Twonky Songs

 

Artist

Genre

Album

Year

2005

Duration

3:05

Track

3

Path

My Music\Twonky\Greatest Twonky Songs\let the music play.mp3

Option settings

 

Tree View

 

musicnode1=

 

Music Artists Twonky Let the music play

Artists,%ARTIST

musicnode2=

 

Music Albums Greatest Twonky Songs Let the music play

Albums,%ALBUM

musicnode3=

 

Music Artists/Albums Twonky Greatest Twonky Songs Let the music play

Artists/Albums,%ARTIST,%ALBUM

musicnode4=

 

Music

Folders My

Folders,%PATH

Music Twonky Greatest Twonky Songs Let the music play

musicnode5=

 

Music Genre/Artists

Rock Twonky Grea

Genre/Artists,%GENRE,%ARTIST,%ALBUM

test Twonky Songs Let the music play

musicnode6=

 

Music Genre/Artists Rock

RST Twonky

Genre/Artists,%GENRE,[3]%ARTIST,%ALB

Greatest Twonky Songs Let the music play

UM

musicnode7=

 

Music Year/Artist 2005 Twonky Greatest Twonky Songs Let the music play

Year/Artists,%YEAR,%ARTIST,%ALBUM

Page 15 of 26

TwonkyMedia User Manual 3.0

Defaults for music nodes:

musicnode1=Artists,%ARTIST

musicnode2=Genres,%GENRE

musicnode3=Albums,%ALBUM

musicnode4=Folders,%PATH

musicnode5=Artists/Albums,%ARTIST,%ALBUM

musicnode6=Genres/Artists,%GENRE,%ARTIST,%ALBUM

musicnode7=Year/Albums,%YEAR,%ALBUM

musicnode8=Year/Artist,%YEAR,%ARTIST,%ALBUM

musicnode9=Alpha,[3]%ARTIST

musicnode10=

Picture examples:

Let’s assume a picture with the following metadata

© TwonkyVision GmbH

© T w o n k y V i s i o n G m b
© T w o n k y V i s i o n G m b

Title

DSCM2003

Path

My Pictures\20040101-holidays\dscm2003.jpg

Date

01 Jan 2004

Width2048

Height

1536

picturenode1=Folders,%PATH

Pictures Folders MyPictures 20040101 DSCM2003

picturenode2=Date,%YEAR,%MONTH,%DAY

Pictures Date 2004 01 01 DSCM2003

picturenode3=Year/Size,%Year,%WIDTH

Pictures Year/Size 2004 2048 DSCM2003

Defaults for picture nodes:

picturenode1=Folders,%PATH

picturenode2=Date,%YEAR,%MONTH

picturenode3=

picturenode4=

picturenode5=

Defaults for video nodes:

videonode1=Folders,%PATH

videonode2=

videonode3=

videonode4=

videonode5=

5.4 Metadata adjustments

The MediaServer can adjust the case of some content attributes like title, artist or album. When this option is set to 1, the MediaServer will correct the upper/lowercase writing of these properties, so that each content item will start with an uppercase letter and the rest of the word is in lower case. The MediaServer will also move strings like "The", "Der", "Die", "Das" to the end of a title, prepending a comma. For example "The Beatles" will become "Beatles, The", so that the Beatles are found under "B" and not "T". This option can be disabled by setting the adaptcase to 0.

Option name:

adaptcase

Values:

0

1

Page 16 of 26

TwonkyMedia User Manual 3.0

Example:

adaptcase=0

Default:

adaptcase=1

5.5 Auto-generated playlists

TwonkyMedia auto-generates two playlists:

© TwonkyVision GmbH

© T w o n k y V i s i o n G m b

most played songs contains the songs with the highest play count last played songs contains the songs which have been played last

The number of songs per list and the names of these playlists can be customized via the following parameters:

Option name:

playlistnumentries

playlistlastplayed

playlistmostplayed

Defaults:

playlistnumentries=10

playlistlastplayed=- Last Played - playlistmostplayed=- Most Played -

5.6 Folder Prefix

Some client device present folders and content items in the navigation tree using the same style. The user can therefore not differentiate whether he can play this item or further navigate. TwonkyMedia therefore allows prefixing all folders with a single character or string.

Example:

folderprefix=FOLDER:

Default:

folderprefix=<

Since entries are sorted in alphabetical order, folders with the default prefix will be listed on top of the content items.

5.7 Randomizing playlists

Playlists can be randomized by the MediaServer on startup when it reads and imports the playlists. Set the option randomizeplaylists to 1 to randomize your playlists on startup – this option is useful if your client device does not support shuffle play on its own.

Default:

randomizeplaylists=0

Page 17 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

6 Network settings

6.1 Access to web configuration page

b H 6 Network settings 6.1 Access to web configuration page The web configuration page is

The web configuration page is by default only available through the local browser. You can disable access to this page completely or enable access also for remote browsers in the network.

Option name:

enableweb

Values:

0

disable the web configuration page

1

enable web configuration for local access only

2

enable web configuration for all remote clients (may be a security issue)

Default:

enableweb=1 for PC, enableweb=2 for NAS

6.2 MediaServer IP address and port

The MediaServer tries to start a HTTP server on HTTP port 9000. If this port is not available, it will automatically scan for t he next free port. If this dynamic behavior available, it will automatically scan for the next free port. If this dynamic behavior is not desired, specify a specific HTTP port with the httpport option. The server will then try this port only - and it will terminate if the port is not available! Set the httpport value to 0 (zero) to enable the dynamic port allocation.

Example:

httpport=9000

Start the MediaServer with the HTTP server listening on port 9000. If port 9000 is not available the MediaServer will not start! If you intend to specify a particular port you should check first with ‘netstat –a’ whether it is already blocked.

Default:

httpport=0

Note: On some Linux/UNIX systems a port is still blocked for a while after a process has terminated – this may result in a port change of the MediaServer after a restart. If you cannot access the MediaServer at port 9000 after a restart, please try also port 9001.

at port 9000 after a restart, please try also port 9001. A similar option is available

A similar option is available for the IP address used by the MediaServer. The default behaviour of the MediaServer is to scan the system for available network interfaces and their corresponding IP addresses and to launch a listening instance of the MediaServer on every network interface. Therefore a system with 3 network cards would have a visible MediaServer on all 3 connected networks to this system. Sometimes the MediaServer fails to identify the IP address and sometimes it is also not wanted to have the MediaServer available on all connected networks. Therefore a specific IP address can be specified which is used by the MediaServer. Set the ip option to an empty string to enable the dynamic scan for network cards.

Example:

ip=192.168.1.10

Start

the

MediaServer

on

the

network

192.168.1.10.

 

Default:

ip=

 

interface

which

is

bound

to

the

IP

address

Page 18 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

Note: If you specify an invalid IP address, the MediaServer may not be able to launch at all – and will not be available via its web configuration. In this case it is recommended to delete the .ini file and try a restart!

6.3 Updates

TwonkyMedia can check automatically if updates are available on the TwonkyVision website. By means of this option you can disable this check. Set it to 0 to disable checks for updates.

Default:

checkupdate=1

6.4 Restart on network changes

Default : checkupdate=1 6.4 Restart on network changes It is possible to automatically restart the MediaServer

It is possible to automatically restart the MediaServer on network changes. This is especially useful when the MediaServer is started on a laptop and the laptop is changing the connection (moved around between Networks). To enable the automated MediaServer restart, set the option nicrestart to 1.

Example:

nicrestart=1

Restart the MediaServer automatically on IP address changes.

Note: Set this option to 0 if you get disconnects when you have a dynamic DSL connection set.

Default:

nicrestart=0

Note: If this option is set to 1 and you have an instable WLAN connection, this may cause trouble with streaming. As the MediaServer restarts on a NIC change it will lose all current streaming connections – and all clients will stop streaming.

Page 19 of 26

TwonkyMedia User Manual 3.0

7 Finetuning the performance

7.1 MediaServer database

© TwonkyVision GmbH

© T w o n k y V i s i o n G m b

The MediaServer stores a number of internal data and caches transcoded files under the directory which is given with the option dbdir . the directory which is given with the option dbdir.

Set this option to a full qualified pathname, where the MediaServer can store a persistent database.

Option name:

dbdir

Example:

dbdir=c:\Windows\mediaserver.db

Default:

dbdir=

As default, the MediaServer will create a directory “twonkymedia.db“ within the first content directory which was specified with the option contentdir.

7.2 Disable rescale

With this option you can disable picture rescaling by the MediaServer. This is in particular useful if you run the MediaServer on a NAS device with low memory.

Example:

norescale=1

Default:

norescale=0

Please note that to enable rescaling, the plugin jpegscale must be available in the same directory as the MediaServer. Usually, this file is installed together with the MediaServer.

7.3 Streaming buffer size

For experienced users it is possible to adjust the size of the streaming buffer of the MediaServer. This may help on some systems, if there is a problem with video streaming. MediaServer. This may help on some systems, if there is a problem with video streaming. The stream buffer size should be between 32000 and 128000.

Default:

streambuffer=32000

Page 20 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

8 Client-specific settings

8.1 Music client

The MediaServer identifies a number of music-only clients, like the Netgear MP101 audio player, automatically. These clients will always be directed to the music sub tree of the MediaServer, as it does not make sense to navigate on pictures and videos with these clients. However, the MediaServer does not know all existing music clients - therefore if your music client is not detected automatically and you see the picture and video nodes on a pure music client, it is possible to specify a comma separated list of IP addresses of known music clients. These requests are automatically pointed to the music subdirectory when the client starts to browse the server.

Option name:

musicclient

Example:

musicclient=192.168.1.11,192.168.1.20

Default:

The clients with the IP addresses 192.168.1.11 and 192.168.1.20 are pure music clients and shall not be provided with pictures and videos. musicclient=

Note: There is no option for picture-only or video-only clients, since we are not aware of such clients so far. Also please note that this option requires to set the client to a fixed IP address – you can not use DHCP addresses as the client will then change its address from time to time.

8.2 Roku: disable server-side search

The nosearch option allows you to disable the search support of the MediaServer for Roku client devices. The default of this option is nosearch=0, so search is enabled. Roku devices, show their own user interface, ignoring the custom tree settings of the server,when they discover that the MediaServer supports search. For MediaServers, which do not support search, the device falls back into a simple browse mode, showing exactly the logical tree view as defined by the MediaServer. To get back your custom tree for navigation (which is the logical tree view of the MediaServer) set the nosearch option to 1.

However, you can than not use the "search" key of the device, as search is disabled - but for now there is no solution available to have both - search support and a custom user interface.

Example:

nosearch=1

Default:

nosearch=0

Note: There is also a firmware upgrade for the Roku Soundbridge available which enables you to use Search and Browse on the server in parallel.

8.3 Noxon

It is possible to specify a number of IP addresses (separated by comma) to identify Noxon clients at fixed IP addresses. The autodetection of Noxon clients does not work reliably, but the Noxon needs special handling for special characters, as it does not understand UTF-8 encoded characters (which is the default for UPnP clients). If your characters look garbled at the Noxon please try to set the IP address of the device with this option.

Example:

noxonclient=192.168.1.50,192.168.1.60

8.4 D-Link

It is possible to specify a number of IP addresses (separated by comma) to identify D-Link clients at fixed IP addresses. The autodetection of D-Link clients does not work reliably, but the D-Link needs special handling for pictures. If your pictures look too small and you do not

Page 21 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

get icons for your folders, please try to set the IP address of the device by means of this option.

Example:

dlinkclient=192.168.1.50,192.168.1.60

8.5 Netgear MP101

The following options can only be used in conjunction with Netgear MP101 clients.

netgearrtp

rtpport

Music streaming via HTTP works reliable between Windows systems and the MP101, but on Linux/UNIX systems it is recommended to switch to RTP streaming. By means of the netgearrtp option you can select RTP streaming for Netgear MP101 clients (netgearrtp=1) instead of HTTP streaming (netgearrtp=0). It is recommended to use RTP on Linux/UNIX systems since it is more stable on these systems.

With rtpport the port number of the RTP server can be selected. Use rtpport=0 for dynamical port allocation.

Example:

netgearrtp=0

rtpport=9090

Default:

rtpport= netgearrtp=0, (Windows) netgearrtp=1 (Linux/UNIX)

8.6 Netgear MP115

It is possible to specify a number of IP addresses (separated by comma) to identify Netgear MP115 clients at fixed IP addresses if the autodetection does not work. This option is mainly needed to enable DivX video support for these clients.

Example:

netgear115client=192.168.1.50,192.168.1.60

Default:

netgear115client=

8.7 Homepod

It is possible to specify a number of IP addresses (separated by comma) to identify Homepod clients at fixed IP addresses if the autodetection does not work.

Example:

homepodclient=192.168.1.50,192.168.1.60

Default:

homepodclient=

8.8 Syabas

It is possible to specify a number of IP addresses (separated by comma) to identify Syabas firmware based clients at fixed IP addresses if the autodetection does not work. Syabas firmware clients are, for example, the Buffalo Linktheater or the IO-Mega devices. If you can not play AVI videos with your device, you should use this option.

Example:

syabasclient =192.168.1.50,192.168.1.60

Default:

syabasclient=

Page 22 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

8.9 Siemens M740AV

It is possible to specify a number of IP addresses (separated by comma) to identify Siemens M740AV clients at fixed IP addresses if the autodetection does not work.

Example:

m740client =192.168.1.50,192.168.1.60

Default:

m740client=

8.10 Telegent TG100

It is possible to specify a number of IP addresses (separated by comma) to identify Telegent TG100 clients at fixed IP addresses. Autodetection does not work for TG100.

Example:

telegentclient =192.168.1.50,192.168.1.60

Default:

telegentclient =

Page 23 of 26

TwonkyMedia User Manual 3.0

© TwonkyVision GmbH

3.0 © T w o n k y V i s i o n G m

9 Command line options

Please note that the following options can only be specified through the command line, i.e. they are only available if TwonkyMedia is running on a PC rather than on an embedded device. The values will not be stored in the .ini file.

device. The values will not be stored in the .ini file. 9.1 Run as Service -install

9.1 Run as Service

-install

-uninstall

in the .ini file. 9.1 Run as Service -install -uninstall On Windows platforms, the MediaServer can

On Windows platforms, the MediaServer can be installed to run as a background service. This has the advantage that no user has to be logged in to the system while the MediaServer is running. To install the MediaServer as a background service, open a command prompt in Windows (run cmd as an application). Navigate to the directory where the MediaServer is located and issue a "mediaserver -install". A Message Box will pop up to inform you that the MediaServer is now installed as a service. The MediaServer is now running - and will be restarted on every system startup. To uninstall the MediaServer as a service, issue a "mediaserver -uninstall" at a command prompt. A Message Box will pop up and inform you that the MediaServer has been removed from the list of services.

Note: When you want to upgrade the MediaServer the service must be stopped, otherwise you can not copy a new executable over the existing one. Please stop the MediaServer service by using the Computer Management Menu under Windows System, or uninstall the service before updating the MediaServer.

or uninstall the service before updating the MediaServer. 9.2 Launching as daemon By means of the

9.2 Launching as daemon

By means of the -D command line parameter the MediaServer is launched as a daemon. It also generates a file "/var/run/mediaserver.pid" with the process id of the MediaServer. This is used by the sample scripts provided with the MediaServer to start, stop and restart the MediaServer background process.

9.3 .ini filename

By means of this command line option, one can specify which .ini file shall be used by the server. This is, for example, useful if the server shall be started several times with different content directories and user preferred names to set up different servers with different content repositories on one machine (e.g. for different users)

Example:

-inifile fathers-server.ini

9.4 Debugging and bug reports

With the -v [n] command line option, it is possible to get a number of messages from the MediaServer, which may be helpful to find problems with the installation, or which can be sent to our support team when there are problems with the MediaServer. Bug reports can be submitted with our Mantis issue tracking system under http://www.twonkyvision.com/mantis. When this option is specified, the MediaServer creates a file under Windows which has the same name and location as the executable file of the MediaServer, but has the extension .log. On UNIX/Linux systems, the MediaServer will write the debugging messages to stdout and critical messages to stderr. Together with the -v option, the debugging level can be specified:

Meaning

Value

Page 24 of 26

TwonkyMedia User Manual 3.0

System messages

1

SSDP messages

2

Database related

4

HTTP related

8

Client identification

16

UPnP eventing

32

EXIF parser

64

HTTP radio proxy

128

XML parser

256

© TwonkyVision GmbH

256 © T w o n k y V i s i o n G m

If you want to get messages from several system components, just add the corresponding values.

Examples:

-v 8 provides all HTTP related messages -v 7 provides all system messages, all SSDP messages and all database related messages -v 511 provides all messages

Page 25 of 26

TwonkyMedia User Manual 3.0

10 Index of configuration parameters

© TwonkyVision GmbH

© T w o n k y V i s i o n G m b

adaptcase 16

musicnode 14

adobepath

13

netgear115client 21

allname 14

netgearrtp 20

allownradiostations 14

nicrestart 18

allpictures

14

norescale 19

alltracks

14

nosearch 20

allvideos

14

noxonclient

20

checkupdate 18

numradiostations 11

compilationsdir

11

picturenode 14

contentdir 10

playlistlastplayed

17

dbdir

19

playlistmostplayed 17

radio

11

dlinkclient 20 enableweb 17 folderprefix 17

playlistnumentries 17 playlists 14

followlinks 10

radiogenre

11

friendlyname 13 homepodclient 21

radioreread 11 randomizeplaylists 17

httpport

17

rootmusic 14

ignoredir

10

rootpicture

14

inifile

22

rootvideo 14

internetradio

14

rtpport 20

ip

18

scantime 13

ituneslib

12

syabasclient 21

language 13

telegentclient

21

language 13 m740client 21 musicclient 19

videonode 14 winamp 12

Page 26 of 26