wangguolei

sdk upgrade

Showing 23 changed files with 0 additions and 4722 deletions

Too many changes to show.

To preserve performance only 23 of 23+ files are displayed.

No preview for this file type
/*
* Module: 网络音频包UDT自定义数据回调
*
* Function: 给客户回调发送前、接收后的 UDT 自定义数据
*
*/
#ifndef LITEAV_ITRTCAUDIOPACKETLISTENER_H
#define LITEAV_ITRTCAUDIOPACKETLISTENER_H
#include <stdio.h>
#include "TXLiteAVBuffer.h"
namespace liteav {
struct TRTCAudioPacket {
const char *userId;
liteav::TXLiteAVBuffer* extraData;
};
class ITRTCAudioPacketListener {
public:
virtual ~ITRTCAudioPacketListener() {}
/*网络层接收到音频数据包*/
virtual bool onRecvAudioPacket(TRTCAudioPacket &data) { return false; }
/*网络层即将发送的音频数据包*/
virtual bool onSendAudioPacket(TRTCAudioPacket &data) { return false; }
};
}
#endif //LITEAV_ITRTCAUDIOPACKETLISTENER_H
This diff could not be displayed because it is too large.
/**
* Module: TRTC 关键类型定义
* Function: 分辨率、质量等级等枚举和常量值的定义
*/
/// @defgroup TRTCCloudDef_ios 关键类型定义
/// 腾讯云实时音视频的关键类型定义
/// @{
#import <Foundation/Foundation.h>
/////////////////////////////////////////////////////////////////////////////////
//
// 渲染控件
//
/////////////////////////////////////////////////////////////////////////////////
/**
* [VIEW] 用于渲染视频画面的渲染控件
*
* TRTC 中有很多需要操控视频画面的接口,这些接口都需要您指定视频渲染控件。
* - 在 iOS 系统中,您可以直接使用 UIView 作为视频渲染控件,SDK 会在您提供的 UIView 上绘制视频画面。
* - 在 Mac 系统中,您可以直接使用 NSView 作为视频渲染控件,SDK 会在您提供的 NSView 上绘制视频画面。
* 示例代码如下:
* <pre>
* UIView *videoView = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 360, 640)];
* [self.view addSubview:videoView];
* [trtcCloud startLocalPreview:YES view:_localView];
* </pre>
*/
#if TARGET_OS_IPHONE || TARGET_OS_SIMULATOR
#import <UIKit/UIKit.h>
typedef UIView TXView;
typedef UIImage TXImage;
typedef UIEdgeInsets TXEdgeInsets;
#elif TARGET_OS_MAC
#import <AppKit/AppKit.h>
typedef NSView TXView;
typedef NSImage TXImage;
typedef NSEdgeInsets TXEdgeInsets;
#endif
#import "TXDeviceManager.h"
/////////////////////////////////////////////////////////////////////////////////
//
// 视频相关枚举值定义
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 1.1 视频分辨率
*
* 此处仅定义横屏分辨率(如 640 × 360),如需使用竖屏分辨率(如360 × 640),需要同时指定 TRTCVideoResolutionMode 为 Portrait。
*/
typedef NS_ENUM(NSInteger, TRTCVideoResolution) {
///宽高比 1:1;分辨率 120x120;建议码率(VideoCall)80kbps; 建议码率(LIVE)120kbps。
TRTCVideoResolution_120_120 = 1,
///宽高比 1:1 分辨率 160x160;建议码率(VideoCall)100kbps; 建议码率(LIVE)150kbps。
TRTCVideoResolution_160_160 = 3,
///宽高比 1:1;分辨率 270x270;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。
TRTCVideoResolution_270_270 = 5,
///宽高比 1:1;分辨率 480x480;建议码率(VideoCall)350kbps; 建议码率(LIVE)500kbps。
TRTCVideoResolution_480_480 = 7,
///宽高比4:3;分辨率 160x120;建议码率(VideoCall)100kbps; 建议码率(LIVE)150kbps。
TRTCVideoResolution_160_120 = 50,
///宽高比 4:3;分辨率 240x180;建议码率(VideoCall)150kbps; 建议码率(LIVE)250kbps。
TRTCVideoResolution_240_180 = 52,
///宽高比 4:3;分辨率 280x210;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。
TRTCVideoResolution_280_210 = 54,
///宽高比 4:3;分辨率 320x240;建议码率(VideoCall)250kbps; 建议码率(LIVE)375kbps。
TRTCVideoResolution_320_240 = 56,
///宽高比 4:3;分辨率 400x300;建议码率(VideoCall)300kbps; 建议码率(LIVE)450kbps。
TRTCVideoResolution_400_300 = 58,
///宽高比 4:3;分辨率 480x360;建议码率(VideoCall)400kbps; 建议码率(LIVE)600kbps。
TRTCVideoResolution_480_360 = 60,
///宽高比 4:3;分辨率 640x480;建议码率(VideoCall)600kbps; 建议码率(LIVE)900kbps。
TRTCVideoResolution_640_480 = 62,
///宽高比 4:3;分辨率 960x720;建议码率(VideoCall)1000kbps; 建议码率(LIVE)1500kbps。
TRTCVideoResolution_960_720 = 64,
///宽高比 16:9;分辨率 160x90;建议码率(VideoCall)150kbps; 建议码率(LIVE)250kbps。
TRTCVideoResolution_160_90 = 100,
///宽高比 16:9;分辨率 256x144;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。
TRTCVideoResolution_256_144 = 102,
///宽高比 16:9;分辨率 320x180;建议码率(VideoCall)250kbps; 建议码率(LIVE)400kbps。
TRTCVideoResolution_320_180 = 104,
///宽高比 16:9;分辨率 480x270;建议码率(VideoCall)350kbps; 建议码率(LIVE)550kbps。
TRTCVideoResolution_480_270 = 106,
///宽高比 16:9;分辨率 640x360;建议码率(VideoCall)500kbps; 建议码率(LIVE)900kbps。
TRTCVideoResolution_640_360 = 108,
///宽高比 16:9;分辨率 960x540;建议码率(VideoCall)850kbps; 建议码率(LIVE)1300kbps。
TRTCVideoResolution_960_540 = 110,
///宽高比 16:9;分辨率 1280x720;建议码率(VideoCall)1200kbps; 建议码率(LIVE)1800kbps。
TRTCVideoResolution_1280_720 = 112,
///宽高比 16:9;分辨率 1920x1080;建议码率(VideoCall)2000kbps; 建议码率(LIVE)3000kbps。
TRTCVideoResolution_1920_1080 = 114,
};
/**
* 1.2 视频宽高比模式
*
* TRTCVideoResolution 中仅定义了横屏分辨率(如 640 × 360),如需使用竖屏分辨率(如360 × 640),需要同时指定 TRTCVideoResolutionMode 为 Portrait。
*/
typedef NS_ENUM(NSInteger, TRTCVideoResolutionMode) {
///横屏分辨率,例如:TRTCVideoResolution_640_360 + TRTCVideoResolutionModeLandscape = 640 × 360。
TRTCVideoResolutionModeLandscape = 0,
///竖屏分辨率,例如:TRTCVideoResolution_640_360 + TRTCVideoResolutionModePortrait = 360 × 640。
TRTCVideoResolutionModePortrait = 1,
};
/**
* 1.3 视频流类型
*
* TRTC 内部有三种不同的视频流,分别是:
* - 高清大画面:一般用来传输摄像头的视频数据。
* - 低清小画面:小画面和大画面的内容相互,但是分辨率和码率都比大画面低,因此清晰度也更低。
* - 辅流画面:一般用于屏幕分享,同一时间在同一个房间中只允许一个用户发布辅流视频,其他用户必须要等该用户关闭之后才能发布自己的辅流。
* @note 不支持单独开启低清小画面,小画面必须依附于大画面而存在,SDK 会自动设定低清小画面的分辨率和码率。
*/
typedef NS_ENUM(NSInteger, TRTCVideoStreamType) {
///高清大画面,一般用来传输摄像头的视频数据。
TRTCVideoStreamTypeBig = 0,
///低清小画面:小画面和大画面的内容相互,但是分辨率和码率都比大画面低,因此清晰度也更低。
TRTCVideoStreamTypeSmall = 1,
///辅流画面:一般用于屏幕分享,同一时间在同一个房间中只允许一个用户发布辅流视频,其他用户必须要等该用户关闭之后才能发布自己的辅流。
TRTCVideoStreamTypeSub = 2,
};
/**
* 1.4 视频画面填充模式
*
* 如果视频显示区域的宽高比不等于视频内容的宽高比时,就需要您指定画面的填充模式:
*/
typedef NS_ENUM(NSInteger, TRTCVideoFillMode) {
///填充模式:即将画面内容居中等比缩放以充满整个显示区域,超出显示区域的部分将会被裁剪掉,此模式下画面可能不完整。
TRTCVideoFillMode_Fill = 0,
///适应模式:即按画面长边进行缩放以适应显示区域,短边部分会被填充为黑色,此模式下图像完整但可能留有黑边。
TRTCVideoFillMode_Fit = 1,
};
/**
* 1.5 视频画面旋转方向
*
* TRTC 提供了对本地和远程画面的旋转角度设置 API,下列的旋转角度都是指顺时针方向的。
*/
typedef NS_ENUM(NSInteger, TRTCVideoRotation) {
///不旋转
TRTCVideoRotation_0 = 0,
///顺时针旋转90度
TRTCVideoRotation_90 = 1,
///顺时针旋转180度
TRTCVideoRotation_180 = 2,
///顺时针旋转270度
TRTCVideoRotation_270 = 3,
};
/**
* 1.6 美颜(磨皮)算法
*
* TRTC 内置多种不同的磨皮算法,您可以选择最适合您产品定位的方案。
*/
typedef NS_ENUM(NSInteger, TRTCBeautyStyle) {
///光滑,算法比较激进,磨皮效果比较明显,适用于秀场直播。
TRTCBeautyStyleSmooth = 0,
///自然,算法更多地保留了面部细节,磨皮效果更加自然,适用于绝大多数直播场景。
TRTCBeautyStyleNature = 1,
///优图,由优图实验室提供,磨皮效果介于光滑和自然之间,比光滑保留更多皮肤细节,比自然磨皮程度更高。
TRTCBeautyStylePitu = 2,
};
/**
* 1.7 视频像素格式
*
* TRTC 提供针对视频的自定义采集和自定义渲染功能:
* - 在自定义采集功能中,您可以用下列枚举值描述您采集的视频像素格式。
* - 在自定义渲染功能中,您可以指定您期望 SDK 回调出的视频像素格式。
*/
typedef NS_ENUM(NSInteger, TRTCVideoPixelFormat) {
///未定义的格式
TRTCVideoPixelFormat_Unknown = 0,
/// YUV420P(I420) 格式
TRTCVideoPixelFormat_I420 = 1,
/// OpenGL 2D 纹理格式
TRTCVideoPixelFormat_Texture_2D = 7,
/// BGRA 格式
TRTCVideoPixelFormat_32BGRA = 6,
/// YUV420SP(NV12)格式
TRTCVideoPixelFormat_NV12 = 5,
};
/**
* 1.8 视频数据传递方式
*
* 在自定义采集和自定义渲染功能,您需要用到下列枚举值来指定您希望以什么方式传递视频数据:
* - 方案一:使用内存 Buffer 传递视频数据,该方案在 iOS 效率尚可,但在 Android 系统上效率较差,Windows 暂时仅支持内存 Buffer 的传递方式。
* - 方案二:使用 Texture 纹理传递视频数据,该方案在 iOS 和 Android 系统下均有较高的效率,Windows 暂不支持,需要您有一定的 OpenGL 编程基础。
*/
typedef NS_ENUM(NSInteger, TRTCVideoBufferType) {
///未定义的传递方式
TRTCVideoBufferType_Unknown = 0,
///使用内存 Buffer 传递视频数据,iOS: PixelBuffer;Android: 用于 JNI 层的 Direct Buffer;Win: 内存数据块。
TRTCVideoBufferType_PixelBuffer = 1,
///使用内存 Buffer 传递视频数据,iOS: 经过一次额外整理后更加紧凑的 NSData 类型的内存块;Android: 用于 JAVA 层的 byte[]。
///该传递的方式的性能是几种方案中效率较差的一种。
TRTCVideoBufferType_NSData = 2,
///使用 Texture 纹理传递视频数据
TRTCVideoBufferType_Texture = 3,
};
/**
* 1.9 视频的镜像类型
*
* 视频的镜像是指对视频内容进行左右翻转,尤其是对本地的摄像头预览视频,开启镜像后能给主播带来熟悉的“照镜子”体验。
*/
typedef NS_ENUM(NSUInteger, TRTCVideoMirrorType) {
///自动模式:如果正使用前置摄像头则开启镜像,如果是后置摄像头则不开启镜像(仅适用于移动设备)。
TRTCVideoMirrorTypeAuto = 0,
///强制开启镜像,不论当前使用的是前置摄像头还是后置摄像头。
TRTCVideoMirrorTypeEnable = 1,
///强制关闭镜像,不论当前使用的是前置摄像头还是后置摄像头。
TRTCVideoMirrorTypeDisable = 2,
};
/// Old version of TRTCVideoMirrorType, reserved for compatibility with older interface.
typedef NS_ENUM(NSUInteger, TRTCLocalVideoMirrorType) {
TRTCLocalVideoMirrorType_Auto = TRTCVideoMirrorTypeAuto,
TRTCLocalVideoMirrorType_Enable = TRTCVideoMirrorTypeEnable,
TRTCLocalVideoMirrorType_Disable = TRTCVideoMirrorTypeDisable,
} __attribute__((deprecated("use TRTCVideoMirrorType instead")));
/**
* 1.10 本地视频截图的数据源
*
* SDK 支持从如下两种数据源中截取图片并保存成本地文件:
* - 视频流:从视频流中截取原生的视频内容,截取的内容不受渲染控件的显示控制。
* - 渲染层:从渲染控件中截取显示的视频内容,可以做到用户所见即所得的效果,但如果显示区域过小,截取出的图片也会很小。
*/
typedef NS_ENUM(NSUInteger, TRTCSnapshotSourceType) {
///从视频流中截取原生的视频内容,截取的内容不受渲染控件的显示控制。
TRTCSnapshotSourceTypeStream = 0,
///从渲染控件中截取显示的视频内容,可以做到用户所见即所得的效果,但如果显示区域过小,截取出的图片也会很小。
TRTCSnapshotSourceTypeView = 1,
};
/////////////////////////////////////////////////////////////////////////////////
//
// 网络相关枚举值定义
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 2.1 应用场景
*
* TRTC 针对常见的音视频应用场景都进行了定向优化,以满足各种垂直场景下的差异化要求,主要场景可以分为如下两类:
* - 直播(LIVE)场景:包括 LIVE 和 VoiceChatRoom,前者是音频+视频,后者是纯音频。
* 直播场景下,用户被分成“主播”和“观众”两种角色,单个房间中同时最多支持10万人在线,适合于观众人数众多的直播场景。
* - 实时(RTC)场景:包括 VideoCall 和 AudioCall,前者是音频+视频,后者是纯音频。
* 实时场景下,用户没有角色的差异,但单个房间中同时最多支持 300 人在线,适合于小范围实时通信的场景。
*/
typedef NS_ENUM(NSInteger, TRTCAppScene) {
///视频通话场景,支持720P、1080P高清画质,单个房间最多支持300人同时在线,最高支持50人同时发言。
///适用于[1对1视频通话]、[300人视频会议]、[在线问诊]、[教育小班课]、[远程面试]等业务场景。
TRTCAppSceneVideoCall = 0,
///视频互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于300ms;支持十万级别观众同时播放,播放延时低至1000ms。
///适用于[低延时互动直播]、[大班课]、[主播PK]、[视频相亲]、[在线互动课堂]、[远程培训]、[超大型会议]等业务场景。
///@note 此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。
TRTCAppSceneLIVE = 1,
///语音通话场景,默认采用 SPEECH 音质,单个房间最多支持300人同时在线,最高支持50人同时发言。
///适用于[1对1语音通话]、[300人语音会议]、[语音聊天]、[语音会议]、[在线狼人杀]等业务场景。
TRTCAppSceneAudioCall = 2,
///语音互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于300ms;支持十万级别观众同时播放,播放延时低至1000ms。
///适用于[语音俱乐部]、[在线K歌房]、[音乐直播间]、[FM电台]等业务场景。
///@note 此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。
TRTCAppSceneVoiceChatRoom = 3,
};
/**
* 2.2 角色
*
* 仅适用于直播类场景(即 TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom),把用户区分成两种不同的身份:
* - 主播:可以随时发布自己的音视频流,但人数有限制,同一个房间中最多只允许 50 个主播同时发布自己的音视频流。
* - 观众:只能观看其他用户的音视频流,要发布音视频流,需要先通过 {@link switchRole} 切换成主播,同一个房间中最多能容纳10万观众。
*/
typedef NS_ENUM(NSInteger, TRTCRoleType) {
///主播:可以随时发布自己的音视频流,但人数有限制,同一个房间中最多只允许 50 个主播同时发布自己的音视频流。
TRTCRoleAnchor = 20,
///观众:只能观看其他用户的音视频流,要发布音视频流,需要先通过 {@link switchRole} 切换成主播,同一个房间中最多能容纳10万观众。
TRTCRoleAudience = 21,
};
/**
* 2.3 流控模式(已废弃)
*/
typedef NS_ENUM(NSInteger, TRTCQosControlMode) {
///本地控制,用于 SDK 开发内部调试,客户请勿使用。
TRTCQosControlModeClient = 0,
///云端控制,默认模式,推荐选择。
TRTCQosControlModeServer = 1,
};
/**
* 2.4 画质偏好
*
* TRTC 在弱网络环境下有两种调控模式:“优先保证画面清晰”或“优先保证画面流畅”,两种模式均会优先保障声音数据的传输。
*/
typedef NS_ENUM(NSInteger, TRTCVideoQosPreference) {
///流畅优先:即当前网络不足以传输既清晰又流畅的画面时,优先保证画面的流畅性,代价就是画面会比较模糊且伴随有较多的马赛克。
TRTCVideoQosPreferenceSmooth = 1,
///清晰优先(默认值):即当前网络不足以传输既清晰又流畅的画面时,优先保证画面的清晰度,代价就是画面会比较卡顿。
TRTCVideoQosPreferenceClear = 2,
};
/**
* 2.5 网络质量
*
* TRTC 会每隔两秒对当前的网络质量进行评估,评估结果为六个等级:Excellent 表示最好,Down 表示最差。
*/
typedef NS_ENUM(NSInteger, TRTCQuality) {
///未定义
TRTCQuality_Unknown = 0,
///当前网络非常好
TRTCQuality_Excellent = 1,
///当前网络比较好
TRTCQuality_Good = 2,
///当前网络一般
TRTCQuality_Poor = 3,
///当前网络较差
TRTCQuality_Bad = 4,
///当前网络很差
TRTCQuality_Vbad = 5,
///当前网络不满足 TRTC 的最低要求
TRTCQuality_Down = 6,
};
/**
* 2.6 视频状态类型
*
* 该枚举类型用于视频状态变化回调接口{@link onRemoteVideoStatusUpdated},用于指定当前的视频状态。
*/
typedef NS_ENUM(NSUInteger, TRTCAVStatusType) {
///停止播放
TRTCAVStatusStopped = 0,
///正在播放
TRTCAVStatusPlaying = 1,
///正在加载
TRTCAVStatusLoading = 2,
};
/**
* 2.7 视频状态变化原因类型
*
* 该枚举类型用于视频状态变化回调接口{@link onRemoteVideoStatusUpdated},用于指定当前的视频状态原因。
*/
typedef NS_ENUM(NSUInteger, TRTCAVStatusChangeReason) {
///缺省值
TRTCAVStatusChangeReasonInternal = 0,
///网络缓冲
TRTCAVStatusChangeReasonBufferingBegin = 1,
///结束缓冲
TRTCAVStatusChangeReasonBufferingEnd = 2,
///本地启动视频流播放
TRTCAVStatusChangeReasonLocalStarted = 3,
///本地停止视频流播放
TRTCAVStatusChangeReasonLocalStopped = 4,
///远端视频流开始(或继续)
TRTCAVStatusChangeReasonRemoteStarted = 5,
///远端视频流停止(或中断
TRTCAVStatusChangeReasonRemoteStopped = 6,
};
/////////////////////////////////////////////////////////////////////////////////
//
// 音频相关枚举值定义
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 3.1 音频采样率
*
* 音频采样率用来衡量声音的保真程度,采样率越高保真程度越好,如果您的应用场景有音乐的存在,推荐使用 TRTCAudioSampleRate48000。
*/
typedef NS_ENUM(NSInteger, TRTCAudioSampleRate) {
/// 16k采样率
TRTCAudioSampleRate16000 = 16000,
/// 32k采样率
TRTCAudioSampleRate32000 = 32000,
/// 44.1k采样率
TRTCAudioSampleRate44100 = 44100,
/// 48k采样率
TRTCAudioSampleRate48000 = 48000,
};
/**
* 3.2 声音音质
*
* TRTC 提供了三种精心校调好的模式,用来满足各种垂直场景下对音质的差异化追求:
* - 人声模式(Speech):适用于以人声沟通为主的应用场景,该模式下音频传输的抗性较强,TRTC 会通过各种人声处理技术保障在弱网络环境下的流畅度最佳。
* - 音乐模式(Music):适用于对声乐要求很苛刻的场景,该模式下音频传输的数据量很大,TRTC 会通过各项技术确保音乐信号在各频段均能获得高保真的细节还原度。
* - 默认模式(Default):介于 Speech 和 Music 之间的档位,对音乐的还原度比人声模式要好,但传输数据量比音乐模式要低很多,对各种场景均有不错的适应性。
*/
typedef NS_ENUM(NSInteger, TRTCAudioQuality) {
///人声模式:采样率:16k;单声道;编码码率:16kbps;具备几个模式中最强的网络抗性,适合语音通话为主的场景,比如在线会议,语音通话等。
TRTCAudioQualitySpeech = 1,
///默认模式:采样率:48k;单声道;编码码率:50kbps;介于 Speech 和 Music 之间的档位,SDK 默认档位,推荐选择。
TRTCAudioQualityDefault = 2,
///音乐模式:采样率:48k;全频带立体声;编码码率:128kbps;适合需要高保真传输音乐的场景,比如在线K歌、音乐直播等。
TRTCAudioQualityMusic = 3,
};
/**
* 3.3 音频路由(即声音的播放模式)
*
* 音频路由,即声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
* 手机有两个扬声器:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。
* - 设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
* - 设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
*/
typedef NS_ENUM(NSInteger, TRTCAudioRoute) {
/// Speakerphone:使用扬声器播放(即“免提”),扬声器位于手机底部,声音偏大,适合外放音乐。
TRTCAudioModeSpeakerphone = 0,
/// Earpiece:使用听筒播放,听筒位于手机顶部,声音偏小,适合需要保护隐私的通话场景。
TRTCAudioModeEarpiece = 1,
};
/**
* 3.4 声音混响模式
*
* 该枚举值应用于设定直播场景中的混响模式,常用于秀场直播中。
*/
typedef NS_ENUM(NSInteger, TRTCReverbType) {
///关闭混响
TRTCReverbType_0 = 0,
/// KTV
TRTCReverbType_1 = 1,
///小房间
TRTCReverbType_2 = 2,
///大会堂
TRTCReverbType_3 = 3,
///低沉
TRTCReverbType_4 = 4,
///洪亮
TRTCReverbType_5 = 5,
///金属声
TRTCReverbType_6 = 6,
///磁性
TRTCReverbType_7 = 7,
};
/**
* 3.5 变声类型
*
* 该枚举值应用于设定直播场景中的变声模式,常用于秀场直播中。
*/
typedef NS_ENUM(NSInteger, TRTCVoiceChangerType) {
///关闭变声
TRTCVoiceChangerType_0 = 0,
///熊孩子
TRTCVoiceChangerType_1 = 1,
///萝莉
TRTCVoiceChangerType_2 = 2,
///大叔
TRTCVoiceChangerType_3 = 3,
///重金属
TRTCVoiceChangerType_4 = 4,
///感冒
TRTCVoiceChangerType_5 = 5,
///外国人
TRTCVoiceChangerType_6 = 6,
///困兽
TRTCVoiceChangerType_7 = 7,
///死肥仔
TRTCVoiceChangerType_8 = 8,
///强电流
TRTCVoiceChangerType_9 = 9,
///重机械
TRTCVoiceChangerType_10 = 10,
///空灵
TRTCVoiceChangerType_11 = 11,
};
/**
* 3.6 系统音量类型(仅适用于移动设备)
*
* 现代智能手机中一般都具备两套系统音量类型,即“通话音量”和“媒体音量”。
* - 通话音量:手机专门为接打电话所设计的音量类型,自带回声抵消(AEC)功能,并且支持通过蓝牙耳机上的麦克风进行拾音,缺点是音质比较一般。
* 当您通过手机侧面的音量按键下调手机音量时,如果无法将其调至零(也就是无法彻底静音),说明您的手机当前处于通话音量。
* - 媒体音量:手机专门为音乐场景所设计的音量类型,无法使用系统的 AEC 功能,并且不支持通过蓝牙耳机的麦克风进行拾音,但具备更好的音乐播放效果。
* 当您通过手机侧面的音量按键下调手机音量时,如果能够将手机音量调至彻底静音,说明您的手机当前处于媒体音量。
* SDK 目前提供了三种系统音量类型的控制模式:自动切换模式、全程通话音量模式、全程媒体音量模式。
*/
typedef NS_ENUM(NSInteger, TRTCSystemVolumeType) {
///自动切换模式:
///也被称为“麦上通话,麦下媒体”,即主播上麦时使用通话音量,观众不上麦则使用媒体音量,适合在线直播场景。
///如果您在 enterRoom 时选择的场景为 TRTCAppSceneLIVE 或 TRTCAppSceneVoiceChatRoom,SDK 会自动使用该模式。
TRTCSystemVolumeTypeAuto = 0,
///全程媒体音量:
///通话全程使用媒体音量,并不是非常常用的音量类型,适用于对音质要求比较苛刻的音乐场景中。
///如果您的用户大都使用外接设备(比如外接声卡)为主,可以使用该模式,否则请慎用。
TRTCSystemVolumeTypeMedia = 1,
///全程通话音量:
///该方案的优势在于用户在上下麦时音频模块无需切换工作模式,可以做到无缝上下麦,适合于用户需要频繁上下麦的应用场景。
///如果您在 enterRoom 时选择的场景为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall,SDK 会自动使用该模式。
TRTCSystemVolumeTypeVOIP = 2,
};
/////////////////////////////////////////////////////////////////////////////////
//
// 更多枚举值定义
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 4.1 Log 级别
*
* 不同的日志等级定义了不同的详实程度和日志数量,推荐一般情况下将日志等级设置为:TRTCLogLevelInfo。
*/
typedef NS_ENUM(NSInteger, TRTCLogLevel) {
///输出所有级别的 Log
TRTCLogLevelVerbose = 0,
///输出 DEBUG,INFO,WARNING,ERROR 和 FATAL 级别的 Log
TRTCLogLevelDebug = 1,
///输出 INFO,WARNING,ERROR 和 FATAL 级别的 Log
TRTCLogLevelInfo = 2,
///输出WARNING,ERROR 和 FATAL 级别的 Log
TRTCLogLevelWarn = 3,
///输出ERROR 和 FATAL 级别的 Log
TRTCLogLevelError = 4,
///仅输出 FATAL 级别的 Log
TRTCLogLevelFatal = 5,
///不输出任何 SDK Log
TRTCLogLevelNone = 6,
};
/**
* 4.2 重力感应开关(仅适用于移动端)
*/
typedef NS_ENUM(NSInteger, TRTCGSensorMode) {
///不适配重力感应
///该模式是桌面平台上的默认值,该模式下,当前用户发布出去的视频画面不受重力感应方向变化的影响。
TRTCGSensorMode_Disable = 0,
///适配重力感应
///该模式是移动平台上的默认值,该模式下,当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整,同时本地预览画面保持方向不变。
/// SDK 目前支持的一种适配模式是:当手机或 Pad 上下颠倒时,为了保证远端用户看到的画面方向正常,SDK 会自动将发布出去的画面上下旋转180度。
///如果您的 APP 的界面层开启了重力感应自适应,推荐使用 UIFixLayout 模式。
TRTCGSensorMode_UIAutoLayout = 1,
///适配重力感应
///该模式下,当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整,同时本地预览画面也会进行相应的旋转适配。
///目前支持的一种特性是:当手机或 Pad 上下颠倒时,为了保证远端用户看到的画面方向正常,SDK 会自动将发布出去的画面上下旋转180度。
///如果您的 APP 的界面层不支持重力感应自适应,并且希望 SDK 的视频画面能够适配重力感应方向,推荐使用 UIFixLayout 模式。
TRTCGSensorMode_UIFixLayout = 2,
};
/**
* 4.3 屏幕分享的目标类型(仅适用于桌面端)
*/
typedef NS_ENUM(NSInteger, TRTCScreenCaptureSourceType) {
///未定义
TRTCScreenCaptureSourceTypeUnknown = -1,
///该分享目标是某一个应用的窗口
TRTCScreenCaptureSourceTypeWindow = 0,
///该分享目标是某一台显示器的屏幕
TRTCScreenCaptureSourceTypeScreen = 1,
};
/**
* 4.4 云端混流的排版模式
*
* TRTC 的云端混流服务能够将房间中的多路音视频流混合成一路,因此您需要指定画面的排版方案,我们提供了如下几种排版模式:
*/
typedef NS_ENUM(NSInteger, TRTCTranscodingConfigMode) {
///未定义
TRTCTranscodingConfigMode_Unknown = 0,
///全手动排版模式
///该模式下,您需要指定每一路画面的精确排版位置。该模式的自由度最高,但易用性也最差:
///- 您需要填写 TRTCTranscodingConfig 中的所有参数,包括每一路画面(TRTCMixUser)的位置坐标。
///- 您需要监听 TRTCCloudDelegate 中的 onUserVideoAvailable() 和 onUserAudioAvailable() 事件回调,并根据当前房间中各个麦上用户的音视频状态不断地调整 mixUsers 参数。
TRTCTranscodingConfigMode_Manual = 1,
///纯音频模式
///该模式适用于语音通话(AudioCall)和语音聊天室(VoiceChatRoom)等纯音频的应用场景。
///- 您只需要在进入房间后,通过 setMixTranscodingConfig() 接口设置一次,之后 SDK 就会自动把房间内所有上麦用户的声音混流到当前用户的直播流上。
///- 您无需设置 TRTCTranscodingConfig 中的 mixUsers 参数,只需设置 audioSampleRate、audioBitrate 和 audioChannels 等参数即可。
TRTCTranscodingConfigMode_Template_PureAudio = 2,
///预排版模式
///最受欢迎的排版模式,因为该模式支持您通过占位符提前对各路画面的位置进行设定,之后 SDK 会自动根据房间中画面的路数动态进行适配调整。
///此模式下,您依然需要设置 mixUsers 参数,但可以将 userId 设置为“占位符”,可选的占位符有:
/// - "$PLACE_HOLDER_REMOTE$" : 指代远程用户的画面,可以设置多个。
/// - "$PLACE_HOLDER_LOCAL_MAIN$" : 指代本地摄像头画面,只允许设置一个。
/// - "$PLACE_HOLDER_LOCAL_SUB$" : 指代本地屏幕分享画面,只允许设置一个。
///此模式下,您不需要监听 TRTCCloudDelegate 中的 onUserVideoAvailable() 和 onUserAudioAvailable() 回调进行实时调整,
///只需要在进房成功后调用一次 setMixTranscodingConfig() 即可,之后 SDK 会自动将真实的 userId 补位到您设置的占位符上。
TRTCTranscodingConfigMode_Template_PresetLayout = 3,
///屏幕分享模式
///适用于在线教育场景等以屏幕分享为主的应用场景,仅支持 Windows 和 Mac 两个平台的 SDK。
///该模式下,SDK 会先根据您通过 videoWidth 和 videoHeight 参数设置的目标分辨率构建一张画布,
///- 当老师未开启屏幕分享时,SDK 会将老师的摄像头画面等比例拉伸绘制到该画布上;
///- 当老师开启屏幕分享之后,SDK 会将屏幕分享画面绘制到同样的画布上。
///此种排版模式的目的是为了确保混流模块的输出分辨率一致,避免课程回放和网页观看的花屏问题(网页播放器不支持可变分辨率)。
///同时,连麦学生的声音也会被默认混合到老师的音视频流中。
///< br>
///由于教学模式下的视频内容以屏幕分享为主,因此同时传输摄像头画面和屏幕分享画面是非常浪费带宽的。
///推荐的做法是直接将摄像头画面通过 setLocalVideoRenderCallback 接口自定义绘制到当前屏幕上。
///在该模式下,您无需设置 TRTCTranscodingConfig 中的 mixUsers 参数,SDK 不会混合学生的画面,以免干扰屏幕分享的效果。
///< br>
///您可以将 TRTCTranscodingConfig 中的 width × height 设为 0px × 0px,SDK 会自动根据用户当前屏幕的宽高比计算出一个合适的分辨率:
///- 如果老师当前屏幕宽度 <= 1920px,SDK 会使用老师当前屏幕的实际分辨率。
///- 如果老师当前屏幕宽度 > 1920px,SDK 会根据当前屏幕宽高比,选择 1920x1080(16:9)、1920x1200(16:10)、1920x1440(4:3) 三种分辨率中的一种。
TRTCTranscodingConfigMode_Template_ScreenSharing = 4,
};
/**
* 4.5 媒体录制类型
*
* 该枚举类型用于本地媒体录制接口{@link startLocalRecording},用于指定是录制音视频文件还是纯音频文件。
*/
typedef NS_ENUM(NSUInteger, TRTCRecordType) {
///仅录制音频
TRTCRecordTypeAudio = 0,
///仅录制视频
TRTCRecordTypeVideo = 1,
///同时录制音频和视频
TRTCRecordTypeBoth = 2,
};
/**
* 4.6 混流输入类型
*/
typedef NS_ENUM(NSUInteger, TRTCMixInputType) {
///不指定,SDK 会根据另一个参数 pureAudio 的数值决定混流输入类型
TRTCMixInputTypeUndefined = 0,
///混入音频和视频
TRTCMixInputTypeAudioVideo = 1,
///只混入视频
TRTCMixInputTypePureVideo = 2,
///只混入音频
TRTCMixInputTypePureAudio = 3,
};
/**
* 4.7 设备类型(仅适用于桌面平台)
*
* 该枚举值用于定义三种类型的音视频设备,即摄像头、麦克风和扬声器,以便让一套设备管理接口可以操控三种不同类型的设备。
* 自 Ver8.0 版本开始,TRTC 在 TXDeviceManager 中重新定义了 “TXMediaDeviceType” 用于替换老版本中的 “TRTCMediaDeviceType”,
* 此处仅保留 “TRTCMediaDeviceType” 的定义,用于兼容老版本的客户代码。
*/
#if TARGET_OS_MAC && !TARGET_OS_IPHONE
typedef NS_ENUM(NSInteger, TRTCMediaDeviceType) {
TRTCMediaDeviceTypeUnknown = -1, ///< undefined device type
TRTCMediaDeviceTypeAudioInput = 0, ///< microphone
TRTCMediaDeviceTypeAudioOutput = 1, ///< speaker
TRTCMediaDeviceTypeVideoCamera = 2, ///< camera
TRTCMediaDeviceTypeVideoWindow = 3, ///< windows(for screen share)
TRTCMediaDeviceTypeVideoScreen = 4, ///< screen (for screen share)
} __attribute__((deprecated("use TXDeviceManager#TXMediaDeviceType instead")));
typedef TXMediaDeviceInfo TRTCMediaDeviceInfo __attribute__((deprecated("use TXDeviceManager#TXMediaDeviceInfo instead")));
#endif
/**
* 4.11 音频录制内容类型
*
* 该枚举类型用于音频录制接口{@link startAudioRecording},用于指定录制音频的内容。
*/
typedef NS_ENUM(NSUInteger, TRTCAudioRecordingContent) {
///录制本地和远端所有音频
TRTCAudioRecordingContentAll = 0,
///仅录制本地音频
TRTCAudioRecordingContentLocal = 1,
///仅录制远端音频
TRTCAudioRecordingContentRemote = 2,
};
/////////////////////////////////////////////////////////////////////////////////
//
// TRTC 核心类型定义
//
/////////////////////////////////////////////////////////////////////////////////
/**
* 5.1 进房参数
*
* 作为 TRTC SDK 的进房参数,只有该参数填写正确,才能顺利进入 roomId 或者 strRoomId 所指定的音视频房间。
* 由于历史原因,TRTC 支持数字和字符串两种类型的房间号,分别是 roomId 和 strRoomId。
* 请注意:不要混用 roomId 和 strRoomId,因为它们之间是不互通的,比如数字 123 和字符串 “123” 在 TRTC 看来是两个完全不同的房间。
*/
@interface TRTCParams : NSObject
///【字段含义】应用标识(必填),腾讯云基于 sdkAppId 完成计费统计。
///【推荐取值】在 [实时音视频控制台](https://console.cloud.tencent.com/rav/) 创建应用后可以在账号信息页面中得到该 ID。
@property(nonatomic, assign) UInt32 sdkAppId;
///【字段含义】用户标识(必填),当前用户的 userId,相当于用户名,使用 UTF-8 编码。
///【推荐取值】如果一个用户在您的帐号系统中的 ID 为“mike”,则 userId 即可设置为“mike”。
@property(nonatomic, copy, nonnull) NSString *userId;
///【字段含义】用户签名(必填),当前 userId 对应的验证签名,相当于使用云服务的登录密码。
///【推荐取值】具体计算方法请参见 [如何计算UserSig](https://cloud.tencent.com/document/product/647/17275)。
@property(nonatomic, copy, nonnull) NSString *userSig;
///【字段含义】数字房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。
///【推荐取值】取值范围:1 - 4294967294。
///【特别说明】roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为0。若两者都填,SDK 将优先选用 roomId。
///【请您注意】不要混用 roomId 和 strRoomId,因为它们之间是不互通的,比如数字 123 和字符串 “123” 在 TRTC 看来是两个完全不同的房间。
@property(nonatomic, assign) UInt32 roomId;
///【字段含义】字符串房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。
///【特别说明】roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为0。若两者都填,SDK 将优先选用 roomId。
///【请您注意】不要混用 roomId 和 strRoomId,因为它们之间是不互通的,比如数字 123 和字符串 “123” 在 TRTC 看来是两个完全不同的房间。
///【推荐取值】限制长度为64字节。以下为支持的字符集范围(共 89 个字符):
/// - 大小写英文字母(a-zA-Z);
/// - 数字(0-9);
/// - 空格、"!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、" {"、"}"、"|"、"~"、","。
@property(nonatomic, copy, nonnull) NSString *strRoomId;
///【字段含义】直播场景下的角色,仅适用于直播场景({@link TRTCAppSceneLIVE} 和{@link TRTCAppSceneVoiceChatRoom}),通话场景下指定该参数是无效的。
///【推荐取值】默认值:主播({@link TRTCRoleAnchor})。
@property(nonatomic, assign) TRTCRoleType role;
///【字段含义】用于指定在腾讯云直播平台上的 streamId(选填),设置之后,您可以在腾讯云直播 CDN 上通过标准拉流方案(FLV或HLS)播放该用户的音视频流。
///【推荐取值】限制长度为64字节,可以不填写,一种推荐的方案是使用 “sdkappid_roomid_userid_main” 作为 streamid,这中命名方式容易辨认且不会在您的多个应用中发生冲突。
///【特殊说明】要使用腾讯云直播 CDN,您需要先在[控制台](https://console.cloud.tencent.com/trtc/) 中的功能配置页开启“启动自动旁路直播”开关。
///【参考文档】[CDN 旁路直播](https://cloud.tencent.com/document/product/647/16826)。
@property(nonatomic, copy, nullable) NSString *streamId;
///【字段含义】云端录制开关(选填),用于指定是否要在云端将该用户的音视频流录制下来。
///【参考文档】[云端录制](https://cloud.tencent.com/document/product/647/16823)。
///【推荐取值】限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
/// <p>
/// 方案一:手动录制方案:
/// 1. 在“[控制台](https://console.cloud.tencent.com/trtc) => 应用管理 => 云端录制配置”中开启云端录制。
/// 2. 设置“录制形式”为“手动录制”。
/// 3. 设置手动录制后,在一个 TRTC 房间中只有设置了 userDefineRecordId 参数的用户才会在云端录制出视频文件,不指定该参数的用户不会产生录制行为。
/// 4. 云端会以 “userDefineRecordId_起始时间_结束时间” 的格式命名录制下来的文件。
/// <p>
/// 方案二:自动录制方案:
/// 1. 需要在“[控制台](https://console.cloud.tencent.com/trtc) => 应用管理 => 云端录制配置”中开启云端录制。
/// 2. 设置“录制形式”为“自动录制”。
/// 3. 设置自动录制后,在一个 TRTC 房间中的任何一个有音视频上行的用户,均会在云端录制出视频文件。
/// 4. 文件会以 “userDefineRecordId_起始时间_结束时间” 的格式命名,如果不指定 userDefineRecordId,则文件会以 “streamId_起始时间_结束时间” 命名。
/// <br>
@property(nonatomic, copy, nullable) NSString *userDefineRecordId;
///【字段含义】用于权限控制的权限票据(选填),当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。
///【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 [进房权限保护](https://cloud.tencent.com/document/product/647/32240)。
@property(nonatomic, copy, nullable) NSString *privateMapKey;
///【字段含义】业务数据字段(选填),部分高级特性才需要用到此字段。
///【推荐取值】请不要自行设置该字段。
@property(nonatomic, copy, nullable) NSString *bussInfo;
@end
/**
* 5.2 视频编码参数
*
* 该设置决定远端用户看到的画面质量,同时也决定了云端录制出的视频文件的画面质量。
*/
@interface TRTCVideoEncParam : NSObject
///【字段含义】 视频分辨率
///【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: 640 × 360 + Portrait = 360 × 640。
///【推荐取值】
/// - 手机视频通话:建议选择 360 × 640 及以下分辨率,resMode 选择 Portrait,即竖屏分辨率。
/// - 手机在线直播:建议选择 540 × 960,resMode 选择 Portrait,即竖屏分辨率。
/// - 桌面平台(Win + Mac):建议选择 640 × 360 及以上分辨率,resMode 选择 Landscape,即横屏分辨率。
@property(nonatomic, assign) TRTCVideoResolution videoResolution;
///【字段含义】分辨率模式(横屏分辨率 or 竖屏分辨率)
///【推荐取值】手机平台(iOS、Android)建议选择 Portrait,桌面平台(Windows、Mac)建议选择 Landscape。
///【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: 640 × 360 + Portrait = 360 × 640。
@property(nonatomic, assign) TRTCVideoResolutionMode resMode;
///【字段含义】视频采集帧率
///【推荐取值】15fps或20fps。5fps以下,卡顿感明显。10fps以下,会有轻微卡顿感。20fps以上,会浪费带宽(电影的帧率为24fps)。
///【特别说明】部分 Android 手机的前置摄像头并不支持15fps以上的采集帧率,部分主打美颜功能的 Android 手机的前置摄像头的采集帧率可能低于10fps。
@property(nonatomic, assign) int videoFps;
///【字段含义】目标视频码率,SDK 会按照目标码率进行编码,只有在弱网络环境下才会主动降低视频码率。
///【推荐取值】请参考本 TRTCVideoResolution 在各档位注释的最佳码率,也可以在此基础上适当调高。
/// 比如:TRTCVideoResolution_1280_720 对应 1200kbps 的目标码率,您也可以设置为 1500kbps 用来获得更好的观感清晰度。
///【特别说明】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数,用于约束 SDK 对视频码率的调整范围:
/// - 如果您追求“弱网络下允许卡顿但要保持清晰”的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60%;
/// - 如果您追求“弱网络下允许模糊但要保持流畅”的效果,可以设置 minVideoBitrate 为一个较低的数值(比如 100kbps);
/// - 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 对视频码率的自适应调节能力。
@property(nonatomic, assign) int videoBitrate;
///【字段含义】最低视频码率,SDK 会在网络不佳的情况下主动降低视频码率以保持流畅度,最低会降至 minVideoBitrate 所设定的数值。
///【特别说明】 默认值:0,此时最低码率由 SDK 会根据您指定的分辨率,自动计算出合适的数值。
///【推荐取值】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数,用于约束 SDK 对视频码率的调整范围:
/// - 如果您追求“弱网络下允许卡顿但要保持清晰”的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60%;
/// - 如果您追求“弱网络下允许模糊但要保持流畅”的效果,可以设置 minVideoBitrate 为一个较低的数值(比如 100kbps);
/// - 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 对视频码率的自适应调节能力。
@property(nonatomic, assign) int minVideoBitrate;
///【字段含义】是否允许动态调整分辨率(开启后会对云端录制产生影响)。
///【推荐取值】该功能适用于不需要云端录制的场景,开启后 SDK 会根据当前网络情况,智能选择出一个合适的分辨率,避免出现“大分辨率+小码率”的低效编码模式。
///【特别说明】默认值:关闭。如有云端录制的需求,请不要开启此功能,因为如果视频分辨率发生变化后,云端录制出的 MP4 在普通的播放器上无法正常播放。
@property(nonatomic, assign) BOOL enableAdjustRes;
@end
/**
* 5.3 网络流控(Qos)参数集
*
* 网络流控相关参数,该设置决定 SDK 在弱网络环境下的调控策略(例如:“清晰优先”或“流畅优先”)
*/
@interface TRTCNetworkQosParam : NSObject
///【字段含义】清晰优先还是流畅优先
///【推荐取值】清晰优先
///【特别说明】该参数主要影响 TRTC 在较差网络环境下的音视频表现:
/// - 流畅优先:即当前网络不足以传输既清晰又流畅的画面时,优先保证画面的流畅性,代价就是画面会比较模糊且伴随有较多的马赛克。
/// - 清晰优先(默认值):即当前网络不足以传输既清晰又流畅的画面时,优先保证画面的清晰度,代价就是画面会比较卡顿。
@property(nonatomic, assign) TRTCVideoQosPreference preference;
///【字段含义】流控模式(已废弃)
///【推荐取值】云端控制
///【特别说明】请设置为云端控制模式(TRTCQosControlModeServer)
@property(nonatomic, assign) TRTCQosControlMode controlMode;
@end
/**
* 5.4 视频画面的渲染参数
*
* 您可以通过设置此参数来控制画面的旋转角度、填充模式和左右镜像模式。
*/
@interface TRTCRenderParams : NSObject
///【字段含义】图像的顺时针旋转角度
///【推荐取值】支持90、180以及270旋转角度,默认值:{@link TRTCVideoRotation_0}
@property(nonatomic) TRTCVideoRotation rotation;
///【字段含义】画面填充模式
///【推荐取值】填充(画面可能会被拉伸裁剪)或适应(画面可能会有黑边),默认值:{@link TRTCVideoFillMode_Fill}
@property(nonatomic) TRTCVideoFillMode fillMode;
///【字段含义】画面镜像模式
///【推荐取值】默认值:{@link TRTCVideoMirrorType_Auto}
@property(nonatomic) TRTCVideoMirrorType mirrorType;
@end
/**
* 5.5 网络质量
*
* 表征网络质量的好坏,您可以通过该数值在用户界面上展示每个用户的网络质量。
*/
@interface TRTCQualityInfo : NSObject
///用户 ID
@property(nonatomic, copy, nullable) NSString *userId;
///网络质量
@property(nonatomic, assign) TRTCQuality quality;
@end
/**
* 5.6 音量大小
*
* 表征语音音量的评估值,您可以通过该数值在用户界面上展示每个用户的音量大小。
*/
@interface TRTCVolumeInfo : NSObject
///说话者的 userId, 如果 userId 为空则代表是当前用户自己。
@property(nonatomic, copy, nullable) NSString *userId;
///说话者的音量大小, 取值范围[0 - 100]。
@property(assign, nonatomic) NSUInteger volume;
@end
/**
* 5.7 网络测速结果
*
* 您可以在用户进入房间前通过 {@link startSpeedTest} 接口进行测速(注意:请不要在通话中调用),
* 测速结果会每2 - 3秒钟返回一次,每次返回一个 IP 地址的测试结果。
*/
@interface TRTCSpeedTestResult : NSObject
///服务器 IP 地址
@property(strong, nonatomic, nonnull) NSString *ip;
///内部通过评估算法测算出的网络质量,网络质量越好得分越高。
@property(nonatomic) TRTCQuality quality;
///上行丢包率,取值范围是 [0 - 1.0],例如 0.3 表示每向服务器发送10个数据包可能会在中途丢失3个。
@property(nonatomic) float upLostRate;
///下行丢包率,取值范围是 [0 - 1.0],例如 0.2 表示每从服务器收取10个数据包可能会在中途丢失2个。
@property(nonatomic) float downLostRate;
///延迟(毫秒),指当前设备到 TRTC 服务器的一次网络往返时间,该值越小越好,正常数值范围是10ms - 100ms。
@property(nonatomic) uint32_t rtt;
@end
/**
* 5.9 视频帧信息
*
* TRTCVideoFrame 用来描述一帧视频画面的裸数据,也就是编码前或者解码后的视频画面数据。
*/
@interface TRTCVideoFrame : NSObject
///【字段含义】视频的像素格式
@property(nonatomic, assign) TRTCVideoPixelFormat pixelFormat;
///【字段含义】视频数据结构类型
@property(nonatomic, assign) TRTCVideoBufferType bufferType;
///【字段含义】bufferType 为 {@link TRTCVideoBufferType_PixelBuffer} 时的视频数据,承载 iOS 平台专用的 PixelBuffer。
@property(nonatomic, assign, nullable) CVPixelBufferRef pixelBuffer;
///【字段含义】bufferType 为 {@link TRTCVideoBufferType_NSData} 时的视频数据,承载 NSData 类型的内存数据块。
@property(nonatomic, retain, nullable) NSData *data;
///【字段含义】视频纹理 ID,bufferType 为 {@link TRTCVideoBufferType_Texture} 时的视频数据,承载用于 OpenGL 渲染的纹理数据。
@property(nonatomic, assign) GLuint textureId;
///【字段含义】视频宽度
@property(nonatomic, assign) uint32_t width;
///【字段含义】视频高度
@property(nonatomic, assign) uint32_t height;
///【字段含义】视频帧的时间戳,单位毫秒
///【推荐取值】自定义视频采集时可以设置为0。若该参数为0,SDK 会自定填充 timestamp 字段,但请“均匀”地控制 sendCustomVideoData 的调用间隔。
@property(nonatomic, assign) uint64_t timestamp;
///【字段含义】视频像素的顺时针旋转角度
@property(nonatomic, assign) TRTCVideoRotation rotation;
@end
/**
* 5.10 音频帧数据
*/
@interface TRTCAudioFrame : NSObject
///【字段含义】音频数据
@property(nonatomic, retain, nonnull) NSData *data;
///【字段含义】采样率
@property(nonatomic, assign) TRTCAudioSampleRate sampleRate;
///【字段含义】声道数
@property(nonatomic, assign) int channels;
///【字段含义】时间戳,单位ms
@property(nonatomic, assign) uint64_t timestamp;
///【字段含义】音频额外数据,远端用户通过 `onLocalProcessedAudioFrame` 写入的数据会通过该字段回调
@property(nonatomic, retain, nullable) NSData *extraData;
@end
/**
* 5.11 云端混流中各路画面的描述信息
*
* TRTCMixUser 用于指定云端混流中每一路视频画面的位置、大小、图层以及流类型等信息。
*/
@interface TRTCMixUser : NSObject
///【字段含义】用户 ID
@property(nonatomic, copy, nonnull) NSString *userId;
///【字段含义】该路音视频流所在的房间号(设置为空值代表当前用户所在的房间号)
@property(nonatomic, copy, nullable) NSString *roomID;
///【字段含义】指定该路画面的坐标区域(单位:像素)
@property(nonatomic, assign) CGRect rect;
///【字段含义】指定该路画面的层级(取值范围:1 - 15,不可重复)
@property(nonatomic, assign) int zOrder;
///【字段含义】指定该路画面是主路画面({@link TRTCVideoStreamTypeBig})还是辅路画面({@link TRTCVideoStreamTypeSub})。
@property(nonatomic) TRTCVideoStreamType streamType;
///【字段含义】指定该路流是不是只混合声音
///【推荐取值】默认值:NO
///【特别说明】已废弃,推荐使用8.5版本开始新引入的字段:inputType。
@property(nonatomic, assign) BOOL pureAudio;
///【字段含义】指定该路流的混合内容(只混合音频、只混合视频、混合音频和视频),该字段是对 pureAudio 字段的升级。
///【推荐取值】默认值:TRTCMixInputTypeUndefined,代表参考 pureAudio 的取值。
/// - 如果您是第一次使用 TRTC,之前并没有对 pureAudio 字段进行过设置,您可以根据实际需要设置该字段,不建议您再设置 pureAudio。
/// - 如果您之前在老版本中已经使用了 pureAudio 字段,并期望保持其设置,则可以将 inputType 设置为 TRTCMixInputTypeUndefined。
@property(nonatomic, assign) TRTCMixInputType inputType;
@end
/**
* 5.12 云端混流的排版布局和转码参数
*
* 用于指定混流时各路画面的排版位置信息和云端转码的编码参数。
*/
@interface TRTCTranscodingConfig : NSObject
///【字段含义】排版模式
///【推荐取值】请根据您的业务场景要求自行选择,预排版模式是适用性较好的一种模式。
@property(nonatomic, assign) TRTCTranscodingConfigMode mode;
///【字段含义】腾讯云直播服务的 AppID
///【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 appid。
@property(nonatomic) int appId;
///【字段含义】腾讯云直播服务的 bizid
///【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 bizid。
@property(nonatomic) int bizId;
///【字段含义】指定云端转码的目标分辨率(宽度)
///【推荐取值】单位:像素值,推荐值:360,如果你只混合音频流,请将 width 和 height 均设置位 0,否则混流转码后的直播流中会有黑色背景。
@property(nonatomic, assign) int videoWidth;
///【字段含义】指定云端转码的目标分辨率(高度)
///【推荐取值】单位:像素值,推荐值:640,如果你只混合音频流,请将 width 和 height 均设置位 0,否则混流转码后的直播流中会有黑色背景。
@property(nonatomic, assign) int videoHeight;
///【字段含义】指定云端转码的目标视频码率(kbps)
///【推荐取值】如果填0,TRTC 会根据 videoWidth 和 videoHeight 估算出一个合理的码率值,您也可以参考视频分辨率枚举定义中所推荐的码率值(见注释部分)。
@property(nonatomic, assign) int videoBitrate;
///【字段含义】指定云端转码的目标视频帧率(FPS)
///【推荐取值】默认值:15fps,取值范围是 (0,30]。
@property(nonatomic, assign) int videoFramerate;
///【字段含义】指定云端转码的目标视频关键帧间隔(GOP)
///【推荐取值】默认值:2,单位为秒,取值范围是 [1,8]。
@property(nonatomic, assign) int videoGOP;
///【字段含义】指定混合画面的底色颜色
///【推荐取值】默认值:0x000000 代表黑色。格式为十六进制数字,比如:“0x61B9F1” 代表 RGB 分别为(97,158,241)。
@property(nonatomic, assign) int backgroundColor;
///【字段含义】指定混合画面的背景图片
///【推荐取值】默认值:空值,即不设置背景图片。
///【特别说明】背景图需要您事先在 “[控制台](https://console.cloud.tencent.com/trtc) => 应用管理 => 功能配置 => 素材管理” 中单击【新增图片】按钮进行上传。
/// 上传成功后可以获得对应的“图片ID”,然后将“图片ID”转换成字符串类型并设置到 backgroundImage 里即可。
/// 例如:假设“图片ID” 为 63,可以设置 backgroundImage = @"63";
@property(nonatomic, copy, nullable) NSString *backgroundImage;
///【字段含义】指定云端转码的目标音频采样率
///【推荐取值】默认值:48000Hz。支持12000HZ、16000HZ、22050HZ、24000HZ、32000HZ、44100HZ、48000HZ。
@property(nonatomic, assign) int audioSampleRate;
///【字段含义】指定云端转码的目标音频码率
///【推荐取值】默认值:64kbps,取值范围是 [32,192]。
@property(nonatomic, assign) int audioBitrate;
///【字段含义】指定云端转码的音频声道数
///【推荐取值】默认值:1,代表单声道。可设定的数值只有两个数字:1-单声道,2-双声道。
@property(nonatomic, assign) int audioChannels;
///【字段含义】指定云端混流中每一路视频画面的位置、大小、图层以及流类型等信息
///【推荐取值】该字段是一个 TRTCMixUser 类型的数组,数组中的每一个元素都用来代表每一路画面的信息。
@property(nonatomic, copy, nonnull) NSArray<TRTCMixUser *> *mixUsers;
///【字段含义】输出到 CDN 上的直播流 ID
///【推荐取值】默认值:空值,即房间里的多路音视频流最终会混合到接口调用者的那一路音视频流上。
/// - 如不设置该参数,SDK 会执行默认逻辑,即房间里的多路音视频流会混合到该接口调用者的那一路音视频流上,也就是 A + B => A。
/// - 如您设置该参数,SDK 会将房间里的多路音视频流混合到您指定的直播流上,也就是 A + B => C(C 代表您指定的 streamId)。
@property(nonatomic, copy, nullable) NSString *streamId;
@end
/**
* 5.13 向非腾讯云 CDN 上发布音视频流时需设置的转推参数
*
* TRTC 的后台服务支持通过标准 RTMP 协议,将其中的音视频流发布到第三方直播 CDN 服务商。
* 如果您使用腾讯云直播 CDN 服务,可无需关注此参数,直接使用 {@link startPublish} 接口即可。
*/
@interface TRTCPublishCDNParam : NSObject
///【字段含义】腾讯云直播服务的 AppID
///【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 appid。
@property(nonatomic) int appId;
///【字段含义】腾讯云直播服务的 bizid
///【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 bizid。
@property(nonatomic) int bizId;
///【字段含义】指定该路音视频流在第三方直播服务商的推流地址(RTMP 格式)
///【推荐取值】各家服务商的推流地址规则差异较大,请根据目标服务商的要求填写合法的推流 URL,TRTC 的后台服务器会按照您填写的 URL 向第三方服务商推送标准格式音视频流。
///【特别说明】推流 URL 必须为 RTMP 格式,必须符合您的目标直播服务商的规范要求,否则目标服务商会拒绝来自 TRTC 后台服务的推流请求。
@property(nonatomic, strong, nonnull) NSString *url;
@end
/**
* 5.14 本地音频文件的录制参数
*
* 该参数用于在音频录制接口 {@link startAudioRecording} 中指定录制参数。
*/
@interface TRTCAudioRecordingParams : NSObject
///【字段含义】录音文件的保存路径(必填)。
///【特别说明】该路径需精确到文件名及格式后缀,格式后缀用于决定录音文件的格式,目前支持的格式有 PCM、WAV 和 AAC。
/// 例如:假如您指定路径为 "mypath/record/audio.aac",代表您希望 SDK 生成一个 AAC 格式的音频录制文件。
/// 请您指定一个有读写权限的合法路径,否则录音文件无法生成。
@property(nonatomic, strong, nonnull) NSString *filePath;
///【字段含义】音频录制内容类型。
///【特别说明】默认录制所有本地和远端音频。
@property(nonatomic, assign) TRTCAudioRecordingContent recordingContent;
@end
/**
* 5.15 本地媒体文件的录制参数
*
* 该参数用于在本地媒体文件的录制接口 {@link startLocalRecording} 中指定录制相关参数。
* 接口 startLocalRecording 是接口 startAudioRecording 的能力加强版本,前者可以录制视频文件,后者只能录制音频文件。
*/
@interface TRTCLocalRecordingParams : NSObject
///【字段含义】录制的文件地址(必填),请确保路径有读写权限且合法,否则录制文件无法生成。
///【特别说明】该路径需精确到文件名及格式后缀,格式后缀用于决定录制出的文件格式,目前支持的格式暂时只有 MP4。
/// 例如:假如您指定路径为 "mypath/record/test.mp4",代表您希望 SDK 生成一个 MP4 格式的本地视频文件。
/// 请您指定一个有读写权限的合法路径,否则录制文件无法生成。
@property(nonatomic, copy, nonnull) NSString *filePath;
///【字段含义】媒体录制类型,默认值:TRTCRecordTypeBoth,即同时录制音频和视频。
@property(nonatomic, assign) TRTCRecordType recordType;
///【字段含义】interval 录制信息更新频率,单位毫秒,有效范围:1000-10000。默认值为-1,表示不回调。
@property(nonatomic, assign) int interval;
@end
/**
* 5.16 音效参数(已废弃)
*
* TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟的播放时间,比如“鼓掌声”、“欢笑声”等。
* 该参数用于在早期版本的音效播放接口 {@link TRTCCloud#playAudioEffect} 中指定音效文件(即短音频文件)的路径和播放次数等。
* 在 7.3 版本以后,音效接口已被新的接口 {@link TXAudioEffectManager#startPlayMusic} 所取代。
* 您在指定 startPlayMusic 的参数 {@link TXAudioMusicParam} 时,如果将 “isShortFile” 设置为 true,即为“音效”文件。
*/
@interface TRTCAudioEffectParam : NSObject
+ (_Nonnull instancetype)new __attribute__((unavailable("Use -initWith:(int)effectId path:(NSString * )path instead")));
- (_Nonnull instancetype)init __attribute__((unavailable("Use -initWith:(int)effectId path:(NSString *)path instead")));
///【字段含义】音效 ID
///【特别说明】SDK 允许播放多路音效,因此需要音效 ID 进行标记,用于控制音效的开始、停止、音量等。
@property(nonatomic, assign) int effectId;
///【字段含义】音效文件路径,支持的文件格式:aac, mp3, m4a。
@property(nonatomic, copy, nonnull) NSString *path;
///【字段含义】循环播放次数
///【推荐取值】取值范围为0 - 任意正整数,默认值:0,表示播放音效一次;1表示播放音效两次;以此类推。
@property(nonatomic, assign) int loopCount;
///【字段含义】音效是否上行
///【推荐取值】YES:音效在本地播放的同时,会上行至云端,因此远端用户也能听到该音效;NO:音效不会上行至云端,因此只能在本地听到该音效。默认值:NO
@property(nonatomic, assign) BOOL publish;
///【字段含义】音效音量
///【推荐取值】取值范围为0 - 100;默认值:100
@property(nonatomic, assign) int volume;
- (_Nonnull instancetype)initWith:(int)effectId path:(NSString *_Nonnull)path;
@end
/**
* 5.17 房间切换参数
*
* 该参数用于切换房间接口{@link switchRoom},可以让用户从一个房间快速切换到另一个房间。
*/
@interface TRTCSwitchRoomConfig : NSObject
///【字段含义】数字房间号码 [选填],在同一个房间内的用户可以看到彼此并能够进行音视频通话。
///【推荐取值】取值范围:1 - 4294967294。
///【特别说明】roomId 和 strRoomId 必须并且只能填一个。若两者都填,则优先选择 roomId。
@property(nonatomic, assign) UInt32 roomId;
///【字段含义】字符串房间号码 [选填],在同一个房间内的用户可以看到彼此并能够进行音视频通话。
///【特别说明】roomId 和 strRoomId 必须并且只能填一个。若两者都填,则优先选择 roomId。
@property(nonatomic, copy, nullable) NSString *strRoomId;
///【字段含义】用户签名 [选填],当前 userId 对应的验证签名,相当于登录密码。
/// 如果您在切换房间时不指定新计算出的 userSig,SDK 会继续使用您在进入房间时(enterRoom)时所指定的 userSig。
/// 这就需要您必须保证旧的 userSig 在切换房间的那一刻仍在签名允许的效期内,否则会导致房间切换失败。
///【推荐取值】具体计算方法请参考 [如何计算UserSig](https://cloud.tencent.com/document/product/647/17275)。
@property(nonatomic, copy, nullable) NSString *userSig;
///【字段含义】用于权限控制的权限票据(选填),当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。
///【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 [进房权限保护](https://cloud.tencent.com/document/product/647/32240)。
@property(nonatomic, copy, nullable) NSString *privateMapKey;
@end
/**
* 5.18 音频自定义回调的格式参数
*
* 该参数用于在音频自定义回调相关的接口中,设置 SDK 回调出来的音频数据的相关格式(包括采样率、声道数等)。
*/
@interface TRTCAudioFrameDelegateFormat : NSObject
///【字段含义】采样率
///【推荐取值】默认值:48000Hz。支持 16000, 32000, 44100, 48000。
@property(nonatomic, assign) TRTCAudioSampleRate sampleRate;
///【字段含义】声道数
///【推荐取值】默认值:1,代表单声道。可设定的数值只有两个数字:1-单声道,2-双声道。
@property(nonatomic, assign) int channels;
///【字段含义】采样点数
///【推荐取值】取值必须是 sampleRate/100 的整数倍。
@property(nonatomic, assign) int samplesPerCall;
@end
/**
* 5.20 屏幕分享的目标信息(仅适用于桌面系统)
*
* 在用户进行屏幕分享时,可以选择抓取整个桌面,也可以仅抓取某个程序的窗口。
* TRTCScreenCaptureSourceInfo 用于描述待分享目标的信息,包括 ID、名称、缩略图等,该结构体中的字段信息均是只读的。
*/
#if TARGET_OS_MAC && !TARGET_OS_IPHONE
@interface TRTCScreenCaptureSourceInfo : NSObject
///【字段含义】采集源类型(是分享整个屏幕?还是分享某个窗口?)
@property(assign, nonatomic) TRTCScreenCaptureSourceType type;
///【字段含义】采集源的ID,对于窗口,该字段代表窗口的 ID;对于屏幕,该字段代表显示器的 ID。
@property(copy, nonatomic, nullable) NSString *sourceId;
///【字段含义】采集源名称(采用 UTF8 编码)
@property(copy, nonatomic, nullable) NSString *sourceName;
///【字段含义】窗口的扩展信息
@property(nonatomic, strong, nullable) NSDictionary *extInfo;
///【字段含义】分享窗口的缩略图
@property(nonatomic, readonly, nullable) NSImage *thumbnail;
///【字段含义】分享窗口的图标
@property(nonatomic, readonly, nullable) NSImage *icon;
@end
#endif
/// @}
/**
* Module: TRTCCloudDelegate @ TXLiteAVSDK
* Function: 腾讯云实时音视频的事件回调接口
*/
/// @defgroup TRTCCloudDelegate_ios TRTCCloudDelegate
/// 腾讯云实时音视频的事件回调接口
/// @{
#import <Foundation/Foundation.h>
#import "TRTCCloudDef.h"
#import "TXLiteAVCode.h"
NS_ASSUME_NONNULL_BEGIN
@class TRTCCloud;
@class TRTCStatistics;
@protocol TRTCCloudDelegate <NSObject>
@optional
/////////////////////////////////////////////////////////////////////////////////
//
// 错误和警告事件
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 错误和警告事件
/// @{
/**
* 1.1 错误事件回调
*
* 错误事件,表示 SDK 抛出的不可恢复的错误,比如进入房间失败或设备开启失败等。
* 参考文档:[错误码表](https://cloud.tencent.com/document/product/647/32257)
*
* @param errCode 错误码
* @param errMsg 错误信息
* @param extInfo 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题
*/
- (void)onError:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg extInfo:(nullable NSDictionary *)extInfo;
/**
* 1.2 警告事件回调
*
* 警告事件,表示 SDK 抛出的提示性问题,比如视频出现卡顿或 CPU 使用率太高等。
* 参考文档:[错误码表](https://cloud.tencent.com/document/product/647/32257)
*
* @param warningCode 警告码
* @param warningMsg 警告信息
* @param extInfo 扩展信息字段,个别警告码可能会带额外的信息帮助定位问题
*/
- (void)onWarning:(TXLiteAVWarning)warningCode warningMsg:(nullable NSString *)warningMsg extInfo:(nullable NSDictionary *)extInfo;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 房间相关事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 房间相关事件回调
/// @{
/**
* 2.1 进入房间成功与否的事件回调
*
* 调用 TRTCCloud 中的 enterRoom() 接口执行进房操作后,会收到来自 TRTCCloudDelegate 的 onEnterRoom(result) 回调:
* - 如果加入成功,回调 result 会是一个正数(result > 0),代表进入房间所消耗的时间,单位是毫秒(ms)。
* - 如果加入失败,回调 result 会是一个负数(result < 0),代表失败原因的错误码。
* 进房失败的错误码含义请参见[错误码表](https://cloud.tencent.com/document/product/647/32257)。
*
* @note
* 1. 在 Ver6.6 之前的版本,只有进房成功会抛出 onEnterRoom(result) 回调,进房失败由 onError() 回调抛出。
* 2. 在 Ver6.6 之后的版本:无论进房成功或失败,均会抛出 onEnterRoom(result) 回调,同时进房失败也会有 onError() 回调抛出。
*
* @param result result > 0 时为进房耗时(ms),result < 0 时为进房错误码。
*/
- (void)onEnterRoom:(NSInteger)result;
/**
* 2.2 离开房间的事件回调
*
* 调用 TRTCCloud 中的 exitRoom() 接口会执行退出房间的相关逻辑,例如释放音视频设备资源和编解码器资源等。
* 待 SDK 占用的所有资源释放完毕后,SDK 会抛出 onExitRoom() 回调通知到您。
*
* 如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK,请等待 onExitRoom() 回调到来后再执行相关操作。
* 否则可能会遇到例如摄像头、麦克风设备被强占等各种异常问题。
*
* @param reason 离开房间原因,0:主动调用 exitRoom 退出房间;1:被服务器踢出当前房间;2:当前房间整个被解散。
*/
- (void)onExitRoom:(NSInteger)reason;
/**
* 2.3 切换角色的事件回调
*
* 调用 TRTCCloud 中的 switchRole() 接口会切换主播和观众的角色,该操作会伴随一个线路切换的过程,
* 待 SDK 切换完成后,会抛出 onSwitchRole() 事件回调。
*
* @param errCode 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
* @param errMsg 错误信息。
*/
- (void)onSwitchRole:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg;
/**
* 2.4 切换房间的结果回调
*
* 调用 TRTCCloud 中的 switchRoom() 接口可以让用户快速地从一个房间切换到另一个房间,
* 待 SDK 切换完成后,会抛出 onSwitchRoom() 事件回调。
*
* @param errCode 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
* @param errMsg 错误信息。
*/
- (void)onSwitchRoom:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg;
/**
* 2.5 请求跨房通话的结果回调
*
* 调用 TRTCCloud 中的 connectOtherRoom() 接口会将两个不同房间中的主播拉通视频通话,也就是所谓的“主播PK”功能。
* 调用者会收到 onConnectOtherRoom() 回调来获知跨房通话是否成功,
* 如果成功,两个房间中的所有用户都会收到来自另一个房间中的 PK 主播的 onUserVideoAvailable() 回调。
*
* @param userId 要跨房通话的另一个房间中的主播的用户 ID。
* @param errCode 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
* @param errMsg 错误信息。
*/
- (void)onConnectOtherRoom:(NSString *)userId errCode:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg;
/**
* 2.6 结束跨房通话的结果回调
*/
- (void)onDisconnectOtherRoom:(TXLiteAVError)errCode errMsg:(nullable NSString *)errMsg;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 用户相关事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 用户相关事件回调
/// @{
/**
* 3.1 有用户加入当前房间
*
* 出于性能方面的考虑,在 TRTC 两种不同的应用场景(即 AppScene,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
* - 直播类场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):该场景下的用户区分主播和观众两种角色,只有主播进入房间时才会触发该通知,观众进入房间时不会触发该通知。
* - 通话类场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下的用户没有角色的区分(可认为都是主播),任何用户进入房间都会触发该通知。
*
* @note
* 1. 事件回调 onRemoteUserEnterRoom 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“用户列表”,有此事件回调不代表一定有视频画面。
* 2. 如果需要显示远程画面,请监听代表某个用户是否有视频画面的 onUserVideoAvailable() 事件回调。
* @param userId 远端用户的用户标识
*/
- (void)onRemoteUserEnterRoom:(NSString *)userId;
/**
* 3.2 有用户离开当前房间
*
* 与 onRemoteUserEnterRoom 相对应,在两种不同的应用场景(即 AppScene,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
* - 直播类场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):只有主播离开房间时才会触发该通知,观众离开房间不会触发该通知。
* - 通话类场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下用户没有角色的区别,任何用户的离开都会触发该通知。
*
* @param userId 远端用户的用户标识
* @param reason 离开原因,0表示用户主动退出房间,1表示用户超时退出,2表示被踢出房间。
*/
- (void)onRemoteUserLeaveRoom:(NSString *)userId reason:(NSInteger)reason;
/**
* 3.3 某远端用户发布/取消了主路视频画面
*
* “主路画面”一般被用于承载摄像头画面。当您收到 onUserVideoAvailable(userId, true) 通知时,表示该路画面已经有可播放的视频帧到达。
* 此时,您需要调用 {@link startRemoteView} 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调 onFirstVideoFrame(userid)。
*
* 当您收到 onUserVideoAvailable(userId, false) 通知时,表示该路远程画面已经被关闭,关闭的原因可能是该用户调用了 {@link muteLocalVideo} 或 {@link stopLocalPreview}。
*
* @param userId 远端用户的用户标识
* @param available 该用户是否发布(或取消发布)了主路视频画面,true: 发布;false:取消发布。
*/
- (void)onUserVideoAvailable:(NSString *)userId available:(BOOL)available;
/**
* 3.4 某远端用户发布/取消了辅路视频画面
*
* “辅路画面”一般被用于承载屏幕分享的画面。当您收到 onUserSubStreamAvailable(userId, true) 通知时,表示该路画面已经有可播放的视频帧到达。
* 此时,您需要调用 {@link startRemoteSubStreamView} 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调 onFirstVideoFrame(userid)。
*
* @note 显示辅路画面使用的函数是 {@link startRemoteSubStreamView} 而非 {@link startRemoteView}。
*
* @param userId 远端用户的用户标识
* @param available 该用户是否发布(或取消发布)了辅路视频画面,true: 发布;false:取消发布。
*/
- (void)onUserSubStreamAvailable:(NSString *)userId available:(BOOL)available;
/**
* 3.5 某远端用户发布/取消了自己的音频
*
* 当您收到 onUserAudioAvailable(userId, true) 通知时,表示该用户发布了自己的声音,此时 SDK 的表现为:
* - 在自动订阅模式下,您无需做任何操作,SDK 会自动播放该用户的声音。
* - 在手动订阅模式下,您可以通过 {@link muteRemoteAudio}(userid, false) 来播放该用户的声音。
*
* @note SDK 默认使用自动订阅模式,您可以通过 {@link setDefaultStreamRecvMode} 设置为手动订阅,但需要在您进入房间之前调用才生效。
*
* @param userId 远端用户的用户标识
* @param available 该用户是否发布(或取消发布)了自己的音频,true: 发布;false:取消发布。
*/
- (void)onUserAudioAvailable:(NSString *)userId available:(BOOL)available;
/**
* 3.6 SDK 开始渲染自己本地或远端用户的首帧画面
*
* SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件,您可以通过回调事件中的 userId 参数来判断事件来自于“本地”还是来自于“远端”。
* - 如果 userId 为空值,代表 SDK 已经开始渲染自己本地的视频画面,不过前提是您已经调用了 {@link startLocalPreview} 或 {@link startScreenCapture}。
* - 如果 userId 不为空,代表 SDK 已经开始渲染远端用户的视频画面,不过前提是您已经调用了 {@link startRemoteView} 订阅了该用户的视频画面。
*
* @note
* 1. 只有当您调用了 {@link startLocalPreview} 或 {@link startScreenCapture} 之后,才会触发自己本地的首帧画面事件回调。
* 2. 只有当您调用了 {@link startRemoteView} 或 {@link startRemoteSubStreamView} 之后,才会触发远端用户的首帧画面事件回调。
*
* @param userId 本地或远端的用户标识,如果 userId 为空值代表自己本地的首帧画面已到来,userId 不为空则代表远端用户的首帧画面已到来。
* @param streamType 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。
* @param width 画面的宽度。
* @param height 画面的高度。
*/
- (void)onFirstVideoFrame:(NSString *)userId streamType:(TRTCVideoStreamType)streamType width:(int)width height:(int)height;
/**
* 3.7 SDK 开始播放远端用户的首帧音频
*
* SDK 会在播放远端用户的首帧音频时抛出该事件,本地音频的首帧事件暂不抛出。
*
* @param userId 远端用户的用户标识
*/
- (void)onFirstAudioFrame:(NSString *)userId;
/**
* 3.8 自己本地的首个视频帧已被发布出去
*
* 当您成功进入房间并通过 {@link startLocalPreview} 或 {@link startScreenCapture} 开启本地视频采集之后(开启采集和进入房间的先后顺序无影响),
* SDK 就会开始进行视频编码,并通过自身的网络模块向云端发布自己本地的视频数据。
* 当 SDK 成功地向云端送出自己的第一帧视频数据帧以后,就会抛出 onSendFirstLocalVideoFrame 事件回调。
*
* @param streamType 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。
*/
- (void)onSendFirstLocalVideoFrame:(TRTCVideoStreamType)streamType;
/**
* 3.9 自己本地的首个音频帧已被发布出去
*
* 当您成功进入房间并通过 {@link startLocalAudio} 开启本地音频采集之后(开启采集和进入房间的先后顺序无影响),
* SDK 就会开始进行音频编码,并通过自身的网络模块向云端发布自己本地的音频数据。
* 当 SDK 成功地向云端送出自己的第一帧音频数据帧以后,就会抛出 onSendFirstLocalAudioFrame 事件回调。
*/
- (void)onSendFirstLocalAudioFrame;
/**
* 3.10 远端视频状态变化的事件回调
*
* 您可以通过此事件回调获取远端每一路画面的播放状态(包括 Playing、Loading 和 Stopped 三种状态),从而进行相应的 UI 展示。
* @param userId 用户标识
* @param streamType 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。
* @param status 视频状态:包括 Playing、Loading 和 Stopped 三种状态。
* @param reason 视频状态改变的原因
* @param extrainfo 额外信息
*/
- (void)onRemoteVideoStatusUpdated:(NSString *)userId streamType:(TRTCVideoStreamType)streamType streamStatus:(TRTCAVStatusType)status reason:(TRTCAVStatusChangeReason)reason extrainfo:(nullable NSDictionary *)info;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 网络和技术指标统计回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 网络和技术指标统计回调
/// @{
/**
* 4.1 网络质量的实时统计回调
*
* 该统计回调每间隔2秒抛出一次,用于通知 SDK 感知到的当前网络的上行和下行质量。
* SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽大小以及稳定情况进行评估,并计算出一个的评估结果:
* 如果评估结果为 1(Excellent) 代表当前的网络情况非常好,如果评估结果为 6(Down)代表当前网络无法支撑 TRTC 的正常通话。
*
* @note 回调参数 localQuality 和 remoteQuality 中的 userId 如果为空置,代表本组数据统计的是自己本地的网络质量,否则是代表远端用户的网络质量。
*
* @param localQuality 上行网络质量
* @param remoteQuality 下行网络质量
*/
- (void)onNetworkQuality:(TRTCQualityInfo *)localQuality remoteQuality:(NSArray<TRTCQualityInfo *> *)remoteQuality;
/**
* 4.2 音视频技术指标的实时统计回调
*
* 该统计回调每间隔2秒抛出一次,用于通知 SDK 内部音频、视频以及网络相关的专业技术指标,这些信息在 {@link TRTCStatistics} 均有罗列:
* - 视频统计信息:视频的分辨率(resolution)、帧率(FPS)和比特率(bitrate)等信息。
* - 音频统计信息:音频的采样率(samplerate)、声道(channel)和比特率(bitrate)等信息。
* - 网络统计信息:SDK 和云端一次往返(SDK => Cloud => SDK)的网络耗时(rtt)、丢包率(loss)、上行流量(sentBytes)和下行流量(receivedBytes)等信息。
*
* @note 如果您只需要获知当前网络质量的好坏,并不需要花太多时间研究本统计回调,更推荐您使用 {@link onNetworkQuality} 来解决问题。
* @param statistics 统计数据,包括自己本地的统计信息和远端用户的统计信息,详情请参考 {@link TRTCStatistics}。
*/
- (void)onStatistics:(TRTCStatistics *)statistics;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 与云端连接情况的事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 与云端连接情况的事件回调
/// @{
/**
* 5.1 SDK 与云端的连接已经断开
*
* SDK 会在跟云端的连接断开时抛出此事件回调,导致断开的原因大多是网络不可用或者网络切换所致,比如用户在通话中走进电梯时就可能会遇到此事件。
* 在抛出此事件之后,SDK 会努力跟云端重新建立连接,重连过程中会抛出 {@link onTryToReconnect},连接恢复后会抛出 {@link onConnectionRecovery} 。
* 所以,SDK 会在如下三个连接相关的事件中按如下规律切换:
* <pre>
* [onConnectionLost] =====> [onTryToReconnect] =====> [onConnectionRecovery]
* /|\ |
* |------------------------------------------------------|
* </pre>
*/
- (void)onConnectionLost;
/**
* 5.2 SDK 正在尝试重新连接到云端
*
* SDK 会在跟云端的连接断开时抛出 {@link onConnectionLost},之后会努力跟云端重新建立连接并抛出本事件,连接恢复后会抛出 {@link onConnectionRecovery}。
*/
- (void)onTryToReconnect;
/**
* 5.3 SDK 与云端的连接已经恢复
*
* SDK 会在跟云端的连接断开时抛出 {@link onConnectionLost},之后会努力跟云端重新建立连接并抛出{@link onTryToReconnect},连接恢复后会抛出本事件回调。
*/
- (void)onConnectionRecovery;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 硬件设备相关事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 硬件设备相关事件回调
/// @{
/**
* 6.1 摄像头准备就绪
*
* 当您调用 {@link startLocalPreivew} 之后,SDK 会尝试启动摄像头,如果摄像头能够启动成功就会抛出本事件。
* 如果启动失败,大概率是因为当前应用没有获得访问摄像头的权限,或者摄像头当前正在被其他程序独占使用中。
* 您可以通过捕获 {@link onError} 事件回调获知这些异常情况并通过 UI 界面提示用户。
*/
- (void)onCameraDidReady;
/**
* 6.2 麦克风准备就绪
*
* 当您调用 {@link startLocalAudio} 之后,SDK 会尝试启动麦克风,如果麦克风能够启动成功就会抛出本事件。
* 如果启动失败,大概率是因为当前应用没有获得访问麦克风的权限,或者麦克风当前正在被其他程序独占使用中。
* 您可以通过捕获 {@link onError} 事件回调获知这些异常情况并通过 UI 界面提示用户。
*/
- (void)onMicDidReady;
/**
* 6.3 当前音频路由发生变化(仅适用于移动设备)
*
* 所谓“音频路由”,是指声音是从手机的扬声器还是从听筒中播放出来,音频路由变化也就是声音的播放位置发生了变化。
* - 当音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
* - 当音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
*
* @param route 音频路由,即声音由哪里输出(扬声器、听筒)。
* @param fromRoute 变更前的音频路由。
*/
#if TARGET_OS_IPHONE
- (void)onAudioRouteChanged:(TRTCAudioRoute)route fromRoute:(TRTCAudioRoute)fromRoute;
#endif
/**
* 6.4 音量大小的反馈回调
*
* SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该事件回调,您可以根据音量大小在 UI 上做出相应的提示,比如“波形图”或“音量槽”。
* 要完成这个功能, 您需要先调用 {@link enableAudioVolumeEvaluation} 开启这个能力并设定事件抛出的时间间隔。
* 需要补充说明的是,无论当前房间中是否有人说话,SDK 都会按照您设定的时间间隔定时抛出此事件回调,只不过当没有人说话时,userVolumes 为空,totalVolume 为 0。
*
* @note userVolumes 为一个数组,对于数组中的每一个元素,当 userId 为空时表示本地麦克风采集的音量大小,当 userId 不为空时代表远端用户的音量大小。
*
* @param userVolumes 是一个数组,用于承载所有正在说话的用户的音量大小,取值范围 0 - 100。
* @param totalVolume 所有远端用户的总音量大小, 取值范围 0 - 100。
*/
- (void)onUserVoiceVolume:(NSArray<TRTCVolumeInfo *> *)userVolumes totalVolume:(NSInteger)totalVolume;
/**
* 6.5 本地设备的通断状态发生变化(仅适用于桌面系统)
*
* 当本地设备(包括摄像头、麦克风以及扬声器)被插入或者拔出时,SDK 便会抛出此事件回调。
*
* @param deviceId 设备 ID
* @param deviceType 设备类型
* @param state 通断状态,0:设备断开;1:设备连接。
*/
#if !TARGET_OS_IPHONE && TARGET_OS_MAC
- (void)onDevice:(NSString *)deviceId type:(TRTCMediaDeviceType)deviceType stateChanged:(NSInteger)state;
#endif
/**
* 6.6 当前麦克风的系统采集音量发生变化
*
* 在 Mac 或 Windows 这样的桌面操作系统上,用户可以在设置中心找到声音相关的设置面板,并设置麦克风的采集音量大小。
* 用户将麦克风的采集音量设置得越大,麦克风采集到的声音的原始音量也就会越大,反之就会越小。
* 在有些型号的键盘以及笔记本电脑上,用户还可以通过按下“禁用麦克风”按钮(图标是一个话筒上上叠加了一道代表禁用的斜线)来将麦克风静音。
*
* 当用户通过系统设置界面或者通过键盘上的快捷键设定操作系统的麦克风采集音量时,SDK 便会抛出此事件。
*
* @note 您需要调用 {@link enableAudioVolumeEvaluation} 接口并设定(interval>0)开启次事件回调,设定(interval == 0)关闭此事件回调。
*
* @param volume 系统采集音量,取值范围 0 - 100,用户可以在系统的声音设置面板上进行拖拽调整。
* @param muted 麦克风是否被用户禁用了:true 被禁用,false 被启用。
*/
#if !TARGET_OS_IPHONE && TARGET_OS_MAC
- (void)onAudioDeviceCaptureVolumeChanged:(NSInteger)volume muted:(BOOL)muted;
#endif
/**
* 6.7 当前系统的播放音量发生变化
*
* 在 Mac 或 Windows 这样的桌面操作系统上,用户可以在设置中心找到声音相关的设置面板,并设置系统的播放音量大小。
* 在有些型号的键盘以及笔记本电脑上,用户还可以通过按下“静音”按钮(图标是一个喇叭上叠加了一道代表禁用的斜线)来将系统静音。
*
* 当用户通过系统设置界面或者通过键盘上的快捷键设定操作系统的播放音量时,SDK 便会抛出此事件。
*
* @note 您需要调用 {@link enableAudioVolumeEvaluation} 接口并设定(interval>0)开启次事件回调,设定(interval == 0)关闭此事件回调。
*
* @param volume 系统播放音量,取值范围 0 - 100,用户可以在系统的声音设置面板上进行拖拽调整。
* @param muted 系统是否被用户静音了:true 被静音,false 已恢复。
*/
#if !TARGET_OS_IPHONE && TARGET_OS_MAC
- (void)onAudioDevicePlayoutVolumeChanged:(NSInteger)volume muted:(BOOL)muted;
#endif
/**
* 6.8 系统声音采集是否被成功开启的事件回调(仅适用于 Mac 系统)
*
* 在 Mac 系统上,您可以通过调用 {@link startSystemAudioLoopback} 为当前系统安装一个音频驱动,并让 SDK 通过该音频驱动捕获当前 Mac 系统播放出的声音。
* 当用于播片教学或音乐直播中,比如老师端可以使用此功能,让 SDK 能够采集老师所播放的电影中的声音,使同房间的学生端也能听到电影中的声音。
* SDK 会将统声音采集是否被成功开启的结果,通过本事件回调抛出,需要您关注参数中的错误码。
*
* @param err ERR_NULL 表示成功,其余值表示失败。
*/
#if !TARGET_OS_IPHONE && TARGET_OS_MAC
- (void)onSystemAudioLoopbackError:(TXLiteAVError)err;
#endif
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 自定义消息的接收事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 自定义消息的接收事件回调
/// @{
/**
* 7.1 收到自定义消息的事件回调
*
* 当房间中的某个用户使用 {@link sendCustomCmdMsg} 发送自定义 UDP 消息时,房间中的其它用户可以通过 onRecvCustomCmdMsg 事件回调接收到该条消息。
*
* @param userId 用户标识
* @param cmdID 命令 ID
* @param seq 消息序号
* @param message 消息数据
*/
- (void)onRecvCustomCmdMsgUserId:(NSString *)userId cmdID:(NSInteger)cmdID seq:(UInt32)seq message:(NSData *)message;
/**
* 7.2 自定义消息丢失的事件回调
*
* 当您使用 {@link sendCustomCmdMsg} 发送自定义 UDP 消息时,即使设置了可靠传输(reliable),也无法确保100@%不丢失,只是丢消息概率极低,能满足常规可靠性要求。
* 在发送端设置了可靠运输(reliable)后,SDK 都会通过此回调通知过去时间段内(通常为5s)传输途中丢失的自定义消息数量统计信息。
*
* @note 只有在发送端设置了可靠传输(reliable),接收方才能收到消息的丢失回调
* @param userId 用户标识
* @param cmdID 命令 ID
* @param errCode 错误码
* @param missed 丢失的消息数量
*/
- (void)onMissCustomCmdMsgUserId:(NSString *)userId cmdID:(NSInteger)cmdID errCode:(NSInteger)errCode missed:(NSInteger)missed;
/**
* 7.3 收到 SEI 消息的回调
*
* 当房间中的某个用户使用 {@link sendSEIMsg} 借助视频数据帧发送 SEI 消息时,房间中的其它用户可以通过 onRecvSEIMsg 事件回调接收到该条消息。
*
* @param userId 用户标识
* @param message 数据
*/
- (void)onRecvSEIMsg:(NSString *)userId message:(NSData *)message;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// CDN 相关事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name CDN 相关事件回调
/// @{
/**
* 8.1 开始向腾讯云直播 CDN 上发布音视频流的事件回调
*
* 当您调用 {@link startPublishing} 开始向腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。
* 随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
*
* @param err 0表示成功,其余值表示失败
* @param errMsg 具体错误原因
*/
- (void)onStartPublishing:(int)err errMsg:(NSString *)errMsg;
/**
* 8.2 停止向腾讯云直播 CDN 上发布音视频流的事件回调
*
* 当您调用 {@link stopPublishing} 停止向腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。
* 随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
*
* @param err 0表示成功,其余值表示失败
* @param errMsg 具体错误原因
*/
- (void)onStopPublishing:(int)err errMsg:(NSString *)errMsg;
/**
* 8.3 开始向非腾讯云 CDN 上发布音视频流的事件回调
*
* 当您调用 {@link startPublishCDNStream} 开始向非腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。
* 随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
*
* @note 当您收到成功的事件回调时,只是说明您的发布指令已经同步到腾讯云后台服务器,但如果目标 CDN 厂商的服务器不接收该条视频流,依然可能导致发布失败。
* @param err 0表示成功,其余值表示失败
* @param errMsg 具体错误原因
*/
- (void)onStartPublishCDNStream:(int)err errMsg:(NSString *)errMsg;
/**
* 8.4 停止向非腾讯云 CDN 上发布音视频流的事件回调
*
* 当您调用 {@link stopPublishCDNStream} 开始向非腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。
* 随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
*
* @param err 0表示成功,其余值表示失败
* @param errMsg 具体错误原因
*/
- (void)onStopPublishCDNStream:(int)err errMsg:(NSString *)errMsg;
/**
* 8.5 设置云端混流的排版布局和转码参数的事件回调
*
* 当您调用 {@link setMixTranscodingConfig} 调整云端混流的排版布局和转码参数时,SDK 会立刻将这一调整指令同步给云端服务器。
* 随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
*
* @param err 错误码:0表示成功,其余值表示失败。
* @param errMsg 具体的错误原因。
*/
- (void)onSetMixTranscodingConfig:(int)err errMsg:(NSString *)errMsg;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 屏幕分享相关事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 屏幕分享相关事件回调
/// @{
/**
* 9.1 屏幕分享开启的事件回调
*
* 当您通过 {@link startScreenCapture} 等相关接口启动屏幕分享时,SDK 便会抛出此事件回调。
*/
- (void)onScreenCaptureStarted;
/**
* 9.2 屏幕分享暂停的事件回调
*
* 当您通过 {@link pauseScreenCapture} 暂停屏幕分享时,SDK 便会抛出此事件回调。
* @param reason 原因。
* - 0:用户主动暂停。
* - 1:注意此字段的含义在 MAC 和 Windows 平台有稍微差异。屏幕窗口不可见暂停(Mac)。表示设置屏幕分享参数导致的暂停(Windows)。
* - 2:表示屏幕分享窗口被最小化导致的暂停(仅 Windows)。
* - 3:表示屏幕分享窗口被隐藏导致的暂停(仅 Windows)。
*/
- (void)onScreenCapturePaused:(int)reason;
/**
* 9.3 屏幕分享恢复的事件回调
*
* 当您通过 {@link resumeScreenCapture} 恢复屏幕分享时,SDK 便会抛出此事件回调。
* @param reason 恢复原因。
* - 0:用户主动恢复。
* - 1:注意此字段的含义在 MAC 和 Windows 平台有稍微差异。屏幕窗口恢复可见从而恢复分享(Mac)。屏幕分享参数设置完毕后自动恢复(Windows)
* - 2:表示屏幕分享窗口从最小化被恢复(仅 Windows)。
* - 3:表示屏幕分享窗口从隐藏被恢复(仅 Windows)。
*/
- (void)onScreenCaptureResumed:(int)reason;
/**
* 9.4 屏幕分享停止的事件回调
*
* 当您通过 {@link stopScreenCapture} 停止屏幕分享时,SDK 便会抛出此事件回调。
* @param reason 停止原因,0:用户主动停止;1:屏幕窗口关闭导致停止;2:表示屏幕分享的显示屏状态变更(如接口被拔出、投影模式变更等)。
*/
- (void)onScreenCaptureStoped:(int)reason;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 本地录制和本地截图的事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 本地录制和本地截图的事件回调
/// @{
/**
* 10.1 本地录制任务已经开始的事件回调
*
* 当您调用 {@link startLocalRecording} 启动本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务是否已经顺利启动。
* @param errCode 错误码 0:初始化录制成功;-1:初始化录制失败;-2: 文件后缀名有误。
* @param storagePath 录制文件存储路径
*/
- (void)onLocalRecordBegin:(NSInteger)errCode storagePath:(NSString *)storagePath;
/**
* 10.2 本地录制任务正在进行中的进展事件回调
*
* 当您调用 {@link startLocalRecording} 成功启动本地媒体录制任务后,SDK 变会定时地抛出本事件回调。
* 您可通过捕获该事件回调来获知录制任务的健康状况。
* 您可以在 {@link startLocalRecording} 时设定本事件回调的抛出间隔。
*
* @param duration 已经录制的累计时长,单位毫秒
* @param storagePath 录制文件存储路径
*/
- (void)onLocalRecording:(NSInteger)duration storagePath:(NSString *)storagePath;
/**
* 10.3 本地录制任务已经结束的事件回调
*
* 当您调用 {@link stopLocalRecording} 停止本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务的最终结果。
* @param errCode 错误码 0:录制成功;-1:录制失败;-2:切换分辨率或横竖屏导致录制结束。
* @param storagePath 录制文件存储路径
*/
- (void)onLocalRecordComplete:(NSInteger)errCode storagePath:(NSString *)storagePath;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 废弃的事件回调(建议使用对应的新回调)
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 废弃的事件回调(建议使用对应的新回调)
/// @{
/**
* 有主播加入当前房间(已废弃)
*
* @deprecated 新版本开始不推荐使用,建议使用 {@link onRemoteUserEnterRoom} 替代之。
*/
- (void)onUserEnter:(NSString *)userId __attribute__((deprecated("use onRemoteUserLeaveRoom instead")));
/**
* 有主播离开当前房间(已废弃)
*
* @deprecated 新版本开始不推荐使用,建议使用 {@link onRemoteUserLeaveRoom} 替代之。
*/
- (void)onUserExit:(NSString *)userId reason:(NSInteger)reason __attribute__((deprecated("use onRemoteUserLeaveRoom instead")));
/**
* 音效播放已结束(已废弃)
*
* @deprecated 新版本开始不推荐使用,建议使用 {@link ITXAudioEffectManager} 接口替代之。
* 新的接口中不再区分背景音乐和音效,而是统一用 {@link startPlayMusic} 取代之。
*/
- (void)onAudioEffectFinished:(int)effectId code:(int)code __attribute__((deprecated("use ITXAudioEffectManager.startPlayMusic instead")));
/// @}
@end // End of class TRTCCloudDelegate
/////////////////////////////////////////////////////////////////////////////////
//
// 视频数据自定义回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 视频数据自定义回调
/// @{
@protocol TRTCVideoRenderDelegate <NSObject>
/**
* 自定义视频渲染回调
*
* 当您设置了本地或者远端的视频自定义渲染回调之后,SDK 就会将原本要交给渲染控件进行渲染的视频帧通过此回调接口抛送给您,以便于您进行自定义渲染。
* @param frame 待渲染的视频帧信息
* @param userId 视频源的 userId,如果是本地视频回调(setLocalVideoRenderDelegate),该参数可以忽略
* @param streamType 频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。
*/
@optional
- (void)onRenderVideoFrame:(TRTCVideoFrame *_Nonnull)frame userId:(NSString *__nullable)userId streamType:(TRTCVideoStreamType)streamType;
@end // End of class TRTCVideoRenderDelegate
@protocol TRTCVideoFrameDelegate <NSObject>
/**
* 用于对接第三方美颜组件的视频处理回调
*
* 如果您选购了第三方美颜组件,就需要在 TRTCCloud 中设置第三方美颜回调,之后 TRTC 就会将原本要进行预处理的视频帧通过此回调接口抛送给您。
* 之后您就可以将 TRTC 抛出的视频帧交给第三方美颜组件进行图像处理,由于抛出的数据是可读且可写的,因此第三方美颜的处理结果也可以同步给 TRTC 进行后续的编码和发送。
*
* @param srcFrame 用于承载 TRTC 采集到的摄像头画面
* @param dstFrame 用于接收第三方美颜处理过的视频画面
* @note 目前仅支持 OpenGL 纹理方案( PC 仅支持 TRTCVideoBufferType_Buffer 格式)。
*
* 情况一:美颜组件自身会产生新的纹理
* 如果您使用的美颜组件会在处理图像的过程中产生一帧全新的纹理(用于承载处理后的图像),那请您在回调函数中将 dstFrame.textureId 设置为新纹理的 ID:
* <pre>
* uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVideoFrame * _Nonnull)dstFrame{
* self.frameID += 1;
* dstFrame.pixelBuffer = [[FURenderer shareRenderer] renderPixelBuffer:srcFrame.pixelBuffer
* withFrameId:self.frameID
* items:self.renderItems
* itemCount:self.renderItems.count];
* return 0;
* }
* </pre>
*
*
* 情况二:美颜组件需要您提供目标纹理
* 如果您使用的第三方美颜模块并不生成新的纹理,而是需要您设置给该模块一个输入纹理和一个输出纹理,则可以考虑如下方案:
* ```ObjectiveC
* uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVideoFrame * _Nonnull)dstFrame{
* thirdparty_process(srcFrame.textureId, srcFrame.width, srcFrame.height, dstFrame.textureId);
* return 0;
* }
* ```
* ```java
* int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCVideoFrame dstFrame) {
* thirdparty_process(srcFrame.texture.textureId, srcFrame.width, srcFrame.height, dstFrame.texture.textureId);
* return 0;
* }
* ```
*/
@optional
- (uint32_t)onProcessVideoFrame:(TRTCVideoFrame *_Nonnull)srcFrame dstFrame:(TRTCVideoFrame *_Nonnull)dstFrame;
/**
* SDK 内部 OpenGL 环境被销的通知
*/
@optional
- (void)onGLContextDestory;
@end // End of class TRTCVideoFrameDelegate
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 音频数据自定义回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 音频数据自定义回调
/// @{
@protocol TRTCAudioFrameDelegate <NSObject>
@optional
/**
* 本地麦克风采集到的原始音频数据回调
*
* 当您设置完音频数据自定义回调之后,SDK 内部会把刚从麦克风采集到的原始音频数据,以 PCM 格式的形式通过本接口回调给您。
* - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
* - 由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
* - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
*
* @param frame PCM 格式的音频数据帧
* @note
* 1. 请不要在此回调函数中做任何耗时操作,由于 SDK 每隔 20ms 就要处理一帧音频数据,如果您的处理时间超过 20ms,就会导致声音异常。
* 2. 此接口回调出的音频数据是可读写的,也就是说您可以在回调函数中同步修改音频数据,但请保证处理耗时。
* 3. 此接口回调出的音频数据**不包含**背景音、音效、混响等前处理效果,延迟极低。
*/
- (void)onCapturedRawAudioFrame:(TRTCAudioFrame *)frame;
/**
* 本地采集并经过音频模块前处理后的音频数据回调
*
* 当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理(ANS、AEC、AGC)之后的数据,以 PCM 格式的形式通过本接口回调给您。
* - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
* - 由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
* - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
*
* 特殊说明:
* 您可以通过设置接口中的 `TRTCAudioFrame.extraData` 字段,达到传输信令的目的。
* 由于音频帧头部的数据块不能太大,建议您写入 `extraData` 时,尽量将信令控制在几个字节的大小,如果超过 100 个字节,写入的数据不会被发送。
* 房间内其他用户可以通过 {@link TRTCAudioFrameDelegate} 中的 `onRemoteUserAudioFrame` 中的 `TRTCAudioFrame.extraData` 字段回调接收数据。
*
* @param frame PCM 格式的音频数据帧
* @note
* 1. 请不要在此回调函数中做任何耗时操作,由于 SDK 每隔 20ms 就要处理一帧音频数据,如果您的处理时间超过 20ms,就会导致声音异常。
* 2. 此接口回调出的音频数据是可读写的,也就是说您可以在回调函数中同步修改音频数据,但请保证处理耗时。
* 3. 此接口回调出的数据已经经过了回声抑制(AEC)处理,但声音的延迟相比于 {@link onCapturedRawAudioFrame} 要高一些。
*/
- (void)onLocalProcessedAudioFrame:(TRTCAudioFrame *)frame;
/**
* 混音前的每一路远程用户的音频数据
*
* 当您设置完音频数据自定义回调之后,SDK 内部会把远端的每一路原始数据,在最终混音之前,以 PCM 格式的形式通过本接口回调给您。
* - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
* - 由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
* - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
*
* @param frame PCM 格式的音频数据帧
* @param userId 用户标识
* @note 此接口回调出的音频数据是只读的,不支持修改
*/
- (void)onRemoteUserAudioFrame:(TRTCAudioFrame *)frame userId:(NSString *)userId;
/**
* 将各路待播放音频混合之后并在最终提交系统播放之前的数据回调
*
* 当您设置完音频数据自定义回调之后,SDK 内部会把各路待播放的音频混合之后的音频数据,在提交系统播放之前,以 PCM 格式的形式通过本接口回调给您。
* - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
* - 由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
* - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
*
* @param frame PCM 格式的音频数据帧
* @note
* 1. 请不要在此回调函数中做任何耗时操作,由于 SDK 每隔 20ms 就要处理一帧音频数据,如果您的处理时间超过 20ms,就会导致声音异常。
* 2. 此接口回调出的音频数据是可读写的,也就是说您可以在回调函数中同步修改音频数据,但请保证处理耗时。
* 3. 此接口回调出的是对各路待播放音频数据的混合,但其中并不包含耳返的音频数据。
*/
- (void)onMixedPlayAudioFrame:(TRTCAudioFrame *)frame;
/**
* SDK 所有音频混合后的音频数据(包括采集到的和待播放的)
*
* 当您设置完音频数据自定义回调之后,SDK 内部会把所有采集到的和待播放的音频数据混合起来,以 PCM 格式的形式通过本接口回调给您,便于您进行自定义录制。
* - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
* - 由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
* - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
*
* @param frame PCM 格式的音频数据帧
* @note
* 1. 此接口回调出的是SDK所有音频数据的混合数据,包括:经过 3A 前处理、特效叠加以及背景音乐混音后的本地音频,所有远端音频,但不包括耳返音频。
* 2. 此接口回调出的音频数据不支持修改。
*/
- (void)onMixedAllAudioFrame:(TRTCAudioFrame *)frame;
@end // End of class TRTCAudioFrameDelegate
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 更多事件回调接口
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 更多事件回调接口
/// @{
@protocol TRTCLogDelegate <NSObject>
@optional
/**
* 本地 LOG 的打印回调
*
* 如果您希望捕获 SDK 的本地日志打印行为,可以通过设置日志回调,让 SDK 将要打印的日志都通过本回调接口抛送给您。
* @param log 日志内容
* @param level 日志等级 参见 TRTC_LOG_LEVEL
* @param module 保留字段,暂无具体意义,目前为固定值 TXLiteAVSDK
*/
- (void)onLog:(nullable NSString *)log LogLevel:(TRTCLogLevel)level WhichModule:(nullable NSString *)module;
@end // End of class TRTCLogDelegate
/// @}
NS_ASSUME_NONNULL_END
/// @}
/**
* Module: TRTC 音视频统计指标(只读)
* Function: TRTC SDK 会以两秒钟一次的频率向您汇报当前实时的音视频指标(帧率、码率、卡顿情况等)
*/
/// @defgroup TRTCStatisic_ios TRTCStatisic
/// TRTC 音视频统计指标
/// @{
/////////////////////////////////////////////////////////////////////////////////
//
// 本地的音视频统计指标
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 本地的音视频统计指标
/// @{
@interface TRTCLocalStatistics : NSObject
///【字段含义】本地视频的宽度,单位 px
@property(nonatomic, assign) uint32_t width;
///【字段含义】本地视频的高度,单位 px
@property(nonatomic, assign) uint32_t height;
///【字段含义】本地视频的帧率,即每秒钟会有多少视频帧,单位:FPS
@property(nonatomic, assign) uint32_t frameRate;
///【字段含义】远端视频的码率,即每秒钟新产生视频数据的多少,单位 Kbps
@property(nonatomic, assign) uint32_t videoBitrate;
///【字段含义】远端音频的采样率,单位 Hz
@property(nonatomic, assign) uint32_t audioSampleRate;
///【字段含义】本地音频的码率,即每秒钟新产生音频数据的多少,单位 Kbps
@property(nonatomic, assign) uint32_t audioBitrate;
///【字段含义】视频流类型(高清大画面|低清小画面|辅流画面)
@property(nonatomic, assign) TRTCVideoStreamType streamType;
///【字段含义】音频设备采集状态(用于检测音频外设的健康度)
/// 0:采集设备状态正常;1:检测到长时间静音;2:检测到破音;3:检测到声音异常间断。
@property(nonatomic, assign) uint32_t audioCaptureState;
@end
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 远端的音视频统计指标
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 远端的音视频统计指标
/// @{
@interface TRTCRemoteStatistics : NSObject
///【字段含义】用户 ID
@property(nonatomic, retain) NSString* userId;
///【字段含义】音频流的总丢包率(%)
/// audioPacketLoss 代表音频流历经“主播 => 云端 => 观众”这样一条完整的传输链路后,最终在观众端统计到的丢包率。
/// audioPacketLoss 越小越好,丢包率为0即表示该路音频流的所有数据均已经完整地到达了观众端。
///如果出现了 downLoss == 0 但 audioPacketLoss != 0 的情况,说明该路音频流在“云端=>观众”这一段链路上没有出现丢包,但是在“主播=>云端”这一段链路上出现了不可恢复的丢包。
@property(nonatomic, assign) uint32_t audioPacketLoss;
///【字段含义】该路视频流的总丢包率(%)
/// videoPacketLoss 代表该路视频流历经“主播 => 云端 => 观众”这样一条完整的传输链路后,最终在观众端统计到的丢包率。
/// videoPacketLoss 越小越好,丢包率为0即表示该路视频流的所有数据均已经完整地到达了观众端。
///如果出现了 downLoss == 0 但 videoPacketLoss != 0 的情况,说明该路视频流在“云端=>观众”这一段链路上没有出现丢包,但是在“主播=>云端”这一段链路上出现了不可恢复的丢包。
@property(nonatomic, assign) uint32_t videoPacketLoss;
///【字段含义】远端视频的宽度,单位 px
@property(nonatomic, assign) uint32_t width;
///【字段含义】远端视频的高度,单位 px
@property(nonatomic, assign) uint32_t height;
///【字段含义】远端视频的帧率,单位:FPS
@property(nonatomic, assign) uint32_t frameRate;
///【字段含义】远端视频的码率,单位 Kbps
@property(nonatomic, assign) uint32_t videoBitrate;
///【字段含义】本地音频的采样率,单位 Hz
@property(nonatomic, assign) uint32_t audioSampleRate;
///【字段含义】本地音频的码率,单位 Kbps
@property(nonatomic, assign) uint32_t audioBitrate;
///【字段含义】播放延迟,单位 ms
///为了避免网络抖动和网络包乱序导致的声音和画面卡顿,TRTC 会在播放端管理一个播放缓冲区,用于对接收到的网络数据包进行整理,
///该缓冲区的大小会根据当前的网络质量进行自适应调整,该缓冲区的大小折算成以毫秒为单位的时间长度,也就是 jitterBufferDelay。
@property(nonatomic, assign) uint32_t jitterBufferDelay;
///【字段含义】端到端延迟,单位 ms
/// point2PointDelay 代表 “主播=>云端=>观众” 的延迟,更准确地说,它代表了“采集=>编码=>网络传输=>接收=>缓冲=>解码=>播放” 全链路的延迟。
/// point2PointDelay 需要本地和远端的 SDK 均为 8.5 及以上的版本才生效,若远端用户为 8.5 以前的版本,此数值会一直为0,代表无意义。
@property(nonatomic, assign) uint32_t point2PointDelay;
///【字段含义】音频播放的累计卡顿时长,单位 ms
@property(nonatomic, assign) uint32_t audioTotalBlockTime;
///【字段含义】音频播放卡顿率,单位 (%)
///音频播放卡顿率(audioBlockRate) = 音频播放的累计卡顿时长(audioTotalBlockTime) / 音频播放的总时长
@property(nonatomic, assign) uint32_t audioBlockRate;
///【字段含义】视频播放的累计卡顿时长,单位 ms
@property(nonatomic, assign) uint32_t videoTotalBlockTime;
///【字段含义】视频播放卡顿率,单位 (%)
///视频播放卡顿率(videoBlockRate) = 视频播放的累计卡顿时长(videoTotalBlockTime) / 视频播放的总时长
@property(nonatomic, assign) uint32_t videoBlockRate;
///【字段含义】该路音视频流的总丢包率(%)
///已废弃,不推荐使用;建议使用 audioPacketLoss、videoPacketLoss 替代
@property(nonatomic, assign) uint32_t finalLoss __attribute__((deprecated("Use audioPacketLoss and videoPacketLoss instead.")));
///【字段含义】视频流类型(高清大画面|低清小画面|辅流画面)
@property(nonatomic, assign) TRTCVideoStreamType streamType;
@end
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 网络和性能的汇总统计指标
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 网络和性能的汇总统计指标
/// @{
@interface TRTCStatistics : NSObject
///【字段含义】当前应用的 CPU 使用率,单位 (%)
@property(nonatomic, assign) uint32_t appCpu;
///【字段含义】当前系统的 CPU 使用率,单位 (%)
@property(nonatomic, assign) uint32_t systemCpu;
///【字段含义】从 SDK 到云端的上行丢包率,单位 (%)
///该数值越小越好,如果 upLoss 为 0%,则意味着上行链路的网络质量很好,上传到云端的数据包基本不发生丢失。
///如果 upLoss 为 30%,则意味着 SDK 向云端发送的音视频数据包中,会有 30% 丢失在传输链路中。
@property(nonatomic, assign) uint32_t upLoss;
///【字段含义】从云端到 SDK 的下行丢包率,单位 (%)
///该数值越小越好,如果 downLoss 为 0%,则意味着下行链路的网络质量很好,从云端接收的数据包基本不发生丢失。
///如果 downLoss 为 30%,则意味着云端向 SDK 传输的音视频数据包中,会有 30% 丢失在传输链路中。
@property(nonatomic, assign) uint32_t downLoss;
///【字段含义】从 SDK 到云端的往返延时,单位 ms
///该数值代表从 SDK 发送一个网络包到云端,再从云端回送一个网络包到 SDK 的总计耗时,也就是一个网络包经历 “SDK=>云端=>SDK” 的总耗时。
///该数值越小越好:如果 rtt < 50ms,意味着较低的音视频通话延迟;如果 rtt > 200ms,则意味着较高的音视频通话延迟。
///需要特别解释的是,rtt 代表 “SDK=>云端=>SDK” 的总耗时,所不需要区分 upRtt 和 downRtt。
@property(nonatomic, assign) uint32_t rtt;
///【字段含义】从 SDK 到本地路由器的往返时延,单位 ms
///该数值代表从 SDK 发送一个网络包到本地路由器网关,再从网关回送一个网络包到 SDK 的总计耗时,也就是一个网络包经历 “SDK=>网关=>SDK” 的总耗时。
///该数值越小越好:如果 gatewayRtt < 50ms,意味着较低的音视频通话延迟;如果 gatewayRtt > 200ms,则意味着较高的音视频通话延迟。
///当网络类型为蜂窝网时,该值无效。
@property(nonatomic, assign) uint32_t gatewayRtt;
///【字段含义】总发送字节数(包含信令数据和音视频数据),单位:字节数(Bytes)
@property(nonatomic, assign) uint64_t sentBytes;
///【字段含义】总接收字节数(包含信令数据和音视频数据),单位:字节数(Bytes)
@property(nonatomic, assign) uint64_t receivedBytes;
///【字段含义】本地的音视频统计信息
///由于本地可能有三路音视频流(即高清大画面,低清小画面,以及辅流画面),因此本地的音视频统计信息是一个数组。
@property(nonatomic, strong) NSArray<TRTCLocalStatistics*>* localStatistics;
///【字段含义】远端的音视频统计信息
///因为同时可能有多个远端用户,而且每个远端用户同时可能有多路音视频流(即高清大画面,低清小画面,以及辅流画面),因此远端的音视频统计信息是一个数组。
@property(nonatomic, strong) NSArray<TRTCRemoteStatistics*>* remoteStatistics;
@end
/// @}
/// @}
//
// TXAudioCustomProcessDelegate.h
// TXLiteAVSDK
//
// Created by realingzhou on 2018/1/15.
// Copyright © 2018年 Tencent. All rights reserved.
//
#ifndef TXAudioCustomProcessDelegate_h
#define TXAudioCustomProcessDelegate_h
#import <Foundation/Foundation.h>
@protocol TXAudioCustomProcessDelegate <NSObject>
/**
* 原始声音的回调
* @param data pcm数据
* @param timeStamp 时间戳
* @param sampleRate 采样率
* @param channels 声道数
* @param withBgm 回调的数据是否包含bgm,当不开启回声消除时,回调的raw pcm会包含bgm
*/
@optional
- (void)onRecordRawPcmData:(NSData *)data timeStamp:(unsigned long long)timeStamp sampleRate:(int)sampleRate channels:(int)channels withBgm:(BOOL)withBgm;
/**
* 经过特效处理的声音回调
* @param data pcm数据
* @param timeStamp 时间戳
* @param sampleRate 采样率
* @param channels 声道数
*/
@optional
- (void)onRecordPcmData:(NSData *)data timeStamp:(unsigned long long)timeStamp sampleRate:(int)sampleRate channels:(int)channels;
@end
#endif /* TXAudioCustomProcessDelegate_h */
/**
* Module: TRTC 背景音乐、短音效和人声特效的管理类
* Function: 用于对背景音乐、短音效和人声特效进行设置的管理类
*/
/// @defgroup TXAudioEffectManager_ios TXAudioEffectManager
/// TRTC 背景音乐、短音效和人声特效的管理类
/// @{
#import <Foundation/Foundation.h>
/////////////////////////////////////////////////////////////////////////////////
//
// 音效相关的枚举值定义
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 音效相关的枚举值定义
/// @{
/**
* 1.1 混响特效
*
* 混响特效可以作用于人声之上,通过声学算法对声音进行叠加处理,模拟出各种不同环境下的临场感受,目前支持如下几种混响效果:
* 0:关闭;1:KTV;2:小房间;3:大会堂;4:低沉;5:洪亮;6:金属声;7:磁性;8:空灵;9:录音棚;10:悠扬。
*/
typedef NS_ENUM(NSInteger, TXVoiceReverbType) {
TXVoiceReverbType_0 = 0, ///< disable
TXVoiceReverbType_1 = 1, ///< KTV
TXVoiceReverbType_2 = 2, ///< small room
TXVoiceReverbType_3 = 3, ///< great hall
TXVoiceReverbType_4 = 4, ///< deep voice
TXVoiceReverbType_5 = 5, ///< loud voice
TXVoiceReverbType_6 = 6, ///< metallic sound
TXVoiceReverbType_7 = 7, ///< magnetic sound
TXVoiceReverbType_8 = 8, ///< ethereal
TXVoiceReverbType_9 = 9, ///< studio
TXVoiceReverbType_10 = 10, ///< melodious
};
/**
* 1.2 变声特效
*
* 变声特效可以作用于人声之上,通过声学算法对人声进行二次处理,以获得与原始声音所不同的音色,目前支持如下几种变声特效:
* 0:关闭;1:熊孩子;2:萝莉;3:大叔;4:重金属;5:感冒;6:外语腔;7:困兽;8:肥宅;9:强电流;10:重机械;11:空灵。
*/
typedef NS_ENUM(NSInteger, TXVoiceChangeType) {
TXVoiceChangeType_0 = 0, ///< disable
TXVoiceChangeType_1 = 1, ///< naughty kid
TXVoiceChangeType_2 = 2, ///< Lolita
TXVoiceChangeType_3 = 3, ///< uncle
TXVoiceChangeType_4 = 4, ///< heavy metal
TXVoiceChangeType_5 = 5, ///< catch cold
TXVoiceChangeType_6 = 6, ///< foreign accent
TXVoiceChangeType_7 = 7, ///< caged animal trapped beast
TXVoiceChangeType_8 = 8, ///< indoorsman
TXVoiceChangeType_9 = 9, ///< strong current
TXVoiceChangeType_10 = 10, ///< heavy machinery
TXVoiceChangeType_11 = 11, ///< intangible
};
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 背景音乐的播放事件回调
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 背景音乐的事件回调接口
/// @{
// Playback progress block of background music
///背景音乐开始播放
typedef void (^TXAudioMusicStartBlock)(NSInteger errCode);
///背景音乐的播放进度
typedef void (^TXAudioMusicProgressBlock)(NSInteger progressMs, NSInteger durationMs);
///背景音乐已经播放完毕
typedef void (^TXAudioMusicCompleteBlock)(NSInteger errCode);
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 背景音乐的播放控制信息
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 背景音乐的播放控制信息
/// @{
/**
* 背景音乐的播放控制信息
*
* 该信息用于在接口 {@link startPlayMusic} 中指定背景音乐的相关信息,包括播放 ID、文件路径和循环次数等:
* 1. 如果要多次播放同一首背景音乐,请不要每次播放都分配一个新的 ID,我们推荐使用相同的 ID。
* 2. 若您希望同时播放多首不同的音乐,请为不同的音乐分配不同的 ID 进行播放。
* 3. 如果使用同一个 ID 播放不同音乐,SDK 会先停止播放旧的音乐,再播放新的音乐。
*/
@interface TXAudioMusicParam : NSObject
///【字段含义】音乐 ID <br/>
///【特殊说明】SDK 允许播放多路音乐,因此需要使用 ID 进行标记,用于控制音乐的开始、停止、音量等。
@property(nonatomic) int32_t ID;
///【字段含义】音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV
@property(nonatomic, copy) NSString *path;
///【字段含义】音乐循环播放的次数 <br/>
///【推荐取值】取值范围为0 - 任意正整数,默认值:0。0表示播放音乐一次;1表示播放音乐两次;以此类推
@property(nonatomic) NSInteger loopCount;
///【字段含义】是否将音乐传到远端 <br/>
///【推荐取值】YES:音乐在本地播放的同时,远端用户也能听到该音乐;NO:主播只能在本地听到该音乐,远端观众听不到。默认值:NO。
@property(nonatomic) BOOL publish;
///【字段含义】播放的是否为短音乐文件 <br/>
///【推荐取值】YES:需要重复播放的短音乐文件;NO:正常的音乐文件。默认值:NO
@property(nonatomic) BOOL isShortFile;
///【字段含义】音乐开始播放时间点,单位:毫秒。
@property(nonatomic) NSInteger startTimeMS;
///【字段含义】音乐结束播放时间点,单位毫秒,0表示播放至文件结尾。
@property(nonatomic) NSInteger endTimeMS;
@end
/// @}
// Definition of audio effect management module
@interface TXAudioEffectManager : NSObject
/**
* TXAudioEffectManager对象不可直接被创建
* 要通过 `TRTCCloud` 或 `TXLivePush` 中的 `getAudioEffectManager` 接口获取
*/
- (instancetype)init NS_UNAVAILABLE;
/////////////////////////////////////////////////////////////////////////////////
//
// 人声相关的特效接口
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 人声相关的特效接口
/// @{
/**
* 1.1 开启耳返
*
* 主播开启耳返后,可以在耳机里听到麦克风采集到的自己发出的声音,该特效适用于主播唱歌的应用场景中。
*
* 需要您注意的是,由于蓝牙耳机的硬件延迟非常高,所以在主播佩戴蓝牙耳机时无法开启此特效,请尽量在用户界面上提示主播佩戴有线耳机。
* 同时也需要注意,并非所有的手机开启此特效后都能达到优秀的耳返效果,我们已经对部分耳返效果不佳的手机屏蔽了该特效。
*
* @note 仅在主播佩戴耳机时才能开启此特效,同时请您提示主播佩戴有线耳机。
* @param enable true:开启;false:关闭。
*/
- (void)enableVoiceEarMonitor:(BOOL)enable;
/**
* 1.2 设置耳返音量
*
* 通过该接口您可以设置耳返特效中声音的音量大小。
*
* @param volume 音量大小,取值范围为0 - 100,默认值:100。
* @note 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
*/
- (void)setVoiceEarMonitorVolume:(NSInteger)volume;
/**
* 1.3 设置人声的混响效果
*
* 通过该接口您可以设置人声的混响效果,具体特效请参考枚举定义{@link TXVoiceReverbType}。
*
* @note 设置的效果在退出房间后会自动失效,如果下次进房还需要对应特效,需要调用此接口再次进行设置。
*/
- (void)setVoiceReverbType:(TXVoiceReverbType)reverbType;
/**
* 1.4 设置人声的变声特效
*
* 通过该接口您可以设置人声的变声特效,具体特效请参考枚举定义{@link TXVoiceChangeType}。
*
* @note 设置的效果在退出房间后会自动失效,如果下次进房还需要对应特效,需要调用此接口再次进行设置。
*/
- (void)setVoiceChangerType:(TXVoiceChangeType)changerType;
/**
* 1.5 设置语音音量
*
* 该接口可以设置语音音量的大小,一般配合音乐音量的设置接口 {@link setAllMusicVolume} 协同使用,用于调谐语音和音乐在混音前各自的音量占比。
*
* @param volume 音量大小,取值范围为0 - 100,默认值:100。
* @note 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
*/
- (void)setVoiceVolume:(NSInteger)volume;
/**
* 1.6 设置语音音调
*
* 该接口可以设置语音音调,用于实现变调不变速的目的。
*
* @param pitch 音调,取值范围为-1.0f~1.0f,默认值:0.0f。
*/
- (void)setVoicePitch:(double)pitch;
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 背景音乐的相关接口
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 背景音乐的相关接口
/// @{
/**
* 2.1 开始播放背景音乐
*
* 每个音乐都需要您指定具体的 ID,您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
*
* @note
* 1. 如果要多次播放同一首背景音乐,请不要每次播放都分配一个新的 ID,我们推荐使用相同的 ID。
* 2. 若您希望同时播放多首不同的音乐,请为不同的音乐分配不同的 ID 进行播放。
* 3. 如果使用同一个 ID 播放不同音乐,SDK 会先停止播放旧的音乐,再播放新的音乐。
*
* @param musicParam 音乐参数
* @param startBlock 播放开始回调
* @param progressBlock 播放进度回调
* @param completeBlock 播放结束回调
*/
- (void)startPlayMusic:(TXAudioMusicParam *)musicParam onStart:(TXAudioMusicStartBlock _Nullable)startBlock onProgress:(TXAudioMusicProgressBlock _Nullable)progressBlock onComplete:(TXAudioMusicCompleteBlock _Nullable)completeBlock;
/**
* 2.2 停止播放背景音乐
*
* @param id 音乐 ID
*/
- (void)stopPlayMusic:(int32_t)id;
/**
* 2.3 暂停播放背景音乐
*
* @param id 音乐 ID
*/
- (void)pausePlayMusic:(int32_t)id;
/**
* 2.4 恢复播放背景音乐
*
* @param id 音乐 ID
*/
- (void)resumePlayMusic:(int32_t)id;
/**
* 2.5 设置所有背景音乐的本地音量和远端音量的大小
*
* 该接口可以设置所有背景音乐的本地音量和远端音量。
* - 本地音量:即主播本地可以听到的背景音乐的音量大小。
* - 远端音量:即观众端可以听到的背景音乐的音量大小。
*
* @param volume 音量大小,取值范围为0 - 100,默认值:100。
* @note 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
*/
- (void)setAllMusicVolume:(NSInteger)volume;
/**
* 2.6 设置某一首背景音乐的远端音量的大小
*
* 该接口可以细粒度地控制每一首背景音乐的远端音量,也就是观众端可听到的背景音乐的音量大小。
*
* @param id 音乐 ID
* @param volume 音量大小,取值范围为0 - 100;默认值:100
* @note 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
*/
- (void)setMusicPublishVolume:(int32_t)id volume:(NSInteger)volume;
/**
* 2.7 设置某一首背景音乐的本地音量的大小
*
* 该接口可以细粒度地控制每一首背景音乐的本地音量,也就是主播本地可以听到的背景音乐的音量大小。
*
* @param id 音乐 ID
* @param volume 音量大小,取值范围为0 - 100,默认值:100。
* @note 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
*/
- (void)setMusicPlayoutVolume:(int32_t)id volume:(NSInteger)volume;
/**
* 2.8 调整背景音乐的音调高低
*
* @param id 音乐 ID
* @param pitch 音调,默认值是0.0f,范围是:[-1 ~ 1] 之间的浮点数;
*/
- (void)setMusicPitch:(int32_t)id pitch:(double)pitch;
/**
* 2.9 调整背景音乐的变速效果
*
* @param id 音乐 ID
* @param speedRate 速度,默认值是1.0f,范围是:[0.5 ~ 2] 之间的浮点数;
*/
- (void)setMusicSpeedRate:(int32_t)id speedRate:(double)speedRate;
/**
* 2.10 获取背景音乐的播放进度(单位:毫秒)
*
* @param id 音乐 ID
* @return 成功返回当前播放时间,单位:毫秒,失败返回-1
*/
- (NSInteger)getMusicCurrentPosInMS:(int32_t)id;
/**
* 2.11 获取背景音乐的总时长(单位:毫秒)
*
* @param path 音乐文件路径。
* @return 成功返回时长,失败返回-1
*/
- (NSInteger)getMusicDurationInMS:(NSString *)path;
/**
* 2.12 设置背景音乐的播放进度(单位:毫秒)
*
* @note 请尽量避免过度频繁地调用该接口,因为该接口可能会再次读写音乐文件,耗时稍高。
* 因此,当用户拖拽音乐的播放进度条时,请在用户完成拖拽操作后再调用本接口。
* 因为 UI 上的进度条控件往往会以很高的频率反馈用户的拖拽进度,如不做频率限制,会导致较差的用户体验。
*
* @param id 音乐 ID
* @param pts 单位: 毫秒
*/
- (void)seekMusicToPosInMS:(int32_t)id pts:(NSInteger)pts;
/// @}
@end // End of interface TXAudioEffectManager
/// @}
//
// TXAudioRawDataDelegate.h
// TXLiteAVSDK
//
// Created by realingzhou on 2018/2/24.
// Copyright © 2018年 Tencent. All rights reserved.
//
#ifndef TXAudioRawDataDelegate_h
#define TXAudioRawDataDelegate_h
@protocol TXAudioRawDataDelegate <NSObject>
/**
* 音频播放信息回调
*
* @param sampleRate 采样率
* @param channels 声道数
*/
@optional
- (void)onAudioInfoChanged:(int)sampleRate channels:(int)channels;
/**
* 音频播放数据回调,数据格式 :PCM
*
* <!!!注意!!!> 该函数内不要做耗时操作<!!!注意!!!>
* 音频播放器会在播放数据的前一刻,调用此函数,同步回调将要播放的数据。因此在函数内部做耗时操作可能会影响播放
*
*
* @param data pcm数据
* @param timestamp 时间戳。注 :会有连续相同的时间戳回调出来,超过2048字节,时间戳才会变化。
*/
@optional
- (void)onPcmDataAvailable:(NSData *)data pts:(unsigned long long)timestamp;
@end
#endif /* TXAudioRawDataDelegate_h */
/**
* Module: 美颜与图像处理参数设置类
* Function: 修改美颜、滤镜、绿幕等参数
*/
#import <Foundation/Foundation.h>
#import <TargetConditionals.h>
#if TARGET_OS_IPHONE
#import <UIKit/UIKit.h>
typedef UIImage TXImage;
#else
#import <AppKit/AppKit.h>
typedef NSImage TXImage;
#endif
NS_ASSUME_NONNULL_BEGIN
/// @defgroup TXBeautyManager_ios TXBeautyManager
/// 美颜与图像处理参数设置类
/// @{
/**
* 美颜(磨皮)算法
* TRTC 内置多种不同的磨皮算法,您可以选择最适合您产品定位的方案。
*/
typedef NS_ENUM(NSInteger, TXBeautyStyle) {
///光滑,算法比较激进,磨皮效果比较明显,适用于秀场直播。
TXBeautyStyleSmooth = 0,
///自然,算法更多地保留了面部细节,磨皮效果更加自然,适用于绝大多数直播场景。
TXBeautyStyleNature = 1,
///优图,由优图实验室提供,磨皮效果介于光滑和自然之间,比光滑保留更多皮肤细节,比自然磨皮程度更高。
TXBeautyStylePitu = 2
};
@interface TXBeautyManager : NSObject
/**
* 设置美颜(磨皮)算法
*
* TRTC 内置多种不同的磨皮算法,您可以选择最适合您产品定位的方案:
*
* @param beautyStyle 美颜风格,TXBeautyStyleSmooth:光滑;TXBeautyStyleNature:自然;TXBeautyStylePitu:优图。
*/
- (void)setBeautyStyle:(TXBeautyStyle)beautyStyle;
/**
* 设置美颜级别
*
* @param beautyLevel 美颜级别,取值范围0 - 9; 0表示关闭,9表示效果最明显。
*/
- (void)setBeautyLevel:(float)beautyLevel;
/**
* 设置美白级别
*
* @param whitenessLevel 美白级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
*/
- (void)setWhitenessLevel:(float)whitenessLevel;
/**
* 开启清晰度增强
*/
- (void)enableSharpnessEnhancement:(BOOL)enable;
/**
* 设置红润级别
*
* @param ruddyLevel 红润级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
*/
- (void)setRuddyLevel:(float)ruddyLevel;
/**
* 设置色彩滤镜效果
*
* 色彩滤镜,是一副包含色彩映射关系的颜色查找表图片,您可以在我们提供的官方 Demo 中找到预先准备好的几张滤镜图片。
* SDK 会根据该查找表中的映射关系,对摄像头采集出的原始视频画面进行二次处理,以达到预期的滤镜效果。
* @param image 包含色彩映射关系的颜色查找表图片,必须是 png 格式。
*/
- (void)setFilter:(nullable TXImage *)image;
/**
* 设置色彩滤镜的强度
*
* 该数值越高,色彩滤镜的作用强度越明显,经过滤镜处理后的视频画面跟原画面的颜色差异越大。
* 我默认的滤镜浓度是0.5,如果您觉得默认的滤镜效果不明显,可以设置为 0.5 以上的数字,最大值为1。
*
* @param strength 从0到1,数值越大滤镜效果越明显,默认值为0.5。
*/
- (void)setFilterStrength:(float)strength;
/**
* 设置绿幕背景视频,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* 此接口所开启的绿幕功能不具备智能去除背景的能力,需要被拍摄者的背后有一块绿色的幕布来辅助产生特效。
*
* @param path MP4格式的视频文件路径; 设置空值表示关闭特效。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
- (int)setGreenScreenFile:(nullable NSString *)path;
/**
* 设置大眼级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param eyeScaleLevel 大眼级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setEyeScaleLevel:(float)eyeScaleLevel;
#endif
/**
* 设置瘦脸级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param faceSlimLevel 瘦脸级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setFaceSlimLevel:(float)faceSlimLevel;
#endif
/**
* 设置 V 脸级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param faceVLevel V脸级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setFaceVLevel:(float)faceVLevel;
#endif
/**
* 设置下巴拉伸或收缩,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param chinLevel 下巴拉伸或收缩级别,取值范围-9 - 9;0 表示关闭,小于0表示收缩,大于0表示拉伸。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setChinLevel:(float)chinLevel;
#endif
/**
* 设置短脸级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param faceShortLevel 短脸级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setFaceShortLevel:(float)faceShortLevel;
#endif
/**
* 设置窄脸级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param level 窄脸级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setFaceNarrowLevel:(float)faceNarrowLevel;
#endif
/**
* 设置瘦鼻级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param noseSlimLevel 瘦鼻级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setNoseSlimLevel:(float)noseSlimLevel;
#endif
/**
* 设置亮眼级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param eyeLightenLevel 亮眼级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setEyeLightenLevel:(float)eyeLightenLevel;
#endif
/**
* 设置牙齿美白级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param toothWhitenLevel 白牙级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setToothWhitenLevel:(float)toothWhitenLevel;
#endif
/**
* 设置祛皱级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param wrinkleRemoveLevel 祛皱级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setWrinkleRemoveLevel:(float)wrinkleRemoveLevel;
#endif
/**
* 设置祛眼袋级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param pounchRemoveLevel 祛眼袋级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setPounchRemoveLevel:(float)pounchRemoveLevel;
#endif
/**
* 设置法令纹去除级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param smileLinesRemoveLevel 法令纹级别,取值范围0 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setSmileLinesRemoveLevel:(float)smileLinesRemoveLevel;
#endif
/**
* 设置发际线调整级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param foreheadLevel 发际线级别,取值范围-9 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setForeheadLevel:(float)foreheadLevel;
#endif
/**
* 设置眼距,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param eyeDistanceLevel 眼距级别,取值范围-9 - 9;0表示关闭,小于0表示拉伸,大于0表示收缩。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setEyeDistanceLevel:(float)eyeDistanceLevel;
#endif
/**
* 设置眼角调整级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param eyeAngleLevel 眼角调整级别,取值范围-9 - 9;0表示关闭,9表示效果最明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setEyeAngleLevel:(float)eyeAngleLevel;
#endif
/**
* 设置嘴型调整级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param mouthShapeLevel 嘴型级别,取值范围-9 - 9;0表示关闭,小于0表示拉伸,大于0表示收缩。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setMouthShapeLevel:(float)mouthShapeLevel;
#endif
/**
* 设置鼻翼调整级别,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param noseWingLevel 鼻翼调整级别,取值范围-9 - 9;0表示关闭,小于0表示拉伸,大于0表示收缩。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setNoseWingLevel:(float)noseWingLevel;
#endif
/**
* 设置鼻子位置,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param nosePositionLevel 鼻子位置级别,取值范围-9 - 9;0表示关闭,小于0表示抬高,大于0表示降低。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setNosePositionLevel:(float)nosePositionLevel;
#endif
/**
* 设置嘴唇厚度,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param lipsThicknessLevel 嘴唇厚度级别,取值范围-9 - 9;0表示关闭,小于0表示拉伸,大于0表示收缩。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setLipsThicknessLevel:(float)lipsThicknessLevel;
#endif
/**
* 设置脸型,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param faceBeautyLevel 美型级别,取值范围0 - 9;0表示关闭,1 - 9值越大,效果越明显。
* @return 0:成功;-5:当前 License 对应 feature 不支持。
*/
#if TARGET_OS_IPHONE
- (int)setFaceBeautyLevel:(float)faceBeautyLevel;
#endif
/**
* 选择 AI 动效挂件,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
*
* @param tmplName 动效挂件名称
* @param tmplDir 动效素材文件所在目录
*/
#if TARGET_OS_IPHONE
- (void)setMotionTmpl:(nullable NSString *)tmplName inDir:(nullable NSString *)tmplDir;
#endif
/**
* 是否在动效素材播放时静音,该接口仅在 [企业版 SDK](https://cloud.tencent.com/document/product/647/32689#Enterprise) 中生效
* 有些挂件本身会有声音特效,通过此 API 可以关闭这些特效播放时所带的声音效果。
*
* @param motionMute YES:静音;NO:不静音。
*/
#if TARGET_OS_IPHONE
- (void)setMotionMute:(BOOL)motionMute;
#endif
@end
/// @}
NS_ASSUME_NONNULL_END
//
// TXBitrateItem.h
// TXLiteAVSDK
//
// Created by annidyfeng on 2017/11/15.
// Copyright © 2017年 Tencent. All rights reserved.
//
#ifndef TXBitrateItem_h
#define TXBitrateItem_h
/// @addtogroup TXVodPlayConfig_ios
/// @{
/// HLS多码率信息
@interface TXBitrateItem : NSObject
@property (nonatomic, assign) NSInteger index; ///< m3u8 文件中的序号
@property (nonatomic, assign) NSInteger width; ///< 此流的视频宽度
@property (nonatomic, assign) NSInteger height; ///< 此流的视频高度
@property (nonatomic, assign) NSInteger bitrate; ///< 此流的视频码率
@end
/// @}
#endif /* TXBitrateItem_h */
//
// TXCAVRoomDef.h
// TXLiteAVSDK
//
// Created by lijie on 2017/7/26.
// Copyright © 2017年 Tencent. All rights reserved.
//
#import <Foundation/Foundation.h>
/// 音视频通话的通话能力权限位。
typedef NS_ENUM(NSInteger, TXEAVRoomAuthBits) {
AVROOM_AUTH_BITS_DEFAULT = -1, ///< 所有权限
AVROOM_AUTH_BITS_CREATE_ROOM = 0x00000001, ///< 创建房间权限。
AVROOM_AUTH_BITS_JOIN_ROOM = 0x00000002, ///< 加入房间的权限。
AVROOM_AUTH_BITS_SEND_AUDIO = 0x00000004, ///< 发送音频的权限。
AVROOM_AUTH_BITS_RECV_AUDIO = 0x00000008, ///< 接收音频的权限。
AVROOM_AUTH_BITS_SEND_CAMERA_VIDEO = 0x00000010, ///< 发送摄像头视频(也就是来至摄像头设备AVCameraDevice或外部视频捕获设备AVExternalCapture的视频)的权限。
AVROOM_AUTH_BITS_RECV_CAMERA_VIDEO = 0x00000020, ///< 接收摄像头视频(也就是来至摄像头设备AVCameraDevice或外部视频捕获设备AVExternalCapture的视频)的权限。
AVROOM_AUTH_BITS_SEND_SCREEN_VIDEO = 0x00000040, ///< 发送屏幕视频(也就是捕获计算机屏幕画面所得到的视频)的权限。
AVROOM_AUTH_BITS_RECV_SCREEN_VIDEO = 0x00000080, ///< 接收屏幕视频(也就是捕获计算机屏幕画面所得到的视频)的权限。
};
// 进房参数
@interface TXCAVRoomParam : NSObject
@property (nonatomic, assign) UInt32 roomID;
@property (nonatomic, assign) TXEAVRoomAuthBits authBits;
@property (nonatomic, strong) NSData* authBuffer;
@end
typedef NS_ENUM(NSInteger, TXEAVRoomEventID) {
/*
* 房间事件
*/
AVROOM_EVT_REQUEST_IP_SUCC = 1001, // 拉取接口机服务器地址成功
AVROOM_EVT_CONNECT_SUCC = 1002, // 连接接口机服务器成功
AVROOM_EVT_ENTER_ROOM_SUCC = 1003, // 进入房间成功
AVROOM_EVT_EXIT_ROOM_SUCC = 1004, // 退出房间成功
AVROOM_EVT_REQUEST_AVSEAT_SUCC = 1005, // 请求视频位成功
AVROOM_ERR_REQUEST_IP_FAIL = -1001, // 拉取接口机服务器地址失败
AVROOM_ERR_CONNECT_FAILE = -1002, // 连接接口机服务器失败
AVROOM_ERR_ENTER_ROOM_FAIL = -1003, // 进入房间失败
AVROOM_ERR_EXIT_ROOM_FAIL = -1004, // 退出房间失败
AVROOM_ERR_REQUEST_AVSEAT_FAIL = -1005, // 请求视频位失败
/*
* 网络事件
*/
AVROOM_WARNING_DISCONNECT = 2001, // 网络断开连接
AVROOM_WARNING_RECONNECT = 2002, // 网络断连, 已启动自动重连
AVROOM_WARNING_NET_BUSY = 2003, // 网络状况不佳:上行带宽太小,上传数据受阻
/*
* 上行音视频事件
*/
AVROOM_EVT_OPEN_CAMERA_SUCC = 3001, // 打开摄像头成功
AVROOM_EVT_START_VIDEO_ENCODER = 3002, // 编码器启动
AVROOM_EVT_UP_CHANGE_RESOLUTION = 3003, // 视频上行分辨率改变
AVROOM_EVT_UP_CHANGE_BITRATE = 3004, // 视频上行动态调整码率
AVROOM_EVT_FIRST_FRAME_AVAILABLE = 3005, // 首帧画面采集完成
AVROOM_WARNING_HW_ACCELERATION_ENCODE_FAIL = 3101, // 硬编码启动失败,采用软编码
AVROOM_ERR_OPEN_CAMERA_FAIL = -3001, // 打开摄像头失败
AVROOM_ERR_OPEN_MIC_FAIL = -3002, // 打开麦克风失败
AVROOM_ERR_VIDEO_ENCODE_FAIL = -3003, // 视频编码失败
AVROOM_ERR_AUDIO_ENCODE_FAIL = -3004, // 音频编码失败
AVROOM_ERR_UNSUPPORTED_RESOLUTION = -3005, // 不支持的视频分辨率
AVROOM_ERR_UNSUPPORTED_SAMPLERATE = -3006, // 不支持的音频采样率
/*
* 下行音视频事件
*/
AVROOM_EVT_RCV_FIRST_I_FRAME = 4001, // 渲染首个视频数据包(IDR)
AVROOM_EVT_PLAY_BEGIN = 4002, // 视频播放开始
AVROOM_EVT_PLAY_LOADING = 4003, // 视频播放loading
AVROOM_EVT_START_VIDEO_DECODER = 4004, // 解码器启动
AVROOM_EVT_DOWN_CHANGE_RESOLUTION = 4005, // 视频下行分辨率改变
AVROOM_WARNING_VIDEO_DECODE_FAIL = 4101, // 当前视频帧解码失败
AVROOM_WARNING_AUDIO_DECODE_FAIL = 4102, // 当前音频帧解码失败
AVROOM_WARNING_HW_ACCELERATION_DECODE_FAIL = 4103, // 硬解启动失败,采用软解
AVROOM_WARNING_VIDEO_PLAY_LAG = 4104, // 当前视频播放出现卡顿(用户直观感受)
};
// 声音播放模式
typedef NS_ENUM(NSInteger, TXEAVRoomAudioMode) {
AVROOM_AUDIO_MODE_SPEAKER = 0, //扬声器
AVROOM_AUDIO_MODE_RECEIVER = 1, //听筒
};
// 视频分辨率比例
typedef NS_ENUM(NSInteger, TXEAVRoomVideoAspect) {
AVROOM_VIDEO_ASPECT_9_16 = 1, // 视频分辨率为9:16或者16:9
AVROOM_VIDEO_ASPECT_3_4 = 2, // 视频分辨率为3:4 或者4:3
AVROOM_VIDEO_ASPECT_1_1 = 3, // 视频分辨率为1:1
};
// Home键的方向
typedef NS_ENUM(NSInteger, TXEAVRoomHomeOrientation) {
AVROOM_HOME_ORIENTATION_RIGHT = 0, // home在右边
AVROOM_HOME_ORIENTATION_DOWN, // home在下面
AVROOM_HOME_ORIENTATION_LEFT, // home在左边
AVROOM_HOME_ORIENTATION_UP, // home在上面
};
// 渲染模式
typedef NS_ENUM(NSInteger, TXEAVRoomRenderMode) {
AVROOM_RENDER_MODE_FILL_SCREEN = 0, // 图像铺满屏幕
AVROOM_RENDER_MODE_FILL_EDGE // 图像长边填满屏幕
};
// 状态键名定义
#define NET_STATUS_USER_ID @"USER_ID"
#define NET_STATUS_CPU_USAGE @"CPU_USAGE" // cpu使用率
#define NET_STATUS_CPU_USAGE_D @"CPU_USAGE_DEVICE" // 设备总CPU占用
#define NET_STATUS_VIDEO_BITRATE @"VIDEO_BITRATE" // 当前视频编码器输出的比特率,也就是编码器每秒生产了多少视频数据,单位 kbps
#define NET_STATUS_AUDIO_BITRATE @"AUDIO_BITRATE" // 当前音频编码器输出的比特率,也就是编码器每秒生产了多少音频数据,单位 kbps
#define NET_STATUS_VIDEO_FPS @"VIDEO_FPS" // 当前视频帧率,也就是视频编码器每条生产了多少帧画面
#define NET_STATUS_VIDEO_GOP @"VIDEO_GOP" // 当前视频GOP,也就是每两个关键帧(I帧)间隔时长,单位s
#define NET_STATUS_NET_SPEED @"NET_SPEED" // 当前的发送速度
#define NET_STATUS_NET_JITTER @"NET_JITTER" // 网络抖动情况,抖动越大,网络越不稳定
#define NET_STATUS_CACHE_SIZE @"CACHE_SIZE" // 缓冲区大小,缓冲区越大,说明当前上行带宽不足以消费掉已经生产的视频数据
#define NET_STATUS_DROP_SIZE @"DROP_SIZE"
#define NET_STATUS_VIDEO_WIDTH @"VIDEO_WIDTH"
#define NET_STATUS_VIDEO_HEIGHT @"VIDEO_HEIGHT"
#define NET_STATUS_SERVER_IP @"SERVER_IP"
#define NET_STATUS_CODEC_CACHE @"CODEC_CACHE" //编解码缓冲大小
#define NET_STATUS_CODEC_DROP_CNT @"CODEC_DROP_CNT" //编解码队列DROPCNT
#define NET_STATUS_VIDEO_CACHE_SIZE @"VIDEO_CACHE_SIZE" // 视频缓冲帧数 (包括jitterbuffer和解码器两部分缓冲)
#define NET_STATUS_V_DEC_CACHE_SIZE @"V_DEC_CACHE_SIZE" // 视频解码器缓冲帧数
#define NET_STATUS_AV_PLAY_INTERVAL @"AV_PLAY_INTERVAL" //视频当前渲染帧的timestamp和音频当前播放帧的timestamp的差值,标示当时音画同步的状态
#define NET_STATUS_AV_RECV_INTERVAL @"AV_RECV_INTERVAL" //jitterbuffer最新收到的视频帧和音频帧的timestamp的差值,标示当时jitterbuffer收包同步的状态
#define NET_STATUS_AUDIO_PLAY_SPEED @"AUDIO_PLAY_SPEED" //jitterbuffer当前的播放速度
#define NET_STATUS_AUDIO_INFO @"AUDIO_INFO"
#define NET_STATUS_SET_VIDEO_BITRATE @"SET_VIDEO_BITRATE"
#define EVT_MSG @"EVT_MSG"
#define EVT_TIME @"EVT_TIME"
//
// TXCAVRoomListener.h
// TXLiteAVSDK
//
// Created by lijie on 2017/7/26.
// Copyright © 2017年 Tencent. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <UIkit/UIKit.h>
@protocol TXCAVRoomListener <NSObject>
/**
* 房间成员变化
* flag为YES: 表示该userID进入房间
* flag为NO: 表示该userID退出房间
*/
@optional
- (void)onMemberChange:(UInt64)userID withFlag:(BOOL)flag;
/**
* 指定userID的视频状态变化通知
* flag为YES: 表示该userID正在进行视频推流
* flag为NO: 表示该userID已经停止视频推流
*/
@optional
- (void)onVideoStateChange:(UInt64)userID withFlag:(BOOL)flag;
/**
* 事件通知
* 参数:
* userID: 用户的唯一标记
* eventID: 事件ID,取值为 TXEAVRoomEventID
* param: 保存有两个值,param[EVT_TIME]为事件发生时间,param[EVT_MSG]为事件描述
*/
@optional
- (void)onAVRoomEvent:(UInt64)userID withEventID:(int)eventID andParam:(NSDictionary *)param;
/**
* 状态通知
* 参数:
* array: 保存上行和所有下行的状态值
* 假设item是数组array中的一个元素, item[NET_STATUS_USER_ID]表示这个item对应的userID
* 例如:如果item是自己的,则item[NET_STATUS_NET_SPEED]表示上行速率
* 如果item是对方的,则item[NET_STATUS_NET_SPEED]表示下行速率
*/
@optional
- (void)onAVRoomStatus:(NSArray *)array;
@end
/**
* Module: TRTC 音视频设备管理模块
* Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬件设备
*/
/// @defgroup TXDeviceManager_ios TXDeviceManager
/// TRTC 音视频设备管理模块
/// @{
#import <Foundation/Foundation.h>
#if TARGET_OS_IPHONE
#import <UIKit/UIKit.h>
#elif TARGET_OS_MAC
#import <AppKit/AppKit.h>
#endif
/////////////////////////////////////////////////////////////////////////////////
//
// 音视频设备相关的类型定义
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 音视频设备相关的类型定义
/// @{
/**
* 系统音量类型(仅适用于移动设备)
*
* 现代智能手机中一般都具备两套系统音量类型,即“通话音量”和“媒体音量”。
* - 通话音量:手机专门为接打电话所设计的音量类型,自带回声抵消(AEC)功能,并且支持通过蓝牙耳机上的麦克风进行拾音,缺点是音质比较一般。
* 当您通过手机侧面的音量按键下调手机音量时,如果无法将其调至零(也就是无法彻底静音),说明您的手机当前出于通话音量。
* - 媒体音量:手机专门为音乐场景所设计的音量类型,无法使用系统的 AEC 功能,并且不支持通过蓝牙耳机的麦克风进行拾音,但具备更好的音乐播放效果。
* 当您通过手机侧面的音量按键下调手机音量时,如果能够将手机音量调至彻底静音,说明您的手机当前出于媒体音量。
*
* SDK 目前提供了三种系统音量类型的控制模式:自动切换模式、全程通话音量模式、全程媒体音量模式。
*/
#if TARGET_OS_IPHONE
typedef NS_ENUM(NSInteger, TXSystemVolumeType) {
///自动切换模式:
///也被称为“麦上通话,麦下媒体”,即主播上麦时使用通话音量,观众不上麦则使用媒体音量,适合在线直播场景。
TXSystemVolumeTypeAuto = 0,
///全程媒体音量:
///通话全程使用媒体音量,并不是非常常用的音量类型,适用于对音质要求比较苛刻的音乐场景中。
///如果您的用户大都使用外接设备(比如外接声卡)为主,可以使用该模式,否则请慎用。
TXSystemVolumeTypeMedia = 1,
///全程通话音量:
///该方案的优势在于用户在上下麦时音频模块无需切换工作模式,可以做到无缝上下麦,适合于用户需要频繁上下麦的应用场景。
TXSystemVolumeTypeVOIP = 2,
};
#endif
/**
* 音频路由(即声音的播放模式)
*
* 音频路由,即声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
* 手机有两个扬声器:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。
* - 设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
* - 设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
*/
#if TARGET_OS_IPHONE
typedef NS_ENUM(NSInteger, TXAudioRoute) {
/// Speakerphone:使用扬声器播放(即“免提”),扬声器位于手机底部,声音偏大,适合外放音乐。
TXAudioRouteSpeakerphone = 0,
/// Earpiece:使用听筒播放,听筒位于手机顶部,声音偏小,适合需要保护隐私的通话场景。
TXAudioRouteEarpiece = 1,
};
#endif
/**
* 设备类型(仅适用于桌面平台)
*
* 该枚举值用于定义三种类型的音视频设备,即摄像头、麦克风和扬声器,以便让一套设备管理接口可以操控三种不同类型的设备。
*/
#if TARGET_OS_MAC && !TARGET_OS_IPHONE
typedef NS_ENUM(NSInteger, TXMediaDeviceType) {
TXMediaDeviceTypeUnknown = -1, ///< undefined device type
TXMediaDeviceTypeAudioInput = 0, ///< microphone
TXMediaDeviceTypeAudioOutput = 1, ///< speaker or earpiece
TXMediaDeviceTypeVideoCamera = 2, ///< camera
};
#endif
/**
* 设备操作
*
* 该枚举值用于本地设备的状态变化通知{@link onDeviceChanged}。
*/
#if TARGET_OS_MAC && !TARGET_OS_IPHONE
typedef NS_ENUM(NSInteger, TXMediaDeviceState) {
///设备已被插入
TXMediaDeviceStateAdd = 0,
///设备已被移除
TXMediaDeviceStateRemove = 1,
///设备已启用
TXMediaDeviceStateActive = 2,
};
#endif
/**
* 音视频设备的相关信息(仅适用于桌面平台)
*
* 该结构体用于描述一个音视频设备的关键信息,比如设备ID、设备名称等等,以便用户能够在用户界面上选择自己期望使用的音视频设备。
*/
#if TARGET_OS_MAC && !TARGET_OS_IPHONE
@interface TXMediaDeviceInfo : NSObject
/// device type
@property(assign, nonatomic) TXMediaDeviceType type;
/// device id
@property(copy, nonatomic, nullable) NSString *deviceId;
/// device name
@property(copy, nonatomic, nullable) NSString *deviceName;
/// device properties
@property(copy, nonatomic, nullable) NSString *deviceProperties;
@end
#endif
/// @}
/**
* 本地设备的通断状态发生变化(仅适用于桌面系统)
*
* 当本地设备(包括摄像头、麦克风以及扬声器)被插入或者拔出时,SDK 便会抛出此事件回调。
*
* @param deviceId 设备 ID
* @param type 设备类型
* @param state 通断状态,0:设备已添加;1:设备已被移除;2:设备已启用。
*/
#if TARGET_OS_MAC && !TARGET_OS_IPHONE
@protocol TXDeviceObserver <NSObject>
- (void)onDeviceChanged:(NSString *)deviceId type:(TXMediaDeviceType)mediaType state:(TXMediaDeviceState)mediaState;
@end
#endif
@interface TXDeviceManager : NSObject
/////////////////////////////////////////////////////////////////////////////////
//
// 移动端设备操作接口(iOS Android)
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 移动端设备操作接口
/// @{
/**
* 1.1 判断当前是否为前置摄像头(仅适用于移动端)
*/
#if TARGET_OS_IPHONE
- (BOOL)isFrontCamera;
/**
* 1.2 切换前置或后置摄像头(仅适用于移动端)
*/
- (NSInteger)switchCamera:(BOOL)frontCamera;
/**
* 1.3 查询当前摄像头是否支持缩放(仅适用于移动端)
*/
- (BOOL)isCameraZoomSupported;
/**
* 1.3 获取摄像头的最大缩放倍数(仅适用于移动端)
*/
- (CGFloat)getCameraZoomMaxRatio;
/**
* 1.4 设置摄像头的缩放倍数(仅适用于移动端)
*
* @param zoomRatio 取值范围1 - 5,取值为1表示最远视角(正常镜头),取值为5表示最近视角(放大镜头)。
*/
- (NSInteger)setCameraZoomRatio:(CGFloat)zoomRatio;
/**
* 1.5 查询是否支持自动识别人脸位置(仅适用于移动端)
*/
- (BOOL)isAutoFocusEnabled;
/**
* 1.6 开启自动对焦功能(仅适用于移动端)
*
* 开启后,SDK 会自动检测画面中的人脸位置,并将摄像头的焦点始终对焦在人脸位置上。
*/
- (NSInteger)enableCameraAutoFocus:(BOOL)enabled;
/**
* 1.7 设置摄像头的对焦位置(仅适用于移动端)
*
* 您可以通过该接口实现如下交互:
* 1. 在本地摄像头的预览画面上,允许用户单击操作。
* 2. 在用户的单击位置显示一个矩形方框,以示摄像头会在此处对焦。
* 3. 随后将用户点击位置的坐标通过本接口传递给 SDK,之后 SDK 会操控摄像头按照用户期望的位置进行对焦。
* @note 使用该接口的前提是先通过 {@link enableCameraAutoFocus} 关闭自动对焦功能。
* @param position 对焦位置,请传入期望对焦点的坐标值
* @return 0:操作成功;负数:操作失败。
*/
- (NSInteger)setCameraFocusPosition:(CGPoint)position;
/**
* 1.8 查询是否支持开启闪光灯(仅适用于移动端)
*/
- (BOOL)isCameraTorchSupported;
/**
* 1.8 开启/关闭闪光灯,也就是手电筒模式(仅适用于移动端)
*/
- (NSInteger)enableCameraTorch:(BOOL)enabled;
/**
* 1.9 设置音频路由(仅适用于移动端)
*
* 手机有两个音频播放设备:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。
* 设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
* 设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
*/
- (NSInteger)setAudioRoute:(TXAudioRoute)route;
/**
* 1.10 设置系统音量类型(仅适用于移动端)
*/
- (NSInteger)setSystemVolumeType:(TXSystemVolumeType)type;
#endif
/// @}
/////////////////////////////////////////////////////////////////////////////////
//
// 桌面端设备操作接口(Windows Mac)
//
/////////////////////////////////////////////////////////////////////////////////
/// @name 桌面端设备操作接口
/// @{
/**
* 2.1 获取设备列表(仅适用于桌面端)
*
* @param type 设备类型,指定需要获取哪种设备的列表。详见 TXMediaDeviceType 定义。
* @note
* - 使用完毕后请调用 release 方法释放资源,这样可以让 SDK 维护 ITXDeviceCollection 对象的生命周期。
* - 不要使用 delete 释放返回的 Collection 对象,delete ITXDeviceCollection* 指针会导致异常崩溃。
* - type 只支持 TXMediaDeviceTypeMic、TXMediaDeviceTypeSpeaker、TXMediaDeviceTypeCamera。
* - 此接口只支持 Mac 和 Windows 平台
*/
#if !TARGET_OS_IPHONE && TARGET_OS_MAC
- (NSArray<TXMediaDeviceInfo *> *_Nullable)getDevicesList:(TXMediaDeviceType)type;
/**
* 2.2 设置当前要使用的设备(仅适用于桌面端)
*
* @param type 设备类型,详见 TXMediaDeviceType 定义。
* @param deviceId 设备ID,您可以通过接口 {@link getDevicesList} 获得设备 ID。
* @return 0:操作成功;负数:操作失败。
*/
- (NSInteger)setCurrentDevice:(TXMediaDeviceType)type deviceId:(NSString *)deviceId;
/**
* 2.3 获取当前正在使用的设备(仅适用于桌面端)
*/
- (TXMediaDeviceInfo *_Nullable)getCurrentDevice:(TXMediaDeviceType)type;
/**
* 2.4 设置当前设备的音量(仅适用于桌面端)
*
* 这里的音量指的是麦克风的采集音量或者扬声器的播放音量,摄像头是不支持设置音量的。
*
* @param volume 音量大小,取值范围为0 - 100,默认值:100。
* @note 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
*/
- (NSInteger)setCurrentDeviceVolume:(NSInteger)volume deviceType:(TXMediaDeviceType)type;
/**
* 2.5 获取当前设备的音量(仅适用于桌面端)
*
* 这里的音量指的是麦克风的采集音量或者扬声器的播放音量,摄像头是不支持获取音量的。
*/
- (NSInteger)getCurrentDeviceVolume:(TXMediaDeviceType)type;
/**
* 2.6 设置当前设备的静音状态(仅适用于桌面端)
*
* 这里的音量指的是麦克风和扬声器,摄像头是不支持静音操作的。
*/
- (NSInteger)setCurrentDeviceMute:(BOOL)mute deviceType:(TXMediaDeviceType)type;
/**
* 2.7 获取当前设备的静音状态(仅适用于桌面端)
*
* 这里的音量指的是麦克风和扬声器,摄像头是不支持静音操作的。
*/
- (BOOL)getCurrentDeviceMute:(TXMediaDeviceType)type;
/**
* 2.8 开始摄像头测试(仅适用于桌面端)
*
* @note 在测试过程中可以使用 {@link setCurrentDevice} 接口切换摄像头。
*/
- (NSInteger)startCameraDeviceTest:(NSView *)view;
/**
* 2.9 结束摄像头测试(仅适用于桌面端)
*/
- (NSInteger)stopCameraDeviceTest;
/**
* 2.10 开始麦克风测试(仅适用于桌面端)
*
* 该接口可以测试麦克风是否能正常工作,测试到的麦克风采集音量的大小,会以回调的形式通知给您,其中 volume 的取值范围为0 - 100。
* @param interval 麦克风音量的回调间隔。
*/
- (NSInteger)startMicDeviceTest:(NSInteger)interval testEcho:(void (^)(NSInteger volume))testEcho;
/**
* 2.11 结束麦克风测试(仅适用于桌面端)
*/
- (NSInteger)stopMicDeviceTest;
/**
* 2.12 开始扬声器测试(仅适用于桌面端)
*
* 该接口通过播放指定的音频文件,用于测试播放设备是否能正常工作。如果用户在测试时能听到声音,说明播放设备能正常工作。
* @param filePath 声音文件的路径
*/
- (NSInteger)startSpeakerDeviceTest:(NSString *)audioFilePath onVolumeChanged:(void (^)(NSInteger volume, BOOL isLastFrame))volumeBlock;
/**
* 2.13 结束扬声器测试(仅适用于桌面端)
*/
- (NSInteger)stopSpeakerDeviceTest;
/**
* 2.14 设备热插拔回调(仅适用于 Mac 系统)
*/
- (void)setObserver:(nullable id<TXDeviceObserver>)observer;
#endif
/// @}
@end
/// @}
//
// TXImageSprite.h
// TXLiteAVSDK
//
// Created by annidyfeng on 2018/8/23.
// Copyright © 2018年 Tencent. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
/// 雪碧图解析工具
@interface TXImageSprite : NSObject
/**
* 设置雪碧图地址
* @param vttUrl VTT链接
* @param images 雪碧图大图列表
*/
- (void)setVTTUrl:(NSURL *)vttUrl imageUrls:(NSArray<NSURL *> *)images;
/**
* 获取缩略图
* @param time 时间点,单位秒
* @return 获取失败返回nil
*/
- (UIImage *)getThumbnail:(GLfloat)time;
@end
#ifndef TXLiteAVBuffer_h
#define TXLiteAVBuffer_h
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
namespace liteav {
/**
* Buffer 数据类型
*/
class TXLiteAVBuffer {
public:
virtual ~TXLiteAVBuffer() {}
/**
* 获取 buffer 的内存地址
*/
virtual uint8_t * data() = 0;
/**
* 获取 buffer 的内存地址
*/
virtual const uint8_t * cdata() const = 0;
/**
* 获取 buffer 的内存size
*/
virtual size_t size() const = 0;
/**
* 设置 buffe 的有效数据 size
* 如果此 size 超过当前 capacity,会造成重新分配内存,并复制数据
*/
virtual void SetSize(size_t size) = 0;
/**
* 确保 buffer 分配的内存空间足够,不用多次分配拷贝内存。此方法会引起内存分配,data / cdata 方法获取的指针失效
* @param capacity buffer 预分配的内存size
*/
virtual void EnsureCapacity(size_t capacity) = 0;
};
}
#endif /* TXLiteAVBuffer_h */
#ifndef __TXLITEAVCODE_H__
#define __TXLITEAVCODE_H__
/////////////////////////////////////////////////////////////////////////////////
//
// 错误码
//
/////////////////////////////////////////////////////////////////////////////////
typedef enum TXLiteAVError
{
/////////////////////////////////////////////////////////////////////////////////
//
// 基础错误码
//
/////////////////////////////////////////////////////////////////////////////////
ERR_NULL = 0, ///< 无错误
/////////////////////////////////////////////////////////////////////////////////
//
// 进房(enterRoom)相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##onEnterRoom() 和 TRTCCloudDelegate##OnError() 通知
//
/////////////////////////////////////////////////////////////////////////////////
ERR_ROOM_ENTER_FAIL = -3301, ///< 进入房间失败,请查看 onError 中的 -3301 对应的 msg 提示确认失败原因
ERR_ROOM_REQUEST_IP_TIMEOUT = -3307, ///< 请求 IP 和 sig 超时,请检查网络是否正常,或网络防火墙是否放行 UDP。可尝试访问下列 IP:162.14.22.165:8000 162.14.6.105:8000 和域名:default-query.trtc.tencent-cloud.com:8000
ERR_ROOM_REQUEST_ENTER_ROOM_TIMEOUT = -3308, ///< 请求进房超时,请检查是否断网或者是否开启vpn,您也可以切换4G进行测试确认
ERR_ENTER_ROOM_PARAM_NULL = -3316, ///< 进房参数为空,请检查: enterRoom:appScene: 接口调用是否传入有效的 param
ERR_SDK_APPID_INVALID = -3317, ///< 进房参数 sdkAppId 错误,请检查 TRTCParams.sdkAppId 是否为空
ERR_ROOM_ID_INVALID = -3318, ///< 进房参数 roomId 错误,请检查 TRTCParams.roomId 或 TRTCParams.strRoomId 是否为空,注意 roomId 和 strRoomId 不可混用
ERR_USER_ID_INVALID = -3319, ///< 进房参数 userId 不正确,请检查 TRTCParams.userId 是否为空
ERR_USER_SIG_INVALID = -3320, ///< 进房参数 userSig 不正确,请检查 TRTCParams.userSig 是否为空
ERR_ROOM_REQUEST_ENTER_ROOM_REFUSED = -3340, ///< 进房请求被拒绝,请检查是否连续调用 enterRoom 进入相同 Id 的房间
ERR_SERVER_INFO_PRIVILEGE_FLAG_ERROR = -100006, ///< 您开启了高级权限控制,但参数 TRTCParams.privateMapKey 校验失败,您可参考 https://cloud.tencent.com/document/product/647/32240 进行检查
ERR_SERVER_INFO_SERVICE_SUSPENDED = -100013, ///< 服务不可用。请检查:套餐包剩余分钟数是否大于0,腾讯云账号是否欠费。您可参考 https://cloud.tencent.com/document/product/647/50492 进行查看与配置
ERR_SERVER_INFO_ECDH_GET_TINYID = -100018, ///< UserSig 校验失败,请检查参数 TRTCParams.userSig 是否填写正确,或是否已经过期。您可参考 https://cloud.tencent.com/document/product/647/50686 进行校验
/////////////////////////////////////////////////////////////////////////////////
//
// 退房(exitRoom)相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##OnError() 通知
//
/////////////////////////////////////////////////////////////////////////////////
ERR_ROOM_REQUEST_QUIT_ROOM_TIMEOUT = -3325, ///< 请求退房超时
/////////////////////////////////////////////////////////////////////////////////
//
// 设备(摄像头、麦克风、扬声器)相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##OnError() 通知
// 区段:-6000 ~ -6999
//
/////////////////////////////////////////////////////////////////////////////////
ERR_CAMERA_START_FAIL = -1301, ///< 打开摄像头失败,例如在 Windows 或 Mac 设备,摄像头的配置程序(驱动程序)异常,禁用后重新启用设备,或者重启机器,或者更新配置程序
ERR_CAMERA_NOT_AUTHORIZED = -1314, ///< 摄像头设备未授权,通常在移动设备出现,可能是权限被用户拒绝了
ERR_CAMERA_SET_PARAM_FAIL = -1315, ///< 摄像头参数设置出错(参数不支持或其它)
ERR_CAMERA_OCCUPY = -1316, ///< 摄像头正在被占用中,可尝试打开其他摄像头
ERR_MIC_START_FAIL = -1302, ///< 打开麦克风失败,例如在 Windows 或 Mac 设备,麦克风的配置程序(驱动程序)异常,禁用后重新启用设备,或者重启机器,或者更新配置程序
ERR_MIC_NOT_AUTHORIZED = -1317, ///< 麦克风设备未授权,通常在移动设备出现,可能是权限被用户拒绝了
ERR_MIC_SET_PARAM_FAIL = -1318, ///< 麦克风设置参数失败
ERR_MIC_OCCUPY = -1319, ///< 麦克风正在被占用中,例如移动设备正在通话时,打开麦克风会失败
ERR_MIC_STOP_FAIL = -1320, ///< 停止麦克风失败
ERR_SPEAKER_START_FAIL = -1321, ///< 打开扬声器失败,例如在 Windows 或 Mac 设备,扬声器的配置程序(驱动程序)异常,禁用后重新启用设备,或者重启机器,或者更新配置程序
ERR_SPEAKER_SET_PARAM_FAIL = -1322, ///< 扬声器设置参数失败
ERR_SPEAKER_STOP_FAIL = -1323, ///< 停止扬声器失败
/////////////////////////////////////////////////////////////////////////////////
//
// 系统声音采集相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##onSystemAudioLoopbackError() 通知
//
/////////////////////////////////////////////////////////////////////////////////
ERR_AUDIO_PLUGIN_START_FAIL = -1330, ///< 开启系统声音录制失败,例如音频驱动插件不可用
ERR_AUDIO_PLUGIN_INSTALL_NOT_AUTHORIZED = -1331, ///< 安装音频驱动插件未授权
ERR_AUDIO_PLUGIN_INSTALL_FAILED = -1332, ///< 安装音频驱动插件失败
/////////////////////////////////////////////////////////////////////////////////
//
// 屏幕分享相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##OnError() 通知
//
/////////////////////////////////////////////////////////////////////////////////
ERR_SCREEN_CAPTURE_START_FAIL = -1308, ///< 开始录屏失败,如果在移动设备出现,可能是权限被用户拒绝了,如果在 Windows 或 Mac 系统的设备出现,请检查录屏接口的参数是否符合要求
ERR_SCREEN_CAPTURE_UNSURPORT = -1309, ///< 录屏失败,在 Android 平台,需要5.0以上的系统,在 iOS 平台,需要11.0以上的系统
ERR_SERVER_CENTER_NO_PRIVILEDGE_PUSH_SUB_VIDEO = -102015, ///< 没有权限上行辅路
ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO = -102016, ///< 其他用户正在上行辅路
ERR_SCREEN_CAPTURE_STOPPED = -7001, ///< 录屏被系统中止
/////////////////////////////////////////////////////////////////////////////////
//
// 编解码相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##OnError() 通知
//
/////////////////////////////////////////////////////////////////////////////////
ERR_VIDEO_ENCODE_FAIL = -1303, ///< 视频帧编码失败,例如 iOS 设备切换到其他应用时,硬编码器可能被系统释放,再切换回来时,硬编码器重启前,可能会抛出
ERR_UNSUPPORTED_RESOLUTION = -1305, ///< 不支持的视频分辨率
ERR_AUDIO_ENCODE_FAIL = -1304, ///< 音频帧编码失败,例如传入自定义音频数据,SDK 无法处理
ERR_UNSUPPORTED_SAMPLERATE = -1306, ///< 不支持的音频采样率
/////////////////////////////////////////////////////////////////////////////////
//
// 自定义采集相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##OnError() 通知
//
/////////////////////////////////////////////////////////////////////////////////
ERR_PIXEL_FORMAT_UNSUPPORTED = -1327, ///< 设置的 pixel format 不支持
ERR_BUFFER_TYPE_UNSUPPORTED = -1328, ///< 设置的 buffer type 不支持
/////////////////////////////////////////////////////////////////////////////////
//
// CDN 绑定和混流相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##onStartPublishing() 和 TRTCCloudDelegate##onSetMixTranscodingConfig 通知。
//
/////////////////////////////////////////////////////////////////////////////////
ERR_PUBLISH_CDN_STREAM_REQUEST_TIME_OUT = -3321, ///< 旁路转推请求超时
ERR_CLOUD_MIX_TRANSCODING_REQUEST_TIME_OUT = -3322, ///< 云端混流请求超时
ERR_PUBLISH_CDN_STREAM_SERVER_FAILED = -3323, ///< 旁路转推回包异常
ERR_CLOUD_MIX_TRANSCODING_SERVER_FAILED = -3324, ///< 云端混流回包异常
ERR_ROOM_REQUEST_START_PUBLISHING_TIMEOUT = -3333, ///< 开始向腾讯云的直播 CDN 推流信令超时
ERR_ROOM_REQUEST_START_PUBLISHING_ERROR = -3334, ///< 开始向腾讯云的直播 CDN 推流信令异常
ERR_ROOM_REQUEST_STOP_PUBLISHING_TIMEOUT = -3335, ///< 停止向腾讯云的直播 CDN 推流信令超时
ERR_ROOM_REQUEST_STOP_PUBLISHING_ERROR = -3336, ///< 停止向腾讯云的直播 CDN 推流信令异常
/////////////////////////////////////////////////////////////////////////////////
//
// 跨房连麦(ConnectOtherRoom)相关错误码
// NOTE: 通过回调函数 TRTCCloudDelegate##onConnectOtherRoom() 通知。
//
/////////////////////////////////////////////////////////////////////////////////
ERR_ROOM_REQUEST_CONN_ROOM_TIMEOUT = -3326, ///< 请求连麦超时
ERR_ROOM_REQUEST_DISCONN_ROOM_TIMEOUT = -3327, ///< 请求退出连麦超时
ERR_ROOM_REQUEST_CONN_ROOM_INVALID_PARAM = -3328, ///< 无效参数
ERR_CONNECT_OTHER_ROOM_AS_AUDIENCE = -3330, ///< 当前是观众角色,不能请求或断开跨房连麦,需要先 switchRole() 到主播
ERR_SERVER_CENTER_CONN_ROOM_NOT_SUPPORT = -102031, ///< 不支持跨房间连麦
ERR_SERVER_CENTER_CONN_ROOM_REACH_MAX_NUM = -102032, ///< 达到跨房间连麦上限
ERR_SERVER_CENTER_CONN_ROOM_REACH_MAX_RETRY_TIMES = -102033, ///< 跨房间连麦重试次数耗尽
ERR_SERVER_CENTER_CONN_ROOM_REQ_TIMEOUT = -102034, ///< 跨房间连麦请求超时
ERR_SERVER_CENTER_CONN_ROOM_REQ = -102035, ///< 跨房间连麦请求格式错误
ERR_SERVER_CENTER_CONN_ROOM_NO_SIG = -102036, ///< 跨房间连麦无签名
ERR_SERVER_CENTER_CONN_ROOM_DECRYPT_SIG = -102037, ///< 跨房间连麦签名解密失败
ERR_SERVER_CENTER_CONN_ROOM_NO_KEY = -102038, ///< 未找到跨房间连麦签名解密密钥
ERR_SERVER_CENTER_CONN_ROOM_PARSE_SIG = -102039, ///< 跨房间连麦签名解析错误
ERR_SERVER_CENTER_CONN_ROOM_INVALID_SIG_TIME = -102040, ///< 跨房间连麦签名时间戳错误
ERR_SERVER_CENTER_CONN_ROOM_SIG_GROUPID = -102041, ///< 跨房间连麦签名不匹配
ERR_SERVER_CENTER_CONN_ROOM_NOT_CONNED = -102042, ///< 本房间无连麦
ERR_SERVER_CENTER_CONN_ROOM_USER_NOT_CONNED = -102043, ///< 本用户未发起连麦
ERR_SERVER_CENTER_CONN_ROOM_FAILED = -102044, ///< 跨房间连麦失败
ERR_SERVER_CENTER_CONN_ROOM_CANCEL_FAILED = -102045, ///< 取消跨房间连麦失败
ERR_SERVER_CENTER_CONN_ROOM_CONNED_ROOM_NOT_EXIST = -102046, ///< 被连麦房间不存在
ERR_SERVER_CENTER_CONN_ROOM_CONNED_REACH_MAX_ROOM = -102047, ///< 被连麦房间达到连麦上限
ERR_SERVER_CENTER_CONN_ROOM_CONNED_USER_NOT_EXIST = -102048, ///< 被连麦用户不存在
ERR_SERVER_CENTER_CONN_ROOM_CONNED_USER_DELETED = -102049, ///< 被连麦用户已被删除
ERR_SERVER_CENTER_CONN_ROOM_CONNED_USER_FULL = -102050, ///< 被连麦用户达到资源上限
ERR_SERVER_CENTER_CONN_ROOM_INVALID_SEQ = -102051, ///< 连麦请求序号错乱
/////////////////////////////////////////////////////////////////////////////////
//
// 客户无需关心的内部错误码
//
/////////////////////////////////////////////////////////////////////////////////
// - Remove From Head
ERR_RTMP_PUSH_NET_DISCONNECT = -1307, ///< 直播,推流出现网络断开,且经过多次重试无法恢复
ERR_RTMP_PUSH_INVALID_ADDRESS = -1313, ///< 直播,推流地址非法,例如不是 RTMP 协议的地址
ERR_RTMP_PUSH_NET_ALLADDRESS_FAIL = -1324, ///< 直播,连接推流服务器失败(若支持智能选路,IP 全部失败)
ERR_RTMP_PUSH_NO_NETWORK = -1325, ///< 直播,网络不可用,请确认 Wi-Fi、移动数据或者有线网络是否正常
ERR_RTMP_PUSH_SERVER_REFUSE = -1326, ///< 直播,服务器拒绝连接请求,可能是该推流地址已经被占用,或者 TXSecret 校验失败,或者是过期了,或者是欠费了
ERR_PLAY_LIVE_STREAM_NET_DISCONNECT = -2301, ///< 直播,网络断连,且经多次重连抢救无效,可以放弃治疗,更多重试请自行重启播放
ERR_GET_RTMP_ACC_URL_FAIL = -2302, ///< 直播,获取加速拉流的地址失败
ERR_FILE_NOT_FOUND = -2303, ///< 播放的文件不存在
ERR_HEVC_DECODE_FAIL = -2304, ///< H265 解码失败
ERR_VOD_DECRYPT_FAIL = -2305, ///< 点播,音视频流解密失败
ERR_GET_VODFILE_MEDIAINFO_FAIL = -2306, ///< 点播,获取点播文件信息失败
ERR_PLAY_LIVE_STREAM_SWITCH_FAIL = -2307, ///< 直播,切流失败(切流可以播放不同画面大小的视频)
ERR_PLAY_LIVE_STREAM_SERVER_REFUSE = -2308, ///< 直播,服务器拒绝连接请求
ERR_RTMP_ACC_FETCH_STREAM_FAIL = -2309, ///< 直播,RTMPACC 低延时拉流失败,且经过多次重试无法恢复
ERR_HEVC_ENCODE_FAIL = -2310, ///< 265编码失败
ERR_HEVC_ENCODE_NOT_SUPPORT = -2311, ///< 265编码判断不支持
ERR_HEVC_SOFTDECODER_START_FAIL = -2312, ///< 265软解启动失败
ERR_ROOM_HEARTBEAT_FAIL = -3302, ///< 心跳失败,客户端定时向服务器发送数据包,告诉服务器自己活着,这个错误通常是发包超时
ERR_ROOM_REQUEST_IP_FAIL = -3303, ///< 拉取接口机服务器地址失败
ERR_ROOM_CONNECT_FAIL = -3304, ///< 连接接口机服务器失败
ERR_ROOM_REQUEST_AVSEAT_FAIL = -3305, ///< 请求视频位失败
ERR_ROOM_REQUEST_TOKEN_HTTPS_TIMEOUT = -3306, ///< 请求 token HTTPS 超时,请检查网络是否正常,或网络防火墙是否放行 HTTPS 访问 official.opensso.tencent-cloud.com:443
ERR_ROOM_REQUEST_VIDEO_FLAG_TIMEOUT = -3309, ///< 请求视频位超时
ERR_ROOM_REQUEST_VIDEO_DATA_ROOM_TIMEOUT = -3310, ///< 请求视频数据超时
ERR_ROOM_REQUEST_CHANGE_ABILITY_TIMEOUT = -3311, ///< 请求修改视频能力项超时
ERR_ROOM_REQUEST_STATUS_REPORT_TIMEOUT = -3312, ///< 请求状态上报超时
ERR_ROOM_REQUEST_CLOSE_VIDEO_TIMEOUT = -3313, ///< 请求关闭视频超时
ERR_ROOM_REQUEST_SET_RECEIVE_TIMEOUT = -3314, ///< 请求接收视频项超时
ERR_ROOM_REQUEST_TOKEN_INVALID_PARAMETER = -3315, ///< 请求 token 无效参数,请检查 TRTCParams.userSig 是否填写正确
ERR_ROOM_REQUEST_EXIT_ROOM_WHEN_ENTERING_ROOM = -3341, ///< 进房尚未成功时,收到了退房请求
ERR_ROOM_REQUEST_AES_TOKEN_RETURN_ERROR = -3329, ///< 请求 AES TOKEN 时,server 返回的内容是空的
ERR_ACCIP_LIST_EMPTY = -3331, ///< 请求接口机 IP 返回的列表为空的
ERR_ROOM_REQUEST_SEND_JSON_CMD_TIMEOUT = -3332, ///< 请求发送Json 信令超时
// Info 服务器(查询接口机 IP), 服务器错误码,数值范围[-100000, -110000]
ERR_SERVER_INFO_UNPACKING_ERROR = -100000, ///< server 解包错误,可能请求数据被篡改
ERR_SERVER_INFO_TOKEN_ERROR = -100001, ///< TOKEN 错误
ERR_SERVER_INFO_ALLOCATE_ACCESS_FAILED = -100002, ///< 分配接口机错误
ERR_SERVER_INFO_GENERATE_SIGN_FAILED = -100003, ///< 生成签名错误
ERR_SERVER_INFO_TOKEN_TIMEOUT = -100004, ///< HTTPS token 超时
ERR_SERVER_INFO_INVALID_COMMAND = -100005, ///< 无效的命令字
ERR_SERVER_INFO_GENERATE_KEN_ERROR = -100007, ///< HTTPS 请求时,生成加密 key 错误
ERR_SERVER_INFO_GENERATE_TOKEN_ERROR = -100008, ///< HTTPS 请求时,生成 token 错误
ERR_SERVER_INFO_DATABASE = -100009, ///< 数据库查询失败(房间相关存储信息)
ERR_SERVER_INFO_BAD_ROOMID = -100010, ///< 房间号错误
ERR_SERVER_INFO_BAD_SCENE_OR_ROLE = -100011, ///< 场景或角色错误
ERR_SERVER_INFO_ROOMID_EXCHANGE_FAILED = -100012, ///< 房间号转换出错
ERR_SERVER_INFO_STRGROUP_HAS_INVALID_CHARS = -100014, ///< 房间号非法
ERR_SERVER_INFO_LACK_SDKAPPID = -100015, ///< 非法SDKAppid
ERR_SERVER_INFO_INVALID = -100016, ///< 无效请求, 分配接口机失败
ERR_SERVER_INFO_ECDH_GET_KEY = -100017, ///< 生成公钥失败
// Access 接口机
ERR_SERVER_ACC_TOKEN_TIMEOUT = -101000, ///< token 过期
ERR_SERVER_ACC_SIGN_ERROR = -101001, ///< 签名错误
ERR_SERVER_ACC_SIGN_TIMEOUT = -101002, ///< 签名超时
ERR_SERVER_ACC_ROOM_NOT_EXIST = -101003, ///< 房间不存在
ERR_SERVER_ACC_ROOMID = -101004, ///< 后台房间标识 roomId 错误
ERR_SERVER_ACC_LOCATIONID = -101005, ///< 后台用户位置标识 locationId 错误
ERR_SERVER_ACC_TOKEN_EORROR = -101006, ///< token里面的tinyid和进房信令tinyid不同 或是 进房信令没有token
// Center 服务器(信令和流控处理等任务)
ERR_SERVER_CENTER_SYSTEM_ERROR = -102000, ///< 后台错误
ERR_SERVER_CENTER_INVALID_ROOMID = -102001, ///< 无效的房间 Id
ERR_SERVER_CENTER_CREATE_ROOM_FAILED = -102002, ///< 创建房间失败
ERR_SERVER_CENTER_SIGN_ERROR = -102003, ///< 签名错误
ERR_SERVER_CENTER_SIGN_TIMEOUT = -102004, ///< 签名过期
ERR_SERVER_CENTER_ROOM_NOT_EXIST = -102005, ///< 房间不存在
ERR_SERVER_CENTER_ADD_USER_FAILED = -102006, ///< 房间添加用户失败
ERR_SERVER_CENTER_FIND_USER_FAILED = -102007, ///< 查找用户失败
ERR_SERVER_CENTER_SWITCH_TERMINATION_FREQUENTLY = -102008, ///< 频繁切换终端
ERR_SERVER_CENTER_LOCATION_NOT_EXIST = -102009, ///< locationid 错误
ERR_SERVER_CENTER_NO_PRIVILEDGE_CREATE_ROOM = -102010, ///< 没有权限创建房间
ERR_SERVER_CENTER_NO_PRIVILEDGE_ENTER_ROOM = -102011, ///< 没有权限进入房间
ERR_SERVER_CENTER_INVALID_PARAMETER_SUB_VIDEO = -102012, ///< 辅路抢视频位、申请辅路请求类型参数错误
ERR_SERVER_CENTER_NO_PRIVILEDGE_PUSH_VIDEO = -102013, ///< 没有权限上视频
ERR_SERVER_CENTER_ROUTE_TABLE_ERROR = -102014, ///< 没有空闲路由表
ERR_SERVER_CENTER_NOT_PUSH_SUB_VIDEO = -102017, ///< 当前用户没有上行辅路
ERR_SERVER_CENTER_USER_WAS_DELETED = -102018, ///< 用户被删除状态
ERR_SERVER_CENTER_NO_PRIVILEDGE_REQUEST_VIDEO = -102019, ///< 没有权限请求视频
ERR_SERVER_CENTER_INVALID_PARAMETER = -102023, ///< 进房参数 bussInfo 错误
ERR_SERVER_CENTER_I_FRAME_UNKNOW_TYPE = -102024, ///< 请求 I 帧未知 opType
ERR_SERVER_CENTER_I_FRAME_INVALID_PACKET = -102025, ///< 请求 I 帧包格式错误
ERR_SERVER_CENTER_I_FRAME_DEST_USER_NOT_EXIST = -102026, ///< 请求 I 帧目标用户不存在
ERR_SERVER_CENTER_I_FRAME_ROOM_TOO_BIG = -102027, ///< 请求 I 帧房间用户太多
ERR_SERVER_CENTER_I_FRAME_RPS_INVALID_PARAMETER = -102028, ///< 请求 I 帧参数错误
ERR_SERVER_CENTER_INVALID_ROOM_ID = -102029, ///< 房间号非法
ERR_SERVER_CENTER_ROOM_ID_TOO_LONG = -102030, ///< 房间号超过限制
ERR_SERVER_CENTER_ROOM_FULL = -102052, ///< 房间满员
ERR_SERVER_CENTER_DECODE_JSON_FAIL = -102053, ///< JSON 串解析失败
ERR_SERVER_CENTER_UNKNOWN_SUB_CMD = -102054, ///< 未定义命令字
ERR_SERVER_CENTER_INVALID_ROLE = -102055, ///< 未定义角色
ERR_SERVER_CENTER_REACH_PROXY_MAX = -102056, ///< 代理机超出限制
ERR_SERVER_CENTER_RECORDID_STORE = -102057, ///< 无法保存用户自定义 recordId
ERR_SERVER_CENTER_PB_SERIALIZE = -102058, ///< Protobuf 序列化错误
ERR_SERVER_SSO_SIG_EXPIRED = -70001, ///< sig 过期,请尝试重新生成。如果是刚生成,就过期,请检查有效期填写的是否过小,或者填的 0
ERR_SERVER_SSO_SIG_VERIFICATION_FAILED_1 = -70003, ///< sig 校验失败,请确认下 sig 内容是否被截断,如缓冲区长度不够导致的内容截断
ERR_SERVER_SSO_SIG_VERIFICATION_FAILED_2 = -70004, ///< sig 校验失败,请确认下 sig 内容是否被截断,如缓冲区长度不够导致的内容截断
ERR_SERVER_SSO_SIG_VERIFICATION_FAILED_3 = -70005, ///< sig 校验失败,可用工具自行验证生成的 sig 是否正确
ERR_SERVER_SSO_SIG_VERIFICATION_FAILED_4 = -70006, ///< sig 校验失败,可用工具自行验证生成的 sig 是否正确
ERR_SERVER_SSO_SIG_VERIFICATION_FAILED_5 = -70007, ///< sig 校验失败,可用工具自行验证生成的 sig 是否正确
ERR_SERVER_SSO_SIG_VERIFICATION_FAILED_6 = -70008, ///< sig 校验失败,可用工具自行验证生成的 sig 是否正确
ERR_SERVER_SSO_SIG_VERIFICATION_FAILED_7 = -70009, ///< 用业务公钥验证 sig 失败,请确认生成的 usersig 使用的私钥和 sdkAppId 是否对应
ERR_SERVER_SSO_SIG_VERIFICATION_FAILED_8 = -70010, ///< sig 校验失败,可用工具自行验证生成的 sig 是否正确
ERR_SERVER_SSO_SIG_VERIFICATION_ID_NOT_MATCH = -70013, ///< sig 中 identifier 与请求时的 identifier 不匹配,请检查登录时填写的 identifier 与 sig 中的是否一致
ERR_SERVER_SSO_APPID_NOT_MATCH = -70014, ///< sig 中 sdkAppId 与请求时的 sdkAppId 不匹配,请检查登录时填写的 sdkAppId 与 sig 中的是否一致
ERR_SERVER_SSO_VERIFICATION_EXPIRED = -70017, ///< 内部第三方票据验证超时,请重试,如多次重试不成功,请@TLS 帐号支持,QQ 3268519604
ERR_SERVER_SSO_VERIFICATION_FAILED = -70018, ///< 内部第三方票据验证超时,请重试,如多次重试不成功,请@TLS 帐号支持,QQ 3268519604
ERR_SERVER_SSO_APPID_NOT_FOUND = -70020, ///< sdkAppId 未找到,请确认是否已经在腾讯云上配置
ERR_SERVER_SSO_ACCOUNT_IN_BLACKLIST = -70051, ///< 帐号已被拉入黑名单,请联系 TLS 帐号支持 QQ 3268519604
ERR_SERVER_SSO_SIG_INVALID = -70052, ///< usersig 已经失效,请重新生成,再次尝试
ERR_SERVER_SSO_LIMITED_BY_SECURITY = -70114, ///< 安全原因被限制
ERR_SERVER_SSO_INVALID_LOGIN_STATUS = -70221, ///< 登录状态无效,请使用 usersig 重新鉴权
ERR_SERVER_SSO_APPID_ERROR = -70252, ///< sdkAppId 填写错误
ERR_SERVER_SSO_TICKET_VERIFICATION_FAILED = -70346, ///< 票据校验失败,请检查各项参数是否正确
ERR_SERVER_SSO_TICKET_EXPIRED = -70347, ///< 票据因过期原因校验失败
ERR_SERVER_SSO_ACCOUNT_EXCEED_PURCHASES = -70398, ///< 创建账号数量超过已购买预付费数量限制
ERR_SERVER_SSO_INTERNAL_ERROR = -70500, ///< 服务器内部错误,请重试
//秒级监控上报错误码
ERR_REQUEST_QUERY_CONFIG_TIMEOUT = -4001, ///< 请求通用配置超时
ERR_CUSTOM_STREAM_INVALID = -4002, ///< 自定义流id错误
ERR_USER_DEFINE_RECORD_ID_INVALID = -4003, ///< userDefineRecordId错误
ERR_MIX_PARAM_INVALID = -4004, ///< 混流参数校验失败
ERR_REQUEST_ACC_BY_HOST_IP = -4005, ///< 通过域名进行0x1请求
// - /Remove From Head
} TXLiteAVError;
/////////////////////////////////////////////////////////////////////////////////
//
// 警告码
//
//> 不需要特别关注,但您可以根据其中某些感兴趣的警告码,对当前用户进行相应的提示
//
/////////////////////////////////////////////////////////////////////////////////
typedef enum TXLiteAVWarning
{
WARNING_HW_ENCODER_START_FAIL = 1103, ///< 硬编码启动出现问题,自动切换到软编码
WARNING_CURRENT_ENCODE_TYPE_CHANGED = 1104, ///< 当前编码格式, 通过key 为type获取,值为1时是265编码,值为0时是264编码
WARNING_VIDEO_ENCODER_SW_TO_HW = 1107, ///< 当前 CPU 使用率太高,无法满足软件编码需求,自动切换到硬件编码
WARNING_INSUFFICIENT_CAPTURE_FPS = 1108, ///< 摄像头采集帧率不足,部分自带美颜算法的 Android 手机上会出现
WARNING_SW_ENCODER_START_FAIL = 1109, ///< 软编码启动失败
WARNING_REDUCE_CAPTURE_RESOLUTION = 1110, ///< 摄像头采集分辨率被降低,以满足当前帧率和性能最优解。
WARNING_CAMERA_DEVICE_EMPTY = 1111, ///< 没有检测到可用的摄像头设备
WARNING_CAMERA_NOT_AUTHORIZED = 1112, ///< 用户未授权当前应用使用摄像头
WARNING_MICROPHONE_DEVICE_EMPTY = 1201, ///< 没有检测到可用的麦克风设备
WARNING_SPEAKER_DEVICE_EMPTY = 1202, ///< 没有检测到可用的扬声器设备
WARNING_MICROPHONE_NOT_AUTHORIZED = 1203, ///< 用户未授权当前应用使用麦克风
WARNING_MICROPHONE_DEVICE_ABNORMAL = 1204, ///< 音频采集设备不可用(例如被占用或者PC判定无效设备)
WARNING_SPEAKER_DEVICE_ABNORMAL = 1205, ///< 音频播放设备不可用(例如被占用或者PC判定无效设备)
WARNING_SCREEN_CAPTURE_NOT_AUTHORIZED = 1206, ///< 用户未授权当前应用使用屏幕录制
WARNING_VIDEO_FRAME_DECODE_FAIL = 2101, ///< 当前视频帧解码失败
WARNING_AUDIO_FRAME_DECODE_FAIL = 2102, ///< 当前音频帧解码失败
WARNING_VIDEO_PLAY_LAG = 2105, ///< 当前视频播放出现卡顿
WARNING_HW_DECODER_START_FAIL = 2106, ///< 硬解启动失败,采用软解码
WARNING_VIDEO_DECODER_HW_TO_SW = 2108, ///< 当前流硬解第一个 I 帧失败,SDK 自动切软解
WARNING_SW_DECODER_START_FAIL = 2109, ///< 软解码器启动失败
WARNING_VIDEO_RENDER_FAIL = 2110, ///< 视频渲染失败
WARNING_START_CAPTURE_IGNORED = 4000, ///< 已经在采集,启动采集被忽略
WARNING_AUDIO_RECORDING_WRITE_FAIL = 7001, ///< 音频录制写入文件失败
WARNING_ROOM_DISCONNECT = 5101, ///< 网络断开连接
WARNING_IGNORE_UPSTREAM_FOR_AUDIENCE = 6001, ///< 当前是观众角色,忽略上行音视频数据
// - Remove From Head
WARNING_NET_BUSY = 1101, ///< 网络状况不佳:上行带宽太小,上传数据受阻
WARNING_RTMP_SERVER_RECONNECT = 1102, ///< 直播,网络断连, 已启动自动重连(自动重连连续失败超过三次会放弃)
WARNING_LIVE_STREAM_SERVER_RECONNECT = 2103, ///< 直播,网络断连, 已启动自动重连(自动重连连续失败超过三次会放弃)
WARNING_RECV_DATA_LAG = 2104, ///< 网络来包不稳:可能是下行带宽不足,或由于主播端出流不均匀
WARNING_RTMP_DNS_FAIL = 3001, ///< 直播,DNS 解析失败
WARNING_RTMP_SEVER_CONN_FAIL = 3002, ///< 直播,服务器连接失败
WARNING_RTMP_SHAKE_FAIL = 3003, ///< 直播,与 RTMP 服务器握手失败
WARNING_RTMP_SERVER_BREAK_CONNECT = 3004, ///< 直播,服务器主动断开
WARNING_RTMP_READ_WRITE_FAIL = 3005, ///< 直播,RTMP 读/写失败,将会断开连接
WARNING_RTMP_WRITE_FAIL = 3006, ///< 直播,RTMP 写失败(SDK 内部错误码,不会对外抛出)
WARNING_RTMP_READ_FAIL = 3007, ///< 直播,RTMP 读失败(SDK 内部错误码,不会对外抛出)
WARNING_RTMP_NO_DATA = 3008, ///< 直播,超过30s 没有数据发送,主动断开连接
WARNING_PLAY_LIVE_STREAM_INFO_CONNECT_FAIL = 3009, ///< 直播,connect 服务器调用失败(SDK 内部错误码,不会对外抛出)
WARNING_NO_STEAM_SOURCE_FAIL = 3010, ///< 直播,连接失败,该流地址无视频(SDK 内部错误码,不会对外抛出)
WARNING_ROOM_RECONNECT = 5102, ///< 网络断连,已启动自动重连
WARNING_ROOM_NET_BUSY = 5103, ///< 网络状况不佳:上行带宽太小,上传数据受阻
// - /Remove From Head
} TXLiteAVWarning;
// - Remove From Head
/////////////////////////////////////////////////////////////////////////////////
//
// (三)事件列表
//
/////////////////////////////////////////////////////////////////////////////////
typedef enum TXLiteAVEvent
{
EVT_RTMP_PUSH_CONNECT_SUCC = 1001, ///< 直播,已经连接 RTMP 推流服务器
EVT_RTMP_PUSH_BEGIN = 1002, ///< 直播,已经与 RTMP 服务器握手完毕,开始推流
EVT_CAMERA_START_SUCC = 1003, ///< 打开摄像头成功
EVT_SCREEN_CAPTURE_SUCC = 1004, ///< 录屏启动成功
EVT_UP_CHANGE_RESOLUTION = 1005, ///< 上行动态调整分辨率
EVT_UP_CHANGE_BITRATE = 1006, ///< 码率动态调整
EVT_FIRST_FRAME_AVAILABLE = 1007, ///< 首帧画面采集完成
EVT_START_VIDEO_ENCODER = 1008, ///< 编码器启动成功
EVT_SNAPSHOT_COMPLETE = 1022, ///< 一帧截图完成
EVT_CAMERA_REMOVED = 1023, ///< 摄像头设备已被移出(Windows 和 Mac 版 SDK 使用)
EVT_CAMERA_AVAILABLE = 1024, ///< 摄像头设备重新可用(Windows 和 Mac 版 SDK 使用)
EVT_CAMERA_CLOSE = 1025, ///< 关闭摄像头完成(Windows 和 Mac 版 SDK 使用)
EVT_RTMP_PUSH_PUBLISH_START = 1026, ///< 直播,与 RTMP 服务器连接后,收到 NetStream.Publish.Start 消息,表明流发布成功(SDK 内部事件,不会对外抛出)
EVT_HW_ENCODER_START_SUCC = 1027, ///< 硬编码器启动成功
EVT_SW_ENCODER_START_SUCC = 1028, ///< 软编码器启动成功
EVT_LOCAL_RECORD_RESULT = 1029, ///< 本地录制结果
EVT_LOCAL_RECORD_PROGRESS = 1030, ///< 本地录制状态通知
EVT_PLAY_LIVE_STREAM_CONNECT_SUCC = 2001, ///< 直播,已经连接 RTMP 拉流服务器
EVT_PLAY_LIVE_STREAM_BEGIN = 2002, ///< 直播,已经与 RTMP 服务器握手完毕,开始拉流
EVT_RENDER_FIRST_I_FRAME = 2003, ///< 渲染首个视频数据包(IDR)
EVT_VIDEO_PLAY_BEGIN = 2004, ///< 视频播放开始
EVT_VIDEO_PLAY_PROGRESS = 2005, ///< 视频播放进度
EVT_VIDEO_PLAY_END = 2006, ///< 视频播放结束
EVT_VIDEO_PLAY_LOADING = 2007, ///< 视频播放 loading
EVT_START_VIDEO_DECODER = 2008, ///< 解码器启动
EVT_DOWN_CHANGE_RESOLUTION = 2009, ///< 下行视频分辨率改变
EVT_GET_VODFILE_MEDIAINFO_SUCC = 2010, ///< 点播,获取点播文件信息成功
EVT_VIDEO_CHANGE_ROTATION = 2011, ///< 视频旋转角度发生改变
EVT_PLAY_GET_MESSAGE = 2012, ///< 消息事件
EVT_VOD_PLAY_PREPARED = 2013, ///< 点播,视频加载完毕
EVT_VOD_PLAY_LOADING_END = 2014, ///< 点播,loading 结束
EVT_PLAY_LIVE_STREAM_SWITCH_SUCC = 2015, ///< 直播,切流成功(切流可以播放不同画面大小的视频)
EVT_VOD_PLAY_TCP_CONNECT_SUCC = 2016, ///< 点播,TCP 连接成功(SDK 内部事件,不会对外抛出)
EVT_VOD_PLAY_FIRST_VIDEO_PACKET = 2017, ///< 点播,收到首帧数据(SDK 内部事件,不会对外抛出)
EVT_VOD_PLAY_DNS_RESOLVED = 2018, ///< 点播,DNS 解析完成(SDK 内部事件,不会对外抛出)
EVT_VOD_PLAY_SEEK_COMPLETE = 2019, ///< 点播,视频播放 Seek 完成(SDK 内部事件,不会对外抛出)
EVT_VIDEO_DECODER_CACHE_TOO_MANY_FRAMES = 2020, ///< 视频解码器缓存帧数过多,超过40帧(SDK 内部事件,不会对外抛出)
EVT_HW_DECODER_START_SUCC = 2021, ///< 硬解码器启动成功(SDK 内部事件,不会对外抛出)
EVT_SW_DECODER_START_SUCC = 2022, ///< 软解码器启动成功(SDK 内部事件,不会对外抛出)
EVT_AUDIO_JITTER_STATE_FIRST_LOADING = 2023, ///< 音频首次加载(SDK 内部事件,不会对外抛出)
EVT_AUDIO_JITTER_STATE_LOADING = 2024, ///< 音频正在加载(SDK 内部事件,不会对外抛出)
EVT_AUDIO_JITTER_STATE_PLAYING = 2025, ///< 音频正在播放(SDK 内部事件,不会对外抛出)
EVT_AUDIO_JITTER_STATE_FIRST_PLAY = 2026, ///< 音频首次播放(SDK 内部事件,不会对外抛出)
EVT_MIC_START_SUCC = 2027, ///< 麦克风启动成功
EVT_PLAY_GET_METADATA = 2028, ///< 视频流MetaData事件
EVT_MIC_RELEASE_SUCC = 2029, ///< 释放麦克风占用
EVT_AUDIO_DEVICE_ROUTE_CHANGED = 2030, ///< 音频设备的route发生改变,即当前的输入输出设备发生改变,比如耳机被拔出
EVT_PLAY_GET_FLVSESSIONKEY = 2031, ///< TXLivePlayer 接收到http响应头中的 flvSessionKey 信息
EVT_AUDIO_SESSION_INTERRUPT = 2032, ///< Audio Session Interrupt事件
EVT_ROOM_ENTER = 1018, ///< 进入房间成功
EVT_ROOM_EXIT = 1019, ///< 退出房间
EVT_ROOM_USERLIST = 1020, ///< 下发房间成员列表(不包括自己)
EVT_ROOM_NEED_REENTER = 1021, ///< WiFi 切换到4G 会触发断线重连,此时需要重新进入房间(拉取最优的服务器地址)
EVT_ROOM_ENTER_FAILED = 1022, ///< 自己进入房间失败
EVT_ROOM_USER_ENTER = 1031, ///< 进房通知
EVT_ROOM_USER_EXIT = 1032, ///< 退房通知
EVT_ROOM_USER_VIDEO_STATE = 1033, ///< 视频状态位变化通知
EVT_ROOM_USER_AUDIO_STATE = 1034, ///< 音频状态位变化通知
EVT_ROOM_REQUEST_IP_SUCC = 8001, ///< 拉取接口机服务器地址成功
EVT_ROOM_CONNECT_SUCC = 8002, ///< 连接接口机服务器成功
EVT_ROOM_REQUEST_AVSEAT_SUCC = 8003, ///< 请求视频位成功
} TXLiteAVEvent;
// - /Remove From Head
#endif /* __TXLITEAVCODE_H__ */
/*
* Module: live 编码数据回调
*
* Function: 回调推流端编码完,和 播放端解码前的数据
*
*/
#ifndef TXLiteAVEncodedDataProcessingListener_h
#define TXLiteAVEncodedDataProcessingListener_h
#include <stdio.h>
#include "TXLiteAVBuffer.h"
namespace liteav {
struct TXLiteAVEncodedData {
const char * userId; // didEncodeVideo 和 didEncodeAudio 回调时,此字段为null;
int streamType; // 视频流类型,参考 TRTCVideoStreamType,audio时,此字段为0
const liteav::TXLiteAVBuffer * originData; // 原始数据
liteav::TXLiteAVBuffer * processedData; // 写回处理后的数据
};
class ITXLiteAVEncodedDataProcessingListener {
public:
virtual ~ITXLiteAVEncodedDataProcessingListener() {}
/**
* 回调编码完的视频数据。
* @note videoData.userId = nullptr
*/
virtual bool didEncodeVideo(TXLiteAVEncodedData & videoData) { return false; }
/**
* 回调解码前的视频数据。
* @note videoData.userId 表示对应的user,当userId 为 nullptr时,表示此时先接收到数据了,对应的userId还未完成同步。获取到userId之后会回调正确的userId
*/
virtual bool willDecodeVideo(TXLiteAVEncodedData & videoData) { return false; }
/**
* 回调编码完的音频数据。
* @note audioData.userId = nullptr
*/
virtual bool didEncodeAudio(TXLiteAVEncodedData & audioData) { return false; }
/**
* 回调解码前的音频数据。
* @note audioData.userId 表示对应的user,当userId 为 nullptr时,表示此时先接收到数据了,对应的userId还未完成同步。获取到userId之后会回调正确的userId
*/
virtual bool willDecodeAudio(TXLiteAVEncodedData & audioData) { return false; }
};
}
#endif /* TXLiteAVEncodedDataProcessingListener_h */
//
// TXLiteAVSDK.h
// TXLiteAVSDK
//
// Created by alderzhang on 2017/6/9.
// Copyright © 2017年 Tencent. All rights reserved.
//
#import <TXLiteAVSDK_Professional/TRTCCloud.h>
#import <TXLiteAVSDK_Professional/TRTCCloudDef.h>
#import <TXLiteAVSDK_Professional/TRTCCloudDelegate.h>
#import <TXLiteAVSDK_Professional/TRTCStatistics.h>
#import <TXLiteAVSDK_Professional/TXAudioCustomProcessDelegate.h>
#import <TXLiteAVSDK_Professional/TXAudioEffectManager.h>
#import <TXLiteAVSDK_Professional/TXAudioRawDataDelegate.h>
#import <TXLiteAVSDK_Professional/TXBeautyManager.h>
#import <TXLiteAVSDK_Professional/TXBitrateItem.h>
#import <TXLiteAVSDK_Professional/TXCAVRoomDef.h>
#import <TXLiteAVSDK_Professional/TXCAVRoomListener.h>
#import <TXLiteAVSDK_Professional/TXDeviceManager.h>
#import <TXLiteAVSDK_Professional/TXImageSprite.h>
#import <TXLiteAVSDK_Professional/TXLiteAVCode.h>
#import <TXLiteAVSDK_Professional/TXLiveAudioSessionDelegate.h>
#import <TXLiteAVSDK_Professional/TXLiveBase.h>
#import <TXLiteAVSDK_Professional/TXLivePlayConfig.h>
#import <TXLiteAVSDK_Professional/TXLivePlayListener.h>
#import <TXLiteAVSDK_Professional/TXLivePlayer.h>
#import <TXLiteAVSDK_Professional/TXLivePush.h>
#import <TXLiteAVSDK_Professional/TXLivePushConfig.h>
#import <TXLiteAVSDK_Professional/TXLivePushListener.h>
#import <TXLiteAVSDK_Professional/TXLiveRecordListener.h>
#import <TXLiteAVSDK_Professional/TXLiveRecordTypeDef.h>
#import <TXLiteAVSDK_Professional/TXLiveSDKEventDef.h>
#import <TXLiteAVSDK_Professional/TXLiveSDKTypeDef.h>
#import <TXLiteAVSDK_Professional/TXPlayerAuthParams.h>
#import <TXLiteAVSDK_Professional/TXUGCBase.h>
#import <TXLiteAVSDK_Professional/TXUGCPartsManager.h>
#import <TXLiteAVSDK_Professional/TXUGCRecord.h>
#import <TXLiteAVSDK_Professional/TXUGCRecordListener.h>
#import <TXLiteAVSDK_Professional/TXUGCRecordTypeDef.h>
#import <TXLiteAVSDK_Professional/TXVideoCustomProcessDelegate.h>
#import <TXLiteAVSDK_Professional/TXVideoEditer.h>
#import <TXLiteAVSDK_Professional/TXVideoEditerListener.h>
#import <TXLiteAVSDK_Professional/TXVideoEditerTypeDef.h>
#import <TXLiteAVSDK_Professional/TXVodDownloadManager.h>
#import <TXLiteAVSDK_Professional/TXVodPlayConfig.h>
#import <TXLiteAVSDK_Professional/TXVodPlayListener.h>
#import <TXLiteAVSDK_Professional/TXVodPlayer.h>
#import <TXLiteAVSDK_Professional/V2TXLiveCode.h>
#import <TXLiteAVSDK_Professional/V2TXLiveDef.h>
#import <TXLiteAVSDK_Professional/V2TXLivePlayer.h>
#import <TXLiteAVSDK_Professional/V2TXLivePlayerObserver.h>
#import <TXLiteAVSDK_Professional/V2TXLivePremier.h>
#import <TXLiteAVSDK_Professional/V2TXLivePusher.h>
#import <TXLiteAVSDK_Professional/V2TXLivePusherObserver.h>
#ifndef TXLiveAudioSessionDelegate_h
#define TXLiveAudioSessionDelegate_h
#import <AVFoundation/AVFoundation.h>
@protocol TXLiveAudioSessionDelegate <NSObject>
#if TARGET_OS_IPHONE
@optional
- (BOOL)setActive:(BOOL)active error:(NSError **)outError;
@optional
- (BOOL)setActive:(BOOL)active withOptions:(AVAudioSessionSetActiveOptions)options error:(NSError **)outError;
@optional
- (BOOL)setMode:(NSString *)mode error:(NSError **)outError;
@optional
- (BOOL)setCategory:(NSString *)category error:(NSError **)outError;
@optional
- (BOOL)setCategory:(NSString *)category withOptions:(AVAudioSessionCategoryOptions)options error:(NSError **)outError;
@optional
- (BOOL)setCategory:(NSString *)category mode:(NSString *)mode options:(AVAudioSessionCategoryOptions)options error:(NSError **)outError;
@optional
- (BOOL)setPreferredIOBufferDuration:(NSTimeInterval)duration error:(NSError **)outError;
@optional
- (BOOL)setPreferredSampleRate:(double)sampleRate error:(NSError **)outError;
@optional
- (BOOL)setPreferredOutputNumberOfChannels:(NSInteger)count error:(NSError **)outError;
@optional
- (BOOL)overrideOutputAudioPort:(AVAudioSessionPortOverride)portOverride error:(NSError **)outError;
@optional
- (BOOL)setPreferredInput:(nullable AVAudioSessionPortDescription *)inPort error:(NSError **)outError;
#endif
@end
#endif /* TXLiveAudioSessionDelegate_h */
#import "TXLiveAudioSessionDelegate.h"
typedef NS_ENUM(NSInteger, TX_Enum_Type_LogLevel) {
///输出所有级别的log
LOGLEVEL_VERBOSE = 0,
/// 输出 DEBUG,INFO,WARNING,ERROR 和 FATAL 级别的log
LOGLEVEL_DEBUG = 1,
/// 输出 INFO,WARNING,ERROR 和 FATAL 级别的log
LOGLEVEL_INFO = 2,
/// 只输出WARNING,ERROR 和 FATAL 级别的log
LOGLEVEL_WARN = 3,
/// 只输出ERROR 和 FATAL 级别的log
LOGLEVEL_ERROR = 4,
/// 只输出 FATAL 级别的log
LOGLEVEL_FATAL = 5,
/// 不输出任何sdk log
LOGLEVEL_NULL = 6,
};
@protocol TXLiveBaseDelegate <NSObject>
@optional
/**
@brief Log回调 
@discussion
1.实现TXLiveBaseDelegate,建议在一个比较早的初始化类中如AppDelegate
2.在初始化中设置此回调,eg:[TXLiveBase sharedInstance].delegate = self;
3.level类型参见TX_Enum_Type_LogLevel
4.module值暂无具体意义,目前为固定值TXLiteAVSDK
*/
- (void)onLog:(NSString*)log LogLevel:(int)level WhichModule:(NSString*)module;
/**
* @brief NTP 校时回调,调用 TXLiveBase updateNetworkTime 后会触发
* @param errCode 0:表示校时成功且偏差在30ms以内,1:表示校时成功但偏差可能在 30ms 以上,-1:表示校时失败
*/
- (void)onUpdateNetworkTime:(int)errCode message:(NSString *)errMsg;
/**
@brief setLicenceURL 接口回调, result = 0 成功,负数失败。
@discussion
需在调用 setLicenceURL 前设置 delegate
*/
- (void)onLicenceLoaded:(int)result Reason:(NSString *)reason;
@end
@interface TXLiveBase : NSObject
/// 通过这个delegate将全部log回调给SDK使用者,由SDK使用者来决定log如何处理
@property (nonatomic, weak) id<TXLiveBaseDelegate> delegate;
+ (instancetype)sharedInstance;
/**
* 设置 liteav SDK 接入的环境。
* 腾讯云在全球各地区部署的环境,按照各地区政策法规要求,需要接入不同地区接入点。
*
* @param env_config 需要接入的环境,SDK 默认接入的环境是:默认正式环境。
* @return 0:成功;其他:错误
*
* @note 目标市场为中国大陆的客户请不要调用此接口,如果目标市场为海外用户,请通过技术支持联系我们,了解 env_config 的配置方法,以确保 App 遵守 GDPR 标准。
*/
+ (int)setGlobalEnv:(const char *)env_config;
/**
* 设置 log 输出级别
* @param level 参见 LOGLEVEL
*/
+ (void)setLogLevel:(TX_Enum_Type_LogLevel)level;
/**
* 启用或禁用控制台日志打印
* @param enabled 指定是否启用
*/
+ (void)setConsoleEnabled:(BOOL)enabled;
+ (void)setAppVersion:(NSString *)verNum;
+ (void)setAudioSessionDelegate:(id<TXLiveAudioSessionDelegate>)delegate;
/**
* @brief 获取 SDK 版本信息
* @return SDK 版本信息
*/
+ (NSString *)getSDKVersionStr;
/**
* @brief 获取 pitu 版本信息
* @return pitu 版本信息
*/
+ (NSString *)getPituSDKVersion;
/**
* @brief 设置 appID,云控使用
*/
+ (void)setAppID:(NSString*)appID;
/**
* @brief 设置 sdk 的 Licence 下载 url 和 key
*/
+ (void)setLicenceURL:(NSString *)url key:(NSString *)key;
/**
* @brief 设置 userId,用于数据上报
*/
+ (void)setUserId:(NSString *)userId;
/**
* @brief 获取 Licence 信息
* @return Licence 信息
*/
+ (NSString *)getLicenceInfo;
/**
* @brief 设置 HEVC 外部解码器工厂实例
*/
+ (void)setExternalDecoderFactory:(id)decoderFactory;
/**
* 启动 NTP 校时服务
*
* @return 0:启动成功;< 0:启动失败
*/
+ (NSInteger)updateNetworkTime;
/**
* 获取 NTP 时间戳(毫秒),请在收到 onUpdateNetworkTime 回调后使用
*
* @return NTP 时间戳(毫秒),若返回 0:未启动 NTP 校时或校时失败,请重启校时
*/
+ (NSInteger)getNetworkTimestamp;
@end
/*
* Module: TXLivePlayConfig @ TXLiteAVSDK
*
* Function: 腾讯云直播播放器的参数配置模块
*
* Version: <:Version:>
*/
#import <Foundation/Foundation.h>
/// @defgroup TXLivePlayConfig_ios TXLivePlayConfig
/// 腾讯云直播播放器的参数配置模块
/// @{
/**
* 腾讯云直播播放器的参数配置模块
*
* 主要负责 TXLivePlayer 对应的参数设置,其中绝大多数设置项在播放开始之后再设置是无效的。
*/
@interface TXLivePlayConfig : NSObject
/////////////////////////////////////////////////////////////////////////////////
//
// 常用设置项
//
/////////////////////////////////////////////////////////////////////////////////
///【字段含义】播放器缓存时间,单位秒,取值需要大于0,默认值:5
@property(nonatomic, assign) float cacheTime;
///【字段含义】是否自动调整播放器缓存时间,默认值:YES
/// YES:启用自动调整,自动调整的最大值和最小值可以分别通过修改 maxCacheTime 和 minCacheTime 来设置
/// NO:关闭自动调整,采用默认的指定缓存时间(1s),可以通过修改 cacheTime 来调整缓存时间
@property(nonatomic, assign) BOOL bAutoAdjustCacheTime;
///【字段含义】播放器缓存自动调整的最大时间,单位秒,取值需要大于0,默认值:5
@property(nonatomic, assign) float maxAutoAdjustCacheTime;
///【字段含义】播放器缓存自动调整的最小时间,单位秒,取值需要大于0,默认值为1
@property(nonatomic, assign) float minAutoAdjustCacheTime;
///【字段含义】播放器视频卡顿报警阈值,单位毫秒
///【推荐取值】800
///【特别说明】只有渲染间隔超过这个阈值的卡顿才会有 PLAY_WARNING_VIDEO_PLAY_LAG 通知
@property(nonatomic, assign) int videoBlockThreshold;
///【字段含义】播放器遭遇网络连接断开时 SDK 默认重试的次数,取值范围1 - 10,默认值:3。
@property(nonatomic, assign) int connectRetryCount;
///【字段含义】网络重连的时间间隔,单位秒,取值范围3 - 30,默认值:3。
@property(nonatomic, assign) int connectRetryInterval;
///【字段含义】是否开启回声消除, 默认值为 NO
@property(nonatomic, assign) BOOL enableAEC;
///【字段含义】是否开启消息通道, 默认值为 NO
@property(nonatomic, assign) BOOL enableMessage;
///【字段含义】是否开启 MetaData 数据回调,默认值为 NO。
/// YES:SDK 通过 EVT_PLAY_GET_METADATA 消息抛出视频流的 MetaData 数据;
/// NO:SDK 不抛出视频流的 MetaData 数据。
/// 标准直播流都会在最开始的阶段有一个 MetaData 数据头,该数据头支持定制。
/// 您可以通过 TXLivePushConfig 中的 metaData 属性设置一些自定义数据,再通过 TXLivePlayListener 中的
/// onPlayEvent(EVT_PLAY_GET_METADATA) 消息接收到这些数据。
///【特别说明】每条音视频流中只能设置一个 MetaData 数据头,除非断网重连,否则 TXLivePlayer 的 EVT_PLAY_GET_METADATA 消息也只会收到一次。
@property(nonatomic, assign) BOOL enableMetaData;
///【字段含义】是否开启 HTTP 头信息回调,默认值为 @“”
/// HTTP 响应头中除了“content-length”、“content-type”等标准字段,不同云服务商还可能会添加一些非标准字段。
/// 比如腾讯云会在直播 CDN 的 HTTP-FLV 格式的直播流中增加 “X-Tlive-SpanId” 响应头,并在其中设置一个随机字符串,用来唯一标识一次直播。
///
/// 如果您在使用腾讯云的直播 CDN,可以设置 flvSessionKey 为 @“X-Tlive-SpanId”,SDK 会在 HTTP 响应头里解析这个字段,
/// 并通过 TXLivePlayListener 中的 onPlayEvent(EVT_PLAY_GET_FLVSESSIONKEY) 事件通知给您的 App。
///
///【特别说明】每条音视频流中只能解析一个 flvSessionKey,除非断网重连,否则 EVT_PLAY_GET_FLVSESSIONKEY 只会抛送一次。
@property(nonatomic, copy) NSString* flvSessionKey;
///【字段含义】视频渲染对象回调的视频格式,默认值:kCVPixelFormatType_420YpCbCr8Planar
///【特别说明】支持:kCVPixelFormatType_420YpCbCr8Planar 和 kCVPixelFormatType_420YpCbCr8BiPlanarFullRange
@property(nonatomic, assign) OSType playerPixelFormatType;
/////////////////////////////////////////////////////////////////////////////////
//
// 待废弃设置项
//
/////////////////////////////////////////////////////////////////////////////////
///【字段含义】是否开启就近选路,待废弃,默认值:YES
@property(nonatomic, assign) BOOL enableNearestIP;
///【字段含义】RTMP 传输通道的类型,待废弃,默认值为:RTMP_CHANNEL_TYPE_AUTO
@property (nonatomic, assign) int rtmpChannelType;
///【字段含义】视频缓存目录,点播 MP4、HLS 有效
@property NSString *cacheFolderPath;
///【字段含义】最多缓存文件个数,默认值:0
@property int maxCacheItems;
///【字段含义】自定义 HTTP Headers
@property NSDictionary *headers;
@end
/// @}
/*
* Module: TXLivePlayListener @ TXLiteAVSDK
*
* Function: 腾讯云直播播放的回调通知
*
* Version: <:Version:>
*/
#import <Foundation/Foundation.h>
#import "TXLiveSDKTypeDef.h"
/// @defgroup TXLivePlayListener_ios TXLivePlayListener
/// 腾讯云直播播放的回调通知
/// @{
@protocol TXLivePlayListener <NSObject>
/**
* 直播事件通知
* @param EvtID 参见 TXLiveSDKEventDef.h
* @param param 参见 TXLiveSDKTypeDef.h
*/
- (void)onPlayEvent:(int)EvtID withParam:(NSDictionary *)param;
/**
* 网络状态通知
* @param param 参见 TXLiveSDKTypeDef.h
*/
- (void)onNetStatus:(NSDictionary *)param;
@end
/// @}