QChatMediaKit.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qcmedia;

import android.content.Context;

import com.netease.nimlib.qcmedia.QChatMediaKitImpl;
import com.netease.nimlib.sdk.qchat.model.QChatServerMember;
import com.netease.nimlib.sdk.qcmedia.enums.QChatMediaType;
import com.netease.nimlib.sdk.qcmedia.model.QChatMediaRTCChannelInfo;
import com.netease.nimlib.sdk.qcmedia.model.QChatMediaServerConfig;
import com.netease.nimlib.sdk.qcmedia.param.QChatMediaGetRTCChannelInfoParam;
import com.netease.nimlib.sdk.qcmedia.param.QChatMediaGetRTCChannelOnlineMembersParam;
import com.netease.nimlib.sdk.qcmedia.param.QChatMediaUpdateRTCChannelInfoParam;

import java.util.List;

/**
 * QChatMedia主类
 */
public interface QChatMediaKit {

    static QChatMediaKit getInstance(){
        return Companion.INSTANCE;
    }

    /**
     * 初始化
     * @param context
     * @param callback
     */
    void initialize(Context context, QCMCallback<Void> callback);


    /**
     *  初始化
     * @param context
     * @param serverConfig 私有化配置
     * @param callback
     */
    void initialize(Context context, QChatMediaServerConfig serverConfig, QCMCallback<Void> callback);

    /**
     * 查询初始化状态
     */
    boolean isInitialized();

    /**
     * 连接RTC频道
     * @param serverId 服务器id
     * @param channelId 频道Id
     * @param type 多媒体频道类型，目前只支持RTC
     * @param callback 回调
     * @return
     */
    void connect(long serverId,long channelId, QChatMediaType type,QCMCallback<Void> callback);

    /**
     * 取消连接RTC频道，无论结果是否成功都将退出房间
     * @param callback
     */
    void disConnect(QCMCallback<Void> callback);

    /**
     * 是否已连接
     * @return
     */
    boolean isConnected();
    /**
     * 修改RTC频道的相关参数
     * @param param 修改RTC频道的相关参数入参
     * @param callback 回调
     */
    void updateRTCChannelInfo(QChatMediaUpdateRTCChannelInfoParam param,QCMCallback<Void> callback);

    /**
     *  查询RTC频道的相关参数
     * @param param 查询RTC频道的相关参数入参
     * @param callback 回调
     */
    void getRTCChannelInfo(QChatMediaGetRTCChannelInfoParam param,QCMCallback<QChatMediaRTCChannelInfo> callback);

    /**
     * 查询RTC频道的在线成员
     * @param param 查询RTC频道的在线成员入参
     * @param callback 回调
     */
    void getRTCChannelOnlineMembers(QChatMediaGetRTCChannelOnlineMembersParam param,QCMCallback<List<? extends QChatServerMember>> callback);

    /**
     * 获取RTC频道控制器
     * @return
     */
    QChatRTCChannelController getRTCChannelRoomController();

    final class Companion {
        private static final QChatMediaKit INSTANCE = new QChatMediaKitImpl();
    }
}