屏幕共享

通过 Juphoon RTC SDK 可以在视频通话过程中实现屏幕共享，坐席可以将自己的屏幕内容，以视频的方式分享给远端参会者（访客），从而提升沟通效率，一般适用于一对一或多人视频通话、在线会议等在线金融场景。

• 视频会议场景中，参会者可以在会议中将本地的文件、数据、网页、PPT 等画面分享给其他与会者，让其他与会者更加直观的了解讨论的内容和主题。
• 在线金融场景中，坐席可以通过屏幕共享或者窗口共享将风险揭示等画面展示给远端的访客观看，移动端访客也可将屏幕共享给坐席观看，提升沟通效率。

1. 设置屏幕共享采集属性

/**
 * 设置屏幕共享采集属性
 *
 * 在调用 {@link #enableScreenCapture} 接口开启屏幕共享前设置即可生效
 * @param width     采集宽度，默认1280
 * @param height    采集高度，默认720
 * @param frameRate 采集帧速率，默认10
 */
public abstract void setScreenCaptureProperty(int width, int height, int frameRate);

/**
 * 开启/关闭屏幕采集
 *
 * @param enable 是否开启
 * @return 开启/关闭 是否成功
 */
public abstract boolean enableScreenCapture(boolean enable);

/**
 * 获取屏幕共享采集Id
 *
 * @return 屏幕共享采集Id
 */
public abstract String getScreenCaptureId();

示例代码：

// 设置屏幕共享采集属性
mediaDevice.setScreenCaptureProperty(1280, 720, 24);

//开启屏幕采集
mediaDevice.enableScreenCapture(true);
//关闭屏幕采集
mediaDevice.enableScreenCapture(false);

2. 开启/关闭屏幕共享

/**
 * 开启/关闭屏幕共享
 *
 * 成员开启或关闭屏幕共享，通话中的所有成员会收到 {@link JRTCGuestCallback#onCallPropertyChanged onCallPropertyChanged} 或 {@link JRTCAgentCallback#onCallPropertyChanged onCallPropertyChanged} 回调。
 * @param enable 开启或关闭屏幕共享
 * - true: 开启屏幕共享
 * - false: 关闭屏幕共享
 * @return 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 */
public abstract boolean enableScreenShare(boolean enable);

开启/关闭屏幕共享通过实现 JRTCAgentCallback (opens new window) 中的 onCallPropertyChanged (opens new window) 接口上报。

可通过 getShareUserId (opens new window) 获取当前正在屏幕共享的成员用户ID；

可通过 getShareStreamId (opens new window) 获取当前屏幕共享的视频流ID。

/**
 * 获取屏幕共享的视频流ID
 *
 * 调用 {@link JRTCMediaDevice#startVideo startVideo} 接口渲染通话中其他成员的屏幕共享画面时使用。
 *
 * @return
 * - 有屏幕共享时返回屏幕共享的视频流ID
 * - 无屏幕共享时返回 null
 */
public abstract String getShareStreamId();

/**
 * 获取发起屏幕共享者的用户ID
 *
 * 可用来判断当前通话中是否有成员发起屏幕共享。
 *
 * @return
 * - 有屏幕共享时返回发起屏幕共享者的用户ID
 * - 无屏幕共享时返回 null
 */
public abstract String getShareUserId();

若是访客发起屏幕共享，还可以根据 getShareStreamId() (opens new window) 渲染屏幕共享的画面。

示例代码：

//发起屏幕共享
agent.enableScreenShare(true);
//结束屏幕共享
agent.enableScreenShare(false);
// 监听到屏幕共享状态改变
public void onCallPropertyChanged(JRTCRoom.PropChangeParam propChangeParam) {
    if (propChangeParam.screenShare) {
        if (!TextUtiles.isEmpty(agent.getShareUserId())) {
            // 开启屏幕屏幕共享或者屏幕共享被替换
            if (TextUtiles.equals(client.getUserId, agent.getShareUserId())) {
            	// 本端发起屏幕共享
        	} else {
            	//通话中其他成员发起屏幕共享
            	// 其他成员发起屏幕共享
            	JRTCVideoSize size = new JRTCVideoSize();
            	size.setWidth(720);
            	size.setHeight(1280);
            	// 订阅屏幕共享视频流
            	agent.requestScreenVideo(size);
                // 开始渲染屏幕共享视频流画面
                mediaDevice.startVideo(agent.getShareStreamId(), JRTCMediaDevice.RENDER_FULL_CONTENT);
        	}
        } else {
            // 结束了屏幕共享
            // 如果不是自己发起的屏幕共享，则取消订阅屏幕共享视频流
            agent.unRequestScreenVideo();
            // 停止渲染屏幕共享视频流画面
            [mediaDevice.stopVideo(screenCanvas);
        }
        
        
    }
}

3. 暂停/恢复屏幕共享

/**
 * 暂停/继续屏幕共享
 * @note
 * 只有自己发起的屏幕共享可以使用该接口暂停，多次调用会覆盖
 * @param suspend true 暂停屏幕共享， false 继续屏幕共享
 * @param tip 暂停屏幕共享后提示文字
 * @return 接口调用结果
 * - true: 接口调用成功, 会收到 {@link JRTCGuestCallback#onCallPropertyChanged onCallPropertyChanged} 回调，可通过{@link #isSuspendScreenShare isSuspendScreenShare} 判断当前屏幕共享是否暂停
 * - false: 接口调用异常
 */
public abstract boolean suspendScreenShare(boolean suspend, String tip);

查询屏幕共享是否暂停

/**
 * 是否屏幕共享暂停
 * @return
 * - true: 暂停屏幕共享
 * - false: 未暂停屏幕共享
 */
public abstract boolean isSuspendScreenShare();

暂停/恢复屏幕共享变化事件通过实现 JRTCAgentCallback (opens new window) 中的 onCallPropertyChanged (opens new window) 接口上报。

示例代码：

// 发起屏幕共享
agent.suspendScreenShare(true,"屏幕共享暂停中");
// 通话属性变化回调
public void onCallPropertyChanged(PropChangeParam propChangeParam) {
    if (propChangeParam.screenShare) {
        if (agent.isSuspendScreenShare) {
            //屏幕共享暂停中
        }
    }
}

4. 订阅/取消订阅屏幕共享的视频流

如果通话中有成员开启了屏幕共享，其他成员将收到 onCallPropertyChanged (opens new window) 的回调，并通过 getShareUserId (opens new window) 获得发起屏幕共享的成员用户ID。

/**
 * 通话属性改变回调
 *
 * @param propChangeParam 通话改变的属性
 * @note 重点关注屏幕共享，即当{@link JRTCRoom.PropChangeParam#screenShare screenShare} 属性为 true 时，去处理屏幕共享相关事件。<br>
 * 可根据 {@link JRTCGuest#getShareStreamId shareRenderId} 和 {@link JRTCGuest#getShareUserId shareUserId} 属性进行屏幕共享画面的渲染和停止渲染。
 */
void onCallPropertyChanged(JRTCRoom.PropChangeParam propChangeParam);

此时可以调用 requestScreenVideo (opens new window) 方法请求订阅屏幕共享的视频流。

/**
 * 订阅通话中屏幕共享的视频流
 *
 * @param videoSize 视频请求的尺寸，详见 {@link JRTCVideoSize}
 * @return 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 */
public abstract boolean requestScreenVideo(JRTCVideoSize videoSize);

取消订阅屏幕共享的视频流，如果不需要屏幕共享视频流，此时可以调用 unRequestScreenVideo (opens new window) 方法取消订阅屏幕共享的视频流，建议不使用时取消订阅屏幕共享的视频流，否则可能造成资源浪费。

 /**
 * 取消订阅通话中屏幕共享的视频流
 *
 * @return 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 */
public abstract boolean unRequestScreenVideo();

5. 渲染共享画面

获取屏幕共享相关参数 getShareUserId (opens new window) 和 getShareStreamId (opens new window)

/**
 * 获取屏幕共享的视频流ID
 * 
 * 调用 {@link JRTCMediaDevice#startVideo startVideo} 接口渲染通话中其他成员的屏幕共享画面时使用。
 *
 * @return - 有屏幕共享时返回屏幕共享的视频流ID
 * - 无屏幕共享时返回 null
 */
public abstract String getShareStreamId();


/**
 * 获取发起屏幕共享者的用户ID
 * 
 * 可用来判断当前通话中是否有成员发起屏幕共享。
 *
 * @return - 有屏幕共享时返回发起屏幕共享者的用户ID
 * - 无屏幕共享时返回 null
 */
public abstract String getShareUserId();

屏幕共享开始/结束均通过实现 onCallPropertyChanged (opens new window) 接口上报。

示例代码：

public void onCallPropertyChanged(JRTCRoom.PropChangeParam propChangeParam) {
    if (propChangeParam.screenShare){
        if (guest.getShareUserId != null && guest.getShareUserId.length() > 0) {
            // 屏幕共享打开，可通过guest.getShareStreamId 渲染共享视频画面
        } else {
            // 屏幕共享关闭，可停止渲染共享视频画面
        }
    }
};