实时音视频RTC

    概述

    概述

    本文档主要介绍如何将 RTC iOS SDK 集成到您的项目中,并介绍各类功能的使用方法。在使用本文档前,您需要先了解RTC的一些基本知识,并已经开通了RTC服务。若您还不了解RTC,可以参考产品描述

    RTC iOS SDK 能够帮助您实现登录音视频通信房间并开始通信,并可以对发布/订阅、音视频参数、设备参数进行设置。

    接口概览

    RTC iOS SDK 提供以下接口

    初始化接口

    API 描述
    initSDKWithAppID 初始化SDK
    setParamSettings 音视频相关参数设置
    getParamSettings 获取音视频相关设置参数
    setEngineStateStatistics RTC统计信息开关

     

    房间相关接口

    API 描述
    loginRtcRoomWithRoomName 登录房间
    logoutRtcRoom 退出房间
    kickOffUserWithId 踢除聊天
    shutUpUserWithId 禁言
    queryUserListOfRoom 查询媒体用户
    queryMessageUserListOfRoom 查询房间用户

     

    发布/订阅流相关接口

    API 描述
    publishStreaming 发布流
    stopPublishStreaming 停止发布流
    subsribeStreaming 订阅流
    stopSubscribeStreaming 停止订阅流

     

    消息相关接口

    API 描述
    sendMessage2 广播消息
    sendMessage2WithUserId 指定用户发送消息
    setUserAttribute attribute 属性设置
    getUserAttribute attribute属性获取

     

    视频相关接口

    API 描述
    startPreview 本地预览
    stopPreview 停止预览
    setLocalDisplay 本地显示view设置
    setRemoteDisplay 远端view设置
    setRemoteDisplayGroup 远端显示 viewGroup 设置
    setVideoCaptureFactory 外部采集设置
    setRenderDelegate 外部渲染设置

     

    摄像头相关接口

    API 描述
    switchCamera 摄像头切换
    muteCamera 关闭/打开摄像头
    cameraFocusWithPoint 摄像头对焦

     

    音频相关接口

    API 描述
    muteMicphone 关闭麦克风
    switchLoundSpeaker 开关扬声器
    presetLoudSpeaker 预置听筒扬声器
    setAudioRecordDelegate 音频录制回调对象设置

     

    美颜相关接口

    API 描述
    setWhitenFactor 美白度设置
    setRedenFactor 红润度设置
    setBuffingFactor 磨皮度设置

     

    转推配置相关接口

    API 描述
    configLiveServerWithUrl 转推配置

     

    通知相关接口

    API 描述
    onRoomEventUpdate 用户信息通知
    onPeerConnectStateUpdate server端连接状态通知
    onStreamInfoUpdate 媒体流通知
    onErrorInfoUpdate 错误通知
    onEngineStatisticsInfo RTC引擎状态信息统计
    onTextMessageArrival2 消息通知
    onTextMessageAttribute 属性更新通知

     

    其他接口

    API 描述
    version 版本号
    setUseTestEnv 是否启用测试环境
    setVerbose 是否打开调试信息
    upLoadLog 上报日志
    setBaiduRtcAppID 动态设置AppId和TokenStr
    setBaiduRtcDelegate 动态设置RTC代理对象
    queryEngineStatisticsInfo 查询RTC统计信息

     

    上一篇
    操作指南
    下一篇
    集成SDK