User manual MACROMEDIA DIRECTOR MX 2004-DIRECTOR SCRIPTING REFERENCE

[. . . ] DIRECTOR MX 2004 Director Scripting Reference Trademarks ActiveEdit, ActiveTest, Add Life to the Web, Afterburner, Aftershock, Andromedia, Allaire, Animation PowerPack, Aria, Attain, Authorware, Authorware Star, Backstage, Blue Sky Software, Blue Sky, Breeze, Bright Tiger, Clustercats, ColdFusion, Contents Tab Composer, Contribute, Design In Motion, Director, Dream Templates, Dreamweaver, Drumbeat 2000, EDJE, EJIPT, Extreme 3D, Fireworks, Flash, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, Help To Source, HomeSite, Hotspot Studio, HTML Help Studio, JFusion, JRun, Kawa, Know Your Site, Knowledge Objects, Knowledge Stream, Knowledge Track, LikeMinds, Lingo, Live Effects, MacRecorder Logo and Design, Macromedia, Macromedia Action!, Macromedia Central, Macromedia Flash, Macromedia M Logo and Design, Macromedia Spectra, Macromedia xRes Logo and Design, MacroModel, Made with Macromedia, Made with Macromedia Logo and Design, MAGIC Logo and Design, Mediamaker, Movie Critic, Open Sesame!, RoboDemo, RoboEngine JFusion, RoboHelp, RoboHelp Office, RoboInfo, RoboInsight, RoboPDF, 1-Step RoboPDF, RoboFlash, RoboLinker, RoboScreenCapture, ReSize, Roundtrip, Roundtrip HTML, Shockwave, Sitespring, Smart Publishing Wizard, Software Video Camera, SoundEdit, Titlemaker, UltraDev, Web Design 101, what the web can be, WinHelp, WinHelp 2000, WinHelp BugHunter, WinHelp Find+, WinHelp Graphics Locator, WinHelp Hyperviewer, WinHelp Inspector, and Xtra are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. [. . . ] This flag should be executed in a prepareMovie event handler in a movie script. This flag is set for the entire session (from the time the Shockwave Player is launched until it is closed and relaunched), not just for the duration of the current movie. By default, this flag is set to FALSE and audio is processed by Director, which allows you to set the soundChannel property and use the standard Lingo sound methods and properties to manipulate the audio stream of a RealMedia sprite, including mixing RealAudio with other Director audio. If this flag is set to TRUE, Lingo control of the sound channel is not processed, and the sound is handled by RealPlayer. Parameters None. 494 Chapter 12: Methods Example The following code shows that the realPlayerNativeAudio() function is set to FALSE, which means that audio in the RealMedia cast member will be processed by Director: -- Lingo syntax put(realPlayerNativeAudio()) -- 0 // JavaScript syntax trace(realPlayerNativeAudio()); // 0 The following code sets the realPlayerNativeAudio() function to TRUE, which means that audio in the RealMedia stream will be processed by RealPlayer and all Lingo control of the sound channel will be ignored: -- Lingo syntax realPlayerNativeAudio(TRUE) // JavaScript syntax realPlayerNativeAudio(1); See also soundChannel (RealMedia) realPlayerPromptToInstall() Usage -- Lingo syntax realPlayerPromptToInstall() // JavaScript syntax realPlayerPromptToInstall(); Description RealMedia function; allows you to get or set a global flag that determines whether automatic detection and alert for RealPlayer 8 is enabled (TRUE) or not (FALSE). By default, this function is set to TRUE, which means that if users do not have RealPlayer 8 and attempt to load a movie containing RealMedia, they are automatically asked if they want to go to the RealNetworks website and install RealPlayer. You can set this flag to FALSE if you want to create your own detection and alert system using the realPlayerVersion() on page 496 function and custom code. If this flag is set to FALSE and an alternate RealPlayer 8 detection and alert system is not in place, users without RealPlayer will be able to load movies containing RealMedia cast members, but the RealMedia sprites will not appear. This function detects the build number of the RealPlayer installed on the user's system to determine whether RealPlayer 8 is installed. On Windows systems, build numbers 6. 0. 8. 132 or later indicate that RealPlayer 8 is installed. On Macintosh systems, RealPlayer Core component build numbers 6. 0. 7. 1001 or later indicate that RealPlayer 8 is installed. This flag should be executed in a prepareMovie event handler in a movie script. This function returns the previous value of the flag. Parameters None. realPlayerPromptToInstall() 495 Example The following code shows that the realPlayerPromptToInstall() function is set to TRUE, which means users who do not have RealPlayer will be prompted to install it: -- Lingo syntax put(realPlayerPromptToInstall()) -- 1 // JavaScript syntax -- Lingo syntax trace(realPlayerPromptToInstall()); // 1 The following code sets the realPlayerPromptToInstall() function to FALSE, which means that users will not be prompted to install RealPlayer unless you have created a detection and alert system: -- Lingo syntax realPlayerPromptToInstall(FALSE) // JavaScript syntax realPlayerPromptToInstall(0); realPlayerVersion() Usage -- Lingo syntax realPlayerVersion() // JavaScript syntax realPlayerVersion(); Description RealMedia function; returns a string identifying the build number of the RealPlayer software installed on the user's system, or an empty string if RealPlayer is not installed. Users must have RealPlayer 8 or later in order to view Director movies containing RealMedia content. On Windows systems, build numbers 6. 0. 8. 132 or later indicate that RealPlayer 8 is installed. On Macintosh systems, RealPlayer Core component build numbers 6. 0. 7. 1001 or later indicate that RealPlayer 8 is installed. The purpose of this function is to allow you to create your own RealPlayer detection and alert system, if you do not want to use the one provided by the function realPlayerPromptToInstall() on page 495. If you choose to create your own detection and alert system using the realPlayerVersion() function, you must do the following: Call realPlayerPromptToInstall(FALSE) (by default, this function is set to TRUE) before any RealMedia cast members are referenced in Lingo or appear in the Score. This function should be set in a prepareMovie event handler in a movie script. Use the xtraList system property to verify that the Xtra for RealMedia (RealMedia Asset. x32) is listed in the Movie Xtras dialog box. The realPlayerVersion() function will not work if the Xtra for RealMedia is not present. The build number returned by this function is the same as the build number you can display in RealPlayer. 496 Chapter 12: Methods To view the RealPlayer build number in Windows: 1 Launch RealPlayer. 2 Choose About RealPlayer from the Help menu. In the window that appears, the build number appears at the top of the screen in the second line. To view the RealPlayer build number on the Macintosh: 1 Launch RealPlayer. 2 Choose About RealPlayer from the Apple menu. The About RealPlayer dialog box appears. [. . . ] This property is useful when the functionality of a movie depends on a certain version of an Xtra extension. 1098 Chapter 14: Properties There are two possible properties that can appear in xtraList: #filename--Specifies the filename of the Xtra extension on the current platform. It is possible to have a list without a #filename entry, such as when the Xtra extension exists only on one platform. #version--Specifies the same version number that appears in the Properties dialog box (Windows) or Info window (Macintosh) when the file is selected on the desktop. An Xtra extension may not necessarily have a version number. Example This statement displays in the Message window all Xtra extensions that are available to the Director Player. -- Lingo syntax trace(_player. xtraList) // JavaScript syntax trace(_player. xtraList); See also mediaXtraList, Player, scriptingXtraList, toolXtraList, transitionXtraList y (vector) Usage member(whichCastmember). vector. y member(whichCastmember). vector[2] Description 3D property; allows you to get or set the y component of a vector. Example This statement shows the y component of a vector: vec = vector(20, 30, 40) put vec. y -- 30. 0000 yAxis Usage member(whichCastmember). transform. yAxis Description 3D transform property; allows you to get but not set the vector representing the transform's canonical y-axis in transform space. yAxis 1099 Example The first line of this example sets the transform of the model ModCylinder to the identity transform. [. . . ]