保利威文档中心

幫助中心

7_9-核心common-开播

更新時間:2023-04-17 15:27:57

1 功能概述

開播場景的推流和連麥模組位於polyvLiveCommonModul模組的streamer包下,推流和連麥的資訊接收和發送依賴於socket,即需用PLVSocketLoginManager完成登入後,才能正常使用推流和連麥的功能。推流和連麥模組採用mvp設計模式,將view層和model層分離,將多個場景中對推流和連麥的demo呼叫的共用程式碼抽離封裝到presenter層中,使頁面的view層的邏輯變得簡潔,封裝的presenter層負責streamerManager的呼叫以及通知view層更新UI。

2 MVP模式

推流和連麥的mvp模式是用IPLVStreamerContract作為契約類別,內部定義了推流和連麥的mvp-view介面IStreamerView,以及推流和連麥的mvp-presenter介面IStreamerPresnter

public interface IPLVStreamerContract {

    // <editor-fold defaultstate="collapsed" desc="1、mvp-推流和连麦view层接口">

    /**
     * mvp-推流和连麦view层接口
     */
    interface IStreamerView {
        /**
         * 设置presenter后的回调
         */
        void setPresenter(@NonNull IStreamerPresenter presenter);

        /**
         * 推流引擎创建成功,View层应创建连麦适配器和初始化连麦布局
         *
         * @param linkMicUid  我的连麦id
         * @param linkMicList 连麦列表。在实现中,要用该列表去渲染
         */
        void onStreamerEngineCreatedSuccess(String linkMicUid, List<PLVLinkMicItemDataBean> linkMicList);

        /**
         * 响应用户开关视频
         *
         * @param uid             用户id
         * @param mute            true表示关闭视频,false表示开启视频
         * @param streamerListPos 推流和连麦列表中的位置
         * @param memberListPos   成员列表中的位置
         */
        void onUserMuteVideo(final String uid, final boolean mute, int streamerListPos, int memberListPos);

        /**
         * 响应用户开关音频
         *
         * @param uid             用户id
         * @param mute            true表示关闭音频,false表示开启音频
         * @param streamerListPos 列表中的位置
         * @param memberListPos   成员列表中的位置
         */
        void onUserMuteAudio(final String uid, final boolean mute, int streamerListPos, int memberListPos);

        /**
         * 响应本地用户麦克风音量变化
         */
        void onLocalUserMicVolumeChanged();

        /**
         * 响应远端用户麦克风音量变化
         */
        void onRemoteUserVolumeChanged(List<PLVMemberItemDataBean> linkMicList);

        /**
         * 响应用户加入连麦频道
         *
         * @param uids
         */
        void onUsersJoin(List<String> uids);

        /**
         * 响应用户离开连麦频道
         *
         * @param uids
         */
        void onUsersLeave(List<String> uids);

        /**
         * 推流网络变化
         *
         * @param quality 网络状态常量
         */
        void onNetworkQuality(int quality);

        /**
         * 更新推流时间
         *
         * @param secondsSinceStartTiming 推流时间,单位:秒
         */
        void onUpdateStreamerTime(int secondsSinceStartTiming);

        /**
         * 因断网延迟20s断流
         */
        void onShowNetBroken();

        /**
         * 当前为结束推流状态
         */
        void onStatesToStreamEnded();

        /**
         * 当前为成功推流状态
         */
        void onStatesToStreamStarted();

        /**
         * 响应推流和连麦错误
         */
        void onStreamerError(int errorCode, Throwable throwable);

        /**
         * 更新成员列表数据
         *
         * @param dataBeanList 成员列表。在实现中,要用该列表去渲染
         */
        void onUpdateMemberListData(List<PLVMemberItemDataBean> dataBeanList);

        /**
         * 相机方向改变
         *
         * @param front true:前置,false:后置
         * @param pos   成员列表中的位置
         */
        void onCameraDirection(boolean front, int pos);

        /**
         * 更新成员列表中的socket用户信息
         *
         * @param pos 成员列表中的位置
         */
        void onUpdateSocketUserData(int pos);

        /**
         * 添加成员列表数据
         *
         * @param pos 成员列表中的位置
         */
        void onAddMemberListData(int pos);

        /**
         * 移除成员列表数据
         *
         * @param pos 成员列表中的位置
         */
        void onRemoveMemberListData(int pos);

        /**
         * 达到最大连麦人数的回调,在达到最大连麦人数后再同意用户连麦时触发
         */
        void onReachTheInteractNumLimit();

        /**
         * 用户请求连麦触发
         *
         * @param uid 连麦的id
         */
        void onUserRequest(String uid);
    }
    // </editor-fold>

    // <editor-fold defaultstate="collapsed" desc="2、mvp-推流和连麦presenter层接口">

    /**
     * mvp-推流和连麦presenter层接口
     */
    interface IStreamerPresenter {
        /**
         * 注册view,可以注册多个
         */
        void registerView(@NonNull IStreamerView v);

        /**
         * 解除注册的view
         */
        void unregisterView(IStreamerView v);

        /**
         * 初始化推流和连麦配置
         */
        void init();

        /**
         * 获取网络质量
         *
         * @return 网络质量常量
         */
        int getNetworkQuality();

        /**
         * 设置推流码率
         *
         * @param bitrate 码率
         */
        void setBitrate(@PLVSStreamerConfig.BitrateType int bitrate);

        /**
         * 获取设置的推流码率
         *
         * @return 设置的推流码率
         */
        int getBitrate();

        /**
         * 获取最大支持的推流码率
         *
         * @return 最大支持的推流码率
         */
        int getMaxBitrate();

        /**
         * 是否允许录制声音
         *
         * @param enable true:允许,false:不允许
         */
        boolean enableRecordingAudioVolume(boolean enable);

        /**
         * 是否允许录制视频/打开摄像头
         *
         * @param enable true:允许,false:不允许
         */
        boolean enableLocalVideo(boolean enable);

        /**
         * 设置相机方向
         *
         * @param front true:前置,false:后置
         */
        boolean setCameraDirection(boolean front);

        /**
         * 创建渲染器
         *
         * @param context 上下文
         * @return 渲染器
         */
        SurfaceView createRenderView(Context context);

        /**
         * 为特定的连麦ID的用户设置连麦渲染器
         *
         * @param renderView 渲染器
         * @param linkMicId  连麦ID
         */
        void setupRenderView(SurfaceView renderView, String linkMicId);

        /**
         * 开始推流
         */
        void startLiveStream();

        /**
         * 停止推流
         */
        void stopLiveStream();

        /**
         * 控制成员列表中的用户加入或离开连麦
         *
         * @param position    成员列表中的位置
         * @param isAllowJoin true:加入,false:离开
         */
        void controlUserLinkMic(int position, boolean isAllowJoin);

        /**
         * 禁/启用用户媒体
         *
         * @param position    成员列表中的位置
         * @param isVideoType true:视频,false:音频
         * @param isMute      true:禁用,false:启用
         */
        void muteUserMedia(int position, boolean isVideoType, boolean isMute);

        /**
         * 下麦全体连麦用户
         */
        void closeAllUserLinkMic();

        /**
         * 全体连麦用户禁用/开启声音
         *
         * @param isMute true:禁用,false:开启
         */
        void muteAllUserAudio(boolean isMute);

        /**
         * 请求成员列表数据
         */
        void requestMemberList();

        /**
         * 获取推流状态
         *
         * @return 推流状态常量
         */
        int getStreamerStatus();

        /**
         * 获取推流和连麦的数据
         */
        @NonNull
        PLVStreamerData getData();

        /**
         * 销毁,包括销毁推流和连麦操作、解除view操作
         */
        void destroy();
    }
    // </editor-fold>
}

2.1 Presenter實作邏輯

IStreamerPresenter的實作類別為PLVStreamerPresenter

其內部主要是使用以下兩個類別來完成核心業務:

1、IPLVLiveRoomDataManager,直播間資料管理器

2、IPLVSStreamerManager,sdk層的推流和連麥管理器streamerManager

2.1.1 初始化

PLVStreamerPresenter在建構子中進行了如下的初始化操作:引用IPLVLiveRoomDataManager,建立PLVStreamerData,初始化建立推流和連麥管理器,開啟推流和連麥的相關資訊監聽器。

public PLVStreamerPresenter(IPLVLiveRoomDataManager liveRoomDataManager) {
    this.liveRoomDataManager = liveRoomDataManager;
    streamerData = new PLVStreamerData();

    String viewerId = liveRoomDataManager.getConfig().getUser().getViewerId();
    PolyvLinkMicConfig.getInstance().init(viewerId, true);//需先初始化,再创建manager
    streamerManager = PLVSStreamerManagerFactory.createNewStreamerManager();

    streamerMsgHandler = new PLVStreamerMsgHandler(this);
    streamerMsgHandler.run();
}

PLVStreamerData是推流和連麥的業務資料,內部儲存的資料都是MutableLiveData類型,主要用於提供給其他的view獲取/監聽推流和連麥的資料,可用作於不同業務模組間的資料監聽及獲取。

PolyvLinkMicConfig.getInstance().init方法是初始化連麥的資料。

PLVSStreamerManagerFactory.createNewStreamerManager()方法內部會建立一個推流和連麥的管理器實例並回傳。

PLVStreamerMsgHandler是推流和連麥的資訊處理器,主要負責監聽socket和rtc的相關推流和連麥的事件,並做相應的邏輯處理。

2.1.2 註冊mvp-view

在ui層建立好mvp-view後,透過呼叫mvp-presenter的regitsterView方法,即可把mvp-view傳給mvp-presenter,這樣mvp-presenter即可通知mvp-view進行一些ui更新等操作;同時mvp-presenter也會把自身傳給mvp-view,使得mvp-view可以呼叫mvp-presenter提供的方法。

@Override
public void registerView(@NonNull IPLVStreamerContract.IStreamerView v) {
    if (iStreamerViews == null) {
        iStreamerViews = new ArrayList<>();
    }
    if (!iStreamerViews.contains(v)) {
        iStreamerViews.add(v);
    }
    v.setPresenter(this);
}

PLVStreamerPresenter可以註冊多個IStreamerView

3 SDK核心類別介紹

推流和連麥的SDK核心類別是IPLVSStreamerManager,該類別是推流和連麥的管理器介面。

3.1 建立

IPLVSStreamerManager的實例可以透過PLVSStreamerManagerFactory.createNewStreamerManager方法建立。

IPLVSStreamerManager streamerManager = PLVSStreamerManagerFactory.createNewStreamerManager();

3.2 初始化

/**
 * 初始化推流sdk
 *
 * @param streamerListener 推流业务监听器
 */
void initEngine(PLVSStreamerListener streamerListener);

3.3 設定監聽器

/**
 * 添加推流事件监听器
 *
 * @param eventHandler 监听器
 */
void addEventHandler(PLVSStreamerEventListener eventHandler);

3.4 推流控制

/**
 * 开始推流
 */
void startLiveStream();

/**
 * 停止推流
 */
void stopLiveStream();

3.5 銷毀

銷毀推流和連麥管理器,並釋放資源。

/**
 * 销毁
 */
void destroy();
联系客服,在线咨询