QChatRTCChannelController.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qcmedia;


import android.content.Intent;
import android.media.projection.MediaProjection;
import com.netease.nimlib.sdk.qcmedia.enums.QChatMediaVideoStreamType;
import com.netease.nimlib.sdk.qcmedia.model.QChatMediaMember;
import com.netease.nimlib.sdk.qcmedia.model.QChatMediaVideoView;
import java.util.List;

/**
 * RTC频道控制器
 */
public interface QChatRTCChannelController {

    /**
     * 添加RTC频道事件监听
     * @param listener RTC频道监听
     */
    void addRTCChannelListener(QChatRTCChannelListener listener);

    /**
     * 移除RTC频道监听
     * @param listener RTC频道监听
     */
    void removeRTCChannelListener(QChatRTCChannelListener listener);

    /**
     * 移除成员
     * @param accid 用户id
     * @param callback 回调
     */
    void kickMemberOut(String accid, QCMCallback<Void> callback);

    /**
     * 切换摄像头
     */
    int switchCamera();

    /**
     * 关闭成员音频,如果accid为当前用户，则关闭本端音频发送，操作其他成员会进行权限校验
     * @param accid 用户accid
     * @param callback 回调
     */
    void muteAudio(String accid,QCMCallback<Void> callback);

    /**
     * 打开成员音频,如果accid为当前用户，则打开本端音频发送，操作其他成员会进行权限校验
     * @param accid 用户accid
     * @param callback 回调
     */
    void unMuteAudio(String accid,QCMCallback<Void> callback);

    /**
     * 关闭所有成员音频
     * @param callback 回调
     */
    void muteAllAudio(QCMCallback<Void> callback);

    /**
     * 打开所有成员音频
     * @param callback 回调
     */
    void unMuteAllAudio(QCMCallback<Void> callback);

    /**
     * 关闭成员视频,如果accid为当前用户，则关闭本端视频，操作其他成员会进行权限校验
     * @param accid 用户accid
     * @param callback 回调
     */
    void muteVideo(String accid,QCMCallback<Void> callback);

    /**
     * 打开成员视频,如果accid为当前用户，则打开本端视频，操作其他成员会进行权限校验
     * @param accid 用户accid
     * @param callback 回调
     */
    void unMuteVideo(String accid,QCMCallback<Void> callback);

    /**
     * 关闭所有成员视频
     * @param callback 回调
     */
    void muteAllVideo(QCMCallback<Void> callback);

    /**
     * 打开所有成员视频
     * @param callback 回调
     */
    void unMuteAllVideo(QCMCallback<Void> callback);

    /**
     * 开启本端屏幕共享
     * @param screenShareResultData Android 的录屏请求结果 Intent，在请求录屏权限时返回
     * @param mediaProjectionCallback 录屏状态回调，用于监听录屏的结束通知
     * @param callback 回调
     */
    void startScreenShare(
            Intent screenShareResultData,
            MediaProjection.Callback mediaProjectionCallback,
            QCMCallback<Void> callback);

    /**
     * 关闭本端屏幕共享
     * @param callback 回调
     */
    void stopScreenShare(QCMCallback<Void> callback);

    /**
     * 尝试关闭RTC频道内成员的屏幕共享，会进行权限校验。
     * @param accid 成员账号Id
     * @param callback 回调
     */
    void stopMemberScreenShare(String accid, QCMCallback<Void> callback);

    /**
     * 订阅指定远端用户的视频流
     * @param accid  用户id
     * @param streamType 流类型
     */
    int subscribeRemoteVideoStream(String accid, QChatMediaVideoStreamType streamType);

    /**
     * 取消订阅指定远端用户的视频流
     * @param accid  用户id
     * @param streamType 流类型
     */
    int unsubscribeRemoteVideoStream(String accid, QChatMediaVideoStreamType streamType);

    /**
     * 订阅指定远端用户辅流视频
     * @param accid  用户id
     */
    int subscribeRemoteVideoSubStream(String accid);

    /**
     * 取消订阅指定远端用户辅流视频
     * @param accid  用户id
     */
    int unsubscribeRemoteVideoSubStream(String accid);

    /**
     * 设置用户视图,如果accid为当前登录用户，则设置本端视图
     * @param videoView 视频画布
     * @param accid  用户id
     */
    int setupVideoCanvas(QChatMediaVideoView videoView, String accid);


    /**
     * 设置远端的辅流视频画布
     * @param videoView 视频画布
     * @param accid  用户id
     */
    int setupRemoteVideoSubStreamCanvas(QChatMediaVideoView videoView, String accid);

    /**
     * 调节本地播放的指定远端用户的信号音量
     * 加入RTC频道后，您可以多次调用该方法设置本地播放的不同远端用户的音量；也可以反复调节本地播放的某个远端用户的音量。
     * @param accid  用户id
     * @param volume  播放音量，取值范围为 [0,100]
     */
    int adjustUserPlaybackSignalVolume(String accid, int volume);

    /**
     * 查询屏幕共享者的userUuid
     */
    String getScreenSharingUserUuid();

    /**
     * 打开或关闭扬声器
     */
    int setSpeakerphoneOn(boolean on);

    /**
     * 查询扬声器是否开启
     */
    boolean isSpeakerphoneOn();

    /**
     * 启用说话者音量提示。
     * 该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户（最多 3 位）的音量相关信息，
     * 即当前谁在说话以及说话者的音量。启用该方法后，只要RTC频道内有发流用户，无论是否有人说话，
     * SDK 都会在加入RTC频道后根据预设的时间间隔触发 [NERoomListener.onRtcAudioVolumeIndication] 回调
     * @param enable 是否启用说话者音量提示。
     * @param interval 指定音量提示的时间间隔。单位为毫秒。必须设置为 100 毫秒的整数倍值，建议设置为 200 毫秒以上。
     */
    int enableAudioVolumeIndication(boolean enable, int interval);

    /**
     * 获取本端成员
     * @return
     */
    QChatMediaMember getLocalQChatMediaMember();

    /**
     * 获取远端成员（不包括本端）
     * @return 远端成员列表
     */
    List<QChatMediaMember> getQChatMediaMembers();
}