V2NIMSignallingJoinParams.java

浏览该文件的文档.

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

import android.text.TextUtils;
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 V2NIMSignallingJoinParams {

    private static final String TAG = "V2NIMSignallingJoinParams";

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

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

    /**
     * 信令相关配置
     */
    private V2NIMSignallingConfig signallingConfig;

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

    private V2NIMSignallingJoinParams() {
        this(null);
    }

    /**
     * 加入信令房间请求参数
     *
     * @param channelId 信令频道ID
     */
    public V2NIMSignallingJoinParams(String channelId) {
        this.channelId = channelId;
    }

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

    /**
     * 获取服务器扩展字段
     *
     * @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 invalid");
            return false;
        }
        return true;

    }

    /**
     * 加入信令房间请求参数构造器
     */
    public static class Builder {
        private final V2NIMSignallingJoinParams params;

        /**
         * 构造函数
         *
         * @param channelId 信令频道ID
         */
        public Builder(String channelId) {
            params = new V2NIMSignallingJoinParams(channelId);
        }

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

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

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

        /**
         * 构建加入信令房间请求参数
         *
         * @return 加入信令房间请求参数
         */
        public V2NIMSignallingJoinParams build() {
            return params;
        }
    }
}