Debian Codegraph @

core/dplugins/generic/tools/mediaserver/upnpsdk/Platinum/README.txt

raw
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 2008 solution located @ Platinum\Build\Targets\x86-microsoft-win32-vs2008\Platinum.sln
15
16 * MacOSX, iOS:
17 Open the XCode project file located @ Platinum/Build/Targets/universal-apple-macosx/Platinum.xcodeproj
18 To include Platinum to your XCode projects, simply add the project file then add Platinum as a Target Dependency as well as libPlatinum.lib in Link Binaries.
19 Alternatively, you can build the Platinum.Framework using the PlatinumFramework target and add it to your project.
20
21 * Linux, Cygwin, MacOSX, iOS
22 Open a shell, go to the Platinum root directory and type 'scons' (http://scons.org).
23 The output of the scons build will be found under Platinum/Build/Targets/{TARGET}/{Debug|Release}.
24 Additionally, the output is copied under Platinum/Targets/{TARGET}/{Debug|Release} for convenience when applicable.
25
26 Command Line Examples:
27 Builds libPlatinum.a, Platinum.Framework on both OSX & iOS using Xcode. Apps & Tests on OSX only.
28 [The framework for OSX is i386 and x86_64 compatible, the iOS version is armv6, armv7 and i386 compatible so you can link with it and run your app on device and simulator]
29 > scons target=universal-apple-macosx-xcode build_config=Release
30
31 Builds Platinum.lib, Tests & Apps for Windows
32 > scons target=x86-microsoft-win32 build_config=Release
33
34 ---------------------------------------------
35 RUNNING SAMPLE APPLICATIONS
36
37 * FileMediaServerTest
38 ---------------------
39 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).
40
41 usage: FileMediaServerTest [-f <friendly_name>] <path>
42 -f : optional upnp server friendly name
43 <path> : local path to serve
44
45 Once started, type 'q' to quit.
46
47 * MediaRendererTest
48 -------------------
49 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 yet. You need to hook up the playback functionality yourself.
50
51 usage: MediaRendererTest [-f <friendly_name>]
52 -f : optional upnp server friendly name
53
54 Once started, type 'q' to quit.
55
56 * MediaCrawler
57 --------------
58 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).
59
60 Once started, type 'q' to quit.
61
62 * MicroMediaController
63 ----------------------
64 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:
65 quit - shutdown
66 exit - same as quit
67 setms - select a media server to become the active media server
68 getms - print the friendly name of the active media server
69 ls - list the contents of the current directory on the active
70 media server
71 cd - traverse down one level in the content tree on the active
72 media server
73 cd .. - traverse up one level in the content tree on the active
74 media server
75 pwd - print the path from the root to your current position in the
76 content tree on the active media server
77
78 Experimental MediaRenderer commands (not yet full implemented):
79 setmr - select a media renderer to become the active media renderer
80 getmr - print the friendly name of the active media renderer
81 open - set the uri on the active media renderer
82 play - play the active uri on the active media renderer
83 stop - stop the active uri on the active media renderer
84
85 * MediaConnect
86 --------------
87 This is a derived implementation of the FileMediaServerTest with the only difference that it makes it visible to a XBox 360.
88
89 * MediaServerCocoaTest
90 ----------------------
91 A basic cocoa test server app showing how to use the Platinum framework on Mac OSX.
92
93 ---------------------------------------------
94 LANGUAGE BINDINGS
95
96 * Objective-C
97 -------------
98 Under Source/Extras/ObjectiveC
99
100 * C++/CLR
101 ---------
102 Under Source/Extras/Managed
103
104 * Android Java/JNI
105 ------------------
106 To build the JNI shared library, you will need to have installed the Android NDK and set up the proper environment variables such as ANDROID_NDK_ROOT.
107 > cd <PlatinumKit>/Platinum
108 > scons target=arm-android-linux build_config=Release
109
110 > cd <PlatinumKit>/Platinum/Source/Platform/Android/module/platinum
111 > ndk-build NDK_DEBUG=0
112
113 > import eclipse Android .project located @ <PlatinumKit>/Platinum/Source/Platform/Android/modules/platinum/
114 This will create the jar file @ <PlatinumKit>/Platinum/Source/Platform/Android/modules/platinum/bin/platinum.jar
115
116 > To Test the Platinum jni layer, import into eclipse both Android projects located @ <PlatinumKit>/Platinum/Source/Platform/Android/samples/sample-upnp & <PlatinumKit>/Platinum/Source/Platform/Android/modules/platinum.
117