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.

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.

iOS Implementation Notes

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.

Android Implementation Notes

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.

Extends: Titanium.UI.View · Since: 0.9

Properties #

accessibilityDisableLongPress#

extendedcreation only

Type: Boolean

Boolean value to remove the long press notification for the device's accessibility service.

Will disable the "double tap and hold for long press" message when selecting an item.

accessibilityHidden#

extended

Type: Boolean

Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.

On iOS this is a direct analog of the accessibilityElementsHidden property defined in the
UIAccessibility Protocol.

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.

accessibilityHint#

extended

Type: String

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
Titanium.UI.View.accessibilityLabel and Titanium.UI.View.accessibilityValue in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.

accessibilityLabel#

extended

Type: String

A succinct 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
Titanium.UI.View.accessibilityValue and Titanium.UI.View.accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Defaults to Title or label of the control.

accessibilityValue#

extended

Type: String

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
Titanium.UI.View.accessibilityLabel and Titanium.UI.View.accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Defaults to State or value of the control.

allowsAirPlay#

Type: Boolean

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

anchorPoint#

extended

Type: Point

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.
The default is center of this view.

animatedCenter#

extended

Type: Point

Current position of the view during an animation.

apiName#

extended

Type: String

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.

autoHide#

Type: Boolean

Indicates if player is hidden by default and shown when its ready.

On Android the background of the video player is set to the primary background color.
When switching on autoHide it will hide the player until the video is loaded.
Then it will automatically show the player. In a Titanium.UI.ListView it will hide
it again when it is outside the viewport.

autoplay#

Type: Boolean

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).

backgroundColor#

extended

Type: String, Titanium.UI.Color

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

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

backgroundDisabledColor#

extended

Type: String

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.
Defaults to the normal background color of this view.

backgroundDisabledImage#

extended

Type: String

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

If backgroundDisabledImage is undefined, and the normal background imagebackgroundImage
is set, the normal image is used when this view is disabled.

backgroundFocusedColor#

extended

Type: String

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.
Defaults to the normal background color of this view.

backgroundFocusedImage#

extended

Type: String

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.
If backgroundFocusedImage is undefined, and the normal background image backgroundImage
is set, the normal image is used when this view is focused.

backgroundGradient#

extended

Type: Gradient

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 points, 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.
Defaults to no gradient.

backgroundImage#

extended

Type: String

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

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, textfields, and so on), platform-specific default images are used.

backgroundLeftCap#

extended

Type: Number

Size of the left end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

backgroundRepeat#

extended

Type: Boolean

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:

backgroundSelectedColor#

extended

Type: String, Titanium.UI.Color

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.
Defaults to transparent, so the background color of this view will be used.

backgroundSelectedImage#

extended

Type: String

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.

If backgroundSelectedImage is undefined, and the normal background image backgroundImage is set
the normal image is used when this view is selected.

backgroundTopCap#

extended

Type: Number

Size of the top end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

backgroundView (deprecated)#

Type: Titanium.UI.View

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 = 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_RESIZE or
VIDEO_SCALING_RESIZE_ASPECT_FILL,
the playing video will fill the entire video player area, obscuring any background
view.

borderColor#

extended

Type: String, Titanium.UI.Color

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

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

Defaults to the normal background color of this view (Android), black (iOS).

borderRadius#

extended

Type: Number, String, Array<Number>, Array<String>

Radius for the rounded corners of the view's border.

Each corner is rounded using an arc of a circle.
Values for each corner can be specified. For example, '20px 20px' will set both left and right corners to 20px.
Specifying '20px 20px 20px 20px' will set top-left, top-right, bottom-right and bottom-left corners in that order.

If you have issues with dark artifacts on Android you can try to disable Hardware acceleration by setting a
backgroundColor with a small amount of transparency: backgroundColor:"rgba(255,255,255,254)".

borderWidth#

extended

Type: Number

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.

bottom#

extended

Type: Number, String

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.

Defaults to undefined.

bubbleParent#

extended

Type: Boolean

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.

center#

extended

Type: Point

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.

Defaults to undefined.

children#

extended

Type: Array<Titanium.UI.View>

Array of this view's child views.

clipMode#

extended

Type: Number

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.

Defaults to undefined. Behaves as if set to Titanium.UI.iOS.CLIP_MODE_DEFAULT.

currentPlaybackTime#

Type: Number

Current playback time of the current movie in milliseconds.

duration#

Type: Number

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.

elevation#

extended

Type: Number

Base elevation of the view relative to its parent in pixels.

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.

endPlaybackTime#

Type: Number

The end time of movie playback, in milliseconds.

On iOS, defaults to 0, 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 0 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.

fairPlayConfiguration#

creation only

Type: FairPlayConfiguration

Handle DRM-encrypted video assets using the Apple FairPlay Streaming API.

Secure the delivery of streaming media to devices through the HTTP Live Streaming (HLS) protocol. Using FairPlay Streaming (FPS) technology, content providers, encoding vendors, and delivery networks can encrypt content, securely exchange keys, and protect playback on iOS, iPadOS and macOS.

filterTouchesWhenObscured#

extended

Type: Boolean

Discards touch related events if another app's system overlay covers the view.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a
system overlay to intercept touch events in your app or to trick the end-user to tap on UI
in your app intended for the overlay.

Setting this property to true causes touch related events (including "click") to not be fired
if a system overlay overlaps the view.

focusable#

extended

Type: Boolean

Whether view should be focusable while navigating with the trackball.

fullscreen (deprecated)#

creation only

Type: Boolean

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 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.

This property was removed on iOS in SDK 7.0.0

height#

extended

Type: Number, String

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:

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.

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.

hiddenBehavior#

extended

Type: Number

Sets the behavior when hiding an object to release or keep the free space

If setting hiddenBehavior to Titanium.UI.HIDDEN_BEHAVIOR_GONE it will automatically release the space the view occupied.
For example: in a vertical layout the views below the object will move up when you hide
an object with hiddenBehavior:Titanium.UI.HIDDEN_BEHAVIOR_GONE.

Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE. Keeps the space and just hides the object (default).
Titanium.UI.HIDDEN_BEHAVIOR_GONE. Releases the space and hides the object.

Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.

horizontalMotionEffect#

extended

Type: MinMaxOptions

Adds a horizontal parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator.
To clear all motion effects, use the Titanium.UI.clearMotionEffects method.

horizontalWrap#

extended

Type: Boolean

Determines whether the layout has wrapping behavior.

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

id#

extended

Type: String

View's identifier.

The id property of the Ti.UI.View represents the view's identifier. The identifier string does
not have to be unique. You can use this property with Titanium.UI.View.getViewById method.

initialPlaybackTime#

Type: Number

The start time of movie playback, in milliseconds.

keepHardwareMode#

extended

Type: Boolean

A value indicating the render mode of the View

Set to true to keep hardware mode when using a border and transparent backgrounds.

keepScreenOn#

extended

Type: Boolean

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.
For iOS look at Titanium.App.idleTimerDisabled.

layout#

extended

Type: String

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.)

<table class="doc-table">
<thead>
<tr>
<th>Scenario</th>
<th>Behavior</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>height</code> & <code>top</code> specified</td>
<td>
Child positioned <code>top</code> unit from parent's top, using specified <code>height</code>;
any <code>center.y</code> and <code>bottom</code> values are ignored.
</td>
</tr>
<tr>
<td><code>height</code> & <code>center.y</code> specified</td>
<td>
Child positioned with center at <code>center.y</code>, using specified <code>height</code>;
any <code>bottom</code> value is ignored.
</td>
</tr>
<tr>
<td><code>height</code> & <code>bottom</code> specified</td>
<td>Child positioned <code>bottom</code> units from parent's bottom, using specified <code>height</code>.</td>
</tr>
<tr>
<td><code>top</code> & <code>center.y</code> specified</td>
<td>
Child positioned with top edge <code>top</code> units from parent's top and center at
<code>center.y</code>. Height is determined implicitly; any <code>bottom</code> value is ignored.
</td>
</tr>
<tr>
<td><code>top</code> & <code>bottom</code> specified</td>
<td>
Child positioned with top edge <code>top</code> units from parent's top and bottom edge
<code>bottom</code> units from parent's bottom. Height is determined implicitly.
</td>
</tr>
<tr>
<td>Only <code>top</code> specified</td>
<td>
Child positioned <code>top</code> units from parent's top, and uses the default height
calculation for the view type.
</td>
</tr>
<tr>
<td><code>center.y</code> and <code>bottom</code> specified</td>
<td>
Child positioned with center at <code>center.y</code> and bottom edge <code>bottom</code>
units from parent's bottom. Height is determined implicitly.
</td>
</tr>
<tr>
<td>Only <code>center.y</code> specified</td>
<td>Child positioned with center at <code>center.y</code>, and uses the default height calculation for the view type.</td>
</tr>
<tr>
<td>Only <code>bottom</code> specified</td>
<td>Child positioned with bottom edge <code>bottom</code> units from parent's bottom, and uses the default height calculation for the view type.</td>
</tr>
<tr>
<td><code>height</code>, <code>top</code>, <code>center.y</code>, and <code>bottom</code> unspecified</td>
<td>Child entered vertically in the parent and uses the default height calculation for the child view type.</td>
</tr>
</tbody>
</table>

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. 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.

Defaults to Composite layout.

left#

extended

Type: Number, String

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.

Defaults to undefined.

lifecycleContainer#

extended

Type: Titanium.UI.Window, Titanium.UI.TabGroup

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.

loadState (deprecated)#

Type: Number

Returns the network load state of the movie player.

media#

Type: Titanium.Blob, Titanium.Filesystem.File, String

Media object to play, as either a Ti.Filesystem.File, a Ti.Blob, or an URL String.

mediaControlStyle (deprecated)#

Type: Number

The style of the playback controls.

Removed from iOS in SDK 7.0.0

mediaTypes#

Type: String

The type of media in the player's current item first track.

moviePlayerStatus#

Type: Number

Returns the status of the movie player.

naturalSize#

Type: MovieSize

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#

extended

Type: Number

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

overlayView#

Type: Titanium.UI.View

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',
});

overrideCurrentAnimation#

extendedcreation only

Type: Boolean

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.

Defaults to undefined but behaves as false

pictureInPictureEnabled#

Type: Boolean

Whether or not the receiver allows Picture in Picture playback.

playableDuration#

Type: Number

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.

playbackState#

Type: Number

Current playback state of the video player.

One of the VIDEO_PLAYBACK_STATE constants defined in Titanium.Media.

playing#

Type: Boolean

Boolean to indicate if the player has started playing.

previewContext#

extended

Type: Titanium.UI.iOS.PreviewContext

The preview context used in the 3D-Touch feature "Peek and Pop".

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 iOS 9 or later and supporting 3D-Touch.
It is ignored on older devices and can manually be checked using Titanium.UI.iOS.forceTouchSupported.

pullBackgroundColor#

extended

Type: String, Titanium.UI.Color

Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.TableView.headerPullView.

Defaults to undefined. Results in a light grey background color on the wrapper view.

rect#

extended

Type: DimensionWithAbsolutes

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.

repeatMode#

Type: Number

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

right#

extended

Type: Number, String

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.

Defaults to undefined.

rotation#

extended

Type: Number

Clockwise 2D rotation of the view in degrees.

Translation values are applied to the static post layout value.

rotationX#

extended

Type: Number

Clockwise rotation of the view in degrees (x-axis).

Translation values are applied to the static post layout value.

rotationY#

extended

Type: Number

Clockwise rotation of the view in degrees (y-axis).

Translation values are applied to the static post layout value.

scaleX#

extended

Type: Number

Scaling of the view in x-axis in pixels.

Translation values are applied to the static post layout value.

scaleY#

extended

Type: Number

Scaling of the view in y-axis in pixels.

Translation values are applied to the static post layout value.

scalingMode#

Type: Number

Determines how the content scales to fit the view.

showsControls#

Type: Boolean

Whether or not the receiver shows playback controls. Default is true.

Clients can set this property to false 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.

size#

extended

Type: Dimension

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.

softKeyboardOnFocus#

extended

Type: Number

Determines keyboard behavior when this view is focused. Defaults to Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS.

speed#

creation only

Type: Number

Playback speed of the video.

Playback speed of the video. Android: only available for API level >= 23.

tintColor#

extended

Type: String, Titanium.UI.Color

The view's tintColor

This property is a direct correspondent of the tintColor property of UIView on iOS. If no value is specified,
the tintColor of the View is inherited from its superview.

extended

Type: String

The default text to display in the control's tooltip.

Assigning a value to this property causes the tool tip to be displayed for the view.
Setting the property to null cancels the display of the tool tip for the view.
Note: This property is only used for apps targeting macOS Catalyst.

top#

extended

Type: Number, String

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.

touchEnabled#

extended

Type: Boolean

Determines whether view should receive touch events.

If false, will forward the events to peers.

touchFeedback#

extended

Type: Boolean

A material design visual construct that provides an instantaneous visual confirmation of touch point.

Touch feedback is only applied to a view's background. It is never applied to the view's foreground content
such as a Titanium.UI.ImageView's image.

For Titanium versions older than 9.1.0, touch feedback only works if you set the
Titanium.UI.View.backgroundColor property to a non-transparent color.

touchFeedbackColor#

extended

Type: String

Optional touch feedback ripple color. This has no effect unless touchFeedback is true.

Defaults to provided theme color.

transform#

extended

Type: Titanium.UI.Matrix2D, Titanium.UI.Matrix3D

Transformation matrix to apply to the view.

Android only supports Matrix2D transforms.

transitionName#

extended

Type: String

A name to identify this view in activity transition.

Name should be unique in the View hierarchy.

translationX#

extended

Type: Number

Horizontal location of the view relative to its left position in pixels.

Translation values are applied to the static post layout value.

translationY#

extended

Type: Number

Vertical location of the view relative to its top position in pixels.

Translation values are applied to the static post layout value.

translationZ#

extended

Type: Number

Depth of the view relative to its elevation in pixels.

Translation values are applied to the static post layout value.

url#

Type: String

URL of the media to play.

URL identifying a local or remote video to play.

verticalMotionEffect#

extended

Type: MinMaxOptions

Adds a vertical parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator.
To clear all motion effects, use the Titanium.UI.clearMotionEffects method.

viewShadowColor#

extended

Type: String, Titanium.UI.Color

Determines the color of the shadow.

iOS Defaults to undefined. Behaves as if transparent. Android default is black.
On Android you can set <item name="android:ambientShadowAlpha">0.5</item> and
<item name="android:spotShadowAlpha">0.5</item> in your theme to change the
opacity.

viewShadowOffset#

extended

Type: Point

Determines the offset for the shadow of the view.

Defaults to undefined. Behaves as if set to (0,-3)

viewShadowRadius#

extended

Type: Number, String

Determines the blur radius used to create the shadow.

Defaults to undefined. Behaves as if set to 3. Accepts density units as of 10.0.1.

visible#

extended

Type: Boolean

Determines whether the view is visible.

volume#

Type: Number

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.

width#

extended

Type: Number, String

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:

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.

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.

zIndex#

extended

Type: Number

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.

Defaults to undefined.

Methods #

add #

extended

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 position 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 sections 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.

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
Titanium.UI.Window, Titanium.UI.iOS.SplitWindow, Titanium.UI.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.NavigationWindow,
Titanium.UI.iOS.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.

Parameters:

Name	Type	Summary	Optional
`view`	`Titanium.UI.View, Array<Titanium.UI.View>`	View to add to this view's hierarchy. You may pass an array of views, e.g. `view.add([subview1, subview2]`.	No

addEventListener #

extended

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

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to invoke when the event is fired.	No

animate #

extended

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 on SDKs older than 9.1.0 - 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.

As of SDK 9.1.0, the final values of the animation will be set on the view just before the complete event and/or the callback is fired.

The rect property can be used to determine the actual size and
position of the view.

Parameters:

Name	Type	Summary	Optional
`animation`	`Titanium.UI.Animation, Dictionary<Titanium.UI.Animation>`	Either a dictionary of animation properties or an Animation object.	No
`callback`	`Callback<Object>`	Function to be invoked upon completion of the animation.	Yes

applyProperties #

extended

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.

Parameters:

Name	Type	Summary	Optional
`props`	`Dictionary`	A dictionary of properties to apply.	No

cancelAllThumbnailImageRequests #

Cancels all pending asynchronous thumbnail requests.

Asynchronous thumbnail requests initiated with
requestThumbnailImagesAtTimes.

clearMotionEffects #

extended

Removes all previously added motion effects.

Use this method together with Titanium.UI.horizontalMotionEffect and Titanium.UI.verticalMotionEffect.

convertPointToView #

extended

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.

Parameters:

Name	Type	Summary	Optional
`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.	No
`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.	No

Returns: Point

fireEvent #

extended

Fires a synthesized event to any registered listeners.

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`event`	`Dictionary`	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.	Yes

getViewById #

extended

Returns the matching view of a given view ID.

Parameters:

Name	Type	Summary	Optional
`id`	`String`	The ID of the view that should be returned. Use the `id` property in your views to enable it for indexing in this method.	No

Returns: Titanium.UI.View

hide #

extended

Hides this view.

Parameters:

Name	Type	Summary	Optional
`options`	`AnimatedOptions`	Animation options for Android only. Since SDK 5.1.0 and used only on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in `{ animated: false }`	Yes

insertAt #

extended

Inserts a view at the specified position in the children array.

Useful if the layout property is set to horizontal or vertical.

Parameters:

Name	Type	Summary	Optional
`params`	`ViewPositionOptions`	Pass an object that specifies the view to insert and optionally at which position (defaults to end)	No

pause #

Pauses playing the video.

play #

Starts playing the video.

release #

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.

remove #

extended

Removes a child view from this view's hierarchy.

Parameters:

Name	Type	Summary	Optional
`view`	`Titanium.UI.View`	View to remove from this view's hierarchy.	No

removeAllChildren #

extended

Removes all child views from this view's hierarchy.

removeEventListener #

extended

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	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to remove. Must be the same function passed to `addEventListener`.	No

replaceAt #

extended

Replaces a view at the specified position in the children array.

Useful if the layout property is set to horizontal or vertical.

Parameters:

Name	Type	Summary	Optional
`params`	`ViewPositionOptions`	Pass an object with the view to insert and the position of the view to replace. In this case the `position` property is required.	No

requestThumbnailImagesAtTimes #

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.

Parameters:

Name	Type	Summary	Optional
`times`	`Array<Number>`	Array of time values, representing offsets into the video, in seconds.	No
`option`	`Number`	Video time precision.	No
`callback`	`Callback<ThumbnailResponse>`	Callback to invoke when a thumbnail is available.	No

show #

extended

Makes this view visible.

Parameters:

Name	Type	Summary	Optional
`options`	`AnimatedOptions`	Animation options for Android only. Since SDK 5.1.0 and only used on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in `{ animated: false }`	Yes

stop #

Stops playing the video.

stopAnimation #

extended

Stops a running animation.

Stops a running view Animation.

toImage #

extended

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

The honorScaleFactor argument is only supported on iOS.

Parameters:

Name	Type	Summary	Optional
`callback`	`Callback<Titanium.Blob>`	Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.	Yes
`honorScaleFactor`	`Boolean`	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.	Yes

Returns: Titanium.Blob

Events #

click #

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.

Event Properties:

Name	Type	Summary
`y`	`Number`	Y coordinate of the event from the `source` view's coordinate system.
`x`	`Number`	X coordinate of the event from the `source` view's coordinate system.

complete #

Fired when movie playback ends or a user exits playback.

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

Event Properties:

Name	Type	Summary
`reason`	`Number`	Reason that playback ended.
`success`	`Boolean`	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`	`String`	Error message, if any returned. Will be undefined if `success` is `true`.
`code`	`Number`	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.

dblclick #

extended

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

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the double click passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

doubletap #

extended

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

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the double tap passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

durationavailable #

Fired when the video duration is available.

Event Properties:

Name	Type	Summary
`duration`	`Number`	Video duration, in milliseconds.

error #

Fired when movie playback encounters an error.

Event Properties:

Name	Type	Summary
`message`	`String`	Reason for error as a string.
`success`	`Boolean`	Indicates a successful operation. Returns `false`.
`error`	`String`	Error message, if any returned. May be `undefined`.
`code`	`Number`	Error code. If the error was generated by the operating system, that system's error value is used. Otherwise, this value will be `-1`.

keypressed #

extended

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.

Event Properties:

Name	Type	Summary
`keyCode`	`Number`	The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.

load #

Fired when the movie play loads.

loadstate #

Fired when the network loadState changes.

Event Properties:

Name	Type	Summary
`loadState`	`Number`	Current value of the loadState property.

longpress #

extended

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.

Event Properties:

Name	Type	Summary
`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.
`obscured`	`Boolean`	Returns `true` if the long press passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

naturalsizeavailable #

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

Event Properties:

Name	Type	Summary
`naturalSize`	`Number`	Current value of the naturalSize property.

playbackstate #

Fired when the playbackState changes.

Event Properties:

Name	Type	Summary
`playbackState`	`Number`	Current value of the playbackState property.

playing #

Fired when the currently playing movie changes.

Event Properties:

Name	Type	Summary
`url`	`String`	URL of the media.

postlayout #

extended

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.

preload #

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

resize #

Fired when the movie player is resized.

rotate #

extended

Fired when the device detects a two finger rotation.

This event is fired when doing a two finger rotation and returning the angle.
The event occurs continuously until a finger is lifted again.

Event Properties:

Name	Type	Summary
`rotate`	`Number`	Rotation in degrees.

singletap #

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

Event Properties:

Name	Type	Summary
`y`	`Number`	Y coordinate of the event from the `source` view's coordinate system.
`x`	`Number`	X coordinate of the event from the `source` view's coordinate system.

swipe #

extended

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

Event Properties:

Name	Type	Summary
`direction`	`String`	Direction of the swipe--either 'left', 'right', 'up', or 'down'.
`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.
`obscured`	`Boolean`	Returns `true` if the swipe passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

touchcancel #

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.

Event Properties:

Name	Type	Summary
`y`	`Number`	Y coordinate of the event from the `source` view's coordinate system.
`x`	`Number`	X coordinate of the event from the `source` view's coordinate system.

touchend #

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.

Event Properties:

Name	Type	Summary
`y`	`Number`	Y coordinate of the event from the `source` view's coordinate system.
`x`	`Number`	X coordinate of the event from the `source` view's coordinate system.

touchmove #

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

Event Properties:

Name	Type	Summary
`y`	`Number`	Y coordinate of the event from the `source` view's coordinate system.
`x`	`Number`	X coordinate of the event from the `source` view's coordinate system.

touchstart #

extended

Fired as soon as the device detects a touch gesture.

Event Properties:

Name	Type	Summary
`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.
`force`	`Number`	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.
`size`	`Number`	The current size of the touch area. Note: This property is only available on some Android devices.
`maximumPossibleForce`	`Number`	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.
`altitudeAngle`	`Number`	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.
`timestamp`	`Number`	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.
`azimuthUnitVectorInViewX`	`Number`	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.
`azimuthUnitVectorInViewY`	`Number`	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.
`obscured`	`Boolean`	Returns `true` if the touch passed through an overlapping window belonging to another app. This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

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_RESIZE_ASPECT
});

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.

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

// 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_RESIZE_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();

Alloy XML Markup

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>

Notificationchannels

Launchoptionstype

Notificationparams

Usernotificationattachment

Usernotificationsettings

Mediascannerresponse

Clipboarditemstype

Systemimageparameters

Titanium.Media.VideoPlayer ​

iOS Implementation Notes ​

Android Implementation Notes ​

Properties #

accessibilityDisableLongPress#

accessibilityHidden#

accessibilityHint#

accessibilityLabel#

accessibilityValue#

allowsAirPlay#

anchorPoint#

animatedCenter#

apiName#

autoHide#

autoplay#

backgroundColor#

backgroundDisabledColor#

backgroundDisabledImage#

backgroundFocusedColor#

backgroundFocusedImage#

backgroundGradient#

backgroundImage#

backgroundLeftCap#

backgroundRepeat#

backgroundSelectedColor#

backgroundSelectedImage#

backgroundTopCap#

backgroundView (deprecated)#

borderColor#

borderRadius#

borderWidth#

bottom#

bubbleParent#

center#

children#

clipMode#

Titanium.Media.VideoPlayer

iOS Implementation Notes

Android Implementation Notes