# Titanium.UI.iOS.WebViewConfiguration

A collection of properties used to initialize a web view.

Availability

8.0.0

9.2.0

Extends

Titanium.Proxy

# Overview

Use the Titanium.UI.iOS.createWebViewConfiguration method to create and use as a parameter of Titanium.UI.WebView.configuration. Using this you can determine how soon a webpage is rendered, how media playback is handled, the granularity of items that the user can select, and many other options. This property can only be set when creating the webview and will be ignored when set afterwards.

See the example section "Usage of WebViewConfiguration with WebView in iOS".

# Properties

# allowsAirPlayMediaPlayback

Availability

8.0.0

9.2.0

allowsAirPlayMediaPlayback :Boolean

A Boolean value indicating whether AirPlay is allowed.

Default: true

# allowsInlineMediaPlayback

Availability

8.0.0

9.2.0

allowsInlineMediaPlayback :Boolean

A Boolean value indicating whether HTML5 videos play inline or use the native full-screen controller.

You must set this property to play inline video. Set this property to true to play videos inline. Set this property to false to use the native full-screen controller. When adding a video element to a HTML document on the iPhone, you must also include the playsinline attribute. The default value for iPhone is false and the default value for iPad is true.

Default: For iPhone false and for iPad true.

# allowsPictureInPictureMediaPlayback

Availability

8.0.0

9.2.0

allowsPictureInPictureMediaPlayback :Boolean

A Boolean value indicating whether HTML5 videos can play picture-in-picture.

Default: true

# mediaTypesRequiringUserActionForPlayback

Availability

8.0.0

9.2.0

mediaTypesRequiringUserActionForPlayback :Number

Determines which media types require a user gesture to begin playing.

This API can be assigned the following constants:

Default: Titanium.UI.iOS.AUDIOVISUAL_MEDIA_TYPE_NONE

# preferences

Availability

8.0.0

9.2.0

preferences :WebViewPreferencesObject

The preference settings to be used by the web view.

# processPool

Availability

8.0.0

9.2.0

processPool :Titanium.UI.iOS.WebViewProcessPool

The process pool from which to obtain the Web Content process of view.

When a web view is initialized, either a new web content process is created for it from the specified pool or an existing process in that pool is used.

# selectionGranularity

Availability

8.0.0

9.2.0

selectionGranularity :Number

The level of granularity with which the user can interactively select content in the web view.

This API can be assigned the following constants:

Default: Titanium.UI.iOS.SELECTION_GRANULARITY_DYNAMIC

# suppressesIncrementalRendering

Availability

8.0.0

9.2.0

suppressesIncrementalRendering :Boolean

A Boolean value indicating whether the web view suppresses content rendering until it is fully loaded into memory.

Default: false