腾讯云直播SDKAPI 概览_音视频解决方案_同尘科技

直播SDK 2年前 (2023-10-19) 浏览 103

API OVERVIEW

V2 推流器相关接口

函数列表 描述
setObserver: 设置推流器回调
setRenderView: 设置本地摄像头预览 View
setRenderMirror: 设置本地摄像头预览镜像
setEncoderMirror: 设置视频编码镜像
setRenderRotation: 设置本地摄像头预览画面的旋转角度
setRenderFillMode: 设置本地摄像头预览画面的填充模式
startCamera: 打开本地摄像头
stopCamera 关闭本地摄像头
startMicrophone 打开麦克风
stopMicrophone 关闭麦克风
startVirtualCamera: 开启图片推流
stopVirtualCamera 关闭图片推流
startScreenCapture: 开始全系统的屏幕分享(该接口支持 iOS 11.0 及以上的 iPhone 和 iPad)
stopScreenCapture 关闭屏幕采集
pauseAudio 静音本地音频
resumeAudio 取消静音本地音频
pauseVideo 暂停推流器的视频流
resumeVideo 恢复推流器的视频流
startPush: 开始音视频数据推流
stopPush 停止推送音视频数据
isPushing 当前推流器是否正在推流中
setAudioQuality: 设置推流音频质量
setVideoQuality: 设置推流视频编码参数
getAudioEffectManager 获取音效管理对象
getBeautyManager 获取美颜管理对象
getDeviceManager 获取设备管理对象
snapshot 截取推流过程中的本地画面
setWatermark:x:y:scale: 设置推流器水印。默认情况下,水印不开启
enableVolumeEvaluation: 启用采集音量大小提示
enableCustomVideoProcess:pixelFormat:bufferType: 开启/关闭自定义视频处理
enableCustomVideoCapture: 开启/关闭自定义视频采集
enableCustomAudioCapture: 开启/关闭自定义音频采集
sendCustomVideoFrame: 在自定义视频采集模式下,将采集的视频数据发送到SDK
sendCustomAudioFrame: 在自定义音频采集模式下,将采集的音频数据发送到SDK
enableAudioProcessObserver:format: 开启/关闭对经过前处理后的本地音频帧的监听回调
sendSeiMessage:data: 发送 SEI 消息
showDebugView: 显示仪表盘
setProperty:value: 调用 V2TXLivePusher 的高级 API 接口。
setMixTranscodingConfig: 设置云端的混流转码参数
startLocalRecording: 开始录制音视频流
stopLocalRecording 停止录制音视频流

直播推流器事件回调

函数列表 描述
onError:message:extraInfo: 直播推流器错误通知,推流器出现错误时,会回调该通知
onWarning:message:extraInfo: 直播推流器警告通知
onCaptureFirstAudioFrame 首帧音频采集完成的回调通知
onCaptureFirstVideoFrame 首帧视频采集完成的回调通知
onMicrophoneVolumeUpdate: 麦克风采集音量值回调
onPushStatusUpdate:message:extraInfo: 推流器连接状态回调通知
onStatisticsUpdate: 直播推流器统计数据回调
onSnapshotComplete: 截图回调
onProcessAudioFrame: 本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调
onProcessVideoFrame:dstFrame: 自定义视频处理回调
onGLContextDestroyed SDK 内部的 OpenGL 环境的销毁通知
onSetMixTranscodingConfig:message: 设置云端的混流转码参数的回调,对应于 setMixTranscodingConfig 接口
onScreenCaptureStarted 当屏幕分享开始时,SDK 会通过此回调通知
onScreenCaptureStopped: 当屏幕分享停止时,SDK 会通过此回调通知
onLocalRecordBegin:storagePath: 录制任务开始的事件回调
onLocalRecording:storagePath: 录制任务正在进行中的进展事件回调
onLocalRecordComplete:storagePath: 录制任务已经结束的事件回调

V2 播放器相关接口

函数列表 描述
setObserver: 设置播放器回调
setRenderView: 设置播放器的视频渲染 View,该控件负责显示视频内容
setRenderRotation: 设置播放器画面的旋转角度
setRenderFillMode: 设置画面的填充模式
startLivePlay: 开始播放音视频流
stopPlay 停止播放音视频流
isPlaying 播放器是否正在播放中
pauseAudio 暂停播放器的音频流
resumeAudio 恢复播放器的音频流
pauseVideo 暂停播放器的视频流
resumeVideo 恢复播放器的视频流
setPlayoutVolume: 设置播放器音量
setCacheParams:maxTime: 设置播放器缓存自动调整的最小和最大时间 ( 单位:秒 )
switchStream: 直播流无缝切换,支持 FLV 和 LEB
getStreamList 获取码流信息
enableVolumeEvaluation: 启用播放音量大小提示
snapshot 截取播放过程中的视频画面
enableObserveVideoFrame:pixelFormat:bufferType: 开启/关闭对视频帧的监听回调
enableObserveAudioFrame: 开启/关闭对音频数据的监听回调
enableReceiveSeiMessage:payloadType: 开启接收 SEI 消息
enablePictureInPicture: 开启画中画功能,仅支持直播和快直播播放
showDebugView: 是否显示播放器状态信息的调试浮层
setProperty:value: 调用 V2TXLivePlayer 的高级 API 接口

直播播放器事件回调

函数列表 描述
onError:code:message:extraInfo: 直播播放器错误通知,播放器出现错误时,会回调该通知
onWarning:code:message:extraInfo: 直播播放器警告通知
onVideoResolutionChanged:width:height: 直播播放器分辨率变化通知
onConnected:extraInfo: 已经成功连接到服务器
onVideoPlaying:firstPlay:extraInfo: 视频播放事件
onAudioPlaying:firstPlay:extraInfo: 音频播放事件
onVideoLoading:extraInfo: 视频加载事件
onAudioLoading:extraInfo: 音频加载事件
onPlayoutVolumeUpdate:volume: 播放器音量大小回调
onStatisticsUpdate:statistics: 直播播放器统计数据回调
onSnapshotComplete:image: 截图回调
onRenderVideoFrame:frame: 自定义视频渲染回调
onPlayoutAudioFrame:frame: 音频数据回调
onReceiveSeiMessage:payloadType:data: 收到 SEI 消息的回调,发送端通过 V2TXLivePusher 中的 sendSeiMessage 来发送 SEI 消息
onStreamSwitched:url:code: 分辨率无缝切换回调
onPictureInPictureStateUpdate:state:message:extraInfo: 画中画状态变更回调

V2TXLive 高级接口

函数列表 描述
getSDKVersionStr 获取 SDK 版本号
setObserver: 设置 V2TXLivePremier 回调接口
setLogConfig: 设置 Log 的配置信息
setEnvironment: 设置 SDK 接入环境
setLicence:key: 设置 SDK 的授权 License
setSocks5Proxy:port:username:password:config: 设置 SDK socks5 代理配置
enableAudioCaptureObserver:format: 开启/关闭对音频采集数据的监听回调(可读写)
enableAudioPlayoutObserver:format: 开启/关闭对最终系统要播放出的音频数据的监听回调
enableVoiceEarMonitorObserver: 开启/关闭耳返音频数据的监听回调
setUserId: 设置 userId
callExperimentalAPI: 调用实验性 API 接口

V2TXLive 高级回调接口

函数列表 描述
onLog:log: 自定义 Log 输出回调接口
onLicenceLoaded:Reason: setLicence 接口回调
onCaptureAudioFrame: 本地麦克风采集到的音频数据回调
onPlayoutAudioFrame: 将各路待播放音频混合之后并在最终提交系统播放之前的数据回调
onVoiceEarMonitorAudioFrame: 耳返的音频数据

人声相关的特效接口

函数列表 描述
enableVoiceEarMonitor: 开启耳返
setVoiceEarMonitorVolume: 设置耳返音量
setVoiceReverbType: 设置人声的混响效果
setVoiceChangerType: 设置人声的变声特效
setVoiceVolume: 设置语音音量
setVoicePitch: 设置语音音调

背景音乐的相关接口

函数列表 描述
startPlayMusic:onStart:onProgress:onComplete: 开始播放背景音乐
stopPlayMusic: 停止播放背景音乐
pausePlayMusic: 暂停播放背景音乐
resumePlayMusic: 恢复播放背景音乐
setAllMusicVolume: 设置所有背景音乐的本地音量和远端音量的大小
setMusicPublishVolume:volume: 设置某一首背景音乐的远端音量的大小
setMusicPlayoutVolume:volume: 设置某一首背景音乐的本地音量的大小
setMusicPitch:pitch: 调整背景音乐的音调高低
setMusicSpeedRate:speedRate: 调整背景音乐的变速效果
getMusicCurrentPosInMS: 获取背景音乐的播放进度(单位:毫秒)
getMusicDurationInMS: 获取背景音乐的总时长(单位:毫秒)
seekMusicToPosInMS:pts: 设置背景音乐的播放进度(单位:毫秒)
setMusicScratchSpeedRate:speedRate: 调整搓碟的变速效果
preloadMusic:onProgress:onError: 预加载背景音乐
getMusicTrackCount: 获取背景音乐的音轨数量
setMusicTrack:track: 指定背景音乐的播放音轨

美颜相关接口

函数列表 描述
setBeautyStyle: 设置美颜(磨皮)算法
setBeautyLevel: 设置美颜级别
setWhitenessLevel: 设置美白级别
enableSharpnessEnhancement: 开启清晰度增强
setRuddyLevel: 设置红润级别
setFilter: 设置色彩滤镜效果
setFilterStrength: 设置色彩滤镜的强度
setGreenScreenFile: 设置绿幕背景视频
setEyeScaleLevel: 设置大眼级别
setFaceSlimLevel: 设置瘦脸级别
setFaceVLevel: 设置 V 脸级别
setChinLevel: 设置下巴拉伸或收缩
setFaceShortLevel: 设置短脸级别
setFaceNarrowLevel: 设置窄脸级别
setNoseSlimLevel: 设置瘦鼻级别
setEyeLightenLevel: 设置亮眼级别
setToothWhitenLevel: 设置牙齿美白级别
setWrinkleRemoveLevel: 设置祛皱级别
setPounchRemoveLevel: 设置祛眼袋级别
setSmileLinesRemoveLevel: 设置法令纹去除级别
setForeheadLevel: 设置发际线调整级别
setEyeDistanceLevel: 设置眼距
setEyeAngleLevel: 设置眼角调整级别
setMouthShapeLevel: 设置嘴型调整级别
setNoseWingLevel: 设置鼻翼调整级别
setNosePositionLevel: 设置鼻子位置
setLipsThicknessLevel: 设置嘴唇厚度
setFaceBeautyLevel: 设置脸型
setMotionTmpl:inDir: 选择 AI 动效挂件
setMotionMute: 是否在动效素材播放时静音

音视频设备相关的类型定义

函数列表 描述
onDeviceChanged:type:state: 本地设备的通断状态发生变化(仅适用于桌面系统)

设备操作接口

函数列表 描述
isFrontCamera 判断当前是否为前置摄像头(仅适用于移动端)
switchCamera: 切换前置或后置摄像头(仅适用于移动端)
isCameraZoomSupported 查询当前摄像头是否支持缩放(仅适用于移动端)
getCameraZoomMaxRatio 获取摄像头的最大缩放倍数(仅适用于移动端)
setCameraZoomRatio: 设置摄像头的缩放倍数(仅适用于移动端)
isAutoFocusEnabled 查询是否支持自动识别人脸位置(仅适用于移动端)
enableCameraAutoFocus: 开启自动对焦功能(仅适用于移动端)
setCameraFocusPosition: 设置摄像头的对焦位置(仅适用于移动端)
isCameraTorchSupported 查询是否支持开启闪光灯(仅适用于移动端)
enableCameraTorch: 开启/关闭闪光灯,也就是手电筒模式(仅适用于移动端)
setAudioRoute: 设置音频路由(仅适用于移动端)
setExposureCompensation: 设置摄像头的曝光参数,取值范围从-1到1
getDevicesList: 获取设备列表(仅适用于桌面端)
setCurrentDevice:deviceId: 设置当前要使用的设备(仅适用于桌面端)
getCurrentDevice: 获取当前正在使用的设备(仅适用于桌面端)
setCurrentDeviceVolume:deviceType: 设置当前设备的音量(仅适用于桌面端)
getCurrentDeviceVolume: 获取当前设备的音量(仅适用于桌面端)
setCurrentDeviceMute:deviceType: 设置当前设备的静音状态(仅适用于桌面端)
getCurrentDeviceMute: 获取当前设备的静音状态(仅适用于桌面端)
enableFollowingDefaultAudioDevice:enable: 设置 SDK 使用的音频设备根据跟随系统默认设备(仅适用于桌面端)
startCameraDeviceTest: 开始摄像头测试(仅适用于桌面端)
stopCameraDeviceTest 结束摄像头测试(仅适用于桌面端)
startMicDeviceTest: 开始麦克风测试(仅适用于桌面端)
startMicDeviceTest:playback: 开始麦克风测试(仅适用于桌面端)
stopMicDeviceTest 结束麦克风测试(仅适用于桌面端)
startSpeakerDeviceTest: 开始扬声器测试(仅适用于桌面端)
stopSpeakerDeviceTest 结束扬声器测试(仅适用于桌面端)
setObserver: 设备热插拔回调(仅适用于 Mac 系统)

弃用接口

函数列表 描述
setSystemVolumeType: 设置系统音量类型(仅适用于移动端)

对音视频的解决方案有疑惑?想了解解决方案收费? 联系解决方案专家

腾讯云限时活动1折起,即将结束: 马上收藏

同尘科技为腾讯云授权服务中心,购买腾讯云享受折上折,更有现金返利:同意关联,立享优惠

阿里云解决方案也看看?: 点击对比阿里云的解决方案

- 0人点赞 -

发表点评 (0条)

not found

暂无评论,你要说点什么吗?