About

This section provides description of the other APIs available on the AdPlayerPlacementView.

Basic properties

• playerTagId - the ID of the AdPlayerTag attached to this placement.
• label - a convenience field to ease the identification of AdPlayerPlacementView in log records.

Display properties

• priority - in case more than one placement is visible on the screen, a priority can be set to decide which one should play. This value is configurable between 1 and 999. In case one or more of the placements are partially visible, the playing placement will be selected based on the highest value of priority times visible percent. In any case, user interactions with the player and API calls will override the priority.
• animateAppearance - defines weather the appearance of new placements on the screen should be animated. Is false by default for instream tags and true for outstream tags.
• appearanceAnimationDuration - the duration of the appearance animation in milliseconds if animateAppearance is set to true.
• appearOnPlay - when set to false, the placement will appear on the screen immediately when the attached tag is available. Otherwise, the placement will appear on the screen only when the tag starts to play video. Is false by default for instream tags and true for outstream tags.
• allowFloatingAbove - in case the player in this AdPlayerPlacementView is defined as "Floating", this property will determine whether or not it can be floating above this AdPlayerPlacementView (when this placement is being scrolled down) in addition to being floating below this AdPlayerPlacementView (when this placement is being scrolled up).

Controls

• close() - prevents the player from appearing in this placement again unless the screen is recreated.

Display modes

Interstitial

An AdPlayerTag may be presented as interstitial. To do so, use the following API:

val tag: AdPlayerTag = TODO()
tag.asInterstitial()
    .withConfiguration {
        backgroundColor = Color.WHITE
        noAdTimeoutSec = 10
        dismissOnBack = true
    }
    .onDismissed {
        // do dismiss action
    }
    .launch()

Floating

Choosing the Floating player mode in the dashboard, allows the player to stay present on the screen and keep playing even after its original position has been scrolled out of view by “floating” at a fixed position on the screen. The floating position can also be selected in the dashboard from a pre defined set of options.

In general, the floating behavior and configuration is controlled from the dashboard but in order to provide flexibility to the application developers, they are the ones who define the borders that will limit the floating behavior by providing a Floating Scope. Here's a visual illustration:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/main_layout"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <FrameLayout
        android:id="@+id/floating_scope"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="@color/aniview_gray">

        <androidx.core.widget.NestedScrollView
            android:id="@+id/screen_content"
            android:layout_width="match_parent"
            android:layout_height="wrap_content">

            <!--Screen content here-->

        </androidx.core.widget.NestedScrollView>

    </FrameLayout>

</androidx.constraintlayout.widget.ConstraintLayout>

The scope is a ViewGroup, preferably a FrameLayout, that should be provided by invoking:

val placement: AdPlayerPlacementView = TODO()
placement.setFloatingScope(scopeViewGroup):

Or alternatively scope view ID can be provided in xml file:

<com.adservrs.adplayer.placements.AdPlayerPlacementView
    xmlns:app="http://schemas.android.com/apk/res-auto"
    ...
    app:floating_scope="@id/ad_placement_scope"
    />

Important remarks

• Floating behavior will not be available without providing a scope!
• Make sure the floating scope doesn’t extend beyond the limits of the visible area. A scope that extends beyond the limits of the visible area will cause the player to float off the screen and be cut off or even not visible at all.