# Titanium.Media

The top-level Media module.

Availability

0.8

9.2.0

Extends

Titanium.Module

# Overview

The Media module is used to access the device's media-related functionality, such as using the device's camera and photo gallery, playing media files, or recording audio or video. For examples of using the Media APIs, refer to the Working with Media APIs guide (opens new window) in addition to the other media submodule API documentation. Note: Some third party Android camera apps may choose to ignore video recording quality settings. If you wish to specifically set the video quality, don't assume EXTRA_VIDEO_QUALITY intent will be respected by the camera app and use Titanium's built-in camera window which can be used to assign the overlay property when calling the showCamera() method.

# Properties

# appMusicPlayer READONLY

Availability

0.8

9.2.0

appMusicPlayer :Titanium.Media.MusicPlayer

An instance of Titanium.Media.MusicPlayer representing the app-specific music player.

# audioPlaying READONLY

Availability

0.8

9.2.0

audioPlaying :Boolean

Returns true if the device is playing audio.

# audioSessionCategory

Availability

3.4.2

9.2.0

audioSessionCategory :String

A constant for the audio session category to be used.

Set to one of the AUDIO_SESSION_CATEGORY constants defined in Titanium.Media.

Must be set while the audio session is inactive (no sounds are playing, no listeners for audio properties on the Media module, but the iPod may be active).

This API can be assigned the following constants:

# availableCameraMediaTypes

Availability

0.8

9.2.0

availableCameraMediaTypes :Array<String>

Array of media type constants supported for the camera.

This API can be assigned the following constants:

# availableCameras READONLY

Availability

3.2.0

0.8

9.2.0

availableCameras :Array<Number>

Array indicating which cameras are available, CAMERA_FRONT, CAMERA_REAR or both.

This API can be assigned the following constants:

# availablePhotoGalleryMediaTypes

Availability

0.8

9.2.0

availablePhotoGalleryMediaTypes :Array<String>

Array of media type constants supported for saving to the device's camera roll or saved images album.

This API can be assigned the following constants:

# availablePhotoMediaTypes

Availability

0.8

9.2.0

availablePhotoMediaTypes :Array<String>

Array of media type constants supported for the photo library.

This API can be assigned the following constants:

# averageMicrophonePower

Availability

0.8

9.2.0

averageMicrophonePower :Number

Current average microphone level in dB or -1 if microphone monitoring is disabled.

See startMicrophoneMonitor, stopMicrophoneMonitor.

# cameraAuthorization READONLY

Availability

5.2.0

9.2.0

cameraAuthorization :Number

Returns the authorization status for the camera.

This API can be assigned the following constants:

# cameraFlashMode

Availability

3.3.0

1.4.0

9.2.0

cameraFlashMode :Number

Determines how the flash is fired when using the device's camera.

This API can be assigned the following constants:

Default: Titanium.Media.CAMERA_FLASH_AUTO> on iOS, <Titanium.Media.CAMERA_FLASH_OFF> on Android

# canRecord READONLY

Availability

6.2.0

0.8

9.2.0

canRecord :Boolean

true if the device has a recording input device available.

# currentRoute READONLY

Availability

3.4.2

9.2.0

currentRoute :RouteDescription

Returns a description of the current route, consisting of zero or more input ports and zero or more output ports.

# isCameraSupported READONLY

Availability

0.8

9.2.0

isCameraSupported :Boolean

true if the device has camera support.

# peakMicrophonePower READONLY

Availability

0.8

9.2.0

peakMicrophonePower :Number

Current microphone level peak power in dB or -1 if microphone monitoring is disabled.

See startMicrophoneMonitor, stopMicrophoneMonitor.

# QUALITY_640x480 READONLY

Availability

7.5.0

0.9.0

9.2.0

QUALITY_640x480 :Number

Media type constant for medium-quality video recording.

If recording, specifies that you want to use VGA-quality video recording (pixel dimensions of 640x480).

# QUALITY_IFRAME_1280x720 READONLY

Availability

7.5.0

6.0.0

9.2.0

QUALITY_IFRAME_1280x720 :Number

Media type constant for medium-quality video recording.

If recording, specifies that you want to use 1280x720 iFrame format.

# QUALITY_IFRAME_960x540 READONLY

Availability

6.0.0

9.2.0

QUALITY_IFRAME_960x540 :Number

Media type constant for medium-quality video recording.

If recording, specifies that you want to use 960x540 iFrame format.

# systemMusicPlayer READONLY

Availability

0.8

9.2.0

systemMusicPlayer :Titanium.Media.MusicPlayer

An instance of Titanium.Media.MusicPlayer representing the system-wide music player.

# volume READONLY

Availability

0.8

9.2.0

volume :Number

Current volume of the playback device.

A value in the range 0.0 to 1.0, with 0.0 representing the minimum volume and 1.0 representing the maximum volume.

# Methods

# beep

Availability

0.8

9.2.0

beep() → void

Plays a device beep notification.

Returns

Type: void

# createAudioPlayer

Availability

0.9

9.2.0

createAudioPlayer([parameters]) → Titanium.Media.AudioPlayer

Creates and returns an instance of Titanium.Media.AudioPlayer.

Parameters

Name	Type	Description
`parameters`	Dictionary<Titanium.Media.AudioPlayer>	Properties to set on a new object, including any defined by Titanium.Media.AudioPlayer except those marked not-creation or read-only.

Returns

Type: Titanium.Media.AudioPlayer

# createAudioRecorder

Availability

6.2.0

0.9

9.2.0

createAudioRecorder([parameters]) → Titanium.Media.AudioRecorder

Creates and returns an instance of Titanium.Media.AudioRecorder.

Parameters

Name	Type	Description
`parameters`	Dictionary<Titanium.Media.AudioRecorder>	Properties to set on a new object, including any defined by Titanium.Media.AudioRecorder except those marked not-creation or read-only.

Returns

Type: Titanium.Media.AudioRecorder

# createSound

Availability

0.8

9.2.0

createSound([parameters]) → Titanium.Media.Sound

Creates and returns an instance of Titanium.Media.Sound.

Parameters

Name	Type	Description
`parameters`	Dictionary<Titanium.Media.Sound>	Properties to set on a new object, including any defined by Titanium.Media.Sound except those marked not-creation or read-only.

Returns

Type: Titanium.Media.Sound

# createSystemAlert DEPRECATED

Availability

6.1.0

9.2.0

createSystemAlert([parameters]) → Titanium.Media.SystemAlert

DEPRECATED SINCE 8.0.0

This iOS-only API has been deprecated and moved to the Ti.SystemAlert module in 8.0.0.

Creates and returns an instance of Titanium.Media.SystemAlert.

Parameters

Name	Type	Description
`parameters`	Dictionary<Titanium.Media.SystemAlert>	Properties to set on a new object, including any defined by Titanium.Media.SystemAlert except those marked not-creation or read-only.

Returns

Type: Titanium.Media.SystemAlert

# createVideoPlayer

Availability

0.9

9.2.0

createVideoPlayer([parameters]) → Titanium.Media.VideoPlayer

Creates and returns an instance of Titanium.Media.VideoPlayer.

Parameters

Name	Type	Description
`parameters`	Dictionary<Titanium.Media.VideoPlayer>	Properties to set on a new object, including any defined by Titanium.Media.VideoPlayer except those marked not-creation or read-only.

Returns

Type: Titanium.Media.VideoPlayer

# hasAudioPermissions DEPRECATED

Availability

6.0.0

9.2.0

hasAudioPermissions() → Boolean

DEPRECATED SINCE 6.1.0

Use hasAudioRecorderPermissions instead.

Returns true if the app has audio permissions.

Recording audio requires explicit permission from the user. After the user grants or denies permission, the system remembers the choice for future use in the same app. If permission is not granted, or if the user has not yet responded to the permission prompt, any audio recording sessions record only silence.

In addition, Apple introduced the Info.plist key NSMicrophoneUsageDescription that is used to display an own description while authorizing microphone permissions. In iOS 10, this key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

Returns

Type: Boolean

# hasAudioRecorderPermissions

Availability

6.2.0

6.1.0

9.2.0

hasAudioRecorderPermissions() → Boolean

Returns true if the app has audio permissions.

Returns

Type: Boolean

# hasCameraPermissions

Availability

5.1.0

9.2.0

hasCameraPermissions() → Boolean

Returns true if the app has camera access.

Returns

Type: Boolean

# hasMusicLibraryPermissions

Availability

6.0.0

9.2.0

hasMusicLibraryPermissions() → Boolean

Returns true if the app has music library access.

Music-library permissions are only needed in iOS 9.3 and later and will be ignored on older iOS versions. Because of that, the method will return true for devices that run iOS < 9.3.

Returns

Type: Boolean

# hasPhotoGalleryPermissions

Availability

9.3.0

6.0.0

9.2.0

hasPhotoGalleryPermissions() → Boolean

Returns true if the app has photo gallery permissions.

Returns

Type: Boolean

# hideCamera

Availability

3.2.0

0.8

9.2.0

hideCamera() → void

Hides the device camera UI.

Must be called after calling showCamera and only when autohide is set to false. This method causes the media capture UI to be hidden.

Returns

Type: void

# hideMusicLibrary

Availability

0.8

9.2.0

hideMusicLibrary() → void

Hides the music library.

Must be called after calling openMusicLibrary and only when autohide is set to false.

Returns

Type: void

# isMediaTypeSupported

Availability

0.8

9.2.0

isMediaTypeSupported(source, type) → Boolean

Returns true if the source supports the specified media type.

You can query whether a given media type is supported by the device's camera (source == 'camera') or photo library (source == 'photo').

An additional value, photogallery can be used to query the media supported by the device's camera roll or saved image album, which is a subset of the iOS photo library. However, when calling openPhotoGallery on iOS, the entire library is displayed, and there is currently no way to restrict the gallery to show only the camera roll/saved images album.

Parameters

Name	Type	Description
`source`	String	Media source specified as a string: `camera` for Camera or `photo` for Photo Library.
`type`	String	Media type to check.

Returns

Type: Boolean

# openMusicLibrary

Availability

0.8

9.2.0

openMusicLibrary(options) → void

Shows the music library and allows the user to select one or more tracks.

If autohide is set to false, you must hide the library explicitly using hideMusicLibrary.

Parameters

Name	Type	Description
`options`	MusicLibraryOptionsType	A dictionary of options as described in MusicLibraryOptionsType.

Returns

Type: void

# openPhotoGallery

Availability

0.8

9.2.0

openPhotoGallery(options) → void

Opens the photo gallery image picker.

In iOS 6, Apple introduced the Info.plist key NSPhotoLibraryUsageDescription that is used to display an own description while authorizing gallery permissions. In iOS 10, this key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

Parameters

Name	Type	Description
`options`	PhotoGalleryOptionsType	Photo gallery options as described in PhotoGalleryOptionsType.

Returns

Type: void

# previewImage

Availability

0.8

previewImage(options) → void

Displays the given image.

Parameters

Name	Type	Description
`options`	Dictionary<PreviewImageOptions>	Dictionary containing the image and callback functions.

Returns

Type: void

# queryMusicLibrary

Availability

0.8

9.2.0

queryMusicLibrary(query) → Array<Titanium.Media.Item>

Searches the music library for items matching the specified search predicates.

Use hasMusicLibraryPermissions to check the granted permissions and requestMusicLibraryPermissions to request the permissions. This is especially important when running on an iOS 10 device, because the music-library access will crash without having the privacy-key NSAppleMusicUsageDescription that is specified in requestMusicLibraryPermissions.

Parameters

Name	Type	Description
`query`	MediaQueryType	The query object to extract information from.

Returns

Type: Array<Titanium.Media.Item>

# requestAudioPermissions DEPRECATED

Availability

5.1.0

requestAudioPermissions(callback) → void

DEPRECATED SINCE 6.1.0

Use the requestAudioRecorderPermissions method instead.

Request the user's permission for audio recording.

Parameters

Name	Type	Description
`callback`	Callback<MediaAuthorizationResponse>	Callback function to execute when the users responds to the authorization alert.

Returns

Type: void

# requestAudioRecorderPermissions

Availability

6.2.0

6.1.0

9.2.0

requestAudioRecorderPermissions([callback]) → Promise<MediaAuthorizationResponse>

Request the user's permission for audio recording.

Parameters

Name	Type	Description
`callback`	Callback<MediaAuthorizationResponse>	Callback function to execute when the users responds to the authorization alert. Optional on SDK 10, as this method will return a `Promise`, which may be used to handle the result.

Returns

On SDK 10+, this method will return a Promise whose resolved value is equivalent to that passed to the optional callback argument.

Type: Promise<MediaAuthorizationResponse>

# requestAuthorization DEPRECATED

Availability

3.1.3

requestAuthorization(callback) → void

DEPRECATED SINCE 5.1.0

Use the requestAudioRecorderPermissions method instead.

Request the user's permission for audio recording.

Parameters

Name	Type	Description
`callback`	Callback<MediaAuthorizationResponse>	Callback function to execute when the users responds to the authorization alert.

Returns

Type: void

# requestCameraAccess DEPRECATED

Availability

4.0.0

requestCameraAccess(callback) → void

DEPRECATED SINCE 5.1.0

Please use the requestCameraPermissions method instead.

Requests for camera access.

This method allows the app to request for camera access, before or without the user granting it in showCamera. The request view will only show if user has not yet made a decision. If he has, the callback will return his earlier decision, and if any changes has to be made, the user has to change it in the device settings.

Parameters

Name	Type	Description
`callback`	Callback<RequestCameraAccessResult>	Function to call indicating if permission was granted or denied.

Returns

Type: void

# requestCameraPermissions

Availability

5.1.0

9.2.0

requestCameraPermissions([callback]) → Promise<RequestCameraAccessResult>

Requests for camera access.

On Android, the request view will show if the permission is not accepted by the user, and the user did not check the box "Never ask again" when denying the request. If the user checks the box "Never ask again," the user has to manually enable the permission in device settings.

This method requests Manifest.permission.CAMERA, Manifest.permission.READ_EXTERNAL_STORAGE and Manifest.permission.WRITE_EXTERNAL_STORAGE on Android. If you require other permissions, you can also use requestPermissions.

In iOS 6, Apple introduced the Info.plist key NSCameraUsageDescription that is used to display an own description while authorizing camera permissions. In iOS 10, this key is mandatory when taking a photo and the application will crash if your app does not include the key. Check the Apple docs for more information. When using the camera to take a video, you also need the NSMicrophoneUsageDescription key. In addition, the authorization dialog will only show if user has not made a decision, yet. If the user has, the callback will return the earlier decision. To change the permission the user needs to change it in the device settings.

Parameters

Name	Type	Description
`callback`	Callback<RequestCameraAccessResult>	Function to call indicating if permission was granted or denied. Optional on SDK 10, as this method will return a `Promise`, which may be used to handle the result.

Returns

On SDK 10+, this method will return a Promise whose resolved value is equivalent to that passed to the optional callback argument.

Type: Promise<RequestCameraAccessResult>

# requestMusicLibraryPermissions

Availability

6.0.0

9.2.0

requestMusicLibraryPermissions(callback) → void

Request permissions for the native music-library.

Music-library permissions are only needed in iOS 9.3 and later and will be ignored on older iOS versions. Because of that, the callback will ignore the permission-check and always return {success: true} for devices that run iOS < 9.3.

Important: On iOS 10, Apple introduced the Info.plist key NSAppleMusicUsageDescription that is used to display an own description while authorizing the music library. This key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

Parameters

Name	Type	Description
`callback`	Callback<RequestMusicLibraryAccessResult>	Function to call indicating if permission was granted or denied.

Returns

Type: void

# requestPhotoGalleryPermissions

Availability

9.3.0

6.0.0

9.2.0

requestPhotoGalleryPermissions([callback]) → Promise<RequestPhotoGalleryAccessResult>

Requests for photo gallery permissions.

In iOS 6, Apple introduced the Info.plist key NSPhotoLibraryUsageDescription that is used to display an own description while authorizing photo gallery permissions. In iOS 10, this key is mandatory when accessing the photo gallery and the application will crash if your app does not include the key. Check the Apple docs for more information. If the user has, the callback will return the earlier decision. To change the permission the user needs to change it in the device settings.

iOS Apps that do not include this method, will present the system-dialog while the dialog is opened with openPhotoGallery.

Parameters

Name	Type	Description
`callback`	Callback<RequestPhotoGalleryAccessResult>	Function to call indicating if permission was granted or denied. Optional on SDK 10, as this method will return a `Promise`, which may be used to handle the result.

Returns

On SDK 10+, this method will return a Promise whose resolved value is equivalent to that passed to the optional callback argument.

Type: Promise<RequestPhotoGalleryAccessResult>

# saveToPhotoGallery

Availability

3.3.0

0.8

9.2.0

saveToPhotoGallery(media, callbacks) → void

Saves media to the device's photo gallery / camera roll.

This operation is asynchronous. The caller can supply callbacks to be triggered when the save operation completes.

Media can be passed as either a Blob object or a File object. If the media argument is not one of these types, an error is generated.

Note that when passing a file (or a blob created from a file), the file name must have the appropriate extension for the data--for example, image.jpg or video1.mov work, but video1.tmp does not. Currently, the .mp4 extension is not supported, but MP4 files may be imported by saving them with the .mov extension.

Make sure to check for gallery access permissions with hasPhotoGalleryPermissions and request the permissions with requestPhotoGalleryPermissions if not granted. On iOS, the NSPhotoLibraryAddUsageDescription plist key is required in the tiapp.xml in order to use this API.

On Android, this method does not support saving videos to the gallery prior to Titanium SDK 6.1.0.

Parameters

Name	Type	Description
`media`	Titanium.Blob \| Titanium.Filesystem.File	Media to save to the camera roll or media gallery.
`callbacks`	Object	Pass a dictionary with the following supported keys: `success` a function that will be called when the save succeeds, and `error` a function that will be called upon receiving an error.

Returns

Type: void

# setOverrideAudioRoute

Availability

0.8

9.2.0

setOverrideAudioRoute(route) → void

Overrides the default audio route when using the AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD session mode.

By default, when using the AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD session mode, the audio output is routed to the speaker in the receiver. This method lets you specify that audio should be routed to the built-in speaker.

If you override the audio route while audio is playing the changes won't not take effect until the audio is restarted.

Parameters

Name	Type	Description
`route`	Number	The specified audio route.

Returns

Type: void

# showCamera

Availability

0.8

9.2.0

showCamera(options) → void

Shows the camera.

By default, the native camera controls are displayed. To add your own camera controls, you can add an overlay view by setting the overlay property on the options argument.

# Android Platform Notes

To suppress the default controls, set autohide to false and then set the overlay property to a view that contains a control (such as a button) to take the photo. You must then control the camera explicitly, using the takePicture and hideCamera methods.
Setting saveToPhotoGallery to false is not guaranteed to work with all camera apps. If this setting is desired, then you should use Titanium's internal camera overlay instead.
You can only use one or the other (video or photo) types in the array.

# iOS Platform Notes

To suppress the default controls, set showControls and autohide to false.

If the showControls option is false, you must control the camera explicitly, using the takePicture and hideCamera methods.

Images taken with the camera will not have accurate geolocation data embedded in the images; the latitude and longitude will be set to '0'. This is not an error, but a limitation which Apple has put on the camera API.

Important: Use hasCameraPermissions and requestCameraPermissions to ask for camera permissions. This is especially important when running on iOS 10 and later, since the application may crash otherwise.

Parameters

Name	Type	Description
`options`	CameraOptionsType	A dictionary of camera options as described in CameraOptionsType.

Returns

Type: void

# startMicrophoneMonitor

Availability

0.8

9.2.0

startMicrophoneMonitor() → void

Starts monitoring the microphone sound level.

Returns

Type: void

# startVideoCapture

Availability

5.4.0

0.8

9.2.0

startVideoCapture() → void

Starts video capture using the camera specified.

Returns

Type: void

# stopMicrophoneMonitor

Availability

0.8

9.2.0

stopMicrophoneMonitor() → void

Stops monitoring the microphone sound level.

Returns

Type: void

# stopVideoCapture

Availability

5.4.0

0.8

9.2.0

stopVideoCapture() → void

Stops video capture using the camera specified.

Returns

Type: void

# switchCamera

Availability

3.2.0

1.8.1

9.2.0

switchCamera(camera) → void

Switches between front and rear-facing cameras. Make sure to set one of the below constants to determine the camera you want to switch to.

In Android, this can only be called when using a custom overlay (see showCamera).

Parameters

Name	Type	Description
`camera`	Number	Constant indicating to which camera you want to switch.

Returns

Type: void

# takePicture

Availability

0.8

9.2.0

takePicture() → void

Uses the device camera to capture a photo.

Must be called after calling showCamera and only when autohide is set to false.

This method causes the media capture device to capture a photo and call the success callback.

Returns

Type: void

# takeScreenshot

Availability

0.8

9.2.0

takeScreenshot(callback) → void

Takes a screen shot of the visible UI on the device.

This method is asynchronous. The screenshot is returned in the callback argument. The callback argument's media property contains the screenshot image as a Titanium.Blob object.

Parameters

Name	Type	Description
`callback`	Callback<ScreenshotResult>	Function to call upon capture.

Returns

Type: void

# vibrate

Availability

0.8

9.2.0

vibrate([pattern]) → void

Makes the device vibrate.

On Android, a pattern argument can be provided to specify a vibration pattern.

The pattern is an array of Number values. Each number in the array is interpreted as a duration in milliseconds. The first number is the delay before the pattern starts, and the remaining numbers are interpreted as alternating periods of on and off times. For example, the following pattern:

[ 0, 500, 100, 500, 100, 500 ]

Would cause the vibration to start immediately (delay = 0), and perform three long vibrations (500 ms) separated by short pauses (100ms).

Parameters

Name	Type	Description
`pattern`	Array<Number>	Array of values identifying a vibrate pattern (only used on Android).

Returns

Type: void

# Events

# cameraready

Availability

6.0.0

Fires when the camera overlay is ready to take pictures.

# routechange

Availability

3.4.2

9.2.0

Fired when an audio line type change is detected.

Properties

Name	Type	Description
reason	String	The reason for route change.
oldRoute	RouteDescription	Returns a description of the old route, consisting of zero or more input ports and zero or more output ports.
currentRoute	RouteDescription	Returns a description of the current route, consisting of zero or more input ports and zero or more output ports.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# volume

Availability

0.8

9.2.0

Fired when the volume output changes.

Properties

Name	Type	Description
volume	Number	New volume level in dB.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# Constants

# AUDIO_FILEFORMAT_3GP2

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_3GP2 :Number

Audio file format 3GPP2.

# AUDIO_FILEFORMAT_3GPP

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_3GPP :Number

Audio file format 3GPP.

# AUDIO_FILEFORMAT_AIFF

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_AIFF :Number

Audio file format Audio Interchange File Format (AIFF).

# AUDIO_FILEFORMAT_AMR

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_AMR :Number

Audio file format Adaptive Multi-Rate (AMR).

# AUDIO_FILEFORMAT_CAF

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_CAF :Number

Audio file format Apple Compressed Audio Format (CAF).

# AUDIO_FILEFORMAT_MP3

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_MP3 :Number

Audio file format MP3.

# AUDIO_FILEFORMAT_MP4

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_MP4 :Number

Audio file format MP4.

# AUDIO_FILEFORMAT_MP4A

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_MP4A :Number

Audio file format MP4A.

# AUDIO_FILEFORMAT_WAVE

Availability

0.8

9.2.0

AUDIO_FILEFORMAT_WAVE :Number

Audio file format WAVE.

# AUDIO_FORMAT_AAC

Availability

0.8

9.2.0

AUDIO_FORMAT_AAC :Number

Audio format MPEG4 AAC encoding.

# AUDIO_FORMAT_ALAW

Availability

0.8

9.2.0

AUDIO_FORMAT_ALAW :Number

Audio format 8-bit aLaw encoding.

# AUDIO_FORMAT_APPLE_LOSSLESS

Availability

0.8

9.2.0

AUDIO_FORMAT_APPLE_LOSSLESS :Number

Audio format Apple lossless encoding.

# AUDIO_FORMAT_ILBC

Availability

0.8

9.2.0

AUDIO_FORMAT_ILBC :Number

Audio format iLBC encoding.

# AUDIO_FORMAT_IMA4

Availability

0.8

9.2.0

AUDIO_FORMAT_IMA4 :Number

Audio format Apple IMA4 encoding.

# AUDIO_FORMAT_LINEAR_PCM

Availability

0.8

9.2.0

AUDIO_FORMAT_LINEAR_PCM :Number

Audio format 16-bit, linear PCM encoding.

# AUDIO_FORMAT_ULAW

Availability

0.8

9.2.0

AUDIO_FORMAT_ULAW :Number

Audio format 8-bit muLaw encoding.

# AUDIO_SESSION_CATEGORY_AMBIENT

Availability

3.4.2

9.2.0

AUDIO_SESSION_CATEGORY_AMBIENT :String

For long-duration sounds such as rain, car engine noise, and so on.

Also used for for 'play along' style applications, such a virtual piano that a user plays over iPod audio.

# AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD

Availability

3.4.2

9.2.0

AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD :String

Session mode for recording (input) and playback (output) of audio, such as for a VOIP (voice over IP) application.

This category is appropriate for simultaneous recording and playback, and also for applications that record and play back but not simultaneously. If you want to ensure that sounds such as Messages alerts do not play while your application is recording, use AUDIO_SESSION_CATEGORY_RECORD instead. This category normally disallows mixing iPod audio with application audio.

In this mode, by default audio playback is routed to the speaker in the iPhone receiver. To have audio playback through the iPhone speaker, use setOverrideAudioRoute.

# AUDIO_SESSION_CATEGORY_PLAYBACK

Availability

3.4.2

9.2.0

AUDIO_SESSION_CATEGORY_PLAYBACK :String

Session mode for playing recorded music or other sounds that are central to the successful use of your application.

When using this mode, your application audio continues with the Ring/Silent switch set to silent or when the screen locks. This property normally disallows mixing iPod audio with application audio.

# AUDIO_SESSION_CATEGORY_RECORD

Availability

3.4.2

9.2.0

AUDIO_SESSION_CATEGORY_RECORD :String

Session mode for recording audio; it silences playback audio.

# AUDIO_SESSION_CATEGORY_SOLO_AMBIENT

Availability

3.4.2

9.2.0

AUDIO_SESSION_CATEGORY_SOLO_AMBIENT :String

Session mode for long-duration sounds such as rain, car engine noise, and so on.

When you use this category, audio from built-in applications, such as the iPod, is silenced. Your audio is silenced when the Ring/Silent switch is set to silent or when the screen locks.

To use long-duration sounds without silencing built-in applications, see AUDIO_SESSION_CATEGORY_AMBIENT.

# AUDIO_SESSION_OVERRIDE_ROUTE_NONE

Availability

0.8

9.2.0

AUDIO_SESSION_OVERRIDE_ROUTE_NONE :Number

Constant that specifies audio should output to the default audio route. See setOverrideAudioRoute for more information.

# AUDIO_SESSION_OVERRIDE_ROUTE_SPEAKER

Availability

0.8

9.2.0

AUDIO_SESSION_OVERRIDE_ROUTE_SPEAKER :Number

Constant that specifies audio should output to the speaker. See setOverrideAudioRoute for more information.

# AUDIO_SESSION_PORT_AIRPLAY

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_AIRPLAY :String

Constant for output on a remote Air Play device. This is an output port.

# AUDIO_SESSION_PORT_BLUETOOTHA2DP

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_BLUETOOTHA2DP :String

Constant for output on a Bluetooth A2DP device. This is an output port.

# AUDIO_SESSION_PORT_BLUETOOTHHFP

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_BLUETOOTHHFP :String

Constant for input or output on a Bluetooth Hands-Free Profile device. This can be both an input and output port.

# AUDIO_SESSION_PORT_BLUETOOTHLE

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_BLUETOOTHLE :String

Constant for output on a Bluetooth Low Energy device. This is an output port. This is available on iOS7 and later.

# AUDIO_SESSION_PORT_BUILTINMIC

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_BUILTINMIC :String

Constant for built-in microphone on an iOS device. This is an input port.

# AUDIO_SESSION_PORT_BUILTINRECEIVER

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_BUILTINRECEIVER :String

Constant for the speaker you hold to your ear when on a phone call. This is an output port.

# AUDIO_SESSION_PORT_BUILTINSPEAKER

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_BUILTINSPEAKER :String

Constant for built-in speaker on an iOS device. This is an output port.

# AUDIO_SESSION_PORT_CARAUDIO

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_CARAUDIO :String

Constant for Input or output via Car Audio. This can be both an input and output port. This is available on iOS7 and later.

# AUDIO_SESSION_PORT_HDMI

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_HDMI :String

Constant for output via High-Definition Multimedia Interface. This is an output port

# AUDIO_SESSION_PORT_HEADPHONES

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_HEADPHONES :String

Constant for headphone or headset output. This is an output port.

# AUDIO_SESSION_PORT_HEADSETMIC

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_HEADSETMIC :String

Constant for microphone on a wired headset. This is an input port.

# AUDIO_SESSION_PORT_LINEIN

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_LINEIN :String

Constant for line level input on a dock connector. This is an input port.

# AUDIO_SESSION_PORT_LINEOUT

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_LINEOUT :String

Constant for line level output on a dock connector. This is an output port.

# AUDIO_SESSION_PORT_USBAUDIO

Availability

3.4.2

9.2.0

AUDIO_SESSION_PORT_USBAUDIO :String

Constant for input or output on a Universal Serial Bus device. This can be both an input and output port.

# AUDIO_STATE_BUFFERING

Availability

7.5.0

9.2.0

AUDIO_STATE_BUFFERING :Number

Audio data is being buffered from the network.

# AUDIO_STATE_INITIALIZED

Availability

7.5.0

9.2.0

AUDIO_STATE_INITIALIZED :Number

Audio playback is being initialized.

# AUDIO_STATE_PAUSED

Availability

7.5.0

9.2.0

AUDIO_STATE_PAUSED :Number

Playback is paused.

# AUDIO_STATE_PLAYING

Availability

7.5.0

9.2.0

AUDIO_STATE_PLAYING :Number

Audio playback is active.

# AUDIO_STATE_STARTING

Availability

7.5.0

9.2.0

AUDIO_STATE_STARTING :Number

Audio playback is starting.

# AUDIO_STATE_STOPPED

Availability

7.5.0

9.2.0

AUDIO_STATE_STOPPED :Number

Audio playback is stopped.

# AUDIO_STATE_STOPPING

Availability

7.5.0

9.2.0

AUDIO_STATE_STOPPING :Number

Audio playback is stopping.

# AUDIO_STATE_WAITING_FOR_DATA

Availability

7.5.0

9.2.0

AUDIO_STATE_WAITING_FOR_DATA :Number

Player is waiting for audio data from the network.

# AUDIO_STATE_WAITING_FOR_QUEUE

Availability

7.5.0

9.2.0

AUDIO_STATE_WAITING_FOR_QUEUE :Number

Player is waiting for audio data to fill the queue.

# CAMERA_AUTHORIZATION_AUTHORIZED

Availability

4.0.0

9.2.0

CAMERA_AUTHORIZATION_AUTHORIZED :Number

Constant specifying that app is authorized to use camera. This is available on iOS7 and later.

# CAMERA_AUTHORIZATION_DENIED

Availability

4.0.0

9.2.0

CAMERA_AUTHORIZATION_DENIED :Number

Constant specifying that app is denied usage of camera. This is available on iOS7 and later.

# CAMERA_AUTHORIZATION_RESTRICTED

Availability

4.0.0

9.2.0

CAMERA_AUTHORIZATION_RESTRICTED :Number

Constant specifying that app is restricted from using camera. This is available on iOS7 and later.

# CAMERA_AUTHORIZATION_UNKNOWN

Availability

5.2.0

9.2.0

CAMERA_AUTHORIZATION_UNKNOWN :Number

Constant specifying that app is not yet authorized to use camera. This is available on iOS7 and later.

# CAMERA_FLASH_AUTO

Availability

3.3.0

1.4.0

9.2.0

CAMERA_FLASH_AUTO :Number

Constant specifying to have the device determine to use the flash or not.

# CAMERA_FLASH_OFF

Availability

3.3.0

1.4.0

9.2.0

CAMERA_FLASH_OFF :Number

Constant specifying to never fire the flash.

# CAMERA_FLASH_ON

Availability

3.3.0

1.4.0

9.2.0

CAMERA_FLASH_ON :Number

Constant specifying to always fire the flash.

# CAMERA_FRONT

Availability

3.2.0

0.8

9.2.0

CAMERA_FRONT :Number

Constant specifying the front camera.

# CAMERA_REAR

Availability

3.2.0

0.8

9.2.0

CAMERA_REAR :Number

Constant indicating the rear camera.

# DEVICE_BUSY

Availability

0.8

9.2.0

DEVICE_BUSY :Number

Constant for media device busy error.

# IMAGE_SCALING_ASPECT_FILL

Availability

10.1.0

IMAGE_SCALING_ASPECT_FILL :Number

Crops the image proportionally causing its content to be clipped either horizontally or vertically.

# IMAGE_SCALING_ASPECT_FIT

Availability

10.1.0

IMAGE_SCALING_ASPECT_FIT :Number

Letterbox or pillarbox scales the image proportionally to fit the container.

# IMAGE_SCALING_AUTO

Availability

10.1.0

IMAGE_SCALING_AUTO :Number

Scales the image depending on how the view container is sized.

If a width and height are both conigured on the image view, then it will use IMAGE_SCALING_FILL to stretch the image disproportionally to fill the view. Otherwise it will use IMAGE_SCALING_ASPECT_FIT to letterbox/pillarbox the image.

# IMAGE_SCALING_FILL

Availability

10.1.0

IMAGE_SCALING_FILL :Number

Stretches the image disproportionally to completely fill the container's bounds.

# IMAGE_SCALING_NONE

Availability

10.1.0

IMAGE_SCALING_NONE :Number

Disables scaling and displays the image as-is.

# MEDIA_TYPE_LIVEPHOTO

Availability

5.2.0

9.2.0

MEDIA_TYPE_LIVEPHOTO :String

Media type constant for live photo media.

# MEDIA_TYPE_PHOTO

Availability

0.8

9.2.0

MEDIA_TYPE_PHOTO :String

Media type constant for photo media.

# MEDIA_TYPE_VIDEO

Availability

0.8

9.2.0

MEDIA_TYPE_VIDEO :String

Media type constant for video media.

# MUSIC_MEDIA_GROUP_ALBUM

Availability

0.8

9.2.0

MUSIC_MEDIA_GROUP_ALBUM :Number

Constant for grouping query results by album.

# MUSIC_MEDIA_GROUP_ALBUM_ARTIST

Availability

0.8

9.2.0

MUSIC_MEDIA_GROUP_ALBUM_ARTIST :Number

Constant for grouping query results by album and artist.

# MUSIC_MEDIA_GROUP_ARTIST

Availability

0.8

9.2.0

MUSIC_MEDIA_GROUP_ARTIST :Number

Constant for grouping query results by artist.

# MUSIC_MEDIA_GROUP_COMPOSER

Availability

0.8

9.2.0

MUSIC_MEDIA_GROUP_COMPOSER :Number

Constant for grouping query results by composer.

# MUSIC_MEDIA_GROUP_GENRE

Availability

0.8

9.2.0

MUSIC_MEDIA_GROUP_GENRE :Number

Constant for grouping query results by genre.

# MUSIC_MEDIA_GROUP_PLAYLIST

Availability

0.8

9.2.0

MUSIC_MEDIA_GROUP_PLAYLIST :Number

Constant for grouping query results by playlist.

# MUSIC_MEDIA_GROUP_PODCAST_TITLE

Availability

0.8

9.2.0

MUSIC_MEDIA_GROUP_PODCAST_TITLE :Number

Constant for grouping query results by podcast title.

# MUSIC_MEDIA_GROUP_TITLE

Availability

0.8

9.2.0

MUSIC_MEDIA_GROUP_TITLE :Number

Constant for grouping query results by title.

# MUSIC_MEDIA_TYPE_ALL

Availability

0.8

9.2.0

MUSIC_MEDIA_TYPE_ALL :Number

Music library media containing any type of content.

# MUSIC_MEDIA_TYPE_ANY_AUDIO

Availability

0.8

9.2.0

MUSIC_MEDIA_TYPE_ANY_AUDIO :Number

Music library media containing any type of audio content.

# MUSIC_MEDIA_TYPE_AUDIOBOOK

Availability

0.8

9.2.0

MUSIC_MEDIA_TYPE_AUDIOBOOK :Number

Music library media containing audiobook content.

# MUSIC_MEDIA_TYPE_MUSIC

Availability

0.8

9.2.0

MUSIC_MEDIA_TYPE_MUSIC :Number

Music library media containing music content.

# MUSIC_MEDIA_TYPE_PODCAST

Availability

0.8

9.2.0

MUSIC_MEDIA_TYPE_PODCAST :Number

Music library media containing podcast content.

# MUSIC_PLAYER_REPEAT_ALL

Availability

0.8

9.2.0

MUSIC_PLAYER_REPEAT_ALL :Number

Constant for "Repeat All" setting.

# MUSIC_PLAYER_REPEAT_DEFAULT

Availability

0.8

9.2.0

MUSIC_PLAYER_REPEAT_DEFAULT :Number

Constant for user's default repeat setting.

# MUSIC_PLAYER_REPEAT_NONE

Availability

0.8

9.2.0

MUSIC_PLAYER_REPEAT_NONE :Number

Constant for "No Repeat" setting.

# MUSIC_PLAYER_REPEAT_ONE

Availability

0.8

9.2.0

MUSIC_PLAYER_REPEAT_ONE :Number

Constant for "Repeat one item" setting.

# MUSIC_PLAYER_SHUFFLE_ALBUMS

Availability

0.8

9.2.0

MUSIC_PLAYER_SHUFFLE_ALBUMS :Number

Constant for shuffling complete albums setting.

# MUSIC_PLAYER_SHUFFLE_DEFAULT

Availability

0.8

9.2.0

MUSIC_PLAYER_SHUFFLE_DEFAULT :Number

Constant for user's default shuffle setting.

# MUSIC_PLAYER_SHUFFLE_NONE

Availability

0.8

9.2.0

MUSIC_PLAYER_SHUFFLE_NONE :Number

Constant for "no shuffle" setting.

# MUSIC_PLAYER_SHUFFLE_SONGS

Availability

0.8

9.2.0

MUSIC_PLAYER_SHUFFLE_SONGS :Number

Constant for shuffling songs setting.

# MUSIC_PLAYER_STATE_INTERRUPTED

Availability

0.8

9.2.0

MUSIC_PLAYER_STATE_INTERRUPTED :Number

Constant for interrupted state.

# MUSIC_PLAYER_STATE_PAUSED

Availability

0.8

9.2.0

MUSIC_PLAYER_STATE_PAUSED :Number

Constant for paused state.

# MUSIC_PLAYER_STATE_PLAYING

Availability

0.8

9.2.0

MUSIC_PLAYER_STATE_PLAYING :Number

Constant for playing state.

# MUSIC_PLAYER_STATE_SEEK_BACKWARD

Availability

0.8

9.2.0

MUSIC_PLAYER_STATE_SEEK_BACKWARD :Number

Constant for backward seek state.

# MUSIC_PLAYER_STATE_SEEK_FORWARD

Availability

0.8

9.2.0

MUSIC_PLAYER_STATE_SEEK_FORWARD :Number

Constant for forward seek state.

# MUSIC_PLAYER_STATE_STOPPED

Availability

0.8

9.2.0

MUSIC_PLAYER_STATE_STOPPED :Number

Constant for stopped state.

# NO_CAMERA

Availability

0.8

9.2.0

NO_CAMERA :Number

Constant for media no camera error.

# NO_VIDEO

Availability

0.8

9.2.0

NO_VIDEO :Number

Constant for media no video error.

# QUALITY_HIGH

Availability

7.5.0

0.9.0

9.2.0

QUALITY_HIGH :Number

Media type constant for high-quality video recording.

Recorded files are suitable for on-device playback and for wired transfer to the Desktop using Image Capture; they are likely to be too large for transfer using Wi-Fi.

# QUALITY_LOW

Availability

7.5.0

0.9.0

9.2.0

QUALITY_LOW :Number

Media type constant for low-quality video recording.

Recorded files can usually be transferred over the cellular network.

# QUALITY_MEDIUM

Availability

0.8

9.2.0

QUALITY_MEDIUM :Number

Media type constant for medium-quality video recording.

Recorded files can usually be transferred using Wi-Fi. This is the default video quality setting.

# UNKNOWN_ERROR

Availability

0.8

9.2.0

UNKNOWN_ERROR :Number

Constant for unknown media error.

# VIDEO_CONTROL_DEFAULT DEPRECATED

Availability

0.8

VIDEO_CONTROL_DEFAULT :Number

DEPRECATED SINCE 7.0.0

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Constant for default video controls.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

Removed on iOS in SDK 7.0.0.

# VIDEO_CONTROL_EMBEDDED DEPRECATED

Availability

0.8

VIDEO_CONTROL_EMBEDDED :Number

DEPRECATED SINCE 7.0.0

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Constant for video controls for an embedded view.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

On Android, this constant has the same effect as VIDEO_CONTROL_DEFAULT. Video controls may only be shown or hidden.

Removed on iOS in SDK 7.0.0.

# VIDEO_CONTROL_FULLSCREEN DEPRECATED

Availability

0.8

VIDEO_CONTROL_FULLSCREEN :Number

DEPRECATED SINCE 7.0.0

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Constant for fullscreen video controls.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

On iOS, use VIDEO_CONTROL_FULLSCREEN when creating a video player that occupies the entire screen, that is, the parent window should be a fullscreen window (fullscreen set to true) and the video player should occupy the entirety of the parent window.

If the user clicks the Done button in the fullscreen control bar, the video player pauses playback and generates a complete event.

Note that if you create a video player that does not occupy the entire screen, and later switch to fullscreen mode, the video controls are switched automatically. That is, if mediaControlStyle is set to VIDEO_CONTROL_DEFAULT or VIDEO_CONTROL_EMBEDDED, it is automatically switched to the fullscreen controls when the player enters fullscreen mode. This is true whether the user initiates the mode switch by clicking the fullscreen button in the embedded controls, or if you programmatically switch to full screen mode (by setting the fullscreen property to true).

On Android, this constant has the same effect as VIDEO_CONTROL_DEFAULT. Video controls may only be shown or hidden.

Removed on iOS in SDK 7.0.0.

# VIDEO_CONTROL_HIDDEN DEPRECATED

Availability

0.8

VIDEO_CONTROL_HIDDEN :Number

DEPRECATED SINCE 7.0.0

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Constant for video controls hidden.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

Removed on iOS in SDK 7.0.0.

# VIDEO_CONTROL_NONE DEPRECATED

Availability

0.8

VIDEO_CONTROL_NONE :Number

DEPRECATED SINCE 7.0.0

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Constant for no video controls.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

Removed on iOS in SDK 7.0.0.

# VIDEO_FINISH_REASON_PLAYBACK_ENDED

Availability

0.8

VIDEO_FINISH_REASON_PLAYBACK_ENDED :Number

Video playback ended normally.

# VIDEO_FINISH_REASON_PLAYBACK_ERROR

Availability

0.8

VIDEO_FINISH_REASON_PLAYBACK_ERROR :Number

Video playback ended abnormally.

# VIDEO_FINISH_REASON_USER_EXITED

Availability

0.8

VIDEO_FINISH_REASON_USER_EXITED :Number

Video playback ended by user action (such as clicking the Done button).

# VIDEO_LOAD_STATE_FAILED

Availability

0.8

9.2.0

VIDEO_LOAD_STATE_FAILED :Number

Indicates that the player can no longer play media items because of an error.

# VIDEO_LOAD_STATE_PLAYABLE

Availability

0.8

9.2.0

VIDEO_LOAD_STATE_PLAYABLE :Number

Current media is playable.

# VIDEO_LOAD_STATE_UNKNOWN

Availability

0.8

9.2.0

VIDEO_LOAD_STATE_UNKNOWN :Number

Current load state is not known.

# VIDEO_MEDIA_TYPE_AUDIO

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_AUDIO :String

The media contains audio media.

# VIDEO_MEDIA_TYPE_CLOSED_CAPTION

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_CLOSED_CAPTION :String

The media contains closed-caption content.

# VIDEO_MEDIA_TYPE_DEPTH_DATA

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_DEPTH_DATA :String

The media contains depth data.

# VIDEO_MEDIA_TYPE_METADATA

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_METADATA :String

The media contains metadata.

# VIDEO_MEDIA_TYPE_METADATA_OBJECT

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_METADATA_OBJECT :String

The media contains metadata objects.

# VIDEO_MEDIA_TYPE_MUXED

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_MUXED :String

The media contains muxed media.

# VIDEO_MEDIA_TYPE_SUBTITLE

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_SUBTITLE :String

The media contains subtitles.

# VIDEO_MEDIA_TYPE_TEXT

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_TEXT :String

The media contains text.

# VIDEO_MEDIA_TYPE_TIMECODE

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_TIMECODE :String

The media contains a time code.

# VIDEO_MEDIA_TYPE_VIDEO

Availability

0.8

9.2.0

VIDEO_MEDIA_TYPE_VIDEO :String

The media contains video.

# VIDEO_PLAYBACK_STATE_INTERRUPTED

Availability

0.8

9.2.0

VIDEO_PLAYBACK_STATE_INTERRUPTED :Number

Video playback has been interrupted.

# VIDEO_PLAYBACK_STATE_PAUSED

Availability

0.8

9.2.0

VIDEO_PLAYBACK_STATE_PAUSED :Number

Video playback is paused.

# VIDEO_PLAYBACK_STATE_PLAYING

Availability

0.8

9.2.0

VIDEO_PLAYBACK_STATE_PLAYING :Number

Video is being played.

# VIDEO_PLAYBACK_STATE_SEEKING_BACKWARD

Availability

0.8

VIDEO_PLAYBACK_STATE_SEEKING_BACKWARD :Number

Video playback is rewinding.

This constant has been removed on iOS in SDK 7.0.0 by using the official Apple AVPlayer that does not expose this functionality so far.

# VIDEO_PLAYBACK_STATE_SEEKING_FORWARD

Availability

0.8

VIDEO_PLAYBACK_STATE_SEEKING_FORWARD :Number

Video playback is seeking forward.

This constant has been removed on iOS in SDK 7.0.0 by using the official Apple AVPlayer that does not expose this functionality so far.

# VIDEO_PLAYBACK_STATE_STOPPED

Availability

0.8

9.2.0

VIDEO_PLAYBACK_STATE_STOPPED :Number

Video playback is stopped.

# VIDEO_REPEAT_MODE_NONE

Availability

6.2.0

0.9.0

9.2.0

VIDEO_REPEAT_MODE_NONE :Number

Constant for disabling repeat on video playback.

# VIDEO_REPEAT_MODE_ONE

Availability

6.2.0

0.9.0

9.2.0

VIDEO_REPEAT_MODE_ONE :Number

Constant for repeating one video (i.e., the one video will repeat constantly) during playback.

# VIDEO_SCALING_ASPECT_FILL DEPRECATED

Availability

0.8

VIDEO_SCALING_ASPECT_FILL :Number

DEPRECATED SINCE 7.0.0

Use VIDEO_SCALING_RESIZE_ASPECT_FILL instead.

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Scale video to fill the screen, clipping edges if necessary.

Video is scaled until the video fills the entire screen. Content at the edges of the larger of the two dimensions is clipped so that the other dimension fits the screen exactly. The aspect ratio of the movie is preserved.

# VIDEO_SCALING_ASPECT_FIT DEPRECATED

Availability

0.8

VIDEO_SCALING_ASPECT_FIT :Number

DEPRECATED SINCE 7.0.0

Use VIDEO_SCALING_RESIZE_ASPECT instead.

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Scale video to fit the screen, letterboxing if necessary.

Video is scaled until the larger dimension fits on the screen exactly. In the other dimension, the region between the edge of the movie and the edge of the screen is filled with a black bar. The aspect ratio of the movie is preserved.

This constant was removed on iOS in SDK 7.0.0

# VIDEO_SCALING_MODE_FILL DEPRECATED

Availability

0.8

VIDEO_SCALING_MODE_FILL :Number

DEPRECATED SINCE 7.0.0

Use <Titanium.Media.VIDEO_SCALING_MODE_RESIZE> instead.

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Video is scaled until both dimensions fit the screen exactly, stretching if necessary.

This constant was removed on iOS in SDK 7.0.0

# VIDEO_SCALING_NONE DEPRECATED

Availability

0.8

VIDEO_SCALING_NONE :Number

DEPRECATED SINCE 7.0.0

This property has been removed for iOS in Titanium SDK 7.0.0 as of the official deprecation by Apple.

Video scaling is disabled.

This constant was removed on iOS in SDK 7.0.0

# VIDEO_SCALING_RESIZE

Availability

8.3.0

7.0.0

9.2.0

VIDEO_SCALING_RESIZE :String | Number

Specifies that the video should be stretched to fill the bounds of layer.

This is a String on iOS, a Number on Android.

# VIDEO_SCALING_RESIZE_ASPECT

Availability

8.3.0

7.0.0

9.2.0

VIDEO_SCALING_RESIZE_ASPECT :String | Number

Specifies that the player should preserve the aspect ratio of video and fit the video within the bounds of layer.

This is a String on iOS, a Number on Android.

# VIDEO_SCALING_RESIZE_ASPECT_FILL

Availability

8.3.0

7.0.0

9.2.0

VIDEO_SCALING_RESIZE_ASPECT_FILL :String | Number

Specifies that the player should preserve the aspect ratio of video and fill the bounds of layer.

This is a String on iOS, a Number on Android.

# VIDEO_TIME_OPTION_CLOSEST_SYNC

Availability

3.6.0

VIDEO_TIME_OPTION_CLOSEST_SYNC :Number

Use the closest sync (or key) frame at given the time.

# VIDEO_TIME_OPTION_EXACT

Availability

0.8

9.2.0

VIDEO_TIME_OPTION_EXACT :Number

Use the exact time.

# VIDEO_TIME_OPTION_NEAREST_KEYFRAME

Availability

3.6.0

0.8

9.2.0

VIDEO_TIME_OPTION_NEAREST_KEYFRAME :Number

Use the closest keyframe in the time.

# VIDEO_TIME_OPTION_NEXT_SYNC

Availability

3.6.0

VIDEO_TIME_OPTION_NEXT_SYNC :Number

Use the sync (or key) frame located right after or at given the time.

# VIDEO_TIME_OPTION_PREVIOUS_SYNC

Availability

3.6.0

VIDEO_TIME_OPTION_PREVIOUS_SYNC :Number

Use the sync (or key) frame located right before or at given the time.