Multiparty-Constraint-Layout-Java

Multiparty Constraint Layout

This app shows how to use basic layouts to display the different video views of the participants.

When building a complex app, there is a better option in order to layout the views - ConstraintLayout. Using this layout has several benefits. One is that you can use a single layout to specify all the view positions instead of having to nest several different layouts.

To use this sample application, add the ConstraintLayout dependency.

Using Constraint Layout to display the views

In order to specify the layout parameters, the application uses the ConstraintSet class. This class lets you specify the relations between two views in the form of view A is above view B or view A is the same size as view B.

For example, to specify that a view is above another view, the application uses a helper method inside the ConstraintSetHelper class:

public void layoutViewAboveView(int aboveViewId, int belowViewId) {
    //  above
    //  below

    set.constrainHeight(aboveViewId, 0);
    set.constrainHeight(belowViewId, 0);
    set.connect(aboveViewId, ConstraintSet.BOTTOM, belowViewId, ConstraintSet.TOP);
    set.connect(belowViewId, ConstraintSet.TOP, aboveViewId, ConstraintSet.BOTTOM);
}

Once all constraints are added to the ConstraintSet, we apply them to the ConstraintLayout:

public void applyToLayout(ConstraintLayout layout, boolean animated) {
    if (animated) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
            TransitionManager.beginDelayedTransition(layout);
        }
    }
    
    set.applyTo(layout);
}

See the ConstraintSetHelper class for more details about how to set up the constraints for different view positions.

In order to actually position the views, the application calculates the constraints whenever a new view is added or removed, in callback methods like the SessionsListener.onStreamReceived method. Those callbacks add the view to the container and call calculateLayout(), which includes logic for view positioning.

In this sample we have four possible layouts:

1. The publisher is alone, so it will be displayed fullscreen.

2. There is just one subscriber. In this case the screen is split in two. The publisher will be displayed above the subscriber.

3. There are more than one subscriber, and they are an even number. In this case, the application displays the Publisher using the full width of the container above all subscribers, and subscribers are displayed in rows two by two.

4. There are more than one subscriber, and they are an odd number. In this case, the container space is like a grid and all views will be displayed two by two, with the publisher in the upper-left corner.

The calculateLayout method implements this logic. For example, for the second case (where there is just one subscriber), here is a simplified version of the code:

private void calculateLayout() {
    ConstraintSetHelper set = new ConstraintSetHelper(R.id.main_container);

    int size = subscribers.size();
    if (size == 1) {
        // Publisher
        // Subscriber
        set.layoutViewAboveView(R.id.publisher_view_id, getResIdForSubscriberIndex(0));
        set.layoutViewWithTopBound(R.id.publisher_view_id, R.id.main_container);
        set.layoutViewWithBottomBound(getResIdForSubscriberIndex(0), R.id.main_container);
        set.layoutViewAllContainerWide(R.id.publisher_view_id, R.id.main_container);
        set.layoutViewAllContainerWide(getResIdForSubscriberIndex(0), R.id.main_container);
    }

    set.applyToLayout(mContainer, true);
}

See the code itself for the other cases.

Further Reading

• See the Android developers guide for Constraint Layout

• Read more about OpenTok Android SDK