Packagecom.gestureworks.cml.elements
Classpublic class YouTube
InheritanceYouTube Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The YouTube element retrieves and streams a Youtube video using the Youtube API. The source of the file will be the Youtube video's ID. The video must be set to allow embedding and accessible without a user sign in.

The Video ID is the 10-digit ID associated with the video link. For example, a direct URL to the video used in this example is: http://www.youtube.com/watch?v=h0MZX-D8xzA. Notice the "h0MZX-D8xzA" is the video's id. A video must be set to allow embedding from its owner to be used by the YouTube API. If you receive "Error 100" or "Error 101", or "150", the video either no longer exists, or its embedding has been disabled.

     
       var ytElement:YouTubeElement = new YouTubeElement();
        ytElement.src = "h0MZX-D8xzA";
        ytElement.autoplay = true;
        ytElement.chrome = true;
        addChild(ytElement);
        ytElement.init();
     
     



Public Properties
 PropertyDefined By
  autoplay : Boolean
Sets whether or not the video plays immediately.
YouTube
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
  chrome : Boolean
Sets whether or not to use the chromed (player with buttons) or not.
YouTube
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
  height : Number
[override] Sets the video height.
YouTube
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
  isPlaying : Boolean
[read-only]
YouTube
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
  loaded : Boolean
[read-only]
YouTube
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
 Inheritedsound : String
TouchContainer
  src : String
Sets the video ID to be loaded.
YouTube
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  width : Number
[override] Sets the video width.
YouTube
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
YouTube
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
close():void
closes the video
YouTube
  
dispose():void
[override] Destructor
YouTube
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialisation method
YouTube
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
  
pause():void
pauses the video
YouTube
  
play():void
Start playing from the beginning.
YouTube
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
  
resume():void
Resume from last spot.
YouTube
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
  
seek(value:Number, seekAhead:Boolean):void
seek
YouTube
 Inherited
method sets the dimensions of each child
TouchContainer
  
stop():void
stops the video
YouTube
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
autoplayproperty
autoplay:Boolean

Sets whether or not the video plays immediately. Note: the player does not start loading the FLV it requests until a call to play the video, or seek to the video is called.

The default value is false;.


Implementation
    public function get autoplay():Boolean
    public function set autoplay(value:Boolean):void
chromeproperty 
chrome:Boolean

Sets whether or not to use the chromed (player with buttons) or not.

The default value is false.


Implementation
    public function get chrome():Boolean
    public function set chrome(value:Boolean):void
heightproperty 
height:Number[override]

Sets the video height.

The default value is 360.


Implementation
    public function get height():Number
    public function set height(value:Number):void
isPlayingproperty 
isPlaying:Boolean  [read-only]


Implementation
    public function get isPlaying():Boolean
loadedproperty 
loaded:Boolean  [read-only]


Implementation
    public function get loaded():Boolean
srcproperty 
src:String

Sets the video ID to be loaded. Must be present or the element will crash.


Implementation
    public function get src():String
    public function set src(value:String):void
widthproperty 
width:Number[override]

Sets the video width.

The default value is 480.


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
YouTube()Constructor
public function YouTube()

Constructor

Method Detail
close()method
public function close():void

closes the video

dispose()method 
override public function dispose():void

Destructor

init()method 
override public function init():void

Initialisation method

pause()method 
public function pause():void

pauses the video

play()method 
public function play():void

Start playing from the beginning.

resume()method 
public function resume():void

Resume from last spot.

seek()method 
public function seek(value:Number, seekAhead:Boolean):void

seek

Parameters

value:Number
 
seekAhead:Boolean

stop()method 
public function stop():void

stops the video