Copyright (c) 2021 Tencent. All rights reserved.
Module: V2TXLiveDef @ TXLiteAVSDK
Function: 腾讯云直播服务(LVB)关键类型定义
类型定义
结构体类型
函数列表 | 描述 |
视频编码参数 | |
视频帧信息 | |
音频帧数据 | |
音频帧回调格式 | |
推流器的统计数据 | |
播放器的统计数据 | |
云端混流中每一路子画面的位置信息 | |
云端混流（转码）配置 | |
本地录制音视频配置 | |
socks5 代理的协议配置 | |
Log配置 | |
支持自适应切换的码流信息 |
枚举类型
枚举类型 | 描述 |
支持协议 | |
视频分辨率 | |
视频宽高比模式 | |
本地摄像头镜像类型 | |
视频画面填充模式 | |
视频画面顺时针旋转角度 | |
视频帧的像素格式 | |
视频数据包装格式 | |
视频纹理包装类 | |
声音音质 | |
音频回调数据读写模式 | |
直播流的连接状态 | |
混流输入类型配置 | |
本地音视频录制模式 | |
日志级别枚举值 |
V2TXLiveMode
V2TXLiveMode
支持协议
枚举 | 取值 | 描述 |
TXLiveMode_RTMP | Not Defined | 支持协议: RTMP。 |
TXLiveMode_RTC | Not Defined | 支持协议: TRTC。 |
V2TXLiveVideoResolution
V2TXLiveVideoResolution
视频分辨率
枚举 | 取值 | 描述 |
V2TXLiveVideoResolution160x160 | Not Defined | 分辨率 160*160，码率范围：100Kbps ~ 150Kbps，帧率：15fps。 |
V2TXLiveVideoResolution270x270 | Not Defined | 分辨率 270*270，码率范围：200Kbps ~ 300Kbps，帧率：15fps。 |
V2TXLiveVideoResolution480x480 | Not Defined | 分辨率 480*480，码率范围：350Kbps ~ 525Kbps，帧率：15fps。 |
V2TXLiveVideoResolution320x240 | Not Defined | 分辨率 320*240，码率范围：250Kbps ~ 375Kbps，帧率：15fps。 |
V2TXLiveVideoResolution480x360 | Not Defined | 分辨率 480*360，码率范围：400Kbps ~ 600Kbps，帧率：15fps。 |
V2TXLiveVideoResolution640x480 | Not Defined | 分辨率 640*480，码率范围：600Kbps ~ 900Kbps，帧率：15fps。 |
V2TXLiveVideoResolution320x180 | Not Defined | 分辨率 320*180，码率范围：250Kbps ~ 400Kbps，帧率：15fps。 |
V2TXLiveVideoResolution480x270 | Not Defined | 分辨率 480*270，码率范围：350Kbps ~ 550Kbps，帧率：15fps。 |
V2TXLiveVideoResolution640x360 | Not Defined | 分辨率 640*360，码率范围：500Kbps ~ 900Kbps，帧率：15fps。 |
V2TXLiveVideoResolution960x540 | Not Defined | 分辨率 960*540，码率范围：800Kbps ~ 1500Kbps，帧率：15fps。 |
V2TXLiveVideoResolution1280x720 | Not Defined | 分辨率 1280*720，码率范围：1000Kbps ~ 1800Kbps，帧率：15fps。 |
V2TXLiveVideoResolution1920x1080 | Not Defined | 分辨率 1920*1080，码率范围：2500Kbps ~ 3000Kbps，帧率：15fps。 |
V2TXLiveVideoResolutionMode
V2TXLiveVideoResolutionMode
视频宽高比模式
注意
横屏模式下的分辨率: V2TXLiveVideoResolution640x360 + V2TXLiveVideoResolutionModeLandscape = 640 × 360。
竖屏模式下的分辨率: V2TXLiveVideoResolution640x360 + V2TXLiveVideoResolutionModePortrait = 360 × 640。
枚举 | 取值 | 描述 |
V2TXLiveVideoResolutionModeLandscape | Not Defined | 横屏模式。 |
V2TXLiveVideoResolutionModePortrait | Not Defined | 竖屏模式。 |
V2TXLiveMirrorType
V2TXLiveMirrorType
本地摄像头镜像类型
枚举 | 取值 | 描述 |
V2TXLiveMirrorTypeAuto | Not Defined | 系统默认镜像类型，前置摄像头镜像，后置摄像头不镜像。 |
V2TXLiveMirrorTypeEnable | Not Defined | 前置摄像头和后置摄像头，都切换为镜像模式。 |
V2TXLiveMirrorTypeDisable | Not Defined | 前置摄像头和后置摄像头，都切换为非镜像模式。 |
V2TXLiveFillMode
V2TXLiveFillMode
视频画面填充模式
枚举 | 取值 | 描述 |
V2TXLiveFillModeFill | Not Defined | 图像铺满屏幕，超出显示视窗的视频部分将被裁剪，画面显示可能不完整。 |
V2TXLiveFillModeFit | Not Defined | 图像长边填满屏幕，短边区域会被填充黑色，画面的内容完整。 |
V2TXLiveFillModeScaleFill | Not Defined | 图像拉伸铺满，因此长度和宽度可能不会按比例变化。 |
V2TXLiveRotation
V2TXLiveRotation
视频画面顺时针旋转角度
枚举 | 取值 | 描述 |
V2TXLiveRotation0 | Not Defined | 不旋转。 |
V2TXLiveRotation90 | Not Defined | 顺时针旋转90度。 |
V2TXLiveRotation180 | Not Defined | 顺时针旋转180度。 |
V2TXLiveRotation270 | Not Defined | 顺时针旋转270度。 |
V2TXLivePixelFormat
V2TXLivePixelFormat
视频帧的像素格式
枚举 | 取值 | 描述 |
V2TXLivePixelFormatUnknown | Not Defined | 未知。 |
V2TXLivePixelFormatI420 | Not Defined | YUV420P I420。 |
V2TXLivePixelFormatTexture2D | Not Defined | OpenGL 2D 纹理。 |
V2TXLiveBufferType
V2TXLiveBufferType
视频数据包装格式
注意
在自定义采集和自定义渲染功能，您需要用到下列枚举值来指定您希望以什么类型的容器来包装视频数据。
Texture: 直接使用时效率最高。
枚举 | 取值 | 描述 |
V2TXLiveBufferTypeUnknown | Not Defined | 未知。 |
V2TXLiveBufferTypeByteBuffer | Not Defined | DirectBuffer，装载 I420 等 buffer，在 native 层使用。 |
V2TXLiveBufferTypeByteArray | Not Defined | byte[]，装载 I420 等 buffer，在 Java 层使用。 |
V2TXLiveBufferTypeTexture | Not Defined | 直接操作纹理 ID，性能最好，画质损失最少。 |
V2TXLiveTexture
V2TXLiveTexture
视频纹理包装类
枚举 | 取值 | 描述 |
public int textureId | Not Defined | 视频纹理 ID。 |
public javax.microedition.khronos.egl.EGLContext eglContext10 | Not Defined | 使用 (javax.microedition.khronos.egl.*) 定义的 OpenGL 接口。 |
public android.opengl.EGLContext eglContext14 | Not Defined | 使用 (android.opengl.*) 定义的 OpenGL 接口。 |
V2TXLiveAudioQuality
V2TXLiveAudioQuality
声音音质
枚举 | 取值 | 描述 |
V2TXLiveAudioQualitySpeech | Not Defined | 语音音质：采样率：16k；单声道；音频码率：16kbps；适合语音通话为主的场景，比如在线会议，语音通话。 |
V2TXLiveAudioQualityDefault | Not Defined | 默认音质：采样率：48k；单声道；音频码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。 |
V2TXLiveAudioQualityMusic | Not Defined | 音乐音质：采样率：48k；双声道 + 全频带；音频码率：128kbps；适合需要高保真传输音乐的场景，比如K歌、音乐直播等。 |
V2TXLiveAudioFrameOperationMode
V2TXLiveAudioFrameOperationMode
音频回调数据读写模式
SDK 提供了两种音频回调数据的操作模式。
读写模式（ReadWrite）：可以获取并修改回调的音频数据，默认模式。
只读模式（ReadOnly）：仅从回调中获取音频数据。
枚举 | 取值 | 描述 |
V2TXLiveAudioFrameOperationModeReadWrite | Not Defined | 读写模式：可以获取并修改回调的音频数据。 |
V2TXLiveAudioFrameOperationModeReadOnly | Not Defined | 只读模式：仅从回调中获取音频数据。 |
V2TXLivePushStatus
V2TXLivePushStatus
直播流的连接状态
枚举 | 取值 | 描述 |
V2TXLivePushStatusDisconnected | Not Defined | 与服务器断开连接。 |
V2TXLivePushStatusConnecting | Not Defined | 正在连接服务器。 |
V2TXLivePushStatusConnectSuccess | Not Defined | 连接服务器成功。 |
V2TXLivePushStatusReconnecting | Not Defined | 重连服务器中。 |
V2TXLiveMixInputType
V2TXLiveMixInputType
混流输入类型配置
枚举 | 取值 | 描述 |
V2TXLiveMixInputTypeAudioVideo | Not Defined | 混入音视频。 |
V2TXLiveMixInputTypePureVideo | Not Defined | 只混入视频。 |
V2TXLiveMixInputTypePureAudio | Not Defined | 只混入音频。 |
V2TXLiveRecordMode
V2TXLiveRecordMode
本地音视频录制模式
枚举 | 取值 | 描述 |
V2TXLiveRecordModeBoth | Not Defined | Both mode: 录制音频和视频 |
V2TXLiveLogLevel
V2TXLiveLogLevel
日志级别枚举值
枚举 | 取值 | 描述 |
V2TXLiveLogLevelAll | 0 | 输出所有级别的 log。 |
V2TXLiveLogLevelDebug | 1 | 输出 DEBUG，INFO，WARNING，ERROR 和 FATAL 级别的 log。 |
V2TXLiveLogLevelInfo | 2 | 输出 INFO，WARNING，ERROR 和 FATAL 级别的 log。 |
V2TXLiveLogLevelWarning | 3 | 只输出 WARNING，ERROR 和 FATAL 级别的 log。 |
V2TXLiveLogLevelError | 4 | 只输出 ERROR 和 FATAL 级别的 log。 |
V2TXLiveLogLevelFatal | 5 | 只输出 FATAL 级别的 log。 |
V2TXLiveLogLevelNULL | 6 | 不输出任何 sdk log。 |
V2TXLiveVideoEncoderParam
V2TXLiveVideoEncoderParam
视频编码参数
该设置决定远端用户看到的画面质量。
枚举类型 | 描述 |
minVideoBitrate | 【字段含义】最低视频码率，SDK 会在网络不佳的情况下主动降低视频码率以保持流畅度，最低会降至 minVideoBitrate 所设定的数值。 【推荐取值】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数，用于约束 SDK 对视频码率的调整范围： 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值，等价于关闭 SDK 对视频码率的自适应调节能力。 |
videoBitrate | 【字段含义】目标视频码率，SDK 会按照目标码率进行编码，只有在弱网络环境下才会主动降低视频码率。 【推荐取值】请参考 V2TXLiveVideoResolution 在各档位注释的最佳码率，也可以在此基础上适当调高。 比如：V2TXLiveVideoResolution1280x720 对应 1200kbps 的目标码率，您也可以设置为 1500kbps 用来获得更好的观感清晰度。 【特别说明】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数，用于约束 SDK 对视频码率的调整范围： 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值，等价于关闭 SDK 对视频码率的自适应调节能力。 |
videoFps | 【字段含义】视频采集帧率。 【推荐取值】15fps 或 20fps。5fps 以下，卡顿感明显。10fps 以下，会有轻微卡顿感。20fps 以上，会浪费带宽（电影的帧率为 24fps）。 |
videoResolution | 【字段含义】 视频分辨率。 【特别说明】如需使用竖屏分辨率，请指定 videoResolutionMode 为 Portrait，例如： 640 × 360 + Portrait = 360 × 640。 【推荐取值】 桌面平台（Win + Mac）：建议选择 640 × 360 及以上分辨率，videoResolutionMode 选择 Landscape，即横屏分辨率。 |
videoResolutionMode | 【字段含义】分辨率模式（横屏分辨率 or 竖屏分辨率）。 【推荐取值】桌面平台（Windows、Mac）建议选择 Landscape。 【特别说明】如需使用竖屏分辨率，请指定 resMode 为 Portrait，例如： 640 × 360 + Portrait = 360 × 640。 |
V2TXLiveVideoFrame
V2TXLiveVideoFrame
视频帧信息
注意
自定义采集和自定义渲染时使用。自定义采集时，需要使用 V2TXLiveVideoFrame 来包装待发送的视频帧；自定义渲染时，会返回经过 V2TXLiveVideoFrame 包装的视频帧。
枚举类型 | 描述 |
buffer | 【字段含义】视频数据。 |
bufferType | 【字段含义】视频数据包装格式。 |
data | 【字段含义】视频数据。 |
height | 【字段含义】视频高度。 |
pixelFormat | 【字段含义】视频帧像素格式。 |
rotation | 【字段含义】视频帧的顺时针旋转角度。 |
texture | 【字段含义】视频纹理包装类。 |
width | 【字段含义】视频宽度。 |
V2TXLiveAudioFrame
V2TXLiveAudioFrame
音频帧数据
枚举类型 | 描述 |
channel | 【字段含义】声道数。 |
data | 【字段含义】音频数据。 |
sampleRate | 【字段含义】采样率。 |
timestamp | 【字段含义】时间戳，单位ms。 |
V2TXLiveAudioFrameObserverFormat
V2TXLiveAudioFrameObserverFormat
音频帧回调格式
枚举类型 | 描述 |
channel | 【字段含义】声道数。 【推荐取值】默认值：1，代表单声道。可设定的数值只有两个数字：1-单声道，2-双声道。 |
mode | 【字段含义】回调数据读写模式。 【推荐取值】V2TXLiveAudioFrameOperationModeReadOnly：仅从回调中获取音频数据。可设定的模式有 V2TXLiveAudioFrameOperationModeReadOnly，V2TXLiveAudioFrameOperationModeReadWrite。 |
sampleRate | 【字段含义】采样率。 【推荐取值】默认值：48000Hz。支持 16000, 32000, 44100, 48000。 |
samplesPerCall | 【字段含义】采样点数。 【推荐取值】取值必须是 sampleRate/100 的整数倍。 |
V2TXLivePusherStatistics
V2TXLivePusherStatistics
推流器的统计数据
枚举类型 | 描述 |
appCpu | 【字段含义】当前 App 的 CPU 使用率（％）。 |
audioBitrate | 【字段含义】音频码率（Kbps）。 |
fps | 【字段含义】帧率（fps）。 |
height | 【字段含义】视频高度。 |
netSpeed | 【字段含义】上行速度（kbps） |
rtt | 【字段含义】从 SDK 到云端的往返延时（ms） |
systemCpu | 【字段含义】当前系统的 CPU 使用率（％）。 |
videoBitrate | 【字段含义】视频码率（Kbps）。 |
width | 【字段含义】视频宽度。 |
V2TXLivePlayerStatistics
V2TXLivePlayerStatistics
播放器的统计数据
枚举类型 | 描述 |
appCpu | 【字段含义】当前 App 的 CPU 使用率（％）。 |
audioBitrate | 【字段含义】音频码率（Kbps）。 |
audioBlockRate | 【字段含义】音频播放卡顿率，单位（％）。 音频播放卡顿率（audioBlockRate） = 音频播放的累计卡顿时长（audioTotalBlockTime） / 音频播放的区间时长（2000ms）。 |
audioPacketLoss | 【字段含义】网络音频丢包率（％），注：仅支持前缀为 [trtc://] 或 [webrtc://] 的播放地址。 |
audioTotalBlockTime | 【字段含义】音频播放的累计卡顿时长（ms）。 该时长为区间（2s）内的卡顿时长。 |
fps | 【字段含义】帧率（fps）。 |
height | 【字段含义】视频高度。 |
jitterBufferDelay | 【字段含义】播放延迟（ms）。 |
netSpeed | 【字段含义】下载速度（kbps） |
rtt | 【字段含义】从 SDK 到云端的往返延时（ms），注：仅支持前缀为 [trtc://] 或 [webrtc://] 的播放地址。 |
systemCpu | 【字段含义】当前系统的 CPU 使用率（％）。 |
videoBitrate | 【字段含义】视频码率（Kbps）。 |
videoBlockRate | 【字段含义】视频播放卡顿率，单位（％）。 视频播放卡顿率（videoBlockRate） = 视频播放的累计卡顿时长（videoTotalBlockTime） / 视频播放的区间时长（2000ms）。 |
videoPacketLoss | 【字段含义】网络视频丢包率（％），注：仅支持前缀为 [trtc://] 或 [webrtc://] 的播放地址。 |
videoTotalBlockTime | 【字段含义】视频播放的累计卡顿时长（ms）。 该时长为区间（2s）内的卡顿时长。 |
width | 【字段含义】视频宽度。 |
V2TXLiveMixStream
V2TXLiveMixStream
云端混流中每一路子画面的位置信息
枚举类型 | 描述 |
height | 【字段含义】图层位置高度（绝对像素值）。 |
inputType | 【字段含义】该直播流的输入类型。 |
streamId | 【字段含义】参与混流的 userId 所在对应的推流 streamId，nil 表示当前推流 streamId。 |
userId | 【字段含义】参与混流的 userId。 |
width | 【字段含义】图层位置宽度（绝对像素值）。 |
x | 【字段含义】图层位置 x 坐标（绝对像素值）。 |
y | 【字段含义】图层位置 y 坐标（绝对像素值）。 |
zOrder | 【字段含义】图层层次（1 - 15）不可重复。 |
V2TXLiveTranscodingConfig
V2TXLiveTranscodingConfig
云端混流（转码）配置
枚举类型 | 描述 |
audioBitrate | 【字段含义】最终转码后的音频码率。 【推荐取值】默认值：64kbps，取值范围是 [32，192]，单位：kbps。 |
audioChannels | 【字段含义】最终转码后的音频声道数。 【推荐取值】默认值：1。取值范围为 [1,2] 中的整型。 |
audioSampleRate | 【字段含义】最终转码后的音频采样率。 【推荐取值】默认值：48000Hz。支持12000HZ、16000HZ、22050HZ、24000HZ、32000HZ、44100HZ、48000HZ。 |
backgroundColor | 【字段含义】混合后画面的底色颜色，默认为黑色，格式为十六进制数字，比如：“0x61B9F1” 代表 RGB 分别为(97,158,241)。 【推荐取值】默认值：0x000000，黑色。 |
backgroundImage | 【字段含义】混合后画面的背景图。 【推荐取值】默认值：nil，即不设置背景图。 上传成功后可以获得对应的“图片ID”，然后将“图片ID”转换成字符串类型并设置到 backgroundImage 里即可。 例如：假设“图片ID” 为 63，可以设置 backgroundImage = "63"。 |
mixStreams | 【字段含义】每一路子画面的位置信息。 |
outputStreamId | 【字段含义】输出到 CDN 上的直播流 ID。 如不设置该参数，SDK 会执行默认逻辑，即房间里的多路流会混合到该接口调用者的视频流上，也就是 A + B => A。 如果设置该参数，SDK 会将房间里的多路流混合到您指定的直播流 ID 上，也就是 A + B => C。 【推荐取值】默认值：nil，即房间里的多路流会混合到该接口调用者的视频流上。 |
videoBitrate | 【字段含义】最终转码后的视频分辨率的码率（kbps）。 【推荐取值】如果填0，后台会根据 videoWidth 和 videoHeight 来估算码率，您也可以参考枚举定义 V2TXLiveVideoResolution 的注释。 |
videoFramerate | 【字段含义】最终转码后的视频分辨率的帧率（FPS）。 【推荐取值】默认值：15fps，取值范围是 (0,30]。 |
videoGOP | 【字段含义】最终转码后的视频分辨率的关键帧间隔（又称为 GOP）。 【推荐取值】默认值：2，单位为秒，取值范围是 [1,8]。 |
videoHeight | 【字段含义】最终转码后的视频分辨率的高度。 【推荐取值】推荐值：640px，如果你是纯音频推流，请将 width × height 设为 0px × 0px，否则混流后会携带一条画布背景的视频流。 |
videoWidth | 【字段含义】最终转码后的视频分辨率的宽度。 【推荐取值】推荐值：360px，如果你是纯音频推流，请将 width × height 设为 0px × 0px，否则混流后会携带一条画布背景的视频流。 |
V2TXLiveLocalRecordingParams
V2TXLiveLocalRecordingParams
本地录制音视频配置
枚举类型 | 描述 |
filePath | 【字段含义】录制的文件地址（必填），请确保路径有读写权限且合法，否则录制文件无法生成。 【推荐取值】该路径需精确到文件名及格式后缀，格式后缀用于决定录制出的文件格式，目前支持的格式暂时只有 MP4。 |
interval | 【字段含义】interval 录制信息更新频率，单位毫秒，有效范围：1000-10000。 【推荐取值】 -1 , 表示不回调。 |
recordMode | 【字段含义】媒体录制模式。 【推荐取值】 V2TXLiveRecordModeBoth , 即同时录制音频和视频。 |
V2TXLiveSocks5ProxyConfig
V2TXLiveSocks5ProxyConfig
socks5 代理的协议配置
枚举类型 | 描述 |
supportHttps | 【字段含义】是否支持 https。 【推荐取值】默认值：true。 |
supportTcp | 【字段含义】是否支持 tcp。 【推荐取值】默认值：true。 |
supportUdp | 【字段含义】是否支持 udp。 【推荐取值】默认值：true。 |
V2TXLiveLogConfig
V2TXLiveLogConfig
Log配置
枚举类型 | 描述 |
enableConsole | 【字段含义】是否允许 SDK 在编辑器（XCoder、Android Studio、Visual Studio 等）的控制台上打印 Log。 【推荐取值】默认值：false。 |
enableLogFile | 【字段含义】是否启用本地 Log 文件。 【特殊说明】如非特殊需要，请不要关闭本地 Log 文件，否则腾讯云技术团队将无法在出现问题时进行跟踪和定位。 【推荐取值】默认值：true。 |
enableObserver | 【字段含义】是否通过 V2TXLivePremierObserver 接收要打印的 Log 信息。 【特殊说明】如果您希望自己实现 Log 写入，可以打开此开关，Log 信息会通过 V2TXLivePremierObserver#onLog 回调给您。 【推荐取值】默认值：false。 |
logLevel | 【字段含义】设置 Log 级别。 【推荐取值】默认值：V2TXLiveLogLevel.V2TXLiveLogLevelAll。 |
logPath | 【字段含义】设置本地 Log 的存储目录，默认 Log 存储位置： Android：/sdcard/Android/data/应用包名/files/log/liteav/。 |
V2TXLiveStreamInfo
V2TXLiveStreamInfo
支持自适应切换的码流信息
枚举类型 | 描述 |
bitrate | 【字段含义】 码率, 单位bps, 默认值：0, 表示未知。 |
framerate | 【字段含义】 帧率, 默认值：0, 表示未知。 |
height | 【字段含义】 视频高, 默认值：0, 表示未知。 |
url | 【字段含义】 流地址, 通过 SwitchStream 接口调用实现多码率质量切换。 |
width | 【字段含义】 视频宽, 默认值：0, 表示未知。 |
