Hierarchy

Properties

stateSavingEnabled: boolean

Enables state saving of the videoview. Saves the configuration with video's current position.

Property

= true]

Android

Since

4.3.1

customErrorMessage: string

Sets a custom error message to be displayed by the view. The error message will be displayed permanently, unless it is cleared by passing null to this method.

Property

Android

Since

4.3.1

backgroundColor: IColor

Gets/sets background color of a view. It allows setting background color with UI.Color instance.

Property

Android

Since

4.3.1

loadingIndicatorEnabled: boolean

Sets whether a loading indicator is displayed when the player is in the buffering state. The loading indicator is not displayed by default.

Property

= false]

Android

Since

4.3.1

nextButtonEnabled: boolean

Sets whether the next button is shown.

Property

= true]

Android

Since

4.3.1

fastForwardButtonEnabled: boolean

Sets whether the fast forward button is shown.

Property

= true]

Android

Since

4.3.1

rewindButtonEnabled: boolean

Sets whether the rewind button is shown.

Property

= true]

Android

Since

4.3.1

previousButtonEnabled: boolean

Sets whether the previous button is shown.

Property

= true]

Android

Since

4.3.1

controllerShowTimeoutMs: number

Sets the controller timeout. The controller is automatically hidden after this duration of time has elapsed without user input and with playback or loading in progress.

Property

The timeout in milliseconds. A non-positive value will cause the ontroller to remain visible indefinitely.

Android

Since

4.3.1

onControllerVisibilityChange: ((visible: boolean) => void)

Type declaration

    • (visible: boolean): void
    • The event to be notified about controller visibility changes.

      Method

      onControllerVisibilityChange

      Android

      Since

      4.3.1

      Parameters

      • visible: boolean

      Returns void

showController: boolean

Sets controller visibility.

Property

Android

Since

4.3.1

yogaNode: any
overScrollMode: number

Gets/sets over-scroll mode for this view.

Property

= UI.Android.OverScrollMode.ALWAYS]

Android

Since

3.0.2

useForeground: boolean

Gets/sets foreground of the view for ripple effect. This property should be set before rippleColor. This property only supported for api level 23 and above.

Property

= false]

Android

Member

UI.View

Since

4.0.2

rippleEnabled: boolean

Gets/sets ripple effect enabled for view. You should set UI.View#rippleColor rippleColor to see the effect.

Property

= false]

Android

Member

UI.View

Since

3.2.1

rippleColor: IColor

Gets/sets ripple effect color for view.

Property

Android

Member

UI.View

Since

3.2.1

elevation: number

Gets/Sets the elevation of the view. For the views that has StateListAnimator natively like Button, will lost its own StateListAnimation when elevation value changed. For details : https://developer.android.com/training/material/shadows-clipping.html

Property

Android

Member

UI.View

See

Since

1.1.12

zIndex: number

Gets/sets the depth location of the view relative to its elevation. To put view over button, you have to change zIndex value after Android Lollipop. On android, default elevation value of button is bigger than other view. This property affects after Android Lollipop. No-op before api level 21.

Property

Android

Member

UI.View

Since

2.0.8

updateRippleEffectIfNeeded: (() => void)

Type declaration

    • (): void
    • Returns void

Events

onFullScreenModeChanged: ((isFullScreen: boolean) => void)

Type declaration

    • (isFullScreen: boolean): void
    • Setting this event makes the fullscreen button appear. The event to be notified when the fullscreen button is clicked, or null to remove the current listener and hide the fullscreen button. This is not the fullscreen implementation, so the fullscreen feature needs to implemented.

      onFullScreenModeChanged

      Android

      Since

      4.3.1

      Parameters

      • isFullScreen: boolean

      Returns void

Methods

  • Sets the full screen button image to minimize/maximize manually. If the UI.VideoView#onFullScreenModeChanged onFullScreenModeChanged callback wasn't assign, there won't be any changes. This is not the fullscreen implementation, so the fullscreen feature needs to implemented.

    Method

    setFullScreenButtonImage

    Android

    Since

    4.3.1

    Parameters

    • isInFullScreen: boolean

      if true, full screen button image will be minimize.

    Returns void

Generated using TypeDoc