REALONE PLAYER SCRIPTING GUIDE Last Update: 15 October 2002 RealNetworks, Inc. PO Box 91123 Seattle, WA 98111-9223 U.S.A. http://www.real.com http://www.realnetworks.com ©2002 RealNetworks, Inc. All rights reserved. Information in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of RealNetworks, Inc. Printed in the United States of America. Helix, The Helix Logo, RBN, the Real "bubble" (logo), Real Broadcast Network, RealAudio, Real.com, RealJukebox, RealMedia, RealNetworks, RealPlayer, RealOne, RealPresenter, RealSlideshow, RealSystem, RealText, RealVideo, SureStream, and Surreal.FX Design are trademarks or registered trademarks of RealNetworks, Inc. Other product and corporate names may be trademarks or registered trademarks of their respective companies. CONTENTS INTRODUCTION 1 What is Helix? .................................................................................................. 1 System Components......................................................................................... 1 How to Download This Guide to Your Computer ............................................... 2 How This Guide Is Organized............................................................................ 3 Conventions Used in this Guide......................................................................... 4 Additional Documentation Resources ............................................................... 4 Technical Support ............................................................................................ 5 RealForum ....................................................................................................... 5 PART I: SCRIPTING WITH REALONE PLAYER 1 REALONE PLAYER ENVIRONMENT 9 The Three-Pane Environment ............................................................................ 9 The Media Playback Pane ............................................................................10 The Related Info Pane..................................................................................11 The Media Browser Pane .............................................................................11 Now Playing List......................................................................................12 Secondary Browsing Windows .................................................................12 Controlling Interactions Between RealOne Player Panes.....................................12 Displaying HTML Pages Through Streaming Media .......................................12 Appending HTML URLs to Media URLs in a Ram File................................13 Embedding HTML URLs In a RealVideo or RealAudio Clip.........................13 Using SMIL to Display HTML Pages..........................................................14 Controlling Content Through the HTML Panes .............................................14 Opening URLs with Simple Links .............................................................15 Javascript and ActiveX Methods ...............................................................15 Using Javascript and ActiveX in the RealOne Player Environment ........................16 Using Javascript Methods and Events............................................................16 Using ActiveX Controls ................................................................................16 Using RealOne Player Methods ........................................................................17 Customizing Playback and Dynamically Opening URLs..................................17 Playing a Clip ..........................................................................................18 Using the Now Playing List.......................................................................21 iii RealOne Player Scripting Guide Opening a URL in the Media Browser Pane...............................................21 Caching URLs to Enhance Playback Performance......................................22 Handling Actions ....................................................................................23 Setting the Background Color ..................................................................23 Retrieving RealOne Player Information .........................................................24 Retrieving Version Information.................................................................24 Unpacking Version Information ...............................................................25 Getting Player Information ......................................................................27 Displaying Clip Information.....................................................................27 Determining Installed Player Components ................................................28 Using RealOne Player Event Handlers ...............................................................29 Handling Media Clip Buffering.....................................................................29 Determining the Current Time Position.........................................................30 Performing Tasks Before Playing a Clip .........................................................30 Detecting a State Change ............................................................................31 2 REALONE PLAYER METHODS 33 AddToNowPlaying ..........................................................................................33 ClearNowPlaying.............................................................................................34 ComponentVersion .........................................................................................35 GetClipInfo.....................................................................................................36 GetPlayerState ................................................................................................37 HandleAction..................................................................................................37 InstalledComponents ......................................................................................39 OpenURLInPlayerBrowser................................................................................40 PlayClip ..........................................................................................................40 PlayerProperty.................................................................................................42 PreloadURL ....................................................................................................43 RealPlayerVersion............................................................................................43 SetVideoBackgroundColor...............................................................................44 3 REALONE PLAYER EVENTS 45 RPOnBuffering................................................................................................45 RPOnPositionLengthChange............................................................................45 RPOnPreload..................................................................................................46 RPOnStateChange ..........................................................................................46 PART II: SCRIPTING WITH THE EMBEDDED PLAYER 4 EMBEDDED ENVIRONMENT 51 Understanding Presentation Embedding...........................................................51 Embedded Environment vs. RealOne Environment ........................................51 How Embedding Works...............................................................................51 iv Contents The Embedded Player ..............................................................................52 Backwards Compatibility.........................................................................52 SMIL in Embedded Presentations .............................................................52 Media Preparation ..................................................................................53 The Two Embedding Methods .....................................................................53 Javascript and VBScript................................................................................54 Methods.................................................................................................54 Callback Events.......................................................................................54 Using the Netscape Plug-in ..............................................................................55 Extending Embedded Controls Through Javascript ........................................55 Receiving Callbacks Through Javascript ........................................................56 Handling Events in Netscape Navigator 6 or later......................................56 Handling Events in Netscape Navigator 4.x ...............................................58 Class Files ...............................................................................................58 Using the ActiveX Control ................................................................................59 Extending Embedded Controls Through VBScript..........................................60 Receiving Callbacks Through VBScript ..........................................................60 Tag Parameters ...............................................................................................61 AUTOGOTOURL ........................................................................................61