RTC开发者中心

全部产品

产品文档

API

下载

示例代码

FAQ

API 概览

API 详情

错误码列表

Class

Class 概览

Class 详情

Protocl

Protocol 概览

Protocol 详情

Enum

Enum 概览

Enum 详情

开发者中心

全部产品

API

iOS 直播 ToB

API 概览

API 概览

更新时间：2023-10-10 11:53:05

初始化相关功能

方法	描述
initEngineWithConfig:delegate:	创建 KRtcEngine 实例。
destroy	销毁 KRtcEngine 实例。
getSdkVersion	查询 SDK 版本号。
setParameters:	通过 JSON 配置 SDK 提供技术预览或特别定制功能。

核心方法

方法	描述
startPushByToken:channelId:streamUrl:	开始直播推流。
stopPush:	停止直播推流。
setConnectRetryCount:	设置推流端重连次数
setConnectRetryInterval:	设置推流端重连间隔
getPushingStatus:	获取当前直播推流状态。

音频相关

方法	描述
enableAudio	启用音频模块。
disableAudio	关闭音频模块。
setLiveAudioProfile:profile:	设置音频编码参数。
adjustRecordingSignalVolume:	调节麦克风采集信号音量。
enableLocalAudio	开启本地音频采集。
disableLocalAudio	关闭本地音频采集。

耳返

方法	描述
enableInEarMonitoring	开启耳返功能。
disableInEarMonitoring	关闭耳返功能。
setInEarMonitoringVolume:	设置耳返音量。

音效接口

方法	描述
setLocalVoiceChanger:	设置本地语音变声
setLocalVoiceReverb:	设置本地音效混响
enableExternalAudioSource	启用外部音频输入，该接口仅支持在 startPush 之前调用。
disableExternalAudioSource	禁用外部音频输入
pushRawAudioFrame:	推送外部音频帧
enableAudioVolumeIndication:	启用用户音量提示。
disableAudioVolumeIndication	禁用用户音量提示。

视频相关

方法	描述
enableVideo	启用视频模块。
disableVideo	关闭视频模块。
enableLocalVideo	开启本地视频采集，调用此方法会开启摄像头采集设备。
disableLocalVideo	关闭本地视频采集。
setVideoEncoderConfiguration:videoEncoderConfig:	设置视频编码参数。
bindLocalVideoView:	初始化本端视频渲染视图。
unbindLocalVideoView:	解绑本端视频渲染视图。
setCameraCaptureMirror:	对自定义美颜之前的摄像头原始采集视频画面进行镜像
setCameraEncodeMirror:	对经过自定义美颜后的准备参与合流编码的摄像头路视频流进行镜像
setLocalRenderMode:ismirror:	对经过自定义美颜后的准备本地预览画面进行镜像
startPreview	启动视频预览，调用该 API 前，需调用 enableLocalVideo 开启摄像头采集设备。
stopPreview	停止预览。
switchCamera	切换摄像头。
startScreenCapture:	开始屏幕共享
stopScreenCapture:	结束屏幕共享
enableExternalVideoSource	启用外部视频输入
disableExternalVideoSource	禁用外部视频输入
pushRawVideoFrame:	推送外部视频帧

美颜接口

方法	描述
setBeautyEffectOptions:options:	设置美颜效果选项

其它接口

方法	描述
onBackground:	设置 App 退后台触发的推流模式。
onForeground	通知 SDK APP 已经返回前台。
startPushImage:image:	启用图片推流
stopPushImage:	停止图片推流
addWatermark:x:y:scale:	添加水印
removeWatermark:	移除水印
startNetworkProbeTest	开始网络质量检测
stopNetworkProbeTest	停止网络质量检测
getCurrentMediaTimestamp	获取当前媒体时间戳
sendSeiMessage:data:repeatCount:	发送自定义的 SEI 消息
setZoom:	调整摄像头的焦距
toggletorch:	打开后置摄像头旁边的闪光灯
setWallClockTime:	设置时钟，用于计算直播延时。
setRenderRotation:	设置本端视频预览旋转角度，该接口仅能够改变主播本地预览画面的方向，而不会改变观众端的画面效果。
snapshot	推流过程中本地截图
setMetaData:	设置自定义MetaData
enableCustomVideoProcess:isUseNewTexture:isUseTextureId:	开启/关闭自定义视频处理

事件回调相关

方法	描述
KRtcEngine:channelId:state:error:	直播推流状态回调。
KRtcEngine:channelId:userId:txQuality:rxQuality:	报告当前网络质量。
KRtcEngine:stats:	报告当前直播推流相关指标。
KRtcEngine:audiovolumeinfo:	用户音量提示回调。
KRtcEngine:channelId:warningCode:	发生警告回调。
KRtcEngine:channelId:errorCode:	发生错误回调。
KRtcEngine:error:	屏幕分享发生错误回调。
KRtcEngine:image:	推流过程中本地截图回调。
didOpenCameraSuccess:	打开摄像头成功回调。
KRtcEngine:channelId:	视频编码器启动回调。
KRtcEngine:srcFrame:dstframe:rotation:	用于对接第三方美颜组件的视频处理回调
onGLContextDestroyed:	SDK 内部的 OpenGL 环境的销毁通知
KRtcEngine:elapse:	首帧视频发送成功的回调通知