Titanium SDK # Titanium.Media
The top-level Media module.
0.8
0.8
9.2.0# 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
# apiName READONLY
3.2.0 3.2.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# appMusicPlayer READONLY
0.8 9.2.0An instance of Titanium.Media.MusicPlayer representing the app-specific music player.
# aspectRatio READONLY
12.2.0Aspect ratio of the image.
Default: Titanium.Media.ASPECT_RATIO_4_3
# audioPlaying READONLY
0.8 9.2.0Returns true if the device is playing audio.
# audioSessionCategory
3.4.2 9.2.0A 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).
# availableCameraMediaTypes
0.8 9.2.0Array of media type constants supported for the camera.
# availableCameras READONLY
3.2.0 0.8 9.2.0Array indicating which cameras are available, CAMERA_FRONT, CAMERA_REAR or both.
# availablePhotoGalleryMediaTypes
0.8 9.2.0Array of media type constants supported for saving to the device's camera roll or saved images album.
# availablePhotoMediaTypes
0.8 9.2.0Array of media type constants supported for the photo library.
# averageMicrophonePower
0.8 9.2.0Current average microphone level in dB or -1 if microphone monitoring is disabled.
# bubbleParent
3.0.0 3.0.0 9.2.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# cameraAuthorization READONLY
5.2.0 9.2.0Returns the authorization status for the camera.
# cameraFlashMode
3.3.0 1.4.0 9.2.0Determines how the flash is fired when using the device's camera.
Default: Titanium.Media.CAMERA_FLASH_AUTO> on iOS, <Titanium.Media.CAMERA_FLASH_OFF> on Android
# cameraOutputSizes READONLY
12.2.0Returns an object of possible targetImageWidth and targetImageHeight values. The output
contains a cameraType (front or back) and object of width/height values. You have to set
targetImageWidth and targetImageHeight if you want to change the camera image output size.
Note: depeneding on your phone and camera the values won't be used or can be different.
# canRecord READONLY
6.2.0 0.8 9.2.0true if the device has a recording input device available.
# currentRoute READONLY
3.4.2 9.2.0Returns a description of the current route, consisting of zero or more input ports and zero or more output ports.
# isCameraSupported READONLY
0.8 0.8 9.2.0true if the device has camera support.
# lifecycleContainer
3.6.0The 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.
# peakMicrophonePower READONLY
0.8 9.2.0Current microphone level peak power in dB or -1 if microphone monitoring is disabled.
# QUALITY_640x480 READONLY
7.5.0 0.9.0 9.2.0Media 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
7.5.0 6.0.0 9.2.0Media type constant for medium-quality video recording.
If recording, specifies that you want to use 1280x720 iFrame format.
# QUALITY_IFRAME_960x540 READONLY
6.0.0 9.2.0Media type constant for medium-quality video recording.
If recording, specifies that you want to use 960x540 iFrame format.
# scalingMode READONLY
12.2.0Scaling mode of the preview image.
Default: Titanium.Media.IMAGE_SCALING_ASPECT_FILL
# systemMusicPlayer READONLY
0.8 9.2.0An instance of Titanium.Media.MusicPlayer representing the system-wide music player.
# useCameraX READONLY
12.2.0To use the new CameraX classes for "camera with overlay" set useCameraX to true
Default: false
# verticalAlign READONLY
12.2.0Vertical align of the preview image for aspect fit.
Default: Titanium.Media.VERTICAL_ALIGN_CENTER
# volume READONLY
0.8 9.2.0Current 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
# addEventListener
0.8 0.8 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
3.0.0 3.0.0 9.2.0Applies 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 | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# createAudioPlayer
0.9 0.9 9.2.0Creates 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
# createAudioRecorder
6.2.0 0.9 9.2.0Creates 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
# createSound
0.8 0.8 9.2.0Creates 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
6.1.0 9.2.0DEPRECATED 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
# createVideoPlayer
0.9 0.9 9.2.0Creates 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
# fireEvent
0.8 0.8 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# hasAudioPermissions DEPRECATED
6.0.0 9.2.0DEPRECATED 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
6.2.0 6.1.0 9.2.0Returns 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
# hasCameraPermissions
5.1.0 5.1.0 9.2.0Returns true if the app has camera access.
Returns
- Type
- Boolean
# hasMusicLibraryPermissions
6.0.0 9.2.0Returns 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
9.3.0 6.0.0 9.2.0Returns true if the app has photo gallery permissions.
If you use Android 13+ you have to add the following permissions to your tiapp.xml:
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO"/>
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
You don't need to check this before using requestPhotoGalleryPermissions. If you already have the permission and use requestPhotoGalleryPermissions it will call the success event, no second permission request is displayed.
Returns
- Type
- Boolean
# hideCamera
3.2.0 0.8 9.2.0Hides 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
0.8 9.2.0Hides the music library.
Must be called after calling openMusicLibrary
and only when autohide is set to false.
Returns
- Type
- void
# isMediaTypeSupported
0.8 9.2.0Returns 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: |
type | String | Media type to check. |
Returns
- Type
- Boolean
# openMusicLibrary
0.8 9.2.0Shows 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
0.8 0.8 9.2.0Opens 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
0.8Displays the given image.
Parameters
| Name | Type | Description |
|---|---|---|
options | Dictionary<PreviewImageOptions> | Dictionary containing the image and callback functions. |
Returns
- Type
- void
# queryMusicLibrary
0.8 9.2.0Searches 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>
# removeEventListener
0.8 0.8 9.2.0Removes 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 | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# requestAudioRecorderPermissions
6.2.0 6.1.0 9.2.0Request the user's permission for audio recording.
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.
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 |
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>
# requestCameraPermissions
5.1.0 5.1.0 9.2.0Requests 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 |
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
6.0.0 9.2.0Request 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
9.3.0 6.0.0 9.2.0Requests 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.
If you use Android 13+ you have to add the following permissions to your tiapp.xml:
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO"/>
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
When you only want to use it for images you can use [requestPermissions](/api/titanium/android.html#requestpermissions) and request android.permission.READ_MEDIA_IMAGES.
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 |
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>
# resumeVideoCapture
12.2.0Resumes video capturing.
Returns
- Type
- void
# saveToPhotoGallery
3.3.0 0.8 9.2.0Saves 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: |
Returns
- Type
- void
# setOverrideAudioRoute
0.8 9.2.0Overrides 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
0.8 0.8 9.2.0Shows 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
autohidetofalseand then set theoverlayproperty 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
saveToPhotoGallerytofalseis 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
0.8 9.2.0Starts monitoring the microphone sound level.
Returns
- Type
- void
# startVideoCapture
5.4.0 5.4.0 9.2.0Starts video capture using the camera specified.
Returns
- Type
- void
# stopMicrophoneMonitor
0.8 9.2.0Stops monitoring the microphone sound level.
Returns
- Type
- void
# stopVideoCapture
5.4.0 5.4.0 9.2.0Stops video capture using the camera specified.
Returns
- Type
- void
# switchCamera
3.2.0 1.8.1 9.2.0Switches 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
0.8 0.8 9.2.0Uses 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
0.8 0.8 9.2.0Takes 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
0.8 0.8 9.2.0Makes 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
# routechange
3.4.2 9.2.0Fired 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
0.8 9.2.0Fired 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_AIFF
0.8 9.2.0Audio file format Audio Interchange File Format (AIFF).
# AUDIO_FILEFORMAT_AMR
0.8 9.2.0Audio file format Adaptive Multi-Rate (AMR).
# AUDIO_FILEFORMAT_CAF
0.8 9.2.0Audio file format Apple Compressed Audio Format (CAF).
# AUDIO_FORMAT_APPLE_LOSSLESS
0.8 9.2.0Audio format Apple lossless encoding.
# AUDIO_FORMAT_LINEAR_PCM
0.8 9.2.0Audio format 16-bit, linear PCM encoding.
# AUDIO_SESSION_CATEGORY_AMBIENT
3.4.2 9.2.0For 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.
See also: AUDIO_SESSION_CATEGORY_SOLO_AMBIENT.
# AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD
3.4.2 9.2.0Session 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
3.4.2 9.2.0Session 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
3.4.2 9.2.0Session mode for recording audio; it silences playback audio.
# AUDIO_SESSION_CATEGORY_SOLO_AMBIENT
3.4.2 9.2.0Session 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
0.8 9.2.0Constant that specifies audio should output to the default audio route. See setOverrideAudioRoute for more information.
# AUDIO_SESSION_OVERRIDE_ROUTE_SPEAKER
0.8 9.2.0Constant that specifies audio should output to the speaker. See setOverrideAudioRoute for more information.
# AUDIO_SESSION_PORT_AIRPLAY
3.4.2 9.2.0Constant for output on a remote Air Play device. This is an output port.
# AUDIO_SESSION_PORT_BLUETOOTHA2DP
3.4.2 9.2.0Constant for output on a Bluetooth A2DP device. This is an output port.
# AUDIO_SESSION_PORT_BLUETOOTHHFP
3.4.2 9.2.0Constant for input or output on a Bluetooth Hands-Free Profile device. This can be both an input and output port.
# AUDIO_SESSION_PORT_BLUETOOTHLE
3.4.2 9.2.0Constant for output on a Bluetooth Low Energy device. This is an output port. This is available on iOS7 and later.
# AUDIO_SESSION_PORT_BUILTINMIC
3.4.2 9.2.0Constant for built-in microphone on an iOS device. This is an input port.
# AUDIO_SESSION_PORT_BUILTINRECEIVER
3.4.2 9.2.0Constant for the speaker you hold to your ear when on a phone call. This is an output port.
# AUDIO_SESSION_PORT_BUILTINSPEAKER
3.4.2 9.2.0Constant for built-in speaker on an iOS device. This is an output port.
# AUDIO_SESSION_PORT_CARAUDIO
3.4.2 9.2.0Constant 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
3.4.2 9.2.0Constant for output via High-Definition Multimedia Interface. This is an output port
# AUDIO_SESSION_PORT_HEADPHONES
3.4.2 9.2.0Constant for headphone or headset output. This is an output port.
# AUDIO_SESSION_PORT_HEADSETMIC
3.4.2 9.2.0Constant for microphone on a wired headset. This is an input port.
# AUDIO_SESSION_PORT_LINEIN
3.4.2 9.2.0Constant for line level input on a dock connector. This is an input port.
# AUDIO_SESSION_PORT_LINEOUT
3.4.2 9.2.0Constant for line level output on a dock connector. This is an output port.
# AUDIO_SESSION_PORT_USBAUDIO
3.4.2 9.2.0Constant for input or output on a Universal Serial Bus device. This can be both an input and output port.
# AUDIO_STATE_BUFFERING
7.5.0 7.5.0 9.2.0Audio data is being buffered from the network.
# AUDIO_STATE_INITIALIZED
7.5.0 7.5.0 9.2.0Audio playback is being initialized.
# AUDIO_STATE_WAITING_FOR_DATA
7.5.0 7.5.0 9.2.0Player is waiting for audio data from the network.
# CAMERA_AUTHORIZATION_AUTHORIZED
4.0.0 9.2.0Constant specifying that app is authorized to use camera. This is available on iOS7 and later.
# CAMERA_AUTHORIZATION_DENIED
4.0.0 9.2.0Constant specifying that app is denied usage of camera. This is available on iOS7 and later.
# CAMERA_AUTHORIZATION_RESTRICTED
4.0.0 9.2.0Constant specifying that app is restricted from using camera. This is available on iOS7 and later.
# CAMERA_AUTHORIZATION_UNKNOWN
5.2.0 9.2.0Constant specifying that app is not yet authorized to use camera. This is available on iOS7 and later.
# CAMERA_FLASH_AUTO
3.3.0 1.4.0 9.2.0Constant specifying to have the device determine to use the flash or not.
# CAMERA_FLASH_OFF
3.3.0 1.4.0 9.2.0Constant specifying to never fire the flash.
# CAMERA_FLASH_ON
3.3.0 1.4.0 9.2.0Constant specifying to always fire the flash.
# IMAGE_SCALING_ASPECT_FILL
10.1.0 10.1.0 10.1.0Crops the image proportionally causing its content to be clipped either horizontally or vertically.
# IMAGE_SCALING_ASPECT_FIT
10.1.0 10.1.0 10.1.0Letterbox or pillarbox scales the image proportionally to fit the container.
# IMAGE_SCALING_AUTO
10.1.0 10.1.0 10.1.0Scales 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
10.1.0 10.1.0 10.1.0Stretches the image disproportionally to completely fill the container's bounds.
# IMAGE_SCALING_NONE
10.1.0 10.1.0 10.1.0Disables scaling and displays the image as-is.
# MEDIA_TYPE_LIVEPHOTO
5.2.0 9.2.0Media type constant for live photo media.
# MUSIC_MEDIA_GROUP_ALBUM
0.8 9.2.0Constant for grouping query results by album.
# MUSIC_MEDIA_GROUP_ALBUM_ARTIST
0.8 9.2.0Constant for grouping query results by album and artist.
# MUSIC_MEDIA_GROUP_ARTIST
0.8 9.2.0Constant for grouping query results by artist.
# MUSIC_MEDIA_GROUP_COMPOSER
0.8 9.2.0Constant for grouping query results by composer.
# MUSIC_MEDIA_GROUP_GENRE
0.8 9.2.0Constant for grouping query results by genre.
# MUSIC_MEDIA_GROUP_PLAYLIST
0.8 9.2.0Constant for grouping query results by playlist.
# MUSIC_MEDIA_GROUP_PODCAST_TITLE
0.8 9.2.0Constant for grouping query results by podcast title.
# MUSIC_MEDIA_GROUP_TITLE
0.8 9.2.0Constant for grouping query results by title.
# MUSIC_MEDIA_TYPE_ALL
0.8 9.2.0Music library media containing any type of content.
# MUSIC_MEDIA_TYPE_ANY_AUDIO
0.8 9.2.0Music library media containing any type of audio content.
# MUSIC_MEDIA_TYPE_AUDIOBOOK
0.8 9.2.0Music library media containing audiobook content.
# MUSIC_MEDIA_TYPE_MUSIC
0.8 9.2.0Music library media containing music content.
# MUSIC_MEDIA_TYPE_PODCAST
0.8 9.2.0Music library media containing podcast content.
# MUSIC_PLAYER_REPEAT_ALL
0.8 9.2.0Constant for "Repeat All" setting.
# MUSIC_PLAYER_REPEAT_DEFAULT
0.8 9.2.0Constant for user's default repeat setting.
# MUSIC_PLAYER_REPEAT_NONE
0.8 9.2.0Constant for "No Repeat" setting.
# MUSIC_PLAYER_REPEAT_ONE
0.8 9.2.0Constant for "Repeat one item" setting.
# MUSIC_PLAYER_SHUFFLE_ALBUMS
0.8 9.2.0Constant for shuffling complete albums setting.
# MUSIC_PLAYER_SHUFFLE_DEFAULT
0.8 9.2.0Constant for user's default shuffle setting.
# MUSIC_PLAYER_SHUFFLE_NONE
0.8 9.2.0Constant for "no shuffle" setting.
# MUSIC_PLAYER_SHUFFLE_SONGS
0.8 9.2.0Constant for shuffling songs setting.
# MUSIC_PLAYER_STATE_INTERRUPTED
0.8 9.2.0Constant for interrupted state.
# MUSIC_PLAYER_STATE_PLAYING
0.8 9.2.0Constant for playing state.
# MUSIC_PLAYER_STATE_SEEK_BACKWARD
0.8 9.2.0Constant for backward seek state.
# MUSIC_PLAYER_STATE_SEEK_FORWARD
0.8 9.2.0Constant for forward seek state.
# MUSIC_PLAYER_STATE_STOPPED
0.8 9.2.0Constant for stopped state.
# NO_FOCUS
12.2.1 0.8 9.2.0Constant for camera didn't focus when taking a trying to take a picture.
# QUALITY_HIGH
7.5.0 0.9.0 9.2.0Media 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
7.5.0 0.9.0 9.2.0Media type constant for low-quality video recording.
Recorded files can usually be transferred over the cellular network.
# QUALITY_MEDIUM
0.8 9.2.0Media type constant for medium-quality video recording.
Recorded files can usually be transferred using Wi-Fi. This is the default video quality setting.
# VIDEO_CONTROL_DEFAULT DEPRECATED
0.8DEPRECATED 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
0.8DEPRECATED 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
0.8DEPRECATED 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
0.8DEPRECATED 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
0.8DEPRECATED 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
0.8Video playback ended normally.
# VIDEO_FINISH_REASON_PLAYBACK_ERROR
0.8Video playback ended abnormally.
# VIDEO_FINISH_REASON_USER_EXITED
0.8Video playback ended by user action (such as clicking the Done button).
# VIDEO_LOAD_STATE_FAILED
0.8 9.2.0Indicates that the player can no longer play media items because of an error.
# VIDEO_LOAD_STATE_PLAYABLE
0.8 0.8 9.2.0Current media is playable.
# VIDEO_LOAD_STATE_UNKNOWN
0.8 0.8 9.2.0Current load state is not known.
# VIDEO_MEDIA_TYPE_CLOSED_CAPTION
0.8 9.2.0The media contains closed-caption content.
# VIDEO_MEDIA_TYPE_DEPTH_DATA
0.8 9.2.0The media contains depth data.
# VIDEO_MEDIA_TYPE_METADATA
0.8 9.2.0The media contains metadata.
# VIDEO_MEDIA_TYPE_METADATA_OBJECT
0.8 9.2.0The media contains metadata objects.
# VIDEO_MEDIA_TYPE_SUBTITLE
0.8 9.2.0The media contains subtitles.
# VIDEO_MEDIA_TYPE_TIMECODE
0.8 9.2.0The media contains a time code.
# VIDEO_PLAYBACK_STATE_INTERRUPTED
0.8 0.8 9.2.0Video playback has been interrupted.
# VIDEO_PLAYBACK_STATE_PAUSED
0.8 0.8 9.2.0Video playback is paused.
# VIDEO_PLAYBACK_STATE_PLAYING
0.8 0.8 9.2.0Video is being played.
# VIDEO_PLAYBACK_STATE_SEEKING_BACKWARD
0.8Video 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
0.8Video 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
0.8 0.8 9.2.0Video playback is stopped.
# VIDEO_REPEAT_MODE_NONE
6.2.0 0.9.0 9.2.0Constant for disabling repeat on video playback.
# VIDEO_REPEAT_MODE_ONE
6.2.0 0.9.0 9.2.0Constant for repeating one video (i.e., the one video will repeat constantly) during playback.
# VIDEO_SCALING_ASPECT_FILL DEPRECATED
0.8DEPRECATED 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
0.8DEPRECATED 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
0.8DEPRECATED 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
0.8DEPRECATED 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
8.3.0 7.0.0 9.2.0Specifies 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
8.3.0 7.0.0 9.2.0Specifies 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
8.3.0 7.0.0 9.2.0Specifies 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
3.6.0Use the closest sync (or key) frame at given the time.
# VIDEO_TIME_OPTION_NEAREST_KEYFRAME
3.6.0 0.8 9.2.0Use the closest keyframe in the time.
# VIDEO_TIME_OPTION_NEXT_SYNC
3.6.0Use the sync (or key) frame located right after or at given the time.
# VIDEO_TIME_OPTION_PREVIOUS_SYNC
3.6.0Use the sync (or key) frame located right before or at given the time.