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.
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)
On Android, using a video player inside a scroll view is not recommended. When scrolling, black bars may appear over the video content.
This is because the video player is rendered on a special Android UI element called a SurfaceView. Android renders the SurfaceView behind the main window and punches a hole in the window to reveal the video. Because the content of the SurfaceView does not reside in the application window, the video content cannot be transformed (moved, scaled or rotated) with the window. This makes it difficult for the content to render properly inside a ScrollView.
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();
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',
mediaControlStyle : 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();
Previous simple example as an Alloy view.
simplevideoplayer.xml:
<Alloy>
<Window id="vidWin" title="Video View Demo" backgroundColor="#fff">
<VideoPlayer id="videoPlayer" ns="Ti.Media" top="2" url="/movie.mp4"
height="300" width="300" backgroundColor="blue" autoplay="true" />
</Window>
</Alloy>
Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.
Requires: Android 4.0 and later iOS 5.0 and later
On iOS this is a direct analog of the accessibilityElementsHidden
property defined in the
UIAccessibility
Protocol.
The native property is only available in iOS 5.0 and later; if
accessibilityHidden
is specified on earlier versions of iOS, it is ignored.
On Android, setting accessibilityHidden
calls the native
View.setImportantForAccessibility
method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and
later; if this property is specified on earlier versions of Android, it is ignored.
Default: false
Briefly describes what performing an action (such as a click) on the view will do.
On iOS this is a direct analog of the accessibilityHint
property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityLabel and accessibilityValue in the order: accessibilityLabel
,
accessibilityValue
, accessibilityHint
. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default:
A succint label identifying the view for the device's accessibility service.
On iOS this is a direct analog of the accessibilityLabel
property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityValue and accessibilityHint in the order: accessibilityLabel
,
accessibilityValue
, accessibilityHint
. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default: Title or label of the control.
A string describing the value (if any) of the view for the device's accessibility service.
On iOS this is a direct analog of the accessibilityValue
property defined in the
UIAccessibility Protocol.
On Android, it is concatenated together with
accessibilityLabel and accessibilityHint in the order: accessibilityLabel
,
accessibilityValue
, accessibilityHint
. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Default: State or value of the control.
Whether or not the current movie can be played on a remote device.
Requires: iOS 4.3 and later
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.
Default: Center of this view.
Current position of the view during an animation.
Current position of the view during an animation.
The name of the API that this proxy corresponds to.
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button
.
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.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Transparent
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.
Default: Same as the normal background color of this view.
Disabled background image for the view, specified as a local file path or URL.
Default: If `backgroundDisabledImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is disabled.
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
.
Default: Same as the normal background color of this view.
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
.
Default: If `backgroundFocusedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is focused.
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 } ]
Android's linear gradients ignores backfillStart
and backfillEnd
, treating them as if
they are true. Android's radial gradients ignore the endPoint
property.
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: 50,
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();
Default: No gradient
Background image for the view, specified as a local file path or URL.
Default: Default behavior when `backgroundImage` is unspecified depends on the type of view and the platform. For generic views, no image is used. For most controls (buttons, text fields, and so on), platform-specific default images are used.
Size of the left end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
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
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.
Default: Background color of this view.
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
.
Default: If `backgroundSelectedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is selected.
Size of the top end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
Sets the background view for customization which is always displayed behind movie content.
deprecated since 7.0.0
Use <Titanium.Media.VideoPlayer.overlayView> instead.
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 = Ti.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.
Border color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Default: Same as the normal background color of this view (Android), black (iOS).
Radius for the rounded corners of the view's border.
Each corner is rounded using an arc of a circle.
Default: 0
Border width of the view.
If borderColor is set without borderWidth, this value will be changed to 1 of the unit declared as 'ti.ui.defaultunit' in tiapp.xml descriptor.
Default: 0
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.
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
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.
View's clipping behavior.
Setting this to Titanium.UI.iOS.CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to Titanium.UI.iOS.CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to Titanium.UI.iOS.CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.
Default: Undefined. Behaves as if set to Titanium.UI.iOS.CLIP_MODE_DEFAULT.
URL of the media to play.
URL of the media to play.
This property has been removed since 3.0.0
Use <Titanium.Media.VideoPlayer.url> instead.
Current playback time of the current movie in milliseconds.
Current playback time of the current movie in milliseconds.
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.
Base elevation of the view relative to its parent in pixels.
Requires: Android 5 and later
The elevation of a view determines the appearance of its shadow. Higher elevations produce larger and softer shadows.
Note: The elevation
property only works on Titanium.UI.View
objects.
Many Android components have a default elevation that cannot be modified.
For more information, see
Google design guidelines: Elevation and shadows.
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.
Default: false
Determines if the movie is presented in the entire screen (obscuring all other application content).
This property has been removed since 7.0.0
This method has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.
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
View height, in platform-specific units.
View height, in platform-specific units.
Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.
Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:
SIZE
or
FILL
constants if it is necessary to set the view's behavior explicitly.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.
This API can be assigned the following constants:
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
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.
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
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.)
Scenario | Behavior |
---|---|
`height` & `top` specified | Child positioned `top` unit from parent's top, using specified `height`; any `center.y` and `bottom` values are ignored. |
`height` & `center.y` specified | Child positioned with center at `center.y`, using specified `height`; any `bottom` value is ignored. |
`height` & `bottom` specified | Child positioned `bottom` units from parent's bottom, using specified `height`. |
`top` & `center.y` specified | Child 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` specified | Child 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` specified | Child positioned `top` units from parent's top, and uses the default height calculation for the view type. |
`center.y` and `bottom` specified | Child positioned with center at `center.y` and bottom edge `bottom` units from parent's bottom. Height is determined implicitly. |
Only `center.y` specified | Child positioned with center at `center.y`, and uses the default height calculation for the view type. |
Only `bottom` specified | Child 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` unspecified | Child 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 and Android (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:
top
or bottom
is specified, the child is centered in the
row.top
or bottom
is specified, the child is aligned to either
the top or bottom of the row, with the specified amount of padding.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 Android and iOS prior to Release
2.1.0, the horizontal layout always wraps and the horizontalWrap
property is not supported.
Default: Composite layout
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.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
Returns the network load state of the movie player.
deprecated since 7.0.0
On iOS, use <Titanium.Media.VideoPlayer.moviePlayerStatus> instead.
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.
The style of the playback controls.
This property has been removed since 7.0.0
On iOS, use <Titanium.Media.VideoPlayer.showsControls> instead.
Mobile web only supports Titanium.Media.VIDEO_CONTROL_NONE and Titanium.Media.VIDEO_CONTROL_DEFAULT.
This API can be assigned the following constants:
Default: System default video controls (Titanium.Media.VIDEO_CONTROL_DEFAULT).
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
This API can be assigned the following constants:
Style of the media playback controls.
This property has been removed
6.0.0 Use <Titanium.Media.VideoPlayer.mediaControlStyle> instead.
Requires: iOS 3.1 and earlier
Provides the ability to set the control mode of the movie player.
Default: Titanium.Media.VIDEO_CONTROL_DEFAULT
Returns the status of the movie player.
Returns the status of the movie player.
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.
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).
Default: 1.0 (opaque)
Use the overlay view to add additional custom views between the video content and the controls.
Use the overlay view to add additional custom views between the video content and the controls.
Note that the overlay 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 = Ti.Media.createVideoPlayer({
height : 300,
width : 300,
overlayView : Ti.UI.createView({
backgroundImage: 'videoPlayerBG.png
width : 300,
height : 300
}),
borderRadius : 20,
borderWidth : 2,
borderColor : 'blue',
});
When on, animate call overrides current animation if applicable.
If this property is set to false, the animate call is ignored if the view is currently being animated.
Default: undefined but behaves as false
Whether or not the receiver allows Picture in Picture playback.
Requires: iOS 9.0 and later
Default: true
Currently playable duration of the movie, in milliseconds, for progressively downloaded network content, or 0.0 if not known.
On Android, this is always the same as duration.
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.
This API can be assigned the following constants:
Boolean to indicate if the player has started playing.
Boolean to indicate if the player has started playing.
The preview context used in the 3D-Touch feature "Peek and Pop".
Requires: iOS 9.0 and later
Preview context to present the "Peek and Pop" of a view. Use an configured instance of Titanium.UI.iOS.PreviewContext here.
Note: This property can only be used on devices running iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using Titanium.UI.iOS.forceTouchSupported.
Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.TableView.headerPullView.
Default: Undefined. Results in a light grey background color on the wrapper view.
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
).
On Android it will also return rect.absoluteX
and 'rect.absoluteY' which are relative to
the main window.
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 how the movie player repeats when reaching the end of playback.
This API can be assigned the following constants:
Default: Titanium.Media.VIDEO_REPEAT_MODE_NONE
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.
Clockwise 2D rotation of the view in degrees.
Clockwise 2D rotation of the view in degrees.
Translation values are applied to the static post layout value.
Clockwise rotation of the view in degrees (x-axis).
Clockwise rotation of the view in degrees (x-axis).
Translation values are applied to the static post layout value.
Clockwise rotation of the view in degrees (y-axis).
Clockwise rotation of the view in degrees (y-axis).
Translation values are applied to the static post layout value.
Scaling of the view in x-axis in pixels.
Scaling of the view in x-axis in pixels.
Translation values are applied to the static post layout value.
Scaling of the view in y-axis in pixels.
Scaling of the view in y-axis in pixels.
Translation values are applied to the static post layout value.
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.
This API can be assigned the following constants:
Whether or not the receiver shows playback controls. Default is YES.
Clients can set this property to NO when they don't want to have any playback controls on top of the visual content (e.g. for a game splash screen). This property should not be used to temporarily change the visibility of the playback controls since it will create or destroy UI elements.
Default: true
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.
This API can be assigned the following constants:
Default: Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS
The playback type of the movie.
This property has been removed since 7.0.0
This method has been removed in Titanium SDK 7.0.0 as of the official deprecation by Apple.
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.
This API can be assigned the following constants:
Default: Titanium.Media.VIDEO_SOURCE_TYPE_UNKNOWN
The view's tintColor. This property is applicable on iOS 7 and greater.
Requires: iOS 7.0 and later
This property is a direct correspondant of the tintColor property of UIView on iOS. If no value is specified, the tintColor of the View is inherited from its superview.
Default:
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.
If false, will forward the events to peers.
Default: true
A material design visual construct that provides an instantaneous visual confirmation of touch point.
Requires: Android 5.0 and later
This is an opt-in feature available from Android Lollipop. Touch feedback is applied only if the backgroundColor is a solid color.
Default: false
Optional touch feedback ripple color. This has no effect unless touchFeedback
is true.
Requires: Android 5.0 and later
Default: Theme provided color.
Transformation matrix to apply to the view.
Android only supports 2DMatrix transforms.
Default: Identity matrix
A name to identify this view in activity transition.
Requires: Android 5 and later
Name should be unique in the View hierarchy.
Horizontal location of the view relative to its left position in pixels.
Horizontal location of the view relative to its left position in pixels.
Translation values are applied to the static post layout value.
Vertical location of the view relative to its top position in pixels.
Vertical location of the view relative to its top position in pixels.
Translation values are applied to the static post layout value.
Depth of the view relative to its elevation in pixels.
Requires: Android 5 and later
Translation values are applied to the static post layout value.
URL of the media to play.
URL of the media to play.
URL identifying a local or remote video to play.
Indicates if the movie player should inherit the application's audio session instead of creating a new session.
deprecated
3.5.0 There is no replacement for this property and its use is discouraged.
Requires: iOS 6.0 and earlier
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
Determines the color of the shadow.
Default: Undefined. Behaves as if transparent.
Determines the offset for the shadow of the view.
Default: Undefined. Behaves as if set to (0,-3)
Determines the blur radius used to create the shadow.
Default: Undefined. Behaves as if set to 3.
Determines whether the view is visible.
Default: true
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
View's width, in platform-specific units.
View's width, in platform-specific units.
Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.
Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:
SIZE
or
FILL
constants if it is necessary to set the view's behavior explicitly.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.
This API can be assigned the following constants:
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.
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:
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.
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
, NavigationWindow
and SplitWindow
objects are
special containers that manage windows. These are discussed in the
"Top-Level Containers" section.
There are certain top-level containers that are not intended to be added as the children of other views. These top-level containers include Titanium.UI.Window, Titanium.UI.iPad.SplitWindow, Titanium.UI.iOS.NavigationWindow, and Titanium.UI.TabGroup. Other types of views must be added to a top-level container in order to be displayed on screen.
The special containers Titanium.UI.iOS.NavigationWindow,
Titanium.UI.iPad.SplitWindow, Titanium.UI.Tab, and
Titanium.UI.TabGroup manage windows.
These managed windows may be referred to as children of the
container, but they are not added using the add
method.
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.
View to add to this view's hierarchy.
You may pass an array of views, e.g. view.add([subview1, subview2]
.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
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.
Either a dictionary of animation properties or an Animation object.
Function to be invoked upon completion of the animation.
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
A dictionary of properties to apply.
Cancels all pending asynchronous thumbnail requests.
Asynchronous thumbnail requests initiated with requestThumbnailImagesAtTimes.
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.
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.
View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.
Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.
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.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Gets the value of the backgroundView property.
deprecated since 7.0.0
Use <Titanium.Media.VideoPlayer.overlayView> instead.
Gets the value of the contentURL property.
This method has been removed since 3.0.0
Use <Titanium.Media.VideoPlayer.url> instead.
Gets the value of the fullscreen property.
This method has been removed since 7.0.0
This method has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.
Gets the value of the loadState property.
deprecated since 7.0.0
On iOS, use <Titanium.Media.VideoPlayer.moviePlayerStatus> instead.
Gets the value of the mediaControlStyle property.
This method has been removed since 7.0.0
On iOS, use <Titanium.Media.VideoPlayer.showsControls> instead.
Gets the value of the movieControlMode property.
This method has been removed since 6.0.0
Use <Titanium.Media.VideoPlayer.mediaControlStyle> instead.
Gets the value of the sourceType property.
This method has been removed since 7.0.0
This method has been removed in Titanium SDK 7.0.0 as of the official deprecation by Apple.
Gets the value of the useApplicationAudioSession property.
deprecated since 3.5.0
There is no replacement for this property and its use is discouraged.
Returns the matching view of a given view ID.
The ID of the view that should be returned. Use the id
property in your views to
enable it for indexing in this method.
Hides this view.
Animation options for Android. Since Release 5.1.0.
Inserts a view at the specified position in the children array.
Useful if the layout
property is set to horizontal
or vertical
.
Pass an object with the following key-value pairs:
view
(Titanium.UI.View): View to insertposition
(Number): Position in the children array to
insert the view. If omitted, inserts the view to the end of the array.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.
Removes a child view from this view's hierarchy.
View to remove from this view's hierarchy.
Removes all child views from this view's hierarchy.
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);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener
.
Replaces a view at the specified position in the children array.
Useful if the layout
property is set to horizontal
or vertical
.
Pass an object with the following key-value pairs:
view
(Titanium.UI.View): View to insertposition
(Number): Position in the children array of
the view elment to replace.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.
Array of time values, representing offsets into the video, in seconds.
Video time precision.
This API can be assigned the following constants:
Callback to invoke when a thumbnail is available.
Sets the value of the accessibilityHidden property.
New value for the property.
Sets the value of the accessibilityHint property.
New value for the property.
Sets the value of the accessibilityLabel property.
New value for the property.
Sets the value of the accessibilityValue property.
New value for the property.
Sets the value of the allowsAirPlay property.
New value for the property.
Sets the value of the anchorPoint property.
New value for the property.
Sets the value of the autoplay property.
New value for the property.
Sets the value of the backgroundColor property.
New value for the property.
Sets the value of the backgroundDisabledColor property.
New value for the property.
Sets the value of the backgroundDisabledImage property.
New value for the property.
Sets the value of the backgroundFocusedColor property.
New value for the property.
Sets the value of the backgroundFocusedImage property.
New value for the property.
Sets the value of the backgroundGradient property.
New value for the property.
Sets the value of the backgroundImage property.
New value for the property.
Sets the value of the backgroundLeftCap property.
New value for the property.
Sets the value of the backgroundRepeat property.
New value for the property.
Sets the value of the backgroundSelectedColor property.
New value for the property.
Sets the value of the backgroundSelectedImage property.
New value for the property.
Sets the value of the backgroundTopCap property.
New value for the property.
Sets the value of the backgroundView property.
deprecated since 7.0.0
Use <Titanium.Media.VideoPlayer.overlayView> instead.
New value for the property.
Sets the value of the borderColor property.
New value for the property.
Sets the value of the borderRadius property.
New value for the property.
Sets the value of the borderWidth property.
New value for the property.
Sets the value of the bottom property.
New value for the property.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the clipMode property.
New value for the property.
Sets the value of the contentURL property.
This method has been removed since 3.0.0
Use <Titanium.Media.VideoPlayer.url> instead.
New value for the property.
Sets the value of the currentPlaybackTime property.
New value for the property.
Sets the value of the duration property.
New value for the property.
Sets the value of the elevation property.
New value for the property.
Sets the value of the endPlaybackTime property.
New value for the property.
Sets the value of the focusable property.
New value for the property.
Sets the value of the fullscreen property.
This method has been removed since 7.0.0
This method has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.
New value for the property.
Sets the value of the height property.
New value for the property.
Sets the value of the hiddenBehavior property.
New value for the property.
Sets the value of the horizontalWrap property.
New value for the property.
Sets the value of the initialPlaybackTime property.
New value for the property.
Sets the value of the keepScreenOn property.
New value for the property.
Sets the value of the layout property.
New value for the property.
Sets the value of the left property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the value of the media property.
New value for the property.
Sets the value of the mediaControlStyle property.
This method has been removed since 7.0.0
On iOS, use <Titanium.Media.VideoPlayer.showsControls> instead.
New value for the property.
Sets the value of the mediaTypes property.
New value for the property.
Sets the value of the movieControlMode property.
This method has been removed since 6.0.0
Use <Titanium.Media.VideoPlayer.mediaControlStyle> instead.
New value for the property.
Sets the value of the naturalSize property.
New value for the property.
Sets the value of the opacity property.
New value for the property.
Sets the value of the overlayView property.
New value for the property.
Sets the value of the overrideCurrentAnimation property.
New value for the property.
Sets the value of the pictureInPictureEnabled property.
New value for the property.
Sets the value of the previewContext property.
New value for the property.
Sets the value of the pullBackgroundColor property.
New value for the property.
Sets the value of the repeatMode property.
New value for the property.
Sets the value of the right property.
New value for the property.
Sets the value of the rotation property.
New value for the property.
Sets the value of the rotationX property.
New value for the property.
Sets the value of the rotationY property.
New value for the property.
Sets the value of the scaleX property.
New value for the property.
Sets the value of the scaleY property.
New value for the property.
Sets the value of the scalingMode property.
New value for the property.
Sets the value of the showsControls property.
New value for the property.
Sets the value of the softKeyboardOnFocus property.
New value for the property.
Sets the value of the sourceType property.
This method has been removed since 7.0.0
This method has been removed in Titanium SDK 7.0.0 as of the official deprecation by Apple.
New value for the property.
Sets the value of the tintColor property.
New value for the property.
Sets the value of the top property.
New value for the property.
Sets the value of the touchEnabled property.
New value for the property.
Sets the value of the touchFeedback property.
New value for the property.
Sets the value of the touchFeedbackColor property.
New value for the property.
Sets the value of the transform property.
New value for the property.
Sets the value of the transitionName property.
New value for the property.
Sets the value of the translationX property.
New value for the property.
Sets the value of the translationY property.
New value for the property.
Sets the value of the translationZ property.
New value for the property.
Sets the value of the url property.
New value for the property.
Sets the value of the useApplicationAudioSession property.
deprecated since 3.5.0
There is no replacement for this property and its use is discouraged.
New value for the property.
Sets the value of the viewShadowColor property.
New value for the property.
Sets the value of the viewShadowOffset property.
New value for the property.
Sets the value of the viewShadowRadius property.
New value for the property.
Sets the value of the visible property.
New value for the property.
Sets the value of the volume property.
New value for the property.
Sets the value of the width property.
New value for the property.
Sets the value of the zIndex property.
New value for the property.
Makes this view visible.
Animation options for Android. Since Release 5.1.0.
Starts a batch update of this view's layout properties.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update 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.
See also: updateLayout, finishLayout, postlayout event.
Returns a thumbnail image for the video at the specified time.
This method has been removed since 3.6.0
Use <Titanium.Media.VideoPlayer.requestThumbnailImagesAtTimes> instead.
Playback time, in seconds.
Video time precision.
This API can be assigned the following constants:
Returns an image of the rendered view, as a Blob.
The honorScaleFactor
method is only supported on iOS.
Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.
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.
Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated.
deprecated since 3.0.0
Use the <Titanium.Proxy.applyProperties> method to batch-update layout properties.
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.
Layout properties to be updated.
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.
Y coordinate of the event from the source
view's coordinate system.
X coordinate of the event from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.click
Fired when movie playback ends or a user exits playback.
On iOS, the reason
property is only included if this information is available.
Reason that playback ended.
This API can be assigned the following constants:
Indicates if the video was played successfully. User exit counts as a success.
Returns true
if reason
is not
VIDEO_FINISH_REASON_PLAYBACK_ERROR,
false
otherwise.
Error message, if any returned. Will be undefined if success
is true
.
Error code.
Error code will be 0 if success
is true
, nonzero otherwise. If the error
was generated by the operating system, that system's error value is used.
Otherwise, this value will be -1.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a double click against the view.
X coordinate of the event from the source
view's coordinate system.
Y coordinate of the event from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a double tap against the view.
X coordinate of the event from the source
view's coordinate system.
Y coordinate of the event from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the video duration is available.
deprecated since 3.0.0
Use <Titanium.Media.VideoPlayer.durationavailable> instead.
Video duration, in milliseconds.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when movie playback encounters an error.
Reason for error as a string.
Indicates a successful operation. Returns false
.
Error message, if any returned. May be undefined.
Error code. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be -1.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a movie changes to or from fullscreen view.
This event has been removed since 7.0.0
This event has been removed in Titanium SDK 7.0.0 as of the official deprecation by Apple.
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.
true
if the player is entering fullscreen mode, false
if it is leaving
fullscreen mode.
Duration of the animated transition to or from fullscreen mode, in seconds.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when a hardware key is pressed in the view.
A keypressed event is generated by pressing a hardware key. On Android, this event can only be fired when the property focusable is set to true. On iOS the event is generated only when using Ti.UI.TextArea, Ti.UI.TextField and Ti.UI.SearchBar.
The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the movie play loads.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the network loadState changes.
Current value of the loadState property.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
X coordinate of the event from the source
view's coordinate system.
Y coordinate of the event from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the media types in the current movie are determined.
deprecated since 3.0.0
Use <Titanium.Media.VideoPlayer.mediatypesavailable> instead.
Current value of the mediaTypes property.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the media types in the current movie are determined.
This event has been removed since 7.0.0
This event has been removed in Titanium SDK 7.0.0 as of the official deprecation by Apple.
Current value of the mediaTypes property.
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the natural size of the current movie is determined.
deprecated since 3.0.0
Use <Titanium.Media.VideoPlayer.naturalsizeavailable> instead.
On iOS 6.0, this event is not fired by the operating system.
Current value of the naturalSize property.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the natural size of the current movie is determined.
On iOS 6.0, this event is not fired by the operating system.
Current value of the naturalSize property.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the playbackState changes.
deprecated since 3.0.0
Use <Titanium.Media.VideoPlayer.playbackstate> instead.
Current value of the playbackState property.
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the playbackState changes.
Current value of the playbackState property.
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the currently playing movie changes.
URL of the media.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
Note that altering any properties that affect layout from the postlayout
callback
may result in an endless loop.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the movie has preloaded and is ready to play.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the movie player is resized.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a single tap against the view.
Y coordinate of the event from the source
view's coordinate system.
X coordinate of the event from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.singletap
Fired when the sourceType property changes.
deprecated since 3.0.0
Use <Titanium.Media.VideoPlayer.sourcechange> instead.
New sourceType
value.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the sourceType property changes.
This event has been removed since 7.0.0
This event has been removed in Titanium SDK 7.0.0 as of the official deprecation by Apple.
New sourceType
value.
This API can be assigned the following constants:
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a swipe gesture against the view.
Direction of the swipe--either 'left', 'right', 'up', or 'down'.
X coordinate of the event's endpoint from the source
view's coordinate system.
Y coordinate of the event's endpoint from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
Y coordinate of the event from the source
view's coordinate system.
X coordinate of the event from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.touchcancel
Fired when a touch event is completed.
On the Android platform, other gesture events, such as longpress
or swipe
, cancel touch events,
so this event may not be triggered after a touchstart
event.
Y coordinate of the event from the source
view's coordinate system.
X coordinate of the event from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.touchend
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
Y coordinate of the event from the source
view's coordinate system.
X coordinate of the event from the source
view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.touchmove
Fired as soon as the device detects a touch gesture.
X coordinate of the event from the source
view's coordinate system.
Y coordinate of the event from the source
view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.