comparison deps/Platinum/README.txt @ 0:3425707ddbf6

Initial import (hopefully this mercurial stuff works...)
author fraserofthenight
date Mon, 06 Jul 2009 08:06:28 -0700
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:3425707ddbf6
1 Platinum UPnP SDK
2 =================
3
4 This toolkit consists of 2 modules:
5 * Neptune : a C++ Runtime Library
6 * Platinum: a modular UPnP Framework [Platinum uses Neptune]
7
8 Unless you intend to use Neptune independently from Platinum, it is recommended that you build binaries directly from the "Build" tree of Platinum. All the dependent binaries will be rebuilt automatically (including Neptune).
9
10 ---------------------------------------------
11 BUILDING SDK & SAMPLE APPLICATIONS
12
13 * Windows:
14 Open the Visual Studio 2005 solution located @ Build\Targets\x86-microsoft-win32-vs2005\Platinum.sln
15 Open the Visual Studio 2008 solution located @ Build\Targets\x86-microsoft-win32-vs2008\Platinum.sln
16
17 * XBox:
18 Open the Visual Studio .NET 2003 solution located @ Build\Targets\x86-microsoft-xbox-vs2003\Platinum.sln
19
20 * MacOSX:
21 Open the XCode project file located @ Build\Targets\universal-apple-macosx\PlatinumApps.xcodeproj
22 To include Platinum to your XCode projects, simply add the project file located @ Build\Targets\universal-apple-macosx\Platinum.xcodeproj.
23
24 * Linux, Cygwin, MacOSX
25 Open a shell, go to the Platinum root directory and type 'scons' (http://scons.org).
26 The output of the scons build will be found under Platinum/Build/Targets/{TARGET}/{Debug|Release}.
27 Additionally, the output is copied under Platinum/Targets/{TARGET}/{Debug|Release} for convenience.
28
29 ---------------------------------------------
30 RUNNING SAMPLE APPLICATIONS
31
32 * FileMediaServerTest
33 This is an example of a UPnP MediaServer. Given a path, it allows a UPnP ControlPoint to browse the content of the directory and its sub-directories. Additionally, files can be streamed (Note that only files with known mimetypes are advertised).
34
35 usage: FileMediaServerTest [-f <friendly_name>] <path>
36 -f : optional upnp server friendly name
37 <path> : local path to serve
38
39 Once started, type 'q' to quit.
40
41 * MediaRendererTest
42 This is an example shell of a UPnP MediaRenderer. It is to be contolled by a UPnP ControlPoint. This is just a SHELL, this won't play anything. You need to hook up the playback functionality yourself.
43
44 usage: MediaRendererTest [-f <friendly_name>]
45 -f : optional upnp server friendly name
46
47 Once started, type 'q' to quit.
48
49 * MediaCrawler
50 This is a combo UPnP MediaServer + ControlPoint. It browses content from other MediaServers it finds on the network and present them under one single aggregated view. This is useful for some devices that need to select one single MediaServer at boot time (i.e. Roku).
51
52 Once started, type 'q' to quit.
53
54 * MicroMediaController
55 This is a ControlPoint (synchronous) that lets you browse any MediaServer using a shell-like interface. Once started, a command prompt lets you enter commands such as:
56 quit - shutdown
57 exit - same as quit
58 setms - select a media server to become the active media server
59 getms - print the friendly name of the active media server
60 ls - list the contents of the current directory on the active
61 media server
62 cd - traverse down one level in the content tree on the active
63 media server
64 cd .. - traverse up one level in the content tree on the active
65 media server
66 pwd - print the path from the root to your current position in the
67 content tree on the active media server
68
69 Experimental MediaRenderer commands (not yet full implemented):
70 setmr - select a media renderer to become the active media renderer
71 getmr - print the friendly name of the active media renderer
72 open - set the uri on the active media renderer
73 play - play the active uri on the active media renderer
74 stop - stop the active uri on the active media renderer