Video

public class
loom.platform.Video

Description

Static control class for playing back videos

API overview

Constructor

Video ()

Attributes

Public attributes

onComplete: VideoCompleteDelegate static native

Called when the video completes normally

onFail: VideoCompleteDelegate static native

Called when the video is unable to play or complete

supported: Boolean static native

Indicates whether or not Video is supported on the current platform

Constants

Constants

RootFolder: String static

Constant string helper that denotes the folder where video files should be located for maximum platform compatibility

Functions

Public functions

playFullscreen ( video: String , scaleMode: VideoScaleMode , controlMode: VideoControlMode , bgColor: Number ): Void static native

Plays a video in Fullscreen mode

Constructor

Video ()

Attributes

onComplete: VideoCompleteDelegate

static native

Called when the video completes normally

onFail: VideoCompleteDelegate

static native

Called when the video is unable to play or complete

supported: Boolean

static native

Indicates whether or not Video is supported on the current platform

Constants

RootFolder: String

static

Constant string helper that denotes the folder where video files should be located for maximum platform compatibility

Functions

getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.


Returns

String fully qualified type name of the Object.

getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.


Returns

Type The Type that describes the object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.


Returns

String type name of the Object.

playFullscreen ( video: String , scaleMode: VideoScaleMode , controlMode: VideoControlMode , bgColor: Number ): Void

static native

Plays a video in Fullscreen mode

Parameters

video: String Name of the video file to play, NOT including its extension. NOTE: This file must reside in "assets/videos/" in order to work across all platforms.
scaleMode: VideoScaleMode Method of scaling the video on screen
controlMode: VideoControlMode Type of video controls to display over the video
bgColor: Number Hex formatted color (ie. 0xFF000000) to set the area of the screen not filled with the video, in cases where it does not fill the screen


toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().


Returns

String String that described the Object.