LiteAVSDK
腾讯云音视频 SDK ,服务于数万家企业客户的高可用组件,致力于最大限度地节省您的研发成本。

结构体

class  AudioMusicParam
 
class  IDeprecatedTRTCCloud
 
class  ITRTCAudioFrameCallback
 
class  ITRTCCloud
 
class  ITRTCCloudCallback
 
class  ITRTCLogCallback
 
class  ITRTCScreenCaptureSourceList
 
class  ITRTCVideoFrameCallback
 
class  ITRTCVideoRenderCallback
 
class  ITXAudioEffectManager
 
class  ITXDeviceCollection
 
class  ITXDeviceInfo
 
class  ITXDeviceManager
 
class  ITXDeviceObserver
 
class  ITXMusicPlayObserver
 
class  IV2TXLiveScreenCaptureSourceList
 
struct  RECT
 
struct  SIZE
 
struct  TRTCAudioEffectParam
 
struct  TRTCAudioFrame
 
struct  TRTCAudioFrameCallbackFormat
 
struct  TRTCAudioRecordingParams
 
struct  TRTCImageBuffer
 
struct  TRTCLocalRecordingParams
 
struct  TRTCLocalStatistics
 
struct  TRTCMixUser
 
struct  TRTCNetworkQosParam
 
struct  TRTCParams
 
struct  TRTCPublishCDNParam
 
struct  TRTCQualityInfo
 
struct  TRTCRemoteStatistics
 
struct  TRTCRenderParams
 
struct  TRTCScreenCaptureProperty
 
struct  TRTCScreenCaptureSourceInfo
 
struct  TRTCSpeedTestResult
 
struct  TRTCStatistics
 
struct  TRTCSwitchRoomConfig
 
struct  TRTCTranscodingConfig
 
struct  TRTCVideoEncParam
 
struct  TRTCVideoFrame
 
struct  TRTCVolumeInfo
 
struct  TXCameraCaptureParam
 
struct  V2TXLiveAudioFrame
 
struct  V2TXLiveAudioFrameObserverFormat
 
struct  V2TXLiveImage
 
class  V2TXLivePlayer
 
class  V2TXLivePlayerObserver
 
struct  V2TXLivePlayerStatistics
 
class  V2TXLivePremier
 
class  V2TXLivePremierObserver
 
class  V2TXLivePusher
 
class  V2TXLivePusherObserver
 
struct  V2TXLivePusherStatistics
 
struct  V2TXLiveScreenCaptureProperty
 
struct  V2TXLiveScreenCaptureSourceInfo
 
struct  V2TXLiveVideoEncoderParam
 
struct  V2TXLiveVideoFrame
 

类型定义

typedef HWND TXView
 
typedef TXMediaDeviceType TRTCDeviceType
 
typedef TXMediaDeviceState TRTCDeviceState
 
typedef ITXDeviceCollection ITRTCDeviceCollection
 
typedef ITXDeviceInfo ITRTCDeviceInfo
 

枚举

enum  TRTCVideoResolution
 
enum  TRTCVideoResolutionMode
 
enum  TRTCVideoStreamType
 
enum  TRTCVideoFillMode
 
enum  TRTCVideoRotation
 
enum  TRTCBeautyStyle
 
enum  TRTCVideoPixelFormat
 
enum  TRTCVideoBufferType
 
enum  TRTCVideoMirrorType
 
enum  TRTCSnapshotSourceType
 
enum  TRTCAppScene
 
enum  TRTCRoleType
 
enum  TRTCQosControlMode
 
enum  TRTCVideoQosPreference
 
enum  TRTCQuality
 
enum  TRTCAVStatusType
 
enum  TRTCAVStatusChangeReason
 
enum  TRTCAudioQuality
 
enum  TRTCAudioFrameFormat
 
enum  TRTCLogLevel
 
enum  TRTCScreenCaptureSourceType
 
enum  TRTCTranscodingConfigMode
 
enum  TRTCLocalRecordType
 
enum  TRTCMixInputType
 
enum  TRTCWaterMarkSrcType
 
enum  TRTCAudioRecordingContent
 
enum  V2TXLiveCode
 
enum  V2TXLiveMode
 

音效相关的枚举值定义

enum  TXVoiceReverbType
 

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

enum  TXSystemVolumeType
 
enum  TXAudioRoute
 
enum  TXMediaDeviceType
 
enum  TXMediaDeviceState
 
enum  TXCameraCaptureMode
 

视频相关类型定义

enum  V2TXLiveVideoResolution
 
enum  V2TXLiveVideoResolutionMode
 
enum  V2TXLiveMirrorType
 
enum  V2TXLiveFillMode
 
enum  V2TXLiveRotation
 
enum  V2TXLivePixelFormat
 
enum  V2TXLiveBufferType
 

音频相关类型定义

enum  V2TXLiveAudioQuality
 

连接状态相关枚举值定义

enum  V2TXLivePushStatus
 

音视频状态有关的枚举值的定义

enum  V2TXLivePlayStatus
 
enum  V2TXLiveStatusChangeReason
 

公共配置组件有关的枚举值的定义

enum  V2TXLiveImageType
 

屏幕分享有关的定义

enum  V2TXLiveScreenCaptureSourceType
 

枚举类型说明

◆ TXAudioRoute

音频路由(即声音的播放模式)

音频路由,即声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。 手机有两个扬声器:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。

  • 设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
  • 设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
枚举值
TXAudioRouteSpeakerphone 

Speakerphone:使用扬声器播放(即“免提”),扬声器位于手机底部,声音偏大,适合外放音乐。

TXAudioRouteEarpiece 

Earpiece:使用听筒播放,听筒位于手机顶部,声音偏小,适合需要保护隐私的通话场景。

◆ TXCameraCaptureMode

摄像头采集偏好

该枚举类型用于摄像头采集参数设置。

枚举值
TXCameraResolutionStrategyAuto 

自动调整采集参数。 SDK 根据实际的采集设备性能及网络情况,选择合适的摄像头输出参数,在设备性能及视频预览质量之间,维持平衡。

TXCameraResolutionStrategyPerformance 

优先保证设备性能。 SDK 根据用户设置编码器的分辨率和帧率,选择最接近的摄像头输出参数,从而保证设备性能。

TXCameraResolutionStrategyHighQuality 

优先保证视频预览质量。 SDK选择较高的摄像头输出参数,从而提高预览视频的质量。在这种情况下,会消耗更多的 CPU 及内存做视频前处理。

TXCameraCaptureManual 

允许用户设置本地摄像头采集的视频宽高。

◆ TXMediaDeviceState

设备操作

该枚举值用于本地设备的状态变化通知onDeviceChanged

枚举值
TXMediaDeviceStateAdd 

设备已被插入

TXMediaDeviceStateRemove 

设备已被移除

TXMediaDeviceStateActive 

设备已启用

◆ TXMediaDeviceType

设备类型(仅适用于桌面平台)

该枚举值用于定义三种类型的音视频设备,即摄像头、麦克风和扬声器,以便让一套设备管理接口可以操控三种不同类型的设备。

枚举值
TXMediaDeviceTypeUnknown 

undefined device type

TXMediaDeviceTypeMic 

microphone

TXMediaDeviceTypeSpeaker 

speaker or earpiece

TXMediaDeviceTypeCamera 

camera

◆ TXSystemVolumeType

系统音量类型(仅适用于移动设备)

现代智能手机中一般都具备两套系统音量类型,即“通话音量”和“媒体音量”。

  • 通话音量:手机专门为接打电话所设计的音量类型,自带回声抵消(AEC)功能,并且支持通过蓝牙耳机上的麦克风进行拾音,缺点是音质比较一般。 当您通过手机侧面的音量按键下调手机音量时,如果无法将其调至零(也就是无法彻底静音),说明您的手机当前出于通话音量。
  • 媒体音量:手机专门为音乐场景所设计的音量类型,无法使用系统的 AEC 功能,并且不支持通过蓝牙耳机的麦克风进行拾音,但具备更好的音乐播放效果。 当您通过手机侧面的音量按键下调手机音量时,如果能够将手机音量调至彻底静音,说明您的手机当前出于媒体音量。

SDK 目前提供了三种系统音量类型的控制模式:自动切换模式、全程通话音量模式、全程媒体音量模式。

枚举值
TXSystemVolumeTypeAuto 

自动切换模式: 也被称为“麦上通话,麦下媒体”,即主播上麦时使用通话音量,观众不上麦则使用媒体音量,适合在线直播场景。

TXSystemVolumeTypeMedia 

全程媒体音量: 通话全程使用媒体音量,并不是非常常用的音量类型,适用于对音质要求比较苛刻的音乐场景中。 如果您的用户大都使用外接设备(比如外接声卡)为主,可以使用该模式,否则请慎用。

TXSystemVolumeTypeVOIP 

全程通话音量: 该方案的优势在于用户在上下麦时音频模块无需切换工作模式,可以做到无缝上下麦,适合于用户需要频繁上下麦的应用场景。

◆ TXVoiceReverbType

混响特效

混响特效可以作用于人声之上,通过声学算法对声音进行叠加处理,模拟出各种不同环境下的临场感受,目前支持如下几种混响效果: 0:关闭;1:KTV;2:小房间;3:大会堂;4:低沉;5:洪亮;6:金属声;7:磁性;8:空灵;9:录音棚;10:悠扬。

枚举值
TXLiveVoiceReverbType_0 

disable

TXLiveVoiceReverbType_1 

KTV

TXLiveVoiceReverbType_2 

small room

TXLiveVoiceReverbType_3 

great hall

TXLiveVoiceReverbType_4 

deep voice

TXLiveVoiceReverbType_5 

loud voice

TXLiveVoiceReverbType_6 

metallic sound

TXLiveVoiceReverbType_7 

magnetic sound

TXLiveVoiceReverbType_8 

ethereal

TXLiveVoiceReverbType_9 

studio

TXLiveVoiceReverbType_10 

melodious

◆ V2TXLiveAudioQuality

声音音质。

枚举值
V2TXLiveAudioQualitySpeech 

语音音质:采样率:16k;单声道;音频码率:16kbps;适合语音通话为主的场景,比如在线会议,语音通话

V2TXLiveAudioQualityDefault 

默认音质:采样率:48k;单声道;音频码率:50kbps;SDK 默认的音频质量,如无特殊需求推荐选择之

V2TXLiveAudioQualityMusic 

音乐音质:采样率:48k;双声道 + 全频带;音频码率:128kbps;适合需要高保真传输音乐的场景,比如K歌、音乐直播等

◆ V2TXLiveBufferType

视频数据包装格式。

注意
在自定义采集和自定义渲染功能,您需要用到下列枚举值来指定您希望以什么样的格式来包装视频数据。
枚举值
V2TXLiveBufferTypeUnknown 

未知

V2TXLiveBufferTypeByteBuffer 

二进制Buffer类型

◆ V2TXLiveCode

枚举值
V2TXLIVE_OK 

没有错误

V2TXLIVE_ERROR_FAILED 

暂未归类的通用错误

V2TXLIVE_ERROR_INVALID_PARAMETER 

调用 API 时,传入的参数不合法

V2TXLIVE_ERROR_REFUSED 

API 调用被拒绝

V2TXLIVE_ERROR_NOT_SUPPORTED 

当前 API 不支持调用

V2TXLIVE_ERROR_INVALID_LICENSE 

license 不合法,调用失败

V2TXLIVE_ERROR_REQUEST_TIMEOUT 

请求服务器超时

V2TXLIVE_ERROR_SERVER_PROCESS_FAILED 

服务器无法处理您的请求

V2TXLIVE_WARNING_NETWORK_BUSY 

网络状况不佳:上行带宽太小,上传数据受阻

V2TXLIVE_WARNING_VIDEO_BLOCK 

当前视频播放出现卡顿

V2TXLIVE_WARNING_CAMERA_START_FAILED 

摄像头打开失败

V2TXLIVE_WARNING_CAMERA_OCCUPIED 

摄像头正在被占用中,可尝试打开其他摄像头

V2TXLIVE_WARNING_CAMERA_NO_PERMISSION 

摄像头设备未授权,通常在移动设备出现,可能是权限被用户拒绝了

V2TXLIVE_WARNING_MICROPHONE_START_FAILED 

麦克风打开失败

V2TXLIVE_WARNING_MICROPHONE_OCCUPIED 

麦克风正在被占用中,例如移动设备正在通话时,打开麦克风会失败

V2TXLIVE_WARNING_MICROPHONE_NO_PERMISSION 

麦克风设备未授权,通常在移动设备出现,可能是权限被用户拒绝了

V2TXLIVE_WARNING_SCREEN_CAPTURE_NOT_SUPPORTED 

当前系统不支持屏幕分享

V2TXLIVE_WARNING_SCREEN_CAPTURE_START_FAILED 

开始录屏失败,如果在移动设备出现,可能是权限被用户拒绝了

V2TXLIVE_WARNING_SCREEN_CAPTURE_INTERRUPTED 

录屏被系统中断

◆ V2TXLiveFillMode

视频画面填充模式。

枚举值
V2TXLiveFillModeFill 

图像铺满屏幕,超出显示视窗的视频部分将被裁剪,画面显示可能不完整

V2TXLiveFillModeFit 

图像长边填满屏幕,短边区域会被填充黑色,画面的内容完整

◆ V2TXLiveImageType

图片类型.

枚举值
V2TXLiveImageTypeFile 

图片文件路径,支持 GIF、JPEG、PNG文件格式

V2TXLiveImageTypeBGRA32 

BGRA32格式内存块

V2TXLiveImageTypeRGBA32 

RGBA32格式内存块

◆ V2TXLiveMirrorType

本地摄像头镜像类型。

枚举值
V2TXLiveMirrorTypeAuto 

系统默认镜像类型,前置摄像头镜像,后置摄像头不镜像

V2TXLiveMirrorTypeEnable 

前置摄像头和后置摄像头,都切换为镜像模式

V2TXLiveMirrorTypeDisable 

前置摄像头和后置摄像头,都切换为非镜像模式

◆ V2TXLiveMode

支持协议

枚举值
V2TXLiveModeNotSupported 
V2TXLiveModeRTMP 
V2TXLiveModeRTC 

支持协议: TRTC

◆ V2TXLivePixelFormat

视频帧的像素格式。

枚举值
V2TXLivePixelFormatUnknown 

未知

V2TXLivePixelFormatI420 

YUV420P I420

V2TXLivePixelFormatBGRA32 

BGRA8888

◆ V2TXLivePlayStatus

直播流的播放状态。

枚举值
V2TXLivePlayStatusStopped 

播放停止

V2TXLivePlayStatusPlaying 

正在播放

V2TXLivePlayStatusLoading 

正在缓冲(首次加载不会抛出 Loading 事件)

◆ V2TXLivePushStatus

直播流连接状态

枚举值
V2TXLivePushStatusDisconnected 

与服务器断开连接

V2TXLivePushStatusConnecting 

正在连接服务器

V2TXLivePushStatusConnectSuccess 

连接服务器成功

V2TXLivePushStatusReconnecting 

重连服务器中

◆ V2TXLiveRotation

视频画面顺时针旋转角度。

枚举值
V2TXLiveRotation0 

不旋转

V2TXLiveRotation90 

顺时针旋转90度

V2TXLiveRotation180 

顺时针旋转180度

V2TXLiveRotation270 

顺时针旋转270度

◆ V2TXLiveScreenCaptureSourceType

屏幕分享目标信息

枚举值
V2TXLiveScreenCaptureSourceTypeUnknown 

未知

V2TXLiveScreenCaptureSourceTypeWindow 

该分享目标是某一个窗口

V2TXLiveScreenCaptureSourceTypeScreen 

该分享目标是整个桌面

V2TXLiveScreenCaptureSourceTypeCustom 

自定义窗口类型

◆ V2TXLiveStatusChangeReason

直播流的播放状态变化原因

枚举值
V2TXLiveStatusChangeReasonInternal 

内部原因

V2TXLiveStatusChangeReasonBufferingBegin 

开始网络缓冲

V2TXLiveStatusChangeReasonBufferingEnd 

结束网络缓冲

V2TXLiveStatusChangeReasonLocalStarted 

本地启动播放

V2TXLiveStatusChangeReasonLocalStopped 

本地停止播放

V2TXLiveStatusChangeReasonRemoteStarted 

远端可播放

V2TXLiveStatusChangeReasonRemoteStopped 

远端流停止或中断

V2TXLiveStatusChangeReasonRemoteOffline 

远端流离线

◆ V2TXLiveVideoResolution

视频分辨率

枚举值
V2TXLiveVideoResolution160x160 

分辨率 160*160,码率范围:100Kbps ~ 150Kbps,帧率:15fps

V2TXLiveVideoResolution270x270 

分辨率 270*270,码率范围:200Kbps ~ 300Kbps,帧率:15fps

V2TXLiveVideoResolution480x480 

分辨率 480*480,码率范围:350Kbps ~ 525Kbps,帧率:15fps

V2TXLiveVideoResolution320x240 

分辨率 320*240,码率范围:250Kbps ~ 375Kbps,帧率:15fps

V2TXLiveVideoResolution480x360 

分辨率 480*360,码率范围:400Kbps ~ 600Kbps,帧率:15fps

V2TXLiveVideoResolution640x480 

分辨率 640*480,码率范围:600Kbps ~ 900Kbps,帧率:15fps

V2TXLiveVideoResolution320x180 

分辨率 320*180,码率范围:250Kbps ~ 400Kbps,帧率:15fps

V2TXLiveVideoResolution480x270 

分辨率 480*270,码率范围:350Kbps ~ 550Kbps,帧率:15fps

V2TXLiveVideoResolution640x360 

分辨率 640*360,码率范围:500Kbps ~ 900Kbps,帧率:15fps

V2TXLiveVideoResolution960x540 

分辨率 960*540,码率范围:800Kbps ~ 1500Kbps,帧率:15fps

V2TXLiveVideoResolution1280x720 

分辨率 1280*720,码率范围:1000Kbps ~ 1800Kbps,帧率:15fps

V2TXLiveVideoResolution1920x1080 

分辨率 1920*1080,码率范围:2500Kbps ~ 3000Kbps,帧率:15fps

◆ V2TXLiveVideoResolutionMode

视频宽高比模式。

注意
  • 横屏模式下的分辨率: V2TXLiveVideoResolution640_360 + V2TXLiveVideoResolutionModeLandscape = 640x360
  • 竖屏模式下的分辨率: V2TXLiveVideoResolution640_360 + V2TXLiveVideoResolutionModePortrait = 360x640
枚举值
V2TXLiveVideoResolutionModeLandscape 

横屏模式

V2TXLiveVideoResolutionModePortrait 

竖屏模式