MACROMEDIA FLASH MEDIA SERVER 2-CLIENT-SIDE ACTIONSCRIPT LANGUAGE REFERENCE FOR FLASH MEDIA SERVER... Service manual

Client-Side ActionScript Language
Reference for Flash Media Server 2

Trademarks
1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central,
ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite,
FlashPaper, Flash Video Encoder, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder,
Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit,
Studio MX, UltraDev, and WebHelp 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.
Third-Party Information
This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not
responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your
own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia
endorses or accepts any responsibility for the content on those third-party sites.
Sorenson™ Spark™ video compression and decompression technology licensed from
Sorenson Media, Inc.
Copyright © 2002-2005 Macromedia, Inc. All rights reserved. This manual may not be copied, photocopied, reproduced,
translated, or converted to any electronic or machine-readable form in whole or in part without written approval from
Macromedia, Inc. Notwithstanding the foregoing, the owner or authorized user of a valid copy of the software with which
this manual was provided may print out one copy of this manual from an electronic version of this manual for the sole
purpose of such owner or authorized user learning to use such software, provided that no part of this manual may be
printed out, reproduced, distributed, resold, or transmitted for any other purposes, including, without limitation,
commercial purposes, such as selling copies of this documentation or providing paid-for support services.
Acknowledgments
Project Management: Suzanne Smith
Writing: Jody Bleyle
Managing Editor: Rosana Francescato
Editing: Geta Carlson
Production Management: Patrice O’Neill
Media Design and Production: Adam Barnett, Aaron Begley, Mario Reynoso, Paul Benkman, John Franics
Special thanks to Erick Vera and the Flash Media Server engineering and QA teams.
First Edition: October 2005
Macromedia, Inc.
601 Townsend St.
San Francisco, CA 94103

3
Contents
Chapter 1: Client-Side ActionScript Language Reference. . . . . . . 5
ActionScript classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
ActionScript elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Camera class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Microphone class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
MovieClip class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
NetConnection class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
NetStream class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
SharedObject class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
System class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Video class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139
Appendix A: Client-Side Information Objects . . . . . . . . . . . . . . .149
Camera information objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
LocalConnection information objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Microphone information objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
NetConnection information objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
NetStream information objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
SharedObject information objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156

4Contents

5
1
CHAPTER 1
Client-Side ActionScript
Language Reference
Macromedia Flash Media Server provides two application program interfaces (APIs): a Client-
Side Media ActionScript API and a Server-Side Media ActionScript API. This guide explains
the client-side API.
This document is designed to be used in combination with the ActionScript documentation
included with Macromedia Flash. Refer to the Flash documentation for general scripting
information. Use this document to add Flash Media Server functionality to your Flash
applications.
For additional information about developing applications for Flash Media Server and to
understand how objects created on the client-side are paired with those on the server-Rside,
see Developing Media Applications.
ActionScript classes
The following table lists all the classes in this guide, Client-Side ActionScript Language
Reference for Flash Media Server 2:
NOTE
Most sample code in this document uses ActionScript 2.0 syntax.
ActionScript class Description
Camera class Lets you capture video from a video camera attached to the
computer that is running Macromedia Flash Player.
Microphone class Lets you capture audio from a microphone attached to the
computer that is running Flash Player.
MovieClip class Lets you specify whether an audio source is to be played locally
(Microphone object) or streamed from Flash Media Server
(NetStream object).

6 Client-Side ActionScript Language Reference
ActionScript elements
Entries in this document are alphabetical by class name and then by method, property, or
event handler name. The following table lists all classes, methods, properties, and event
handlers individually in alphabetical order.
NetConnection class Manages a bidirectional connection between Flash Player and a
server, which lets you connect to Flash Remoting or to Flash
Media Server.
NetStream class Opens a one-way streaming connection between Flash Player
and Flash Media Server through a connection made available by
a NetConnection object.
SharedObject class Allows real-time data sharing between multiple client SWF files
and objects that are persistent on the local or remote location.
System class The System class contains properties related to certain
operations that take place on the user's computer, such as
operations with shared objects, local settings for cameras and
microphones, and use of the Clipboard.
Video class Lets you display live or recorded streaming video on the Stage
without embedding it in your SWF file.
ActionScript element See entry
activityLevel Camera.activityLevel, Microphone.activityLevel
attachAudio MovieClip.attachAudio(), NetStream.attachAudio()
attachVideo NetStream.attachVideo(), Video.attachVideo()
bandwidth Camera.bandwidth
bufferLength NetStream.bufferLength
bufferTime NetStream.bufferTime
call NetConnection.call()
clear SharedObject.clear(), Video.clear()
close NetConnection.close(), NetStream.close(),
SharedObject.close()
connect NetConnection.connect(), SharedObject.connect()
currentFps Camera.currentFps, NetStream.currentFps
data SharedObject.data
ActionScript class Description

ActionScript elements 7
deblocking Video.deblocking
flush SharedObject.flush()
fps Camera.fps
gain Microphone.gain
get Camera.get(), Microphone.get()
getLocal SharedObject.getLocal()
getRemote SharedObject.getRemote()
getSize SharedObject.getSize()
height Camera.height, Video.height
index Camera.index, Microphone.index
isConnected NetConnection.isConnected
keyFrameInterval Camera.keyFrameInterval
loopback Camera.loopback
liveDelay NetStream.liveDelay
motionLevel Camera.motionLevel
motionTimeOut Camera.motionTimeOut
muted Camera.muted, Microphone.muted
name Camera.name, Microphone.name
names Camera.names, Microphone.names
onActivity Camera.onActivity, Microphone.onActivity
onCuePoint NetStream.onCuePoint
onMetaData NetStream.onMetaData
onPlayStatus NetStream.onPlayStatus
onStatus Camera.onStatus, Microphone.onStatus, NetConnection.onStatus,
NetStream.onStatus, SharedObject.onStatus
onSync SharedObject.onSync
pause NetStream.pause()
play NetStream.play()
publish NetStream.publish()
quality Camera.quality
ActionScript element See entry

8 Client-Side ActionScript Language Reference
Camera class
Availability
■Flash Player 6.
■Flash Media Server (not required).
rate Microphone.rate
receiveAudio NetStream.receiveAudio()
receiveVideo NetStream.receiveVideo()
seek NetStream.seek()
send NetStream.send(), SharedObject.send()
setBufferTime NetStream.setBufferTime()
setFps SharedObject.setFps()
setGain Microphone.setGain()
setKeyFrameInterval Camera.setKeyFrameInterval()
setLoopback Camera.setLoopback()
setMode Camera.setMode()
setMotionLevel Camera.setMotionLevel()
setQuality Camera.setQuality()
setRate Microphone.setRate()
setSilenceLevel Microphone.setSilenceLevel()
setUseEchoSuppression Microphone.setUseEchoSuppression()
showSettings System.showSettings()
silenceLevel Microphone.silenceLevel
silenceTimeout Microphone.silenceTimeout
smoothing Video.smoothing
time NetStream.time
uri NetConnection.uri
useCodepage System.useCodepage
useEchoSuppression Microphone.useEchoSuppression
width Camera.width, Video.width
ActionScript element See entry

Camera class 9
The Camera class lets you capture video from a video camera attached to the computer that is
running Macromedia Flash Player. When used with Flash Media Server, this class lets you
transmit, display, and optionally record the video being captured. With these capabilities, you
can develop media applications such as video conferencing, instant messaging with video, and
so on. Flash provides similar audio capabilities; for more information, see the Microphone
class entry.
You can also use a Camera object without a server—for example, to monitor a video feed from
a webcam attached to your local system.
To create or reference a Camera object, use the Camera.get() method.
Method summary for the Camera class
NOTE
When a SWF file tries to access the camera returned by Camera.get(), Flash Player
displays a Privacy dialog box that lets the user choose whether to allow or deny access
to the camera. (Make sure your Stage size is at least 215 x 138 pixels for the Camera
class examples; this is the minimum size Flash requires to display the dialog box.) End
users and administrative users may also disable camera access on a per-site or global
basis.
Method Description
Camera.get() Returns a reference to a Camera object for capturing
video.
Camera.setKeyFrameInterval() Specifies which video frames are transmitted in full
instead of being interpolated by the video compression
algorithm.
Camera.setLoopback() Specifies whether to use a compressed video stream for a
local view of what the camera is transmitting.
Camera.setMode() Sets aspects of the camera capture mode, including
height, width, and frames per second.
Camera.setMotionLevel() Specifies how much motion is required to invoke
Camera.onActivity(true).
Camera.setQuality() Sets the maximum amount of bandwidth per second or
the required picture quality of the current outgoing video
feed.

10 Client-Side ActionScript Language Reference
Property summary for the Camera class
Property (read-only) Description
Camera.activityLevel A numeric value from 0 to 100 that specifies the amount of
motion the camera is detecting.
Camera.bandwidth The maximum amount of bandwidth the current outgoing
video feed can use, in bytes.
Camera.currentFps The rate at which the camera is capturing data, in frames per
second.
Camera.fps The rate at which you would like the camera to capture data, in
frames per second.
Camera.height The current capture height, in pixels.
Camera.index The index of the camera, as reflected in the array returned by
Camera.names.
Camera.keyFrameInterval A number that specifies which video frames are transmitted in
full instead of being interpolated by the video compression
algorithm.
Camera.loopback A Boolean value that specifies whether a local view of what
the camera is capturing is compressed or uncompressed.
Camera.motionLevel A numeric value from 0 to 100 that specifies the amount of
motion required to invoke Camera.onActivity(true).
Camera.motionTimeOut The number of milliseconds between the time the camera
stops detecting motion and the time
Camera.onActivity(false) is invoked.
Camera.muted A Boolean value that specifies whether the user has allowed
or denied access to the camera.
Camera.name The name of the camera as specified by the camera hardware.
Camera.names Class property; an array of strings containing the names of all
available video capture devices, including video capture cards
and cameras.
Camera.quality A number that specifies the current level of picture quality
based on the amount of compression being applied to each
video frame.
Camera.width The current capture width, in pixels.