Titanium.Media.VideoPlayer

Object of Titanium.Media.
Platform Since
Android 0.9
iPhone 0.9
iPad 0.9

Summary

The VideoPlayer object is returned by Titanium.Media.createVideoPlayer and is useful for playing videos.

Methods

Name Summary
add

Adds a child to this view's hierarchy.

addEventListener

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

animate

Animates this view.

cancelAllThumbnailImageRequests

Cancels all pending asynchronous thumbnail requests. (iPhone, iPad only.)

convertPointToView

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

fireEvent

Fires a synthesized event to any registered listeners.

getAllowsAirPlay

Gets the value of the allowsAirPlay property. (iPhone, iPad only.)

getAnchorPoint

Gets the value of the anchorPoint property. (iPhone, iPad only.)

getAnimatedCenterPoint

Gets the value of the animatedCenterPoint property.

getAutoplay

Gets the value of the autoplay property.

getBackgroundColor

Gets the value of the backgroundColor property.

getBackgroundDisabledColor

Gets the value of the backgroundDisabledColor property. (Android only.)

getBackgroundDisabledImage

Gets the value of the backgroundDisabledImage property. (Android only.)

getBackgroundFocusedColor

Gets the value of the backgroundFocusedColor property. (Android only.)

getBackgroundFocusedImage

Gets the value of the backgroundFocusedImage property. (Android only.)

getBackgroundGradient

Gets the value of the backgroundGradient property.

getBackgroundImage

Gets the value of the backgroundImage property.

getBackgroundLeftCap

Gets the value of the backgroundLeftCap property. (iPhone, iPad only.)

getBackgroundRepeat

Gets the value of the backgroundRepeat property. (iPhone, iPad only.)

getBackgroundSelectedColor

Gets the value of the backgroundSelectedColor property. (Android, Mobile Web only.)

getBackgroundSelectedImage

Gets the value of the backgroundSelectedImage property. (Android, Mobile Web only.)

getBackgroundTopCap

Gets the value of the backgroundTopCap property. (iPhone, iPad only.)

getBorderColor

Gets the value of the borderColor property.

getBorderRadius

Gets the value of the borderRadius property.

getBorderWidth

Gets the value of the borderWidth property.

getBottom

Gets the value of the bottom property.

getCenter

Gets the value of the center property.

getChildren

Gets the value of the children property.

getContentURL

Gets the value of the contentURL property.

getCurrentPlaybackTime

Gets the value of the currentPlaybackTime property.

getDuration

Gets the value of the duration property.

getEndPlaybackTime

Gets the value of the endPlaybackTime property.

getFocusable

Gets the value of the focusable property. (Android only.)

getFullscreen

Gets the value of the fullscreen property.

getHeight

Gets the value of the height property.

getInitialPlaybackTime

Gets the value of the initialPlaybackTime property.

getKeepScreenOn

Gets the value of the keepScreenOn property. (Android only.)

getLayout

Gets the value of the layout property.

getLeft

Gets the value of the left property.

getLoadState

Gets the value of the loadState property.

getMedia

Gets the value of the media property. (iPhone, iPad only.)

getMediaControlStyle

Gets the value of the mediaControlStyle property.

getMediaTypes

Gets the value of the mediaTypes property. (iPhone, iPad only.)

getMovieControlMode

Gets the value of the movieControlMode property. (iPhone, iPad only.)

getNaturalSize

Gets the value of the naturalSize property. (iPhone, iPad only.)

getOpacity

Gets the value of the opacity property.

getPlayableDuration

Gets the value of the playableDuration property.

getPlaybackState

Gets the value of the playbackState property.

getPlaying

Gets the value of the playing property.

getRepeatMode

Gets the value of the repeatMode property.

getRight

Gets the value of the right property.

getScalingMode

Gets the value of the scalingMode property.

getSize

Gets the value of the size property.

getSoftKeyboardOnFocus

Gets the value of the softKeyboardOnFocus property. (Android only.)

getSourceType

Gets the value of the sourceType property. (iPhone, iPad only.)

getTop

Gets the value of the top property.

getTouchEnabled

Gets the value of the touchEnabled property.

getTransform

Gets the value of the transform property.

getUrl

Gets the value of the url property.

getUseApplicationAudioSession

Gets the value of the useApplicationAudioSession property. (iPhone, iPad only.)

getVisible

Gets the value of the visible property.

getWidth

Gets the value of the width property.

getZIndex

Gets the value of the zIndex property.

hide

Hides this view.

pause

pause playing the video.

play

start playing the video

release

release 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

Removes a child view from this view's hierarchy.

removeEventListener

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

requestThumbnailImagesAtTimes

Asynchronously request thumbnails for one or more times, provided as an array of numbers (double). Fires a thumbnail event on completion. Optionally invokes the callback function passed in the method. (iPhone, iPad only.)

setAllowsAirPlay

Sets the value of the allowsAirPlay property. (iPhone, iPad only.)

setAnchorPoint

Sets the value of the anchorPoint property. (iPhone, iPad only.)

setAutoplay

Sets the value of the autoplay property.

setBackgroundColor

Sets the value of the backgroundColor property.

setBackgroundDisabledColor

Sets the value of the backgroundDisabledColor property. (Android only.)

setBackgroundDisabledImage

Sets the value of the backgroundDisabledImage property. (Android only.)

setBackgroundFocusedColor

Sets the value of the backgroundFocusedColor property. (Android only.)

setBackgroundFocusedImage

Sets the value of the backgroundFocusedImage property. (Android only.)

setBackgroundGradient

Sets the value of the backgroundGradient property.

setBackgroundImage

Sets the value of the backgroundImage property.

setBackgroundLeftCap

Sets the value of the backgroundLeftCap property. (iPhone, iPad only.)

setBackgroundRepeat

Sets the value of the backgroundRepeat property. (iPhone, iPad only.)

setBackgroundSelectedColor

Sets the value of the backgroundSelectedColor property. (Android, Mobile Web only.)

setBackgroundSelectedImage

Sets the value of the backgroundSelectedImage property. (Android, Mobile Web only.)

setBackgroundTopCap

Sets the value of the backgroundTopCap property. (iPhone, iPad only.)

setBackgroundView

A view for customization which is always displayed behind movie content. (iPhone, iPad only.)

setBorderColor

Sets the value of the borderColor property.

setBorderRadius

Sets the value of the borderRadius property.

setBorderWidth

Sets the value of the borderWidth property.

setBottom

Sets the value of the bottom property.

setCenter

Sets the value of the center property.

setContentURL

Sets the value of the contentURL property.

setCurrentPlaybackTime

Sets the value of the currentPlaybackTime property.

setDuration

Sets the value of the duration property.

setEndPlaybackTime

Sets the value of the endPlaybackTime property.

setFocusable

Sets the value of the focusable property. (Android only.)

setFullscreen

Sets the value of the fullscreen property.

setHeight

Sets the value of the height property.

setInitialPlaybackTime

Sets the value of the initialPlaybackTime property.

setKeepScreenOn

Sets the value of the keepScreenOn property. (Android only.)

setLayout

Sets the value of the layout property.

setLeft

Sets the value of the left property.

setMedia

the a non-url based media to play, either a File or Blob. (iPhone, iPad only.)

setMediaControlStyle

Sets the value of the mediaControlStyle property.

setMediaTypes

Sets the value of the mediaTypes property. (iPhone, iPad only.)

setMovieControlMode

Sets the value of the movieControlMode property. (iPhone, iPad only.)

setNaturalSize

Sets the value of the naturalSize property. (iPhone, iPad only.)

setOpacity

Sets the value of the opacity property.

setRepeatMode

Sets the value of the repeatMode property.

setRight

Sets the value of the right property.

setScalingMode

Sets the value of the scalingMode property.

setSoftKeyboardOnFocus

Sets the value of the softKeyboardOnFocus property. (Android only.)

setSourceType

Sets the value of the sourceType property. (iPhone, iPad only.)

setTop

Sets the value of the top property.

setTouchEnabled

Sets the value of the touchEnabled property.

setTransform

Sets the value of the transform property.

setUrl

Sets the value of the url property.

setUseApplicationAudioSession

Sets the value of the useApplicationAudioSession property. (iPhone, iPad only.)

setVisible

Sets the value of the visible property.

setWidth

Sets the value of the width property.

setZIndex

Sets the value of the zIndex property.

show

Makes this view visible.

stop

stop playing the video

thumbnailImageAtTime

Returns a thumbnail at the given time as a blob. (iPhone, iPad only.)

toImage

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

Properties

Name Type Summary
allowsAirPlay Boolean

Whether or not the movie can be played on a remote device. (iPhone, iPad only.)

anchorPoint Point

Anchor point where animation should occur, relative to the view's boundaries. (iPhone, iPad only.)

animatedCenterPoint Point

Current position of the view during an animation. read-only

autoplay Boolean

indicates if a movie should automatically start playback when it is likely to finish uninterrupted based on e.g. network conditions. Defaults to true.

backgroundColor String

Background color of the view.

backgroundDisabledColor String

Disabled background color of the view. (Android only.)

backgroundDisabledImage String

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

backgroundFocusedColor String

Focused background color of the view. (Android only.)

backgroundFocusedImage String

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

backgroundGradient Gradient

A background gradient for the view.

backgroundImage String

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

backgroundLeftCap Number

Size of the left end cap. (iPhone, iPad only.)

backgroundRepeat Boolean

Toggle for whether or not to tile a background across a view. (iPhone, iPad only.)

backgroundSelectedColor String

Selected background color of the view. (Android, Mobile Web only.)

backgroundSelectedImage String

Selected background image url for the view, specified as a local file path or URL. (Android, Mobile Web only.)

backgroundTopCap Number

Size of the top end cap. (iPhone, iPad only.)

borderColor String

Border color of the view.

borderRadius Number

Border radius of the view.

borderWidth Number

Border width of the view.

bottom Number or String

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

center Point

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

children Array<Titanium.UI.View>

Array of this view's child views. read-only

contentURL String

Deprecated use url property instead.

currentPlaybackTime Number

the current playback time of the now playing item in seconds.

duration Number

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

endPlaybackTime Number

The end time of movie playback. Defaults to NaN in iOS, which indicates natural end time of the movie. On Android, this is always the same as duration (the natural end time) and there is no effect if you change the value.

focusable Boolean

Whether view should be focusable while navigating with the trackball. (Android only.)

fullscreen Boolean

Determines if the movie is presented in the entire screen (obscuring all other application content). Default is false. In iOS, setting this property to true before the movie player's view is visible will have no effect. In Android, setting this value to true means that the video will have its own Android Activity rather than being embedded as a view. In Android, this property is only relevant at creation time (e.g., createVideoPlayer({fullscreen: true})).

height Number or String

View height, in platform-specific units.

initialPlaybackTime Number

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

keepScreenOn Boolean

Whether to keep the device screen on. (Android only.)

layout String

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

left Number or String

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

loadState Number

Returns the network load state of the movie player. read-only

media Object

the media object, either a File or Blob. (iPhone, iPad only.)

mediaControlStyle Number

The style of the playback controls.

mediaTypes Number

The types of media in the movie, or Titanium.Media.VIDEO_MEDIA_TYPE_NONE if not known. (iPhone, iPad only.)

movieControlMode Number

Deprecated deprecated in 3.2+ of the iPhone SDK - use mediaControlStyle. Provides the ability to set the control mode of the movie player. Defaults to Titanium.Media.VIDEO_CONTROL_DEFAULT. (iPhone, iPad only.)

naturalSize Object

returns a dictionary with properties width and height. Returns the natural size of the movie or 0 for both properties if not known or applicable. (iPhone, iPad only.)

opacity Number

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

playableDuration Number

The currently playable duration of the movie, for progressively downloaded network content. On Android, this is always the same as duration. read-only

playbackState Number

Returns the current playback state of the music player read-only

playing Boolean

Boolean to indicate if the player has started playing. read-only

repeatMode Number

Determines how the movie player repeats when reaching the end of playback. Defaults to Titanium.Media.VIDEO_REPEAT_MODE_NONE.

right Number or String

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

scalingMode Number

Determines how the content scales to fit the view.

size Object

Rendered size of the view as a dictionary of width and height properties. read-only

softKeyboardOnFocus Number

Determines keyboard behavior when this view is focused. (Android only.)

sourceType Number

The playback type of the movie. Defaults to Titanium.Media.VIDEO_SOURCE_TYPE_UNKNOWN. Specifying a playback type before playing the movie can result in faster load times. (iPhone, iPad only.)

top Number or String

The view's top position.

touchEnabled Boolean

Whether view should receive touch events.

transform Titanium.UI.2DMatrix or Titanium.UI.iOS.3DMatrix

Transformation matrix to apply to the view.

url String

url of the media to play.

useApplicationAudioSession Boolean

Indicates if the movie player should inherit the application's audio session instead of creating a new session (which would interrupt the application's session). Defaults to true. Setting this property during playback will not take effect until playback is stopped and started again. (iPhone, iPad only.)

visible Boolean

Boolean value indicating whether the view is visible.

width Number or String

View's width, in platform-specific units.

zIndex Number

Z index position relative to other sibling views.

Events

Name Summary
click

Fired when the device detects a click against the view.

complete

fired when movie playback ends or a user exits playback

dblclick

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

doubletap

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

durationAvailable

fired when the duration is available

error

fired when movie playback encounters an error

fullscreen

fired when a movie changes from fullscreen view

load

fired when the movie play loads

loadstate

fired when the network loadState changes

longclick

Fired when the device detects a long click. (Android only.)

longpress

Fired when the device detects a long press.

mediaTypesAvailable

fired when the media types is available (iPhone, iPad only.)

naturalSizeAvailable

fired when the natural size is available (iPhone, iPad only.)

pinch

Fired when the device detects a pinch gesture. (iPhone, iPad only.)

playbackState

fired when the playbackState changes

playing

fired when the currently playing movie changes

preload

fired when the movie has preloaded and is ready to play

resize

fired when the movie player is resized (iPhone, iPad only.)

singletap

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

sourceChange

fired when the movieSourceType is Titanium.Media.VIDEO_SOURCE_TYPE_UNKNOWN when preparing for playback. (iPhone, iPad only.)

swipe

Fired when the device detects a swipe gesture (left or right) against the view.

thumbnail

fired when a movie thumbnail is available from requestThumbnailImagesAtTimes (iPhone, iPad only.)

touchcancel

Fired when a touch event is interrupted by the device.

touchend

Fired when a touch event is completed.

touchmove

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

touchstart

Fired as soon as the device detects a touch gesture.

twofingertap

Fired when the device detects a two-finger tap against the view.