| Package | com.gestureworks.cml.element |
| Class | public class Media |
| Inheritance | Media  TouchContainer TouchContainerFactory TouchSprite flash.display.Sprite |
| Subclasses | MediaElement |
See also
| Property | Defined By | ||
|---|---|---|---|
 | _$height : Number = 0 | TouchSprite | |
| _$rotation : Number = 0 | TouchSprite | |
| $rotation : Number | TouchSprite | |
| _$scaleX : Number = 1 | TouchSprite | |
| $scaleX : Number | TouchSprite | |
| _$scaleY : Number = 1 | TouchSprite | |
| $scaleY : Number | TouchSprite | |
| $transformPoint : Point | TouchSprite | |
| _$width : Number = 0 | TouchSprite | |
| _$x : Number = 0 | TouchSprite | |
| $x : Number | TouchSprite | |
| _$y : Number = 0 | TouchSprite | |
| $y : Number | TouchSprite | |
| autoplay : Boolean
Indicates whether the file plays upon load
| Media | ||
| autoShuffle : Boolean
autoshuffles
| TouchContainerFactory | |
| broadcastTarget : Boolean | TouchSprite | |
| childList : ChildList [read-only]
returns the childlist
| TouchContainerFactory | |
| class_ : String
Object's css class;
| TouchContainerFactory | |
| className : String
sets the class name of displayobject
| TouchContainerFactory | |
| cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
| clusterBubbling : Boolean
Allows touch points from a childclusters to copy into container touch objects
in the local parent child display list stack. | TouchSprite | |
| clusterEvents : Boolean
Determins whether clusterEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| clusterID : int | TouchSprite | |
| cmlIndex : int
sets the cml index
| TouchContainerFactory | |
| cml_item : Boolean | TouchSprite | |
| cO : ClusterObject | TouchSprite | |
| current : * [read-only]
Returns a reference to the current media object
| Media | ||
| debugDisplay : Boolean | TouchSprite | |
| deltaFilterOn : Boolean
Determins whether filtering is applied to the delta values. | TouchSprite | |
| dimensionsTo : String
sets the dimensions of touchcontainer
| TouchContainerFactory | |
| disableAffineTransform : Boolean
Determins whether internal (native) transformations are affine (dynamically centered) on the touchSprite. | TouchSprite | |
| disableNativeTransform : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite. | TouchSprite | |
| dN : Number | TouchSprite | |
| dropShadow : Boolean
Sets the drop shadow effect
| TouchContainerFactory | |
| GESTRELIST_UPDATE : String = gestureList update [static] | TouchSprite | |
| gestureEventComplete : Boolean
Indicates weather all gestureEvents have been completed on the touchSprite. | TouchSprite | |
| gestureEventRelease : Boolean
Indicates whether all touch points have been released on the touchSprite. | TouchSprite | |
| gestureEvents : Boolean
Determins whether gestureEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| gestureEventStart : Boolean
Indicates whether any gestureEvents have been started on the touchSprite. | TouchSprite | |
| gestureFilters : Boolean | TouchSprite | |
| gestureList : Object | TouchSprite | |
| gestureReleaseInertia : Boolean
Determins whether release inertia is given to gestureEvents on the touchSprite. | TouchSprite | |
| gestureTouchInertia : Boolean
Determins whether touch inertia is processed on the touchSprite. | TouchSprite | |
| _gestureTweenOn : Boolean = false | TouchSprite | |
| gestureTweenOn : Boolean | TouchSprite | |
| gO : GestureListObject | TouchSprite | |
| group : String | TouchContainerFactory | |
| height : Number [override]
Sets media height
| Media | ||
| id : String
sets childlist id
| TouchContainerFactory | |
| layout : *
speciffies the type of layout
| TouchContainerFactory | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| TouchContainer | |
| layoutList : Dictionary | TouchContainer | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| TouchContainer | |
| loop : Boolean
Indicates whether the media will re-play when it has reached the end
| Media | ||
| maxScale : Number
This method is called after class initialization. | TouchContainerFactory | |
| minScale : Number
This method is called after class initialization. | TouchContainerFactory | |
| mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainerFactory | |
| N : int | TouchSprite | |
| nestedTransform : Boolean | TouchSprite | |
| outline_alpha : Number
sets the alpha of outline
| TouchContainerFactory | |
| outline_color : Number
sets the color of outline
| TouchContainerFactory | |
| outline_joint : String
TODO
| TouchContainerFactory | |
| outlineOn : String
specifies the outline of container to true or false
| TouchContainerFactory | |
| outline_stroke : int
sets the line stroke of outline
| TouchContainerFactory | |
| pointArray : Vector.<PointObject> [read-only] | TouchSprite | |
| pointCount : int | TouchSprite | |
| propertyStates : Array Deprecated: Please Use state | TouchContainerFactory | |
| resample : Boolean
Specifies whether a loaded image is resampled to the provided width and/or height. | Media | ||
| scale : Number
Scales display object
| TouchContainer | |
| sO : StrokeObject | TouchSprite | |
| src : String
Sets the media file source
| Media | ||
| state : Array
property states array
| TouchContainerFactory | |
| targeting : Boolean
Turns off manual ALL targeting control, defaults to a simple hit test
targeting model with exclusive target clustering
| TouchSprite | |
| targetList : Array
Allows touch and gesture events to explicitly target a group of defined
touch objects which can be outside of the local parent child display list stack
| TouchSprite | |
| targetObject : Object
Allows touch and gesture events to explicitly target a touch object
this can be outside the local parent child display list stack
| TouchSprite | |
| targetParent : Boolean
Allows touch and gesture events to explicitly target the parent touch object
| TouchSprite | |
| tc : TouchCluster | TouchSprite | |
| td : TouchDebugDisplay | TouchSprite | |
| tg : TouchGesture | TouchSprite | |
| tiO : TimelineObject | TouchSprite | |
| touchChildren : Boolean | TouchSprite | |
| touchObjectID : int [read-only] | TouchSprite | |
| tp : TouchPipeline | TouchSprite | |
| traceDebugModeOn : Boolean | TouchSprite | |
| transformComplete : Boolean | TouchSprite | |
| transformEventComplete : Boolean | TouchSprite | |
| transformEvents : Boolean
Determins whether transformEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| transformEventStart : Boolean | TouchSprite | |
| transformGestureVectors : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite. | TouchSprite | |
| transformStart : Boolean | TouchSprite | |
| trO : TransformObject | TouchSprite | |
| tt : TouchTransform | TouchSprite | |
| width : Number [override]
Sets media width
| Media | ||
| x_lock : Boolean | TouchSprite | |
| y_lock : Boolean | TouchSprite | |
| Method | Defined By | ||
|---|---|---|---|
Media()
Constructor
| Media | ||
| activateTouch():void
TODO
| TouchContainerFactory | |
| addAllChildren():void
method searches the child and adds to the list
| TouchContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
Registers event listeners. | TouchSprite | |
| applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
| childToList(id:String, child:*):void
child appended to the childlist
| TouchContainerFactory | |
| clone():*
Clone method
| TouchContainer | |
close():void
Closes the currently open media file
| Media | ||
| displayComplete():void [override] | TouchContainer | |
dispose():void [override]
Dispose method
| Media | ||
| hideIndex(index:int):void
hides child list index
| TouchContainer | |
| hideKey(key:String):void
hides childlist key visibility
| TouchContainer | |
init():void [override]
Initialisation method
| Media | ||
| makeGestureList(value:XMLList):Object
TODO
| TouchContainerFactory | |
| onTouchDown(event:TouchEvent, target:* = null):void
decides how to assign the captured touch point to a cluster
can pass to parent, an explicit target, an explicit list or
targets or a passed to any touch object in the local display stack. | TouchSprite | |
open(file:String):void
Opens the file specified in the argument
| Media | ||
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | TouchContainer | |
pause():void
Pauses media playback
| Media | ||
play():void
Plays the media file from the beginning
| Media | ||
| postparseCML(cml:XMLList):void
postparse method
| TouchContainerFactory | |
resume():void
Resumes media playback from paused position
| Media | ||
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
seek(offset:Number):void
Sets the media playhead position
| Media | ||
| setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainerFactory | |
| showIndex(index:int):void
shows index of the child list
| TouchContainer | |
| showKey(key:String):void
shows the child list key visibility
| TouchContainer | |
stop():void
Pauses the media file and returns to the playhead to the beginning
| Media | ||
| updateClusterAnalysis():void | TouchSprite | |
| updateDebugDisplay():void | TouchSprite | |
| updateGesturePipeline():void | TouchSprite | |
| updateListeners():void
Registers/unregisters event handlers depending on the active modes
| TouchSprite | |
| updateMotionClusterAnalysis():void | TouchSprite | |
| updateProperties(state:Number = 0):void
update properties of child
| TouchContainerFactory | |
| updateSensorClusterAnalysis():void | TouchSprite | |
| updateTObjProcessing():void | TouchSprite | |
| autoplay | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesautoplay:BooleanIndicates whether the file plays upon load
The default value is false.
public function get autoplay():Boolean public function set autoplay(value:Boolean):void| current | property |
current:* [read-only] Returns a reference to the current media object
The default value is null.
public function get current():*| height | property |
height:Number[override] Sets media height
The default value is 0.
public function get height():Number public function set height(value:Number):void| loop | property |
loop:BooleanIndicates whether the media will re-play when it has reached the end
The default value is false.
public function get loop():Boolean public function set loop(value:Boolean):void| resample | property |
resample:BooleanSpecifies whether a loaded image is resampled to the provided width and/or height. In order for resampling to work, this must be set to true, and a width and/or height must be set prior to calling open.
The default value is false.
public function get resample():Boolean public function set resample(value:Boolean):void| src | property |
src:StringSets the media file source
The default value is null.
public function get src():String public function set src(value:String):void| width | property |
width:Number[override] Sets media width
The default value is 0.
public function get width():Number public function set width(value:Number):void| Media | () | Constructor |
public function Media()Constructor
| close | () | method |
public function close():voidCloses the currently open media file
| dispose | () | method |
override public function dispose():voidDispose method
| init | () | method |
override public function init():voidInitialisation method
| open | () | method |
public function open(file:String):voidOpens the file specified in the argument
Parameters
file:String |
| pause | () | method |
public function pause():voidPauses media playback
| play | () | method |
public function play():voidPlays the media file from the beginning
| resume | () | method |
public function resume():voidResumes media playback from paused position
| seek | () | method |
public function seek(offset:Number):voidSets the media playhead position
Parameters
offset:Number |
| stop | () | method |
public function stop():voidPauses the media file and returns to the playhead to the beginning