AVChatLiveCompositingLayout.java

浏览该文件的文档.

/*
 * Copyright (c) 2014-2018 NetEase, Inc.
 * All right reserved.
 */

package com.netease.nimlib.sdk.avchat.model;


import android.text.TextUtils;

import com.netease.nrtc.engine.rawapi.RtcLiveCompositingLayout;
import com.netease.nrtc.sdk.video.LiveCompositingLayout;

@Deprecated
public class AVChatLiveCompositingLayout extends RtcLiveCompositingLayout {

    @Deprecated
    public interface Mode {

        /**
         * 右侧纵排浮窗
         */
        int LAYOUT_FLOATING_RIGHT_VERTICAL = CompositingMode.LAYOUT_FLOATING_RIGHT_VERTICAL;


        /**
         * 左侧纵排浮窗
         */
        int LAYOUT_FLOATING_LEFT_VERTICAL = CompositingMode.LAYOUT_FLOATING_LEFT_VERTICAL;


        /**
         * 切分屏幕
         */
        int LAYOUT_SPLIT_SCREEN = CompositingMode.LAYOUT_SPLIT_SCREEN;


        /**
         * 切分屏幕，画面缩放
         */
        int LAYOUT_SPLIT_SCREEN_SCALING = CompositingMode.LAYOUT_SPLIT_SCREEN_SCALING;


        /**
         * 自定义模式, 需要设置 {@link LiveCompositingLayout#setExtraInfo(String)} 字段
         */
        int LAYOUT_ENHANCE = CompositingMode.LAYOUT_ENHANCE;


        /**
         * 纯音频模式，可以设置额外的人数限制
         */
        int LAYOUT_ONLY_AUDIO = CompositingMode.LAYOUT_ONLY_AUDIO;
    }


    /**
     * @param mode      混合模式 {@link Mode}
     * @param extraInfo 额外信息
     * @see <a href="http://netease.im/blog/12-3">http://netease.im/blog/12-3</a>
     */
    public AVChatLiveCompositingLayout(int mode, String extraInfo) {
        super(mode, extraInfo);
    }

    /**
     * @param mode 混合模式 {@link CompositingMode}
     */
    public AVChatLiveCompositingLayout(int mode) {
        super(mode);
    }

    /**
     * 默认布局
     */
    public AVChatLiveCompositingLayout() {
        super();
    }

    /**
     * 获取混合模式
     *
     * @return 混合模式
     * @see CompositingMode
     */
    public int getMode() {
        return mode;
    }


    /**
     * 设置混合模式
     *
     * @param mode 混合模式
     * @see CompositingMode
     */
    public void setMode(int mode) {
        this.mode = mode;
    }

    /**
     * 获取额外信息，{@link Mode#LAYOUT_ENHANCE}, {@link Mode#LAYOUT_ONLY_AUDIO} 时有效
     *
     * @return 用户自定义信息
     */
    public String getExtraInfo() {
        return extraInfo;
    }


    /**
     * 设置额外信息，{@link Mode#LAYOUT_ENHANCE}, {@link Mode#LAYOUT_ONLY_AUDIO} 时有效
     *
     * @param extraInfo 用户自定义信息
     */
    public void setExtraInfo(String extraInfo) {
        this.extraInfo = extraInfo;
    }

    @Override
    public String toString() {
        return "mode:" + mode + ", extra:" + (TextUtils.isEmpty(extraInfo) ? "null" : "layout");
    }

}