V2NIMSignallingCallSetupParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.avsignalling.params;

import android.text.TextUtils;
import com.netease.nimlib.SDKCacheUI;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.v2.avsignalling.config.V2NIMSignallingConfig;
import com.netease.nimlib.sdk.v2.avsignalling.config.V2NIMSignallingRtcConfig;

/**
 * 呼叫建立请求参数
 */
public class V2NIMSignallingCallSetupParams {

    private static final String TAG = "V2NIMSignallingCallSetupParams";

    /**
     * 信令频道ID，唯一标识了该频道房间
     */
    private final String channelId;

    /**
     * 接受的呼叫者账号ID
     */
    private final String callerAccountId;

    /**
     * 请求ID，可以用UUID实现，主要为了便于业务实现请求响应绑定
     */
    private final String requestId;

    /**
     * 服务器扩展字段，json格式，长度限制4096
     */
    private String serverExtension;

    /**
     * 信令相关配置，在接受场景无效
     */
    private V2NIMSignallingConfig signallingConfig;

    /**
     * 音视频相关参数配置
     */
    private V2NIMSignallingRtcConfig rtcConfig;

    private V2NIMSignallingCallSetupParams() {
        this(null, null, null);
    }

    public V2NIMSignallingCallSetupParams(String channelId, String callerAccountId, String requestId) {
        this.channelId = channelId;
        this.callerAccountId = callerAccountId;
        this.requestId = requestId;
    }

    /**
     * 获取信令频道ID
     *
     * @return 信令频道ID
     */
    public String getChannelId() {
        return channelId;
    }

    /**
     * 获取接受的呼叫者账号ID
     *
     * @return 呼叫者账号ID
     */
    public String getCallerAccountId() {
        return callerAccountId;
    }

    /**
     * 获取请求ID
     *
     * @return 请求ID
     */
    public String getRequestId() {
        return requestId;
    }

    /**
     * 获取服务器扩展字段
     *
     * @return 服务器扩展字段
     */
    public String getServerExtension() {
        return serverExtension;
    }

    /**
     * 设置服务器扩展字段
     *
     * @param serverExtension 服务器扩展字段
     */
    public void setServerExtension(String serverExtension) {
        this.serverExtension = serverExtension;
    }

    /**
     * 获取信令相关配置
     *
     * @return 信令相关配置
     */
    public V2NIMSignallingConfig getSignallingConfig() {
        return signallingConfig;
    }

    /**
     * 设置信令相关配置
     *
     * @param signallingConfig 信令相关配置
     */
    public void setSignallingConfig(V2NIMSignallingConfig signallingConfig) {
        this.signallingConfig = signallingConfig;
    }

    /**
     * 获取音视频相关参数配置
     *
     * @return 音视频相关参数配置
     */
    public V2NIMSignallingRtcConfig getRtcConfig() {
        return rtcConfig;
    }

    /**
     * 设置音视频相关参数配置
     *
     * @param rtcConfig 音视频相关参数配置
     */
    public void setRtcConfig(V2NIMSignallingRtcConfig rtcConfig) {
        this.rtcConfig = rtcConfig;
    }

    /**
     * 参数是否合法
     * @return 是否合法
     */
    public boolean isValid() {
        if (TextUtils.isEmpty(channelId)){
            NimLog.e(TAG, "channelId is empty");
            return false;
        }
        if (TextUtils.isEmpty(callerAccountId)){
            NimLog.e(TAG, "callerAccountId is empty");
            return false;
        }
        if(callerAccountId.equals(SDKCacheUI.getAccount())){
            NimLog.e(TAG, "callerAccountId is equal to self account");
            return false;
        }
        if (TextUtils.isEmpty(requestId)){
            NimLog.e(TAG, "requestId is empty");
            return false;
        }
        return true;
    }
    /**
     * 呼叫建立请求参数构建类
     */
    public static class Builder {

        private final String channelId;
        private final String callerAccountId;
        private final String requestId;
        private String serverExtension;
        private V2NIMSignallingConfig signallingConfig;
        private V2NIMSignallingRtcConfig rtcConfig;

        /**
         * 构造呼叫建立请求参数构建类
         *
         * @param channelId      信令频道ID
         * @param callerAccountId 呼叫者账号ID
         * @param requestId      请求ID
         */
        public Builder(String channelId, String callerAccountId, String requestId) {
            this.channelId = channelId;
            this.callerAccountId = callerAccountId;
            this.requestId = requestId;
        }

        /**
         * 设置服务器扩展字段
         *
         * @param serverExtension 服务器扩展字段
         * @return 呼叫建立请求参数构建类
         */
        public Builder serverExtension(String serverExtension) {
            this.serverExtension = serverExtension;
            return this;
        }

        /**
         * 设置信令相关配置
         *
         * @param signallingConfig 信令相关配置
         * @return 呼叫建立请求参数构建类
         */
        public Builder signallingConfig(V2NIMSignallingConfig signallingConfig) {
            this.signallingConfig = signallingConfig;
            return this;
        }

        /**
         * 设置音视频相关参数配置
         *
         * @param rtcConfig 音视频相关参数配置
         * @return 呼叫建立请求参数构建类
         */
        public Builder rtcConfig(V2NIMSignallingRtcConfig rtcConfig) {
            this.rtcConfig = rtcConfig;
            return this;
        }

        /**
         * 构建呼叫建立请求参数
         *
         * @return 呼叫建立请求参数
         */
        public V2NIMSignallingCallSetupParams build() {
            V2NIMSignallingCallSetupParams params = new V2NIMSignallingCallSetupParams(channelId, callerAccountId, requestId);
            params.setServerExtension(serverExtension);
            params.setSignallingConfig(signallingConfig);
            params.setRtcConfig(rtcConfig);
            return params;
        }
    }
}