Titanium 2.X

Titanium.Media.VideoPlayer

> Titanium.Media.VideoPlayer

A native control for playing videos.

The video player is a native view that can be used to play videos, either stored locally or streamed from a web server. The player can occupy the full screen, or can be used as a view that can be added to other views.

Use the Titanium.Media.createVideoPlayer method to create a video player.

Platform Implementation Notes

All platforms support specifying the video content as a URL, either to a local file or a remote stream. This is done by setting the url property.

On iOS, video content can also be specified as a Blob or File object using the media property.

On iOS, a video player can dynamically switch back and forth between fullscreen mode and standard mode. If the native video controls are displayed, the user can use them to switch between standard and fullscreen mode.

On Android, the video player cannot switch modes. To create a fullscreen player, you must specify fullscreen: true when you create the player. This fullscreen player creates its own Android Activity on top of the activity stack. Unlike a normal view, this fullscreen video player appears as soon as it is created. The user can close the player by pressing the Back button. See the code examples for a sample using the fullscreen player on Android.

There are several known issues with clipping on the Android video player.

  • When used with scalingMode set to VIDEO_SCALING_ASPECT_FILL or VIDEO_SCALING_NONE, the video content is not correctly clipped to the boundaries of the view.
    (TIMOB-7628)

  • When a border is set on the view, the video content does not take the border width into account, so the video content covers the border. (TIMOB-7628)

  • If a borderRadius is specified, the video content is not clipped to the rounded corners. (TIMOB-7629)

Examples

Simple Video Player Example

The following code creates a simple video player to play a local video file.

var vidWin = Titanium.UI.createWindow({
    title : 'Video View Demo',
    backgroundColor : '#fff'
});

var videoPlayer = Titanium.Media.createVideoPlayer({
    top : 2,
    autoplay : true,
    backgroundColor : 'blue',
    height : 300,
    width : 300,
    mediaControlStyle : Titanium.Media.VIDEO_CONTROL_DEFAULT,
    scalingMode : Titanium.Media.VIDEO_SCALING_ASPECT_FIT
});

videoPlayer.url = 'movie.mp4';
vidWin.add(videoPlayer);
vidWin.open();

Android Fullscreen Video Player

The Android fullscreen video player operates differently from other video players. The following example shows how to create, show, and close a fullscreen video player.

Note that in this example, a button is included to close the player, to demonstrate a method for dismissing the player programmatically. In practice, the user can always dismiss the player by using the Back button, so an on-screen control would not be required.

Titanium.UI.setBackgroundColor('#000');
var win = Titanium.UI.createWindow({
    title : 'Test',
    backgroundColor : '#fff',
    exitOnClose : true
});

// Change to a valid URL
var contentURL = "http://www.example.com/stream.mp4";

var openButton = Ti.UI.createButton({
    title : "Start Video",
    top : "0dp",
    height : "40dp",
    left : "10dp",
    right : "10dp"
});

openButton.addEventListener('click', function() {
    var activeMovie = Titanium.Media.createVideoPlayer({
        url : contentURL,
        backgroundColor : 'blue',
        movieControlMode : Titanium.Media.VIDEO_CONTROL_DEFAULT,
        scalingMode : Titanium.Media.VIDEO_SCALING_ASPECT_FILL,
        fullscreen : true,
        autoplay : true
    });

    var closeButton = Ti.UI.createButton({
        title : "Exit Video",
        top : "0dp",
        height : "40dp",
        left : "10dp",
        right : "10dp"
    });

    closeButton.addEventListener('click', function() {
        activeMovie.hide();
        activeMovie.release();
        activeMovie = null;
    });
    
    activeMovie.add(closeButton);
});
win.add(openButton);
win.open();

  • 0.9
  • 0.9
  • 0.9
  • 1.8
Defined By

Properties

Titanium.Media.VideoPlayer
allowsAirPlay : Boolean

Whether or not the current movie can be played on a remote device.

Whether or not the current movie can be played on a remote device.

  • 0.9
  • 0.9

Coordinate of the view about which to pivot an animation.

Coordinate of the view about which to pivot an animation.

Used on iOS only. For Android, use Titanium.UI.Animation.anchorPoint.

Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right corner.

See the "Using an anchorPoint" example in Titanium.UI.Animation for a demonstration.

  • 0.9
  • 0.9

Current position of the view during an animation.

Current position of the view during an animation.

  • 0.9
  • 0.9
  • 0.9
Titanium.Media.VideoPlayer
: Boolean
Indicates if a movie should automatically start playback. ...

Indicates if a movie should automatically start playback.

On iOS, playback starts automatically if autoplay is true and the movie is likely to finish uninterrupted. The OS determines whether the movie is likely to finish uninterrupted based on factors including the bit rate of the movie and network conditions (if the movie is being streamed from a remote source).

Default: true

Background color of the view, as a color name or hex triplet.

Background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Disabled background color of the view, as a color name or hex triplet.

Disabled background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

  • 0.9

Disabled background image for the view, specified as a local file path or URL.

Disabled background image for the view, specified as a local file path or URL.

  • 0.9

Focused background color of the view, as a color name or hex triplet.

Focused background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

For normal views, the focused color is only used if focusable is true.

  • 0.9

Focused background image for the view, specified as a local file path or URL.

Focused background image for the view, specified as a local file path or URL.

For normal views, the focused background is only used if focusable is true.

  • 0.9

A background gradient for the view.

A background gradient for the view.

A gradient can be defined as either linear or radial. A linear gradient varies continuously along a line between the startPoint and endPoint.

A radial gradient is interpolated between two circles, defined by startPoint and startRadius and endPoint and endRadius respectively.

The start and end points and radius values can be defined in device units, in the view's coordinates, or as percentages of the view's size. Thus, if a view is 60 x 60, the center point of the view can be specified as:

{ x: 30, y: 30 }

Or: { x: '50%', y: '50%' }

When specifying multiple colors, you can specify an offset value for each color, defining how far into the gradient it takes effect. For example, the following color array specifies a gradient that goes from red to blue back to red:

colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]

Mobile Web has two limitations: backfillStart and backfillEnd are ignored and the system behaves as if they are true, and endPoint is not supported for radial gradients.

Android currently only supports linear gradients. It also ignores backfillStart and backfillEnd treating them as if they are true.

Example

Linear and Radial Gradients

The following code excerpt creates two views, one with a linear gradient and one with a radial gradient.

var win1 = Titanium.UI.createWindow({
    title:'Tab 1',
    backgroundColor:'#fff',
    layout: 'vertical'
});

var radialGradient = Ti.UI.createView({
    top: 10,
    width: 100,
    height: 100,
    backgroundGradient: {
        type: 'radial',
        startPoint: { x: 50, y: 50 },
        endPoint: { x: 50, y: 50 },
        colors: [ 'red', 'blue'],
        startRadius: '90%',
        endRadius: 0,
        backfillStart: true
    }
});
var linearGradient = Ti.UI.createView({
    top: 10,
    width: 100,
    height: 100,
    backgroundGradient: {
        type: 'linear',
        startPoint: { x: '0%', y: '50%' },
        endPoint: { x: '100%', y: '50%' },
        colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],
    }
});
win1.add(radialGradient);
win1.add(linearGradient);
win1.open();

  • 0.9
  • 0.9
  • 1.8
  • 0.9

Background image for the view, specified as a local file path or URL.

Background image for the view, specified as a local file path or URL.

Size of the left end cap.

Size of the left end cap.

End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the left end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The right end cap is therefore computed by adding the size of the left end cap and the middle portion together and then subtracting that value from the width of the image

  • 0.9
  • 0.9
Determines whether to tile a background across a view. ...

Determines whether to tile a background across a view.

Setting this to true makes the set backgroundImage repeat across the view as a series of tiles. The tiling begins in the upper-left corner, where the upper-left corner of the background image is rendered. The image is then tiled to fill the available space of the view.

Note that setting this to true may incur performance penalties for large views or background images, as the tiling must be redone whenever a view is resized.

On iOS, the following views do not currently support tiled backgrounds:

Default: false

  • 0.9
  • 0.9
  • 0.9

Selected background color of the view, as a color name or hex triplet.

Selected background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

focusable must be true for normal views.

  • 0.9
  • 1.8

Selected background image url for the view, specified as a local file path or URL.

Selected background image url for the view, specified as a local file path or URL.

For normal views, the selected background is only used if focusable is true.

  • 0.9
  • 1.8

Size of the top end cap.

Size of the top end cap.

End caps specify the portion of an image that should not be resized when an image is stretched. This technique is used to implement buttons and other resizable image-based interface elements. When a button with end caps is resized, the resizing occurs only in the middle of the button, in the region between the end caps. The end caps themselves keep their original size and appearance. This property specifies the size of the top end cap. The middle (stretchable) portion is assumed to be 1 pixel wide. The bottom end cap is therefore computed by adding the size of the top end cap and the middle portion together and then subtracting that value from the height of the image.

  • 0.9
  • 0.9

Border color of the view, as a color name or hex triplet.

Border color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Border radius of the view.

Border radius of the view.

Border width of the view.

Border width of the view.

bottom : Number/String

View's bottom position, in platform-specific units.

View's bottom position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

View's center position, in the parent view's coordinates.

View's center position, in the parent view's coordinates.

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Array of this view's child views.

Array of this view's child views.

Titanium.Media.VideoPlayer
: Stringdeprecated
Use the url property instead. ...

Use the url property instead.

deprecated since 1.4.0

Titanium.Media.VideoPlayer
currentPlaybackTime : Numberreadonly

Current playback time of the current movie in milliseconds.

Current playback time of the current movie in milliseconds.

Titanium.Media.VideoPlayer
duration : Number

The duration of the current movie in milliseconds, or 0.0 if not known.

The duration of the current movie in milliseconds, or 0.0 if not known.

The duration of the movie may not be available when playback is started. The durationAvailable event is fired when the duration is known.

Titanium.Media.VideoPlayer
endPlaybackTime : Number

The end time of movie playback, in milliseconds.

The end time of movie playback, in milliseconds.

On iOS, defaults to NaN, which indicates natural end time of the movie. Changing the value to a value less than duration causes the movie to stop playing at the specified point. On iOS, this value is not applicable to streaming media, so NaN is returned if the current media is being streamed.

On Android, this is always the same as duration (the natural end time), and changing the value has no effect.

Whether view should be focusable while navigating with the trackball. ...

Whether view should be focusable while navigating with the trackball.

Default: false

  • 0.9
Titanium.Media.VideoPlayer
: Boolean
Determines if the movie is presented in the entire screen (obscuring all other application content). ...

Determines if the movie is presented in the entire screen (obscuring all other application content).

Note that this must be set at different times on different platforms:

On iOS, setting this property to true before the movie player's view is visible has no effect.

On Android, this property must be set at creation time. For example:

var player = Ti.Media.createVideoPlayer({fullscreen: true});

On Android, setting this value to true means that the video will have its own Android Activity rather than being embedded as a view.

Default: false

height : Number/String

View height, in platform-specific units.

View height, in platform-specific units.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

  • Titanium.UI.SIZE. The view should size itself to fit its contents.
  • Titanium.UI.FILL. The view should size itself to fill its parent.
  • 'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

    On Mobile Web, 'auto' always selects SIZE behavior.

This is an input property for specifying the view's height dimension. To determine the view's size once rendered, use the rect or size properties.

Determines whether the layout has wrapping behavior. ...

Determines whether the layout has wrapping behavior.

For more information, see the discussion of horizontal layout mode in the description of the layout property.

Default: true

  • 2.1
  • 2.1
  • 2.1
  • 2.1
Titanium.Media.VideoPlayer
initialPlaybackTime : Number

The start time of movie playback, in milliseconds.

The start time of movie playback, in milliseconds.

Defaults to NaN in iOS and 0 in Android, indicating the natural start time of the movie.

Determines whether to keep the device screen on. ...

Determines whether to keep the device screen on.

When true the screen will not power down. Note: enabling this feature will use more power, thereby adversely affecting run time when on battery.

Default: false

  • 0.9
Specifies how the view positions its children. ...

Specifies how the view positions its children. One of: 'composite', 'vertical', or 'horizontal'.

There are three layout options:

  • composite (or absolute). Default layout. A child view is positioned based on its positioning properties or "pins" (top, bottom, left, right and center). If no positioning properties are specified, the child is centered.

    The child is always sized based on its width and height properties, if these are specified. If the child's height or width is not specified explicitly, it may be calculated implicitly from the positioning properties. For example, if both left and center.x are specified, they can be used to calculate the width of the child control.

    Because the size and position properties can conflict, there is a specific precedence order for the layout properties. For vertical positioning, the precedence order is: height, top, center.y, bottom.

    The following table summarizes the various combinations of properties that can be used for vertical positioning, in order from highest precedence to lowest. (For example, if height, center.y and bottom are all specified, the height and center.y values take precedence.)

    ScenarioBehavior
    height & top specifiedChild positioned top unit from parent's top, using specified height; any center.y and bottom values are ignored.
    height & center.y specifiedChild positioned with center at center.y, using specified height; any bottom value is ignored.
    height & bottom specifiedChild positioned bottom units from parent's bottom, using specified height.
    top & center.y specifiedChild positioned with top edge top units from parent's top and center at center.y. Height is determined implicitly; any bottom value is ignored.
    top & bottom specifiedChild positioned with top edge top units from parent's top and bottom edge bottom units from parent's bottom. Height is determined implicitly.
    Only top specifiedChild positioned top units from parent's top, and uses the default height calculation for the view type.
    center.y and bottom specifiedChild positioned with center at center.y and bottom edge bottom units from parent's bottom. Height is determined implicitly.
    Only center.y specifiedChild positioned with center at center.y, and uses the default height calculation for the view type.
    Only bottom specifiedChild positioned with bottom edge bottom units from parent's bottom, and uses the default height calculation for the view type.
    height, top, center.y, and bottom unspecifiedChild centered vertically in the parent and uses the default height calculation for the child view type.

    Horizontal positioning works like vertical positioning, except that the precedence is width, left, center.x, right.

    For complete details on composite layout rules, see Transitioning to the New UI Layout System in the Titanium Mobile Guides.

  • vertical. Children are laid out vertically from top to bottom. The first child is laid out top units from its parent's bounding box. Each subsequent child is laid out below the previous child. The space between children is equal to the upper child's bottom value plus the lower child's top value.

    Each child is positioned horizontally as in the composite layout mode.

  • horizontal. Horizontal layouts have different behavior depending on whether wrapping is enabled. Wrapping is enabled by default (the horizontalWrap property is true).

    With wrapping behavior, the children are laid out horizontally from left to right, in rows. If a child requires more horizontal space than exists in the current row, it is wrapped to a new row. The height of each row is equal to the maximum height of the children in that row.

    Wrapping behavior is available on iOS, Android and Mobile Web (Release 2.1.0 and later). When the horizontalWrap property is set to true, the first row is placed at the top of the parent view, and successive rows are placed below the first row. Each child is positioned vertically within its row somewhat like composite layout mode. In particular:

    • If neither top or bottom is specified, the child is centered in the row.
    • If either top or bottom is specified, the child is aligned to either the top or bottom of the row, with the specified amount of padding.
    • If both top and bottom is specified for a given child, the properties are both treated as padding.

    If the horizontalWrap property is false, the behavior is more equivalent to a vertical layout. Children are laid or horizontally from left to right in a single row. The left and right properties are used as padding between the children, and the top and bottom properties are used to position the children vertically.

    On Mobile Web prior to Release 2.1.0, the horizontal layout does not wrap by default, and does not support the horizontalWrap property. On Android and iOS prior to Release 2.1.0, the horizontal layout always wraps and the horizontalWrap property is not supported.

Default: Composite layout

left : Number/String

View's left position, in platform-specific units.

View's left position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Titanium.Media.VideoPlayer
loadState : Numberreadonly

Returns the network load state of the movie player.

Returns the network load state of the movie player.

Titanium.Media.VideoPlayer
media : Titanium.Blob/Titanium.Filesystem.File/String

Media object to play, as either a File, a Blob, or a URL.

Media object to play, as either a File, a Blob, or a URL.

  • 0.9
  • 0.9
Titanium.Media.VideoPlayer
: Number
The style of the playback controls. ...

The style of the playback controls.

Specify one of the VIDEO_CONTROL constants from Titanium.Media.

Mobile web only supports Titanium.Media.VIDEO_CONTROL_NONE and Titanium.Media.VIDEO_CONTROL_DEFAULT.

Default: System default video controls (Titanium.Media.VIDEO_CONTROL_DEFAULT).

Titanium.Media.VideoPlayer
mediaTypes : Number

The types of media in the movie, or Titanium.Media.VIDEO_MEDIA_TYPE_NONE if not known.

The types of media in the movie, or Titanium.Media.VIDEO_MEDIA_TYPE_NONE if not known.

A movie can contain video (VIDEO_MEDIA_TYPE_VIDEO), audio, (VIDEO_MEDIA_TYPE_AUDIO), or both.

A movie with both audio and video media is represented by a bitwise OR of the two constants:

Titanium.Media.VIDEO_MEDIA_TYPE_VIDEO|Titanium.Media.VIDEO_MEDIA_TYPE_AUDIO

  • 0.9
  • 0.9
Titanium.Media.VideoPlayer
: Numberdeprecated
Use mediaControlStyle instead. ...

Use mediaControlStyle instead.

deprecated since 1.8.0

Provides the ability to set the control mode of the movie player.

Default: Titanium.Media.VIDEO_CONTROL_DEFAULT

  • 0.9
  • 0.9
Titanium.Media.VideoPlayer
naturalSize : MovieSize

Returns the natural size of the movie.

Returns the natural size of the movie.

Returns a dictionary with properties width and height. Returns 0 for both properties if not known or applicable.

The naturalSizeAvailable event is fired when the natural size is known.

  • 0.9
  • 0.9
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). ...

Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).

Default: 1.0 (opaque)

Titanium.Media.VideoPlayer
playableDuration : Numberreadonly

The currently playable duration of the movie, for progressively downloaded network content.

The currently playable duration of the movie, for progressively downloaded network content.

On Android, this is always the same as duration.

Titanium.Media.VideoPlayer
playbackState : Numberreadonly

Current playback state of the video player.

Current playback state of the video player.

One of the VIDEO_PLAYBACK_STATE constants defined in Titanium.Media.

Titanium.Media.VideoPlayer
playing : Booleanreadonly

Boolean to indicate if the player has started playing.

Boolean to indicate if the player has started playing.

The bounding box of the view relative to its parent, in system units.

The bounding box of the view relative to its parent, in system units.

The view's bounding box is defined by its size and position.

The view's size is rect.width x rect.height. The view's top-left position relative to its parent is (rect.x , rect.y).

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.

  • 2.0
  • 2.0
  • 2.0
  • 2.0
Titanium.Media.VideoPlayer
: Number
Determines how the movie player repeats when reaching the end of playback. ...

Determines how the movie player repeats when reaching the end of playback.

Specify VIDEO_REPEAT_MODE_NONE to disable repeat, or VIDEO_REPEAT_MODE_ONE to repeat a single video continuously.

Default: Titanium.Media.VIDEO_REPEAT_MODE_NONE

  • 0.9
  • 0.9
  • 1.8
right : Number/String

View's right position, in platform-specific units.

View's right position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Titanium.Media.VideoPlayer
: Number
Determines how the content scales to fit the view. ...

Determines how the content scales to fit the view.

Mobile web only supports Titanium.Media.VIDEO_SCALING_NONE and Titanium.Media.VIDEO_SCALING_ASPECT_FIT.

Default: Titanium.Media.VIDEO_SCALING_ASPECT_FIT

The size of the view in system units.

The size of the view in system units.

Although property returns a Dimension dictionary, only the width and height properties are valid. The position properties--x and y--are always 0.

To find the position and size of the view, use the rect property instead.

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.

Determines keyboard behavior when this view is focused.

Titanium.Media.VideoPlayer
: Number
The playback type of the movie. ...

The playback type of the movie.

One of: VIDEO_SOURCE_TYPE_FILE, VIDEO_SOURCE_TYPE_STREAMING, or VIDEO_SOURCE_TYPE_UNKNOWN.

Specifying a playback type before playing the movie can result in faster load times.

The sourceChange event is fired when movie's source type is determined.

Default: Titanium.Media.VIDEO_SOURCE_TYPE_UNKNOWN

  • 0.9
  • 0.9
top : Number/String

The view's top position.

The view's top position.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Determines whether view should receive touch events. ...

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true

Transformation matrix to apply to the view.

Transformation matrix to apply to the view.

Android and Mobile Web only support 2DMatrix transforms.

Titanium.Media.VideoPlayer
url : String/String[]

URL of the media to play.

URL of the media to play.

URL identifying a local or remote video to play.

On Mobile Web, video format support depends on the web browser. You can specify an array of URLs to videos of different formats. The web browser will select the first video URL in the array that it is able to play. This is not supported on iOS and Android.

Titanium.Media.VideoPlayer
: Boolean
Indicates if the movie player should inherit the application's audio session instead of creating a new session. ...

Indicates if the movie player should inherit the application's audio session instead of creating a new session.

Creating a new session interrupts the application's session.

Setting this property during playback will not take effect until playback is stopped and started again.

Default: true

  • 0.9
  • 0.9
Determines whether the view is visible. ...

Determines whether the view is visible.

Default: true

Titanium.Media.VideoPlayer
: Number
Volume of the audio portion of the video. ...

Volume of the audio portion of the video.

On iOS, this adjusts the volume of the application's session as well, and will not work if useApplicationAudioSession has been set false. On the iOS device, setting this will be accompanied by an OS-provided indicator. However, the iOS simulator does not honor this volume setting, and is a known issue with Apple's simulator.

Default: 1.0

  • 2.1
  • 2.1
width : Number/String

View's width, in platform-specific units.

View's width, in platform-specific units.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

  • Titanium.UI.SIZE. The view should size itself to fit its contents.
  • Titanium.UI.FILL. The view should size itself to fill its parent.
  • 'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

On Mobile Web, 'auto' always selects SIZE behavior.

This is an input property for specifying the view's width dimension. To determine the view's size once rendered, use the rect or size properties.

Z-index stack order position, relative to other sibling views.

Z-index stack order position, relative to other sibling views.

A view does not have a default z-index value, meaning that it is undefined by default. When this property is explicitly set, regardless of its value, it causes the view to be positioned in front of any sibling that has an undefined z-index.

Defined By

Methods

Adds a child to this view's hierarchy. ...

Adds a child to this view's hierarchy.

The child view is added as the last child in this view's hierarchy.

Although all views inherit from Titanium.UI.View, not all views are capable of containing other views. In particular:

  • Some views are not designed to be containers at all.
  • Some views are special-purpose containers that can only contain certain other views.
  • Some views are top-level containers that cannot (or should not) be added to other views.

Non-Container Views

The following views are not intended to act as containers that can hold other views:

Adding children to the these views may be supported on some platforms, but is not guaranteed to work across platforms. Where it is supported, it may not work as expected.

For maximum portability, these views should be treated as if they do not support children.
Instead of adding children to these views, applications can positon other views as siblings. For example, instead of adding a button as a child of a WebView, you can add the button to the web view's parent such that it appears on top of the web view.

Special-Purpose Containers

A few view objects act as special-purpose containers--that is, they only manage certain types of children, and many of them support a special means of adding these children, instead of the general add method. These containers include:

  • ButtonBar and TabbedBar are designed to hold their own internally-created buttons, assigned by adding strings to the "labels" array. Views added using the add method are displayed on top of these buttons.

  • Picker. Can only hold PickerRows and PickerColumns, which are added using the add method. Adding other types of views to a Picker is not supported.

  • TableView is a specialized container for TableViewSection and TableViewRow objects. These objects must be added using the properties and methods that TableView provides for adding and removing sectons and rows.

    On some platforms, it is possible to add arbitrary child views to a table view using the add method. However, this is not guaranteed to work on all platforms, and in general, should be avoided.

  • TableViewSection is a specialized container for TableViewRow objects, which are added using the add method. The add method on TableViewSection can only be used to add TableViewRow objects.

  • Toolbar is designed to hold buttons and certain other controls, added to its items array. Views added using the add method are displayed on top of the controls in the items array.

  • The Tab, TabGroup, NavigationGroup and SplitWindow objects are special containers that manage windows. These are discussed in the "Top-Level Containers" section.

Top-Level Containers

There are certain top-level containers that are not intended to be added as the children of other views. These top-level containers include Window, SplitWindow, and TabGroup. Other types of views must be added to a top-level container in order to be displayed on screen.

The special containers NavigationGroup, SplitWindow, Tab, and TabGroup manage windows. These managed windows may be referred to as children of the container, but they are not added using the add method.

Note that although a NavigationGroup manages windows, it is not itself top-level container. It must be added to a Window in order to be displayed.

Tab is another kind of special container: it is not itself a top-level container, but can only be used within a TabGroup. You cannot add a Tab to an arbitrary container.

Parameters

Returns

  • void
( String name, Callback<Object> callback )
Adds the specified callback as an event listener for the named event. ...

Adds the specified callback as an event listener for the named event.

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Animates this view. ...

Animates this view.

The Animation object or dictionary passed to this method defines the end state for the animation, the duration of the animation, and other properties.

Note that if you use animate to move a view, the view's actual position is changed, but its layout properties, such as top, left, center and so on are not changed--these reflect the original values set by the user, not the actual position of the view.

The rect property can be used to determine the actual size and position of the view. Note that on Mobile Web, the rect property is not updated after animation. This is a known issue TIMOB-8930.

Parameters

Returns

  • void
Titanium.Media.VideoPlayer
( )
Cancels all pending asynchronous thumbnail requests. ...

Cancels all pending asynchronous thumbnail requests.

Asynchronous thumbnail requests initiated with requestThumbnailImagesAtTimes.

  • 0.9
  • 0.9

Returns

  • void
Translates a point from this view's coordinate system to another view's coordinate system. ...

Translates a point from this view's coordinate system to another view's coordinate system.

Returns null if either view is not in the view hierarchy.

Keep in mind that views may be removed from the view hierarchy if their window is blurred or if the view is offscreen (such as in some situations with Titanium.UI.ScrollableView).

If this view is a Titanium.UI.ScrollView, the view's x and y offsets are subtracted from the return value.

  • 1.8
  • 1.8
  • 1.8
  • 2.0

Parameters

  • point : Point

    A point in this view's coordinate system.

    If this argument is missing an x or y property, or the properties can not be converted into numbers, an exception will be raised.

  • destinationView : Titanium.UI.View

    View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.

Returns

Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree. ...

Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree.

Since the layout pass scheduled is asynchronous, the rect and size values may not be available immediately after finishLayout is called.

To be notified when the layout pass completes, add a listener for the postlayout event.

On Mobile Web, this method has no effect, but is included for parity.

  • 2.0
  • 2.0
  • 2.0
  • 2.0

Returns

  • void
( String name, Dictionary event )
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • name : String

    Name of the event.

  • event : Dictionary

    A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

  • void
Titanium.Media.VideoPlayer
( ) : Boolean
Gets the value of the allowsAirPlay property. ...

Gets the value of the allowsAirPlay property.

  • 0.9
  • 0.9

Returns

  • Boolean
Gets the value of the anchorPoint property. ...

Gets the value of the anchorPoint property.

  • 0.9
  • 0.9

Returns

Gets the value of the animatedCenter property. ...

Gets the value of the animatedCenter property.

  • 0.9
  • 0.9
  • 0.9

Returns

Titanium.Media.VideoPlayer
( ) : Boolean
Gets the value of the autoplay property. ...

Gets the value of the autoplay property.

Returns

  • Boolean
Gets the value of the backgroundColor property. ...

Gets the value of the backgroundColor property.

Returns

  • String
Gets the value of the backgroundDisabledColor property. ...

Gets the value of the backgroundDisabledColor property.

  • 0.9

Returns

  • String
Gets the value of the backgroundDisabledImage property. ...

Gets the value of the backgroundDisabledImage property.

  • 0.9

Returns

  • String
Gets the value of the backgroundFocusedColor property. ...

Gets the value of the backgroundFocusedColor property.

  • 0.9

Returns

  • String
Gets the value of the backgroundFocusedImage property. ...

Gets the value of the backgroundFocusedImage property.

  • 0.9

Returns

  • String
Gets the value of the backgroundGradient property. ...

Gets the value of the backgroundGradient property.

  • 0.9
  • 0.9
  • 1.8
  • 0.9

Returns

Gets the value of the backgroundImage property. ...

Gets the value of the backgroundImage property.

Returns

  • String
Gets the value of the backgroundLeftCap property. ...

Gets the value of the backgroundLeftCap property.

  • 0.9
  • 0.9

Returns

  • Number
Gets the value of the backgroundRepeat property. ...

Gets the value of the backgroundRepeat property.

  • 0.9
  • 0.9
  • 0.9

Returns

  • Boolean
Gets the value of the backgroundSelectedColor property. ...

Gets the value of the backgroundSelectedColor property.

  • 0.9
  • 1.8

Returns

  • String
Gets the value of the backgroundSelectedImage property. ...

Gets the value of the backgroundSelectedImage property.

  • 0.9
  • 1.8

Returns

  • String
Gets the value of the backgroundTopCap property. ...

Gets the value of the backgroundTopCap property.

  • 0.9
  • 0.9

Returns

  • Number
Gets the value of the borderColor property. ...

Gets the value of the borderColor property.

Returns

  • String
Gets the value of the borderRadius property. ...

Gets the value of the borderRadius property.

Returns

  • Number
Gets the value of the borderWidth property. ...

Gets the value of the borderWidth property.

Returns

  • Number
( ) : Number/String
Gets the value of the bottom property. ...

Gets the value of the bottom property.

Returns

  • Number/String
Gets the value of the center property. ...

Gets the value of the center property.

Returns

Gets the value of the children property. ...

Gets the value of the children property.

Returns

Titanium.Media.VideoPlayer
( ) : Stringdeprecated
Gets the value of the contentURL property. ...

Gets the value of the contentURL property.

deprecated since 1.4.0

Returns

  • String
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the currentPlaybackTime property. ...

Gets the value of the currentPlaybackTime property.

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the duration property. ...

Gets the value of the duration property.

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the endPlaybackTime property. ...

Gets the value of the endPlaybackTime property.

Returns

  • Number
Gets the value of the focusable property. ...

Gets the value of the focusable property.

  • 0.9

Returns

  • Boolean
Titanium.Media.VideoPlayer
( ) : Boolean
Gets the value of the fullscreen property. ...

Gets the value of the fullscreen property.

Returns

  • Boolean
( ) : Number/String
Gets the value of the height property. ...

Gets the value of the height property.

Returns

  • Number/String
Gets the value of the horizontalWrap property. ...

Gets the value of the horizontalWrap property.

  • 2.1
  • 2.1
  • 2.1
  • 2.1

Returns

  • Boolean
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the initialPlaybackTime property. ...

Gets the value of the initialPlaybackTime property.

Returns

  • Number
Gets the value of the keepScreenOn property. ...

Gets the value of the keepScreenOn property.

  • 0.9

Returns

  • Boolean
Gets the value of the layout property. ...

Gets the value of the layout property.

Returns

  • String
( ) : Number/String
Gets the value of the left property. ...

Gets the value of the left property.

Returns

  • Number/String
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the loadState property. ...

Gets the value of the loadState property.

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the mediaControlStyle property. ...

Gets the value of the mediaControlStyle property.

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the mediaTypes property. ...

Gets the value of the mediaTypes property.

  • 0.9
  • 0.9

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Numberdeprecated
Gets the value of the movieControlMode property. ...

Gets the value of the movieControlMode property.

deprecated since 1.8.0

  • 0.9
  • 0.9

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : MovieSize
Gets the value of the naturalSize property. ...

Gets the value of the naturalSize property.

  • 0.9
  • 0.9

Returns

Gets the value of the opacity property. ...

Gets the value of the opacity property.

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the playableDuration property. ...

Gets the value of the playableDuration property.

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the playbackState property. ...

Gets the value of the playbackState property.

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Boolean
Gets the value of the playing property. ...

Gets the value of the playing property.

Returns

  • Boolean
Gets the value of the rect property. ...

Gets the value of the rect property.

  • 2.0
  • 2.0
  • 2.0
  • 2.0

Returns

Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the repeatMode property. ...

Gets the value of the repeatMode property.

  • 0.9
  • 0.9
  • 1.8

Returns

  • Number
( ) : Number/String
Gets the value of the right property. ...

Gets the value of the right property.

Returns

  • Number/String
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the scalingMode property. ...

Gets the value of the scalingMode property.

Returns

  • Number
Gets the value of the size property. ...

Gets the value of the size property.

Returns

Gets the value of the softKeyboardOnFocus property. ...

Gets the value of the softKeyboardOnFocus property.

  • 0.9

Returns

  • Number
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the sourceType property. ...

Gets the value of the sourceType property.

  • 0.9
  • 0.9

Returns

  • Number
( ) : Number/String
Gets the value of the top property. ...

Gets the value of the top property.

Returns

  • Number/String
Gets the value of the touchEnabled property. ...

Gets the value of the touchEnabled property.

Returns

  • Boolean
Gets the value of the transform property. ...

Gets the value of the transform property.

Returns

Titanium.Media.VideoPlayer
( ) : String/String[]
Gets the value of the url property. ...

Gets the value of the url property.

Returns

  • String/String[]
Titanium.Media.VideoPlayer
( ) : Boolean
Gets the value of the useApplicationAudioSession property. ...

Gets the value of the useApplicationAudioSession property.

  • 0.9
  • 0.9

Returns

  • Boolean
Gets the value of the visible property. ...

Gets the value of the visible property.

Returns

  • Boolean
Titanium.Media.VideoPlayer
( ) : Number
Gets the value of the volume property. ...

Gets the value of the volume property.

  • 2.1
  • 2.1

Returns

  • Number
( ) : Number/String
Gets the value of the width property. ...

Gets the value of the width property.

Returns

  • Number/String
Gets the value of the zIndex property. ...

Gets the value of the zIndex property.

Returns

  • Number
Hides this view. ...

Hides this view.

Returns

  • void
Titanium.Media.VideoPlayer
( )
Pauses playing the video. ...

Pauses playing the video.

Returns

  • void
Titanium.Media.VideoPlayer
( )
Starts playing the video. ...

Starts playing the video.

Returns

  • void
Titanium.Media.VideoPlayer
( )
Releases the internal video resources immediately. ...

Releases the internal video resources immediately.

This is not usually necessary but can help if you no longer need to use the player after it is used to help converse memory.

Returns

  • void
Removes a child view from this view's hierarchy. ...

Removes a child view from this view's hierarchy.

Parameters

Returns

  • void
( String name, Callback<Object> callback )
Removes the specified callback as an event listener for the named event. ...

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Titanium.Media.VideoPlayer
( Number[] times, Number option, Callback<ThumbnailResponse> callback )
Asynchronously request thumbnail images for one or more points in time in the video. ...

Asynchronously request thumbnail images for one or more points in time in the video.

The times parameter specifies an array of time values, in seconds. For each time value, the platform generates an image representing the video at that point in time.

The callback function is invoked when a thumbnail is available.

Calling this method will cancel all pending asynchronous thumbnail requests.

  • 0.9
  • 0.9

Parameters

Returns

  • void
Titanium.Media.VideoPlayer
( Boolean allowsAirPlay )
Sets the value of the allowsAirPlay property. ...

Sets the value of the allowsAirPlay property.

  • 0.9
  • 0.9

Parameters

  • allowsAirPlay : Boolean

    New value for the property.

Returns

  • void
Sets the value of the anchorPoint property. ...

Sets the value of the anchorPoint property.

  • 0.9
  • 0.9

Parameters

  • anchorPoint : Point

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Boolean autoplay )
Sets the value of the autoplay property. ...

Sets the value of the autoplay property.

Parameters

  • autoplay : Boolean

    New value for the property.

Returns

  • void
( String backgroundColor )
Sets the value of the backgroundColor property. ...

Sets the value of the backgroundColor property.

Parameters

  • backgroundColor : String

    New value for the property.

Returns

  • void
( String backgroundDisabledColor )
Sets the value of the backgroundDisabledColor property. ...

Sets the value of the backgroundDisabledColor property.

  • 0.9

Parameters

  • backgroundDisabledColor : String

    New value for the property.

Returns

  • void
( String backgroundDisabledImage )
Sets the value of the backgroundDisabledImage property. ...

Sets the value of the backgroundDisabledImage property.

  • 0.9

Parameters

  • backgroundDisabledImage : String

    New value for the property.

Returns

  • void
( String backgroundFocusedColor )
Sets the value of the backgroundFocusedColor property. ...

Sets the value of the backgroundFocusedColor property.

  • 0.9

Parameters

  • backgroundFocusedColor : String

    New value for the property.

Returns

  • void
( String backgroundFocusedImage )
Sets the value of the backgroundFocusedImage property. ...

Sets the value of the backgroundFocusedImage property.

  • 0.9

Parameters

  • backgroundFocusedImage : String

    New value for the property.

Returns

  • void
Sets the value of the backgroundGradient property. ...

Sets the value of the backgroundGradient property.

  • 0.9
  • 0.9
  • 1.8
  • 0.9

Parameters

  • backgroundGradient : Gradient

    New value for the property.

Returns

  • void
( String backgroundImage )
Sets the value of the backgroundImage property. ...

Sets the value of the backgroundImage property.

Parameters

  • backgroundImage : String

    New value for the property.

Returns

  • void
( Number backgroundLeftCap )
Sets the value of the backgroundLeftCap property. ...

Sets the value of the backgroundLeftCap property.

  • 0.9
  • 0.9

Parameters

  • backgroundLeftCap : Number

    New value for the property.

Returns

  • void
( Boolean backgroundRepeat )
Sets the value of the backgroundRepeat property. ...

Sets the value of the backgroundRepeat property.

  • 0.9
  • 0.9
  • 0.9

Parameters

  • backgroundRepeat : Boolean

    New value for the property.

Returns

  • void
( String backgroundSelectedColor )
Sets the value of the backgroundSelectedColor property. ...

Sets the value of the backgroundSelectedColor property.

  • 0.9
  • 1.8

Parameters

  • backgroundSelectedColor : String

    New value for the property.

Returns

  • void
( String backgroundSelectedImage )
Sets the value of the backgroundSelectedImage property. ...

Sets the value of the backgroundSelectedImage property.

  • 0.9
  • 1.8

Parameters

  • backgroundSelectedImage : String

    New value for the property.

Returns

  • void
( Number backgroundTopCap )
Sets the value of the backgroundTopCap property. ...

Sets the value of the backgroundTopCap property.

  • 0.9
  • 0.9

Parameters

  • backgroundTopCap : Number

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Titanium.UI.View view )
Sets the background view for customization which is always displayed behind movie content. ...

Sets the background view for customization which is always displayed behind movie content.

To create a background behind the movie content on iOS, you can specify a background view. On iOS, you can set the backgroundColor property directly on the video player, but not a background image or background gradient. For this kind of effect, specify a background view.

Note that the background view must be sized explicitly: percentage sizes do not work properly.

The following code sample creates a video player with a background image:

var videoPlayer = Titanium.Media.createVideoPlayer({
    height : 300,
    width : 300,
    backgroundView : Ti.UI.createView({
        backgroundImage: 'videoPlayerBG.png
        width : 300,
        height : 300
    })
    borderRadius : 20,
    borderWidth : 2,
    borderColor : 'blue',
});

Note that if scalingMode is set to VIDEO_SCALING_MODE_FILL or VIDEO_SCALING_ASPECT_FILL, the playing video will fill the entire video player area, obscuring any background view.

  • 0.9
  • 0.9

Parameters

Returns

  • void
( String borderColor )
Sets the value of the borderColor property. ...

Sets the value of the borderColor property.

Parameters

  • borderColor : String

    New value for the property.

Returns

  • void
( Number borderRadius )
Sets the value of the borderRadius property. ...

Sets the value of the borderRadius property.

Parameters

  • borderRadius : Number

    New value for the property.

Returns

  • void
( Number borderWidth )
Sets the value of the borderWidth property. ...

Sets the value of the borderWidth property.

Parameters

  • borderWidth : Number

    New value for the property.

Returns

  • void
( Number/String bottom )
Sets the value of the bottom property. ...

Sets the value of the bottom property.

Parameters

  • bottom : Number/String

    New value for the property.

Returns

  • void
Sets the value of the center property. ...

Sets the value of the center property.

Parameters

  • center : Point

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( String contentURL )deprecated
Sets the value of the contentURL property. ...

Sets the value of the contentURL property.

deprecated since 1.4.0

Parameters

  • contentURL : String

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number duration )
Sets the value of the duration property. ...

Sets the value of the duration property.

Parameters

  • duration : Number

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number endPlaybackTime )
Sets the value of the endPlaybackTime property. ...

Sets the value of the endPlaybackTime property.

Parameters

  • endPlaybackTime : Number

    New value for the property.

Returns

  • void
( Boolean focusable )
Sets the value of the focusable property. ...

Sets the value of the focusable property.

  • 0.9

Parameters

  • focusable : Boolean

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Boolean fullscreen )
Sets the value of the fullscreen property. ...

Sets the value of the fullscreen property.

Parameters

  • fullscreen : Boolean

    New value for the property.

Returns

  • void
( Number/String height )
Sets the value of the height property. ...

Sets the value of the height property.

Parameters

  • height : Number/String

    New value for the property.

Returns

  • void
( Boolean horizontalWrap )
Sets the value of the horizontalWrap property. ...

Sets the value of the horizontalWrap property.

  • 2.1
  • 2.1
  • 2.1
  • 2.1

Parameters

  • horizontalWrap : Boolean

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number initialPlaybackTime )
Sets the value of the initialPlaybackTime property. ...

Sets the value of the initialPlaybackTime property.

Parameters

  • initialPlaybackTime : Number

    New value for the property.

Returns

  • void
( Boolean keepScreenOn )
Sets the value of the keepScreenOn property. ...

Sets the value of the keepScreenOn property.

  • 0.9

Parameters

  • keepScreenOn : Boolean

    New value for the property.

Returns

  • void
( String layout )
Sets the value of the layout property. ...

Sets the value of the layout property.

Parameters

  • layout : String

    New value for the property.

Returns

  • void
( Number/String left )
Sets the value of the left property. ...

Sets the value of the left property.

Parameters

  • left : Number/String

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Titanium.Blob/Titanium.Filesystem.File/String media )
Sets the value of the media property. ...

Sets the value of the media property.

  • 0.9
  • 0.9

Parameters

Returns

  • void
Titanium.Media.VideoPlayer
( Number mediaControlStyle )
Sets the value of the mediaControlStyle property. ...

Sets the value of the mediaControlStyle property.

Parameters

  • mediaControlStyle : Number

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number mediaTypes )
Sets the value of the mediaTypes property. ...

Sets the value of the mediaTypes property.

  • 0.9
  • 0.9

Parameters

  • mediaTypes : Number

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number movieControlMode )deprecated
Sets the value of the movieControlMode property. ...

Sets the value of the movieControlMode property.

deprecated since 1.8.0

  • 0.9
  • 0.9

Parameters

  • movieControlMode : Number

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( MovieSize naturalSize )
Sets the value of the naturalSize property. ...

Sets the value of the naturalSize property.

  • 0.9
  • 0.9

Parameters

  • naturalSize : MovieSize

    New value for the property.

Returns

  • void
( Number opacity )
Sets the value of the opacity property. ...

Sets the value of the opacity property.

Parameters

  • opacity : Number

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number repeatMode )
Sets the value of the repeatMode property. ...

Sets the value of the repeatMode property.

  • 0.9
  • 0.9
  • 1.8

Parameters

  • repeatMode : Number

    New value for the property.

Returns

  • void
( Number/String right )
Sets the value of the right property. ...

Sets the value of the right property.

Parameters

  • right : Number/String

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number scalingMode )
Sets the value of the scalingMode property. ...

Sets the value of the scalingMode property.

Parameters

  • scalingMode : Number

    New value for the property.

Returns

  • void
( Number softKeyboardOnFocus )
Sets the value of the softKeyboardOnFocus property. ...

Sets the value of the softKeyboardOnFocus property.

  • 0.9

Parameters

  • softKeyboardOnFocus : Number

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number sourceType )
Sets the value of the sourceType property. ...

Sets the value of the sourceType property.

  • 0.9
  • 0.9

Parameters

  • sourceType : Number

    New value for the property.

Returns

  • void
( Number/String top )
Sets the value of the top property. ...

Sets the value of the top property.

Parameters

  • top : Number/String

    New value for the property.

Returns

  • void
( Boolean touchEnabled )
Sets the value of the touchEnabled property. ...

Sets the value of the touchEnabled property.

Parameters

  • touchEnabled : Boolean

    New value for the property.

Returns

  • void
Sets the value of the transform property. ...

Sets the value of the transform property.

Parameters

Returns

  • void
Titanium.Media.VideoPlayer
( String/String[] url )
Sets the value of the url property. ...

Sets the value of the url property.

Parameters

  • url : String/String[]

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Boolean useApplicationAudioSession )
Sets the value of the useApplicationAudioSession property. ...

Sets the value of the useApplicationAudioSession property.

  • 0.9
  • 0.9

Parameters

  • useApplicationAudioSession : Boolean

    New value for the property.

Returns

  • void
( Boolean visible )
Sets the value of the visible property. ...

Sets the value of the visible property.

Parameters

  • visible : Boolean

    New value for the property.

Returns

  • void
Titanium.Media.VideoPlayer
( Number volume )
Sets the value of the volume property. ...

Sets the value of the volume property.

  • 2.1
  • 2.1

Parameters

  • volume : Number

    New value for the property.

Returns

  • void
( Number/String width )
Sets the value of the width property. ...

Sets the value of the width property.

Parameters

  • width : Number/String

    New value for the property.

Returns

  • void
( Number zIndex )
Sets the value of the zIndex property. ...

Sets the value of the zIndex property.

Parameters

  • zIndex : Number

    New value for the property.

Returns

  • void
Makes this view visible. ...

Makes this view visible.

Returns

  • void
Starts a batch update of this view's layout properties. ...

Starts a batch update of this view's layout properties.

To prevent a layout pass each time a property is modified, call startLayout before changing any properties that may change this view's layout. This initiates a batch update mode where layout changes are deferred.

Call finishLayout to end batch update mode and trigger a layout pass. For example:

view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();

Note that any property changes made during the batch update may be deferred until finishLayout is called. This may vary somewhat by platform. For example, changing the text of a label may trigger a layout pass. In iOS, updating the label text is deferred, while on Mobile Web, the label text is updated immediately but the control is not resized until finishLayout is called.

See also: updateLayout, finishLayout, postlayout event.

On Mobile Web, this method is included for parity only, and thus has no effect.

  • 2.0
  • 2.0
  • 2.0
  • 2.0

Returns

  • void
Titanium.Media.VideoPlayer
( )
Stops playing the video. ...

Stops playing the video.

Returns

  • void
Titanium.Media.VideoPlayer
( Number time, Number option ) : Titanium.Blob
Returns a thumbnail image for the video at the specified time. ...

Returns a thumbnail image for the video at the specified time.

  • 0.9
  • 0.9

Parameters

Returns

( [Callback<Titanium.Blob> callback], [Boolean honorScaleFactor] ) : Titanium.Blob
Returns an image of the rendered view, as a Blob. ...

Returns an image of the rendered view, as a Blob.

The honorScaleFactor method is only supported on iOS.

  • 0.9
  • 0.9
  • 0.9

Parameters

  • callback : Callback<Titanium.Blob> (optional)

    Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.

  • honorScaleFactor : Boolean (optional)

    Determines whether the image is scaled based on scale factor of main screen. (iOS only)

    When set to true, image is scale factor is honored. When set to false, the image in the blob has the same dimensions for retina and non-retina devices.

    Default: False

Returns

Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated. ...

Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated.

This is another way to perform a batch update. The updateLayout method is called with a dictionary of layout properties to perform the batch update. For example:

view.updateLayout({top:50, left:50});

This is equivalent to the following:

view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();

See also: startLayout, finishLayout, postlayout event.

On Mobile Web, this method is included for parity only, and thus has no effect.

  • 2.0
  • 2.0
  • 2.0
  • 2.0

Parameters

  • params : Dictionary

    Layout properties to be updated.

Returns

  • void
Defined By

Events

Titanium.Media.VideoPlayer
Fired when the device detects a click against the view. ...

Fired when the device detects a click against the view.

There is a subtle difference between singletap and click events.

A singletap event is generated when the user taps the screen briefly without moving their finger. This gesture will also generate a click event.

However, a click event can also be generated when the user touches, moves their finger, and then removes it from the screen.

On Android, a click event can also be generated by a trackball click.

  • 0.9
  • 1.8

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Overrides: Titanium.UI.View.click

Titanium.Media.VideoPlayer
Fired when movie playback ends or a user exits playback. ...

Fired when movie playback ends or a user exits playback.

On iOS, the reason property is only included if this information is available.

Properties

Fired when the device detects a double click against the view. ...

Fired when the device detects a double click against the view.

Properties

  • globalPoint : Objectdeprecated

    Dictionary with properties x and y describing the location of the event in screen coordinates.

    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired when the device detects a double tap against the view. ...

Fired when the device detects a double tap against the view.

  • 0.9
  • 0.9
  • 0.9

Properties

  • globalPoint : Objectdeprecated

    Dictionary with properties x and y describing the location of the event in screen coordinates.

    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Titanium.Media.VideoPlayer
Fired when the video duration is available. ...

Fired when the video duration is available.

Properties

  • duration : Number

    Video duration, in milliseconds.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when movie playback encounters an error. ...

Fired when movie playback encounters an error.

  • 0.9
  • 1.8

Properties

  • message : String

    Reason for error as a string.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when a movie changes to or from fullscreen view. ...

Fired when a movie changes to or from fullscreen view.

On iOS, this event is fired at the beginning of the transition to fullscreen mode. A duration property is provided, indicating the duration of the animated transition to or from fullscreen mode.

  • 0.9
  • 0.9
  • 1.8

Properties

  • duration : Number

    Duration of the animated transition to or from fullscreen mode, in seconds.

    •  
    •  
  • entering : Boolean

    true if the player is entering fullscreen mode, false if it is leaving fullscreen mode.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when the movie play loads. ...

Fired when the movie play loads.

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when the network loadState changes. ...

Fired when the network loadState changes.

Properties

  • loadState : Number

    Current value of the loadState property.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Fired when the device detects a long press. ...

Fired when the device detects a long press.

A long press is generated by touching and holding on the touchscreen. Unlike a longclick, it does not respond to the trackball button.

The event occurs before the finger is lifted.

A longpress and a longclick can occur together.

In contrast to a longclick, this event returns the x and y coordinates of the touch.

  • 0.9
  • 0.9
  • 0.9

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Titanium.Media.VideoPlayer
Fired when the media types in the current movie are determined. ...

Fired when the media types in the current movie are determined.

  • 0.9
  • 0.9

Properties

  • mediaTypes : Number

    Current value of the mediaTypes property.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when the natural size of the current movie is determined. ...

Fired when the natural size of the current movie is determined.

On iOS 6.0, this event is not fired by the operating system.

  • 0.9
  • 0.9

Properties

  • naturalSize : Number

    Current value of the naturalSize property.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when the playbackState changes. ...

Fired when the playbackState changes.

Properties

Titanium.Media.VideoPlayer
Fired when the currently playing movie changes. ...

Fired when the currently playing movie changes.

  • 0.9
  • 0.9
  • 1.8

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • url : String

    URL of the media.

Fired when a layout cycle is finished. ...

Fired when a layout cycle is finished.

This event is fired when the view and its ancestors have been laid out. The rect and size values should be usable when this event is fired.

This event is typically triggered by either changing layout properties or by changing the orientation of the device. Note that changing the layout of child views or ancestors can also trigger a relayout of this view. On Mobile Web, this event can also be triggered by resizing the browser window.

Note that altering any properties that affect layout from the postlayout callback may result in an endless loop.

  • 2.0
  • 2.0
  • 2.0
  • 2.0

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when the movie has preloaded and is ready to play. ...

Fired when the movie has preloaded and is ready to play.

  • 0.9
  • 1.8

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when the movie player is resized. ...

Fired when the movie player is resized.

  • 0.9
  • 0.9

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media.VideoPlayer
Fired when the device detects a single tap against the view. ...

Fired when the device detects a single tap against the view.

  • 0.9
  • 1.8

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Overrides: Titanium.UI.View.singletap

Titanium.Media.VideoPlayer
Fired when the sourceType property changes. ...

Fired when the sourceType property changes.

  • 0.9
  • 0.9

Properties

  • source : Object

    Source object that fired the event.

  • sourceType : Object

    New sourceType value.

  • type : String

    Name of the event fired.

Fired when the device detects a swipe gesture against the view. ...

Fired when the device detects a swipe gesture against the view.

  • 0.9
  • 0.9
  • 0.9
  • 1.8

Properties

  • direction : String

    Direction of the swipe--either 'left', 'right', 'up', or 'down'.

  • globalPoint : Objectdeprecated

    Dictionary with properties x and y describing the location of the event's endpoint in screen coordinates.

    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event's endpoint from the source view's coordinate system.

  • y : Number

    Y coordinate of the event's endpoint from the source view's coordinate system.

Titanium.Media.VideoPlayer
Fired when a touch event is interrupted by the device. ...

Fired when a touch event is interrupted by the device.

A touchcancel can happen in circumstances such as an incoming call to allow the UI to clean up state.

  • 0.9
  • 1.8

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Overrides: Titanium.UI.View.touchcancel

Titanium.Media.VideoPlayer
Fired when a touch event is completed. ...

Fired when a touch event is completed.

  • 0.9
  • 1.8

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Overrides: Titanium.UI.View.touchend

Titanium.Media.VideoPlayer
Fired as soon as the device detects movement of a touch. ...

Fired as soon as the device detects movement of a touch.

Event coordinates are always relative to the view in which the initial touch occurred

  • 0.9
  • 1.8

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Overrides: Titanium.UI.View.touchmove

Fired as soon as the device detects a touch gesture. ...

Fired as soon as the device detects a touch gesture.

Properties

  • globalPoint : Objectdeprecated

    Dictionary with properties x and y describing the location of the event in screen coordinates.

    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.