阿里云RTC的基本功能包含初始化SDK、加入频道、本地发布和订阅远端、离开频道等。当您成功初始化SDK,您可以进行本地预览视频功能,进行简单的预览和测试,您也可以设置手动或者自动模式。

前提条件

在实现基本功能前,请您确保下载最新SDK,请参见SDK下载
获得加入频道必须的频道鉴权令牌(Token):
  • 您可以在控制台生成临时Token校验加入频道是否成功,详情请参见控制台生成Token
  • 在安全要求更高的场景下,建议您在服务端生成Token,详情请参见服务端生成Token
说明 本文中的实现方法为主要功能方法,仅供参考,您可以根据业务需求进行实际开发。

操作步骤

  1. 请您先初始化SDK。

    首先您需要创建AliRtcEngine实例,并注册AliRtcEngineDelegate监听相关回调。如果您在ViewController中持有AliRtcEngine实例,请声明属性。

    @interface ViewController () <AliRtcEngineDelegate>
    @property (nonatomic, strong) AliRtcEngine *engine;
    @end          

    iOS回调接口请参见回调及监听

    self.engine = [AliRtcEngine sharedInstance:self extras:@""];            
    说明 目前SDK暂不支持多实例
    1. 本地预览。在创建完AliRtcEngine实例后,您可以创建canvas布局进行本地预览视频。
      AliVideoCanvas *canvas = [[AliVideoCanvas alloc] init];
      canvas.renderMode = AliRtcRenderModeAuto;
      canvas.view = (AliRenderView *)view; /* 预览窗口视图 */
      canvas.mirrorMode = AliRtcRenderMirrorModeOnlyFrontCameraPreviewEnabled;
      [self.engine setLocalViewConfig:canvas forTrack:AliRtcVideoTrackCamera];
      [self.engine startPreview];           

      您也可以取消本地预览。

      [self.engine stopPreview];           
      说明
      • AliRtcRenderMode提供四种渲染模式。
        • AliRtcRenderModeAuto(推荐):自动模式。
        • AliRtcRenderModeStretch:拉伸填充视图,不保持视频比例。
        • AliRtcRenderModeFill:在保持视频宽高比的同时缩放,填充黑边。
        • AliRtcRenderModeCrop:在保持视频宽高比的同时缩放,并裁剪以适合视图。
      • 视图必须是AliRenderView或者其子类。
      • AliRtcRenderMirrorMode在本地或远端均可设置镜像模式,并提供三种镜像模式。
        • AliRtcRenderMirrorModeOnlyFrontCameraPreviewEnabled:只有前置摄像头预览镜像,其余不镜像。
        • AliRtcRenderMirrorModeAllEnabled:全部镜像。
        • AliRtcRenderMirrorModeAllDisabled:全部不镜像。
    2. 设置自动或者手动模式。
      说明 阿里云RTC iOS端默认实现自动发布和订阅,您也可以通过代码手动发布和订阅
      • 自动发布模式: 如果您打开自动发布模式,加入频道之后,SDK将自动开始发布音视频流;如果关闭自动发布模式,则需要您调用publish接口之后才会发布音视频流。
      • 自动订阅模式: 如果您打开自动订阅模式,加入频道之后,SDK将会自动订阅当前频道内其他人的音视频流;如果关闭自动订阅模式,则需要您调用subscribe接口之后才会订阅其他人的音视频流。
      /*
      设置自动发布和订阅,只能在加入频道之前配置
      autoPublish 是否自动发布,取值:YES|NO
      autoSubscribe 是否自动订阅,取值:YES|NO
      */ 
      [self.engine setAutoPublish:YES withAutoSubscribe:YES];          
  2. 加入频道。
    AliRtcAuthInfo *authinfo = [[AliRtcAuthInfo alloc]init];
    authinfo.channel   = /* 频道ID */;
    authinfo.appid     = /* 应用ID */;
    authinfo.nonce     = /* 随机码 */;
    authinfo.user_id   = /* 用户ID */;
    authinfo.token     = /* 鉴权令牌Token */;
    authinfo.timestamp = /* 时间戳 */;
    authinfo.gslb      = /* GSLB地址 */;
    [self.engine joinChannel:authinfo name:/* 用户显示名称 */ onResult:^(NSInteger errCode){
        // 加入频道UI处理
    }]; 
    参数 描述
    AppID 应用ID,在控制台应用管理页面创建和查看。
    ChannelId 频道ID。1~64位,支持大小写字母、数字、下划线(_)、中划线(-)。
    UserId 用户ID。1~64位,支持大小写字母、数字、下划线(_)、中划线(-)。
    说明 同一个用户ID在其他端登录,先入会的端会被后入会的端踢出频道。
    Nonce 随机码。需要加上前缀AK-,由字母[a-zA-Z]和数字[0-9]组成,不包含特殊字符,最大64字节。例如:AK-2b9be4b25c2d38c409c376ffd2372be1。
    TimeStamp 频道过期时间戳。代表令牌有效时间为当前时间+所选择小时数。
    Token 频道鉴权令牌,计算方法:token = sha256(appId + appKey + channelId + userId + nonce + timestamp)
    GSLB 服务地址,该参数是数组类型,当前请使用:["https://rgslb.rtc.aliyuncs.com"],请您通过业务服务器下发到客户端SDK,不建议您将该地址固化在客户端代码。
  3. 发布或取消发布本地流。

    发布本地流。

    • 自动发布模式下:加入频道成功后,即可发布本地流,无需再次调用publish接口。
    • 手动发布模式下:加入频道成功后,可通过以下接口发布本地流。

    如果发布过程中需要变更配置或者停止发布,需要按如下流程先重新设置配置参数,然后再调用publish接口。

    //YES表示允许发布音频流,NO表示不允许
    [self.engine configLocalAudioPublish:YES];
    //YES表示允许发布相机流,NO表示不允许
    [self.engine configLocalCameraPublish:YES];
    //YES表示允许发布次要视频流;NO表示不允许
    [self.engine configLocalSimulcast:YES forTrack:AliRtcVideoTrackCamera];
    [self.engine publish:^(int err) {
        // 相关UI操作
    }];           

    取消发布本地流。

    [self.engine configLocalAudioPublish:NO];
    [self.engine configLocalCameraPublish:NO];
    [self.engine configLocalSimulcast:NO forTrack:AliRtcVideoTrackCamera];
    [self.engine publish:^(int err) {
        // 取消相关UI操作
    }];          
  4. 订阅或取消订阅远程流。

    订阅远程流。

    • 自动订阅模式下:加入频道成功后,即可订阅远端流,无需再次调用subscribe接口。
    • 手动订阅模式下:加入频道成功后,可通过以下接口订阅远端流。

    如果订阅过程中需要变更配置或者停止订阅,需要按如下流程先重新设置配置参数,然后再调用subscribe接口。

    //enable YES表示允许订阅音频流,NO表示不允许
    [self.engine configRemoteAudio:/* remoteUserID */ enable:YES];
    //YES表示允许订阅屏幕流,NO表示不允许
    [self.engine configRemoteScreenTrack:/* remoteUserID */ enable:YES];
    //preferMaster YES表示优先拉取大流,NO表示优先订阅次小流
    //enable YES表示允许订阅相机流,NO表示不允许
    [self.engine configRemoteCameraTrack:/* remoteUserID */ preferMaster:YES enable:YES];
    [self.engine subscribe:/* remoteUserID */ onResult:^(NSString *uid, AliRtcVideoTrack vt, AliRtcAudioTrack at) {
    }];          

    无论是自动模式还是非自动模式,当您订阅成功后,通过delegate可以获取订阅的callback,然后您可以进行相关UI操作或逻辑处理。

    - (void)onSubscribeChangedNotify:(NSString *)uid audioTrack:(AliRtcAudioTrack)audioTrack videoTrack:(AliRtcVideoTrack)videoTrack {
        dispatch_async(dispatch_get_main_queue(), ^{
            // UI或者逻辑处理,例如渲染远端视频流的操作如下
            if(videoTrack & AliRtcVideoTrackCamera) {
            // camera track
            AliVideoCanvas *canvas = [[AliVideoCanvas alloc] init];
            canvas.renderMode = /* renderMode */;
            canvas.view = (AliRenderView *)view;/* 渲染view */
            [self.engine setRemoteViewConfig:canvas uid:uid forTrack:AliRtcVideoTrackCamera];
          }
        });
    }           

    您可以通过下述delegate回调监听远端用户的流状态变更。例如,手动模式下,收到此回调后,可以获取到远端用户的发布状态,然后相应做出订阅(subscribe)操作,或者更新UI等。

    - (void)onRemoteTrackAvailableNotify:(NSString *)uid audioTrack:(AliRtcAudioTrack)audioTrack videoTrack:(AliRtcVideoTrack)videoTrack {
    }           

    取消订阅远程流。

    [self.engine configRemoteAudio:/* remoteUserID */ enable:NO];
    [self.engine configRemoteScreenTrack:/* remoteUserID */ enable:NO];
    [self.engine configRemoteCameraTrack:/* remoteUserID */ preferMaster:YES enable:NO];
    [self.engine subscribe:/* remoteUserID */ onResult:^(NSString *uid, AliRtcVideoTrack vt, AliRtcAudioTrack at) {
    }];            
  5. 离开频道。
    [self.engine leaveChannel];           
    您可以下载示例代码,快速跑通Demo,实现频道内和其他人进行实时音视频通话,详情请参见iOS Demo

    接口方法请参见AliRtcEngine接口