本章将介绍如何实现互动直播,互动直播的 API 调用时序见下图:

/cn/document/V2.1/images/doc_python_image/multivideoworkflow.png

初始化

调用 JCMediaDevice createJCMediaChannel create 以初始化实现多方通话需要的模块:

//初始化
-(bool)initialize {
   //1. 媒体类
   JCMediaDevice *mediaDevice = [JCMediaDevice create:client callback:self];
   //2. 媒体通道类
   JCMediaChannel *mediaChannel = [JCMediaChannel create:client mediaDevice:mediaDevice callback:self];
   return client.state == JCClientStateLogined;
}

其中:

  • JCMediaDevice create 方法中的 callback 为 JCMediaDeviceCallback 协议的代理对象,该协议用于将媒体设备相关的事件通知给上层。因此需要先指定 callback 的代理对象,然后在该代理对象中实现 JCMediaDeviceCallback 的方法。

JCMediaDeviceCallback 中的主要方法如下

//摄像头变化
-(void)onCameraUpdate;

//音频输出变化
-(void)onAudioOutputTypeChange:(NSString*)audioOutputType;

//声音中断恢复
-(void)onAudioInerruptAndResume:(BOOL)interrupt;

//收到第一帧数据
-(void)onRenderReceived:(JCMediaDeviceVideoCanvas*)canvas;

//渲染开始
-(void)onRenderStart:(JCMediaDeviceVideoCanvas*)canvas;
  • JCMediaChannel create 方法中的 callback 为 JCMediaChannelCallback 协议的代理对象,该协议用于将频道中的相关事件通知给上层。因此需要先指定 callback 的代理对象,然后在该代理对象中实现 JCMediaChannelCallback 的方法。

JCMediaChannel 中的主要方法如下

//自身状态变化回调
-(void)onMediaChannelStateChange:(JCMediaChannelState)state oldState:(JCMediaChannelState)oldState;

//加入频道结果回调
-(void)onJoin:(bool)result reason:(JCMediaChannelReason)reason channelId:(NSString*)channelId;

//离开频道结果回调
-(void)onLeave:(JCMediaChannelReason)reason channelId:(NSString*)channelId;

//解散频道结果回调
-(void)onStop:(bool)result reason:(JCMediaChannelReason)reason;

//新成员加入回调
-(void)onParticipantJoin:(JCMediaChannelParticipant*)participant;

//成员离开回调
-(void)onParticipantLeft:(JCMediaChannelParticipant*)participant;

//成员更新回调
-(void)onParticipantUpdate:(JCMediaChannelParticipant*)participant participantChangeParam:(JCMediaChannelParticipantChangeParam *)participantChangeParam;

//成员声音变化
-(void)onParticipantVolumeChange:(JCMediaChannelParticipant*)participant;

角色设置

直播有两种用户角色:主播和观众。加入频道前要先进行角色设置。其中主播可以上传本地音视频流,观众只能看到主播的画面、听到主播的声音。

角色值可以根据 JCMediaChannelCustomRole 枚举值进行自定义,例如

//自定义主播角色
JCMediaChannelCustomRole ROLE_BROASCASTER = JCMediaChannelCustomRole0;
//自定义观众角色
JCMediaChannelCustomRole ROLE_AUDIENCE = JCMediaChannelCustomRole1;

调用 setCustomRole 设置自己的角色以进入频道。

// 设置角色,participant(第二个参数) 值为 nil 代表设置自身的角色
[mediaChannel setCustomRole:ROLE_BROASCASTER participant:nil];

加入频道

加入频道前需根据成员角色进行音视频流上传的控制,主播需要上传本地音视频流,观众则不需要。

1. 调用 enableUploadAudioStream 开启音频流,调用 enableUploadVideoStream 开启视频流。

-(void)joinRoom:(JCMediaChannelCustomRole)customRole {
    //根据角色上传本地音视频流
    [mediaChannel enableUploadVideoStream:customRole == ROLE_BROASCASTER];
    [mediaChannel enableUploadAudioStream:customRole == ROLE_BROASCASTER];
    [mediaChannel enableAudioOutput:true];
}
  1. 角色设置后,调用 join 方法创建并加入频道。您需要在该方法中传入如下参数:

  • channelIdOrUri:频道 ID 或频道 Uri,当 param 中 uriMode 设置为 true 时表示频道 Uri,其他表示频道 ID。频道 ID 或 Uri 相同的用户会进入同一个频道。

  • joinParam:加入参数,没有则填 nil。 详见 JCMediaChannelJoinParam 对象。

[mediaChannel join:@"222" joinParam:nil];

3. 加入频道后收到 onJoin 回调。

// 加入频道结果回调
-(void)onJoin:(bool)result reason:(JCMediaChannelReason)reason channelId:(NSString*)channelId
{
    if (result) {
      // 加入成功
    } else {
      // 加入失败
    }
}

创建本地视频画面

1. 加入频道后,通过 JCMediaChannel 中的 selfParticipant 属性获取频道内自身对象。

// 1. 获得频道成员自身对象
JCMediaChannelParticipant *participant = mediaChannel.selfParticipant;
  1. 调用 JCMediaChannelParticipant 类中的 startVideo 方法打开本地视频预览。该方法会返回一个 JCMediaDeviceVideoCanvas 对象,该对象用于将视频渲染到画布上,并管理渲染的方式。(调用此方法会打开摄像头)

示例代码:

// 2. 打开本地视频预览
JCMediaDeviceVideoCanvas *localCanvas = [participant startVideo:JCMediaDeviceRenderFullScreen pictureSize:JCMediaChannelPictureSizeLarge];

创建远端视频画面

视频通话中,通常需要看到其他用户。通过 JCMediaChannel 中的 participants 属性获取频道内所有成员对象。

然后调用 JCMediaChannelParticipant 类中的 startVideo 方法设置远端用户的视图。调用该方法会返回一个 JCMediaDeviceVideoCanvas 对象,该对象用于将视频渲染到画布上,并管理渲染的方式。

startVideo 方法调用后,还需要调用 JCMediaChannel 中的 requestVideo 方法请求频道中其他用户的视频流。

示例代码:

//取频道内所有成员对象
NSArray* participants = mediaChannel.participants;
for (JCMediaChannelParticipant* participant in participants) {
if (participant.video) {
    //创建远端画面
    JCMediaDeviceVideoCanvas *remoteCanvas = [participant startVideo:JCMediaDeviceRenderFullScreen pictureSize:JCMediaChannelPictureSizeLarge];
    //请求远端视频流
    mediaChannel.requestVideo:participant pictureSize:JCMediaChannelPictureSizeLarge];
}

离开频道

调用 leave 方法离开当前频道。

[mediaChannel leave];

离开频道后,自身收到 onLeave 回调,其他成员同时收到 onParticipantLeft 回调。

销毁本地和远端视频画面

在视频挂断后,调用 JCMediaChannelParticipant 里的 stopVideo 销毁本地和远端视频画面。

示例代码:

-(void)onLeave:(JCMediaChannelReason)reason channelId:(NSString*)channelId {
    if (localCanvas != nil) { // 本地视频销毁
        [participant stopVideo];
    }
    if (remoteCanvas != nil) { // 远端视频销毁
        [participant stopVideo];
    }
}

解散频道

如果想解散频道,可以调用下面的接口,此时所有成员都将被退出。

// 结束频道
[mediaChannel stop];

解散频道后,发起结束的成员收到 onStop 回调,其他成员同时收到 onLeave 回调。 解散失败原因枚举值请参考 JCMediaChannelReason

解散频道后,同样需要调用 JCMediaChannelParticipant 里的 stopVideo 销毁本地和远端视频画面。