home *** CD-ROM | disk | FTP | other *** search
/ Netscape Plug-Ins Developer's Kit / Netscape_Plug-Ins_Developers_Kit.iso / plugins / xing / swplayer.sit.hqx / Documentation next >
Encoding:
Text File  |  1996-07-19  |  9.9 KB  |  213 lines
  1. StreamWorks 2.0
  2. ⌐1996 Xing Technology, Inc. 
  3.  
  4. http://www.xingtech.com/
  5.  
  6. Contents
  7.  
  8. -  Introducing the StreamWorks Player
  9. -  Playing Streams
  10. -  Displaying Information about a Stream
  11. -  Controlling the Video Display Window
  12. -  Controlling Audio Playback
  13. -  Setting Network Options
  14. -  Diagnostics
  15. -  Contacting us
  16.  
  17. Introducing the StreamWorks¬ Player
  18.  
  19. The StreamWorks Player is an application for receiving video/audio streams delivered by StreamWorks Servers and StreamWorks 
  20. Transmitters. The StreamWorks Player features:
  21. -  VCR-style controls for controlling playback;
  22. -  flexible methods for opening streams;
  23. -  diagnostic tools.
  24.  
  25. The StreamWorks Player currently supports a number of computer platforms and is available in two forms:
  26. -  Helper Application - This version of the StreamWorks Player operates as a stand-alone application and as a Helper Application
  27.    to web browsers.
  28. -  Plug-In - This version of the StreamWorks Player operates as a Plug-In to Netscape 2.x.
  29.  
  30. Consult Xing's Web site (www.xingtech.com) for the current availability on the supported platforms and for general information 
  31. about StreamWorks, the StreamWorks Player's relationship to other StreamWorks components, and the types of streams available.
  32.  
  33.  
  34. Playing Streams
  35. Starting the StreamWorks Player
  36.  
  37. As with most applications, you can start the StreamWorks Player in a number of ways:
  38. On the Macintosh - Open the StreamWorks Player program, e.g., by double-clicking on the "StreamWorks Player" 
  39. icon, or double click one of its files. 
  40.  
  41. Opening and Closing Streams
  42.  
  43. When the StreamWorks Player is registered as a helper application, it automatically opens a stream any time you click on a 
  44. Hypertext reference to a file with the ".xdm" filename extension. An XDM file contains a stream specification that resembles 
  45. a standard URL used by WEB Browsers; URL-style stream specifications are in the form:
  46.  
  47. XDMA://{swServer}:{swPort}/{Stream}
  48.  
  49. Where:
  50. -  "XDMA" specifies the StreamWorks protocol;
  51. -  {swServer} is the IPaddress of a StreamWorks Server;
  52. -  {swPort} is the Port to which the StreamWorks Server listens for stream requests; by default, this Port is "1558" and 
  53.     can usually be excluded from the URL.
  54. -  {Stream} is the name of a PLAY file or an on-demand audio/video file residing on the StreamWorks Server.
  55.     For example:
  56.     XDMA://111.222.111.222:1558/grammy.mpg
  57.  
  58. Opening Streams With Menu Commands
  59.  
  60. After starting the StreamWorks Player, you can use menu commands to open a stream:
  61. -  Choose "Open Stream?" from the File menu. A dialog appears and asks you to enter a stream specification.
  62. -  Enter a URL-style stream specification or the pathname of a local XDM file, and click the OK button.
  63.  
  64. Opening Streams With Command Line Parameters
  65.  
  66. You can cause the StreamWorks Player to automatically open a stream by passing it the pathname of a local XDM file as 
  67. a command line parameter.
  68.  
  69.  
  70. Starting and Stopping Playback
  71.  
  72. After opening a stream, use the following techniques to control playback:
  73. -  To begin playback, click the Play button.
  74. -  To stop playback, click the  Stop button.
  75.  
  76. NOTE: When you stop and re-start playback, the StreamWorks Player first closes its connection to the current StreamWorks 
  77. Server and then must establish a new connection to the StreamWorks Server. If the StreamWorks Server becomes busy 
  78. while playback is stopped, the attempt to establish a new connection may be refused, and you will receive an error 
  79. "Stream Busy".
  80.  
  81. Navigating a Stream
  82.  
  83. To change the current position within a stream that has been opened in the StreamWorks Player, drag the Slider across 
  84. the Track Bar to the desired position. When you use this technique, the Current Position Indicator displays the new position.
  85.  
  86. NOTE: The navigation controls are available only when the current stream is an On-Demand File.
  87.  
  88. Closing a Stream
  89.  
  90. To close a stream that is opened in the StreamWorks Player, use one of the following techniques:
  91. -  Choose Close from the File menu.
  92. -  Open another stream; the previously opened stream is automatically closed.
  93. -  Exit the StreamWorks Player.
  94.  
  95.  
  96. Displaying Information abaout a Stream
  97.  
  98. To display information about a stream that has been opened in the StreamWorks Player, use one of the following techniques:
  99. -  Choose Stream Info? from the File menu.
  100. -  Click the Info button.
  101.  
  102. The Information Window appears and displays the following information about the opened stream:
  103. -  Server Name - the IP address of the StreamWorks server from which the stream originates.
  104. -  Stream Name - the name of the current stream.
  105. -  Stream Length - the total duration of the stream expressed in SMPTE Timecode format. This field is active only when 
  106.     the current stream is an On-Demand File.
  107. -  File Duration - the temporal length of the stream expressed in SMPTE Timecode format.
  108. -  Total Data Rate - the total amount of data in the stream measured in kilobits/second.
  109. -  Video Data Rate - the amount of video data in the stream measured in kilobits/second.
  110. -  Video Width - the horizontal size of video frames in the stream measured in pixels.
  111. -  Video Height - the vertical size of video frames in the stream measured in pixels.
  112. -  Total Audio Rate - the amount of audio data in the stream measured in kilobits/second.
  113. -  Audio Sample Rate - the sample rate of audio data in the stream;
  114. -  Audio Channels - the number of channels in the stream's audio data; valid values are Mono, Stereo, Joint Stereo, 
  115.    and Dual Channel.
  116. -  Audio Format - the format of audio data in the stream; valid values are MPEG1, MPEG2, and LBR.
  117.  
  118.  
  119. Controlling the Video Display Window
  120.  
  121. When you open a stream that contains video data, the Video Display Window appears and displays the stream's 
  122. first video frame. Read the following topics for instructions for controlling the Video Display window.
  123.  
  124. Stretching the Video Display Window
  125. To resize the Video Display Window by stretching the Window, use standard techniques for resizing the window frame. 
  126. Hold the Control key while stretching the Video Display window to maintain the windows' Aspect Ratio.
  127.  
  128. NOTE: Stretching the Video Display window is currently unsupported in the StreamWorks Player for Xwindows.
  129.  
  130. Closing the Video Display Window
  131. Closing the Video Display window hides the window and closes the current stream.
  132.  
  133. Video Frame Quality
  134. StreamWorks on the Macintosh requires at least 256 colors to run.
  135.  
  136. Controlling Audio Playback
  137. When you play a stream that contains audio data, the StreamWorks Player plays the audio through your computer's 
  138. Sound System and provides controls for muting audio playback and adjusting audio playback volume. 
  139.  
  140. Muting Audio Playback 
  141.  
  142. To toggle the Mute setting, click the Audio button.
  143.  
  144. Adjusting Audio Playback Volume
  145.  
  146. To adjust the audio playback volume, right-mouse click the Audio button, and drag the Volume Control's slider adjust the volume.
  147.  
  148. Controlling Audio Quality
  149.  
  150. To control audio playback quality, use the following items in the Settings menu:
  151. -  Playback -> Mono - Forces Monaural Audio Playback.
  152. -  Playback -> Stereo - Enables Stereo Audio Playback.
  153. -  Playback -> Optimize Audio - Causes the StreamWorks Player to optimize audio quality.
  154. -  Playback -> Mixed - Causes the StreamWorks Player to balance resource allocation between audio and video playback.
  155. -  Playback -> Optimize Video - Causes the StreamWorks Player to reduce audio quality, so processing time can be allocated 
  156.    to video playback.
  157.  
  158. The characteristics of the audio data generated by the StreamWorks Player can affect your computer's overall playback 
  159. performance; e.g., stereo audio contains twice as much data as monaural audio. Depending on the nature of your computer's 
  160. sound system, the overhead processing associated with transferring this additional data to your computer's sound board 
  161. may adversely affect overall playback performance.
  162.  
  163.  
  164. Setting Network Options
  165.  
  166. To insure proper interaction with other StreamWorks components, you must specify your computer's network connection 
  167. speed and relationship to network firewalls.
  168.  
  169. Specifying a Connection Speed
  170.  
  171. When the StreamWorks Player sends to a StreamWorks Server a stream request, the request includes data indicating the 
  172. StreamWorks Player's network connection speed. To insure proper delivery of streams, you must specify your computer's 
  173. connection speed by choosing an item from the StreamWorks Player's Settings menu:
  174.  
  175. -  9600 Modem - indicates that your computer's connection speed is 9.6kbs;
  176. -  14.4 Modem - indicates that your computer's connection speed is 14.4kbs;
  177. -  28.8 Modem - indicates that your computer's connection speed is 28.8kbs;
  178. -  56K (1B ISDN) - indicates that your computer's connection speed is 56kbs;
  179. -  128K (2B ISDN) - indicates that your computer's connection speed is 128kbs;
  180. -  1.5M (T1) - indicates that your computer's connection speed is 1500kbs;
  181. -  Other - opens a dialog in which you enter your computer's connection speed.
  182.  
  183. Specifying a Firewall Proxy
  184.  
  185. A firewall is a device (usually a computer) that prevents direct network communications between a Local Area Network 
  186. (e.g., a LAN in a corporate office) and the Internet. Any network communications between the LAN and the Internet 
  187. must be permitted by "punching holes" in the firewall or running "proxies" on the firewall.
  188.  
  189. StreamWorks streams may be accessed through firewalls via one of two methods - either the network administrator needs 
  190. to "punch a hole" in the existing firewall for incoming and outgoing UDP traffic on port 1558 (this is Xing's InterNIC 
  191. registered port), or your administrator can run an appropriate proxy.
  192.  
  193. If your administrator chooses to run a firewall proxy, you must configure the StreamWorks Player to use this proxy 
  194. when contacting StreamWorks Servers:
  195. -  Start the StreamWorks Player
  196. -  Choose Network╔ from the Settings menu.
  197. -  Complete the Firewall proxy fields as instructed by your administrator.
  198.  
  199.  
  200. Diagnostics
  201.  
  202. The StreamWorks Player's Diagnostics window displays various real-time statistics regarding stream reception.
  203.  
  204.  
  205. Contacting us
  206.  
  207. Xing Technology 
  208. 1540 West Branch Street
  209. Arroyo Grande, CA, 93420
  210. Phone 805/473-0145 
  211.  
  212. http://www.xingtech.com/
  213.