ToobPlayer 1.0.0: API Reference

Loads the preview image of the YouTube video specified by the url property into the image image container.

Validates the YouTube ID specified by p_id. After the validation is complete, p_handler will be invoked with the results of the validation.

checkYouTubeId method can be used to validate user input. extractYouTubeId can also be used to validate a YouTube ID, however, checkYouTubeId will check if the video is actually available on the YouTube.

Example

function myHandler(p_isValid, p_id) {
	trace("["+p_id+"] is "+(p_isValid ? "a valid YouTube id." : "an invalid YouTube id."));
}

myToobPlayer.checkYouTubeId("XOXOXOXOXOX", myHandler); 
// output: [XOXOXOXOXOX] is an invalid YouTube id.

myToobPlayer.checkYouTubeId("T8oRFcA0mFM", myHandler);
// output: [T8oRFcA0mFM] is a valid YouTube id.
                    

Extracts the YouYube ID from a string. If the YouTube ID cannot be extracted, method returns undefined.

Example

import xm.components.ToobPlayerComponent;

var youTubeUrl:String;

youTubeUrl = "T8oRFcA0mFM";
trace(ToobPlayerComponent.extractYouTubeId(youTubeUrl));

youTubeUrl = "http://www.youtube.com/watch?v=T8oRFcA0mFM";
trace(ToobPlayerComponent.extractYouTubeId(youTubeUrl));

youTubeUrl = "...'><param name='movie' value='http://www.youtube.com/v/T8oRFcA0mFM&rel=1'></par...";
trace(ToobPlayerComponent.extractYouTubeId(youTubeUrl));

youTubeUrl = "...<embed src='http://www.youtube.com/v/T8oRFcA0mFM&rel=1' type='appl...";
trace(ToobPlayerComponent.extractYouTubeId(youTubeUrl));

youTubeUrl = "my.flv";
trace(typeof ToobPlayerComponent.extractYouTubeId(myFlvUrl));
                    

Output:

T8oRFcA0mFM
T8oRFcA0mFM
T8oRFcA0mFM
T8oRFcA0mFM
undefined
                    

Resizes the component to the requested size.

Registers a listener object or function (p_handler) with a component instance that is broadcasting an event. When the event occurs, the listener object or function is notified. If p_handler is a function, it will be invoked from within the dispatching object's scope.

Example 1

myToobPlayer.display.addEventListener("complete", this);

function complete(e:Object):Void {
	if (myToobPlayer.display.playing) {
		// finished playing current video; play next video
		myToobPlayer.url = nextClip;
	}
}
                    

Example 2

myToobPlayer.display.addEventListener("complete", myCompleteHandler);

function myCompleteHandler(e:Object):Void {
	if (myToobPlayer.display.playing) {
		// finished playing current video; play next video
		myToobPlayer.url = nextClip;
	}
}
                    

Registers a listener function (p_handler) with a component instance that is broadcasting an event. When the event occurs, the listener function is invoked using the p_obj scope.

Example

myToobPlayer.display.addEventListenerL("complete", this, "myCompleteHandler");
myToobPlayer.display.addEventListenerL("complete", myToobPlayer, function() { trace("Finished playing: "+this.url); });

function myCompleteHandler(e:Object):Void {
	if (myToobPlayer.display.playing) {
		// finished playing current video; play next video
		myToobPlayer.url = nextClip;
	}
}
                    

Unregisters a listener.

Example 1

myToobPlayer.display.removeEventListener("complete", this);
                    

Example 2

myToobPlayer.display.removeEventListener("complete", myCompleteHandler);
                    

Unregisters a listener.

Example

myToobPlayer.display.removeEventListener("complete", this, "myCompleteHandler");
                    

Unregisters all listeners registered with a p_eventName event.

Example

myToobPlayer.display.removeAllEventListeners("complete");
                    

Dispatches an event to any listener registered with an instance of the class. This method is usually called from within a component's class file. p_eventObj is passed to all listeners, and must contain a type property indicating the name of the event.

Example

// this is how the class triggers the complete event
dispatchEvent({ type: "complete"});
                    

Specifies an FLV file to play. If a YouTube video URI is specified, the temporary direct link to youTube video will be acquired using the youTubeProxy. If autoPlay property is set to true, playback will start immediately, i.e., in case of a YouTube video URI, as soon as the temporary direct link has been acquired. Otherwise, use display.play method to start the playback programmatically.

url is mostly identical to display.url. However, display.url does not handle acquiring of YouTube links.

url uses extractYouTubeId to detect YouTube IDs.

Please note: url property is delayed in its execution, if the component had not been fully initialized.

Example

if (myToobPlayer.autoPlay) {
	// start playing the video
	myToobPlayer.url = "clip.flv";
}
else {
	// url property is delayed during the component initialization,
	// and because of this, myToobPlayer.display.play() will not be able to
	// work properly, if we do not wait a frame for the component to 
	// fully initialize
	onEnterFrame = function() {
		myToobPlayer.url = "clip.flv";
		myToobPlayer.display.play();
		delete onEnterFrame;
	}
}

// or simpler
myToobPlayer.autoPlay = true;
myToobPlayer.url = "clip.flv";
                    

Example with YouTube

if (myToobPlayer.autoPlay) {
	// start playing the video
	myToobPlayer.url = "http://www.youtube.com/watch?v=T8oRFcA0mFM";
}
else {
	myToobPlayer.url = "http://www.youtube.com/watch?v=T8oRFcA0mFM";
	myToobPlayer.display.addEventListener("acquiredYouTubeUrl", function () {
		myToobPlayer.display.play(); });
	// or you could simply activate myToobPlayer.autoPlay
}
                    

autoPlay is an alias for the display.autoPlay property. If set to true, causes the FLV file to play immediately when the url property is set. The default value is true.

Example

// do not auto-play the video
myToobPlayer.autoPlay = false;

// load preview image from YouTube
myToobPlayer.autoLoadYouTubePreviewImage = true;
myToobPlayer.url = "http://www.youtube.com/watch?v=T8oRFcA0mFM";
                    

autoRepeat is an alias for the display.autoRepeat property. If set to true, causes the FLV file to play continuously, i.e. to start over each time upon reaching its end. The default value is false.

Example

myToobPlayer.autoRepeat = true;
                    

volume is an alias for the display.volume property. It indicates the volume control setting. The default value is 50.

Example

// mute
myToobPlayer.volume = 0;
                    

Toggles the display of the full-screen button.

Example

myToobPlayer.showFullScreenButton = true;
                    

Determines how the component behaves when the user rolls the mouse wheel over the component area. Possible values are "none", "seek", and "volume". By default, this value is "seek".

Example

// disable mouse wheel
myToobPlayer.mouseWheel = "none";
                    

Indicates the playhead increment or decrement (in seconds) for each notch the user rolls the mouse wheel. Larger value produces faster seeking. The default value is 5 seconds.

Example

myToobPlayer.mouseWheel = "seek";

// faster seeking using mouse wheel
myToobPlayer.mouseWheelSeekStep = 10;
                    

Indicates the volume increment or decrement (in percent) for each notch the user rolls the mouse wheel. Larger value produces faster volume change. The default value is 5 percent.

Example

myToobPlayer.mouseWheel = "volume";

// faster volume control using mouse wheel
myToobPlayer.mouseWheelVolumeStep = 10;
                    

Defines whether or not the YouTube preview image will be loaded automatically upon setting the url property.

Example

myToobPlayer.autoPlay = false;
myToobPlayer.autoLoadYouTubePreviewImage = true;
myToobPlayer.url = "http://www.youtube.com/watch?v=T8oRFcA0mFM";
                    

After setting the url property, there is a short period of time indicated by the isAcquiringYouTubeUrl property, during which the direct link to the YouTube video is acquired.

Example

myToobPlayer.display.addEventListener("acquiringYouTubeUrl", this);
myToobPlayer.display.addEventListener("acquiredYouTubeUrl", this);

myToobPlayer.url = "http://www.youtube.com/watch?v=T8oRFcA0mFM";

function acquiringYouTubeUrl() {
	trace(myToobPlayer.isAcquiringYouTubeUrl); // true
}

function acquiredYouTubeUrl() {
	trace(myToobPlayer.isAcquiringYouTubeUrl); // false
	trace(myToobPlayer.display.url); // the acquired address of the YouTube video
}
                    

Indicates whether the full-screen mode is active.

Reference to the FLVDisplay component. This component handles the FLV video.

Example

// rewind the video
myToobPlayer.display.time = 0;
myToobPlayer.display.pause(true);
                    

Reference to the FLVController component. This component provides a user interface to control the video playback, set the video volume, etc.

Reference to the ImageContainer component. This component is used to implement automatic loading of the YouTube preview images, and may also be used to display custom preview images.

Example

myToobPlayer.display.clear();
myToobPlayer.image.clear();

myToobPlayer.autoPlay = false;
myToobPlayer.image.url = "myPreviewImage.jpg";
myToobPlayer.url = "myVideo.flv";
                    

The width of the component, in pixels.

Example

myToobPlayer.width = 400;
                    

The height of the component, in pixels.

Example

trace("h: "+myToobPlayer.height);
                    

The minimal width of the component, in pixels. By default, equals to 0.

The minimal height of the component, in pixels. By default, equals to 0.

The maximal width of the component, in pixels. By default, equals to Infinity.

The maximal height of the component, in pixels. By default, equals to Infinity.

Reference to the aligner object that manages the aligning within the component.

Broadcast before entering the full-screen mode.

Example

myToobPlayer.addEventListener("enterFullScreen", this);

function enterFullScreen() {
	trace("entering full-screen");
}
                    

Broadcast after exiting the full-screen mode.

Example

myToobPlayer.addEventListener("exitFullScreen", this);

function enterFullScreen() {
	trace("back from full-screen");
}
                    

Broadcast when the component has been resized.

Example

myToobPlayer.addEventListener("resize", this);

myToobPlayer._x = 0;
myToobPlayer._y = 0;
myToobPlayer.setSize(Stage.width, Stage.height);

function resize() {
	trace("w: "+myToobPlayer.width+" h: "+myToobPlayer.height);
}
                    

Possible output:

w: 1280 h: 1024