通过阅读本文,您可以了解实时音视频Windows SDK涉及的数据类型。
目录
数据类型 | 描述 |
用户音量信息。 | |
音频样本。 | |
视频样本。 | |
频道模式。 | |
用户角色。 | |
会话数据统计信息。 | |
本地视频统计信息。 | |
远端视频统计信息。 | |
本地音频统计信息。 | |
远端音频统计信息。 | |
视频数据输出位置。 | |
视频数据类型。 | |
外接设备类型。 | |
外接设备状态。 | |
网络连接状态。 | |
网络连接状态变更原因。 | |
视频流类型。 | |
推流状态。 | |
订阅状态。 | |
用户离线原因。 | |
相机流类型。 | |
音频流类型。 | |
网络质量。 | |
横竖屏类型。 | |
渲染模式。 | |
镜像模式。 | |
旋转角度。 | |
日志级别。 | |
音频声道数。 | |
录制音频采样率。 | |
录制类型。 | |
录制格式 | |
录制音频文件的音频质量。 | |
录制视频文件的视频质量。 | |
音频质量模式。 | |
音频场景模式参数。 | |
本地静音模式。 | |
录制音频设置。 | |
录制视频设置。 | |
录制视频设置的画布大小。 | |
录制视频的布局信息。 | |
录制视频的背景颜色。 | |
录制布局的用户画面配置信息。 | |
用户画面的位置信息。 | |
混流录制坐标。 | |
录制模板。 | |
设备信息。 | |
基础美颜设置。 | |
OnBye类型枚举。 | |
变声音效模式。 | |
音效混响模式。 | |
音效混响参数。 | |
渲染画布。 | |
旁路推流错误码。 | |
水印图片的设置。 | |
相机采集偏好属性。 | |
摄像头采集偏好。 | |
视频编码帧率。 | |
视频编码码率。 | |
编码视频镜像模式。 | |
视频编码偏好。 | |
屏幕分享编码偏好。 | |
屏幕分享配置。 | |
屏幕分享区域。 | |
屏幕分享源信息。 | |
屏幕分享配置信息。 | |
屏幕分享类型。 | |
鉴权信息。 | |
视频裸数据源类型。 | |
音频裸数据源类型。 | |
视频数据类型。 | |
错误码。 | |
视频输出宽度对齐方式。 | |
显示仪表盘类型。 | |
旁路推流LiveStream状态。 | |
旁路直播图片显示类型。 | |
旁路直播文字类型。 | |
旁路直播输入类型。 | |
旁路直播输入类型。 | |
视频流状态变化。 | |
触发视频流状态变化的原因。 | |
旁路直播裁剪模式。 | |
旁路直播媒体处理模式。 | |
旁路直播转推流类型。 | |
旁路直播模式。 | |
旁路直播状态。 | |
旁路直播文本信息。 | |
旁路直播图片信息。 | |
旁路直播用户自定义窗格信息。 | |
旁路直播配置。 | |
旁路模式混流参数。 | |
旁路模式单路参数。 | |
旁路直播计费规格。 | |
旁路直播编码参数。 | |
旁路直播音频采样率。 | |
旁路直播时钟小工具。 | |
背景替换缩放模式。 | |
音乐伴奏播放状态。 | |
音乐伴奏播放错误码。 |
API详情
AliEngineUserVolumeInfo
用户音量信息。
参数 | 类型 | 描述 |
uid | String | 当前用户的UID,取值:
|
volume | int | 当前回调的音量。 |
speech_state | bool |
|
sumVolume | int | 回调周期内累计的音量, 用于判别当前说话人,取值范围[0,255]。 |
AliEngineAudioRawData
音频样本。
参数 | 类型 | 描述 |
dataPtr | void* | 音频数据 。 |
numOfSamples | int | 采样点数(单个声道)。 |
bytesPerSample | int | 每个采样点的字节数。 |
numOfChannels | int | 声道数。 |
samplesPerSec | int | 每秒采样点数。 |
AliEngineVideoRawData
视频样本。
参数 | 类型 | 描述 |
format | AliEngineVideoFormat | 视频数据类型 。 |
type | AliEngineBufferType | 视频数据类型。 |
dataLength | int | 数据大小。 |
pixelBuffer | void* | pixelBuffer数据。 |
dataPtr | void* | yuv数据指针。 |
dataYPtr | void* | Y分量指针。 |
dataUPtr | void* | U分量指针。 |
dataVPtr | void* | V分量指针。 |
strideY | int | YUV数据中的Y缓冲区的行跨度。 |
strideU | int | YUV数据中的U缓冲区的行跨度。 |
strideV | int | YUV数据中的V缓冲区的行跨度。 |
height | int | 视频帧的高。 |
width | int | 视频帧的宽。 |
rotation | int | 视频帧的旋转角度。 |
timeStamp | long long | 时间戳。 |
AliEngineChannelProfile
频道模式。
枚举名 | 描述 |
AliEngineCommunication | 通信模式。 |
AliEngineInteractiveLive | 互动模式。 |
AliEngineClientRole
用户角色。
枚举名 | 描述 |
AliEngineClientRoleInteractive | 主播角色。 |
AliEngineClientRoleLive | 观众角色。 |
AliEngineStats
会话数据统计信息。
参数 | 类型 | 描述 |
sentKBitrate | long long | 发送码率。 |
rcvdKBitrate | long long | 接收码率。 |
sentBytes | long long | 发送字节数。 |
rcvdBytes | long long | 接收字节数。 |
systemCpu | unsigned int | 系统CPU使用率。 |
appCpu | unsigned int | RTC进程CPU使用率。 |
videoRcvdKBitrate | long long | 视频接收码率。 |
videoSentKBitrate | long long | 视频发送码率。 |
callDuration | unsigned long long | 通话时长,单位:秒。 |
sentLossRate | long long | 客户端到服务器的丢包率。 |
sentLossPkts | long long | 客户端到服务器的丢包数。 |
sentExpectedPkts | long long | 客户端到服务器的总包数。 |
rcvdLossRate | long long | 客户端到服务器的下行丢包率。 |
rcvdLossPkts | long long | 客户端到服务器的下行丢包数。 |
rcvdExpectedPkts | long long | 客户端到服务器的下行总包数。 |
lastmileDelay | long long | 延时时长,单位:毫秒。 |
availableSendBitrate | long long | 可发送的码率 |
AliEngineLocalVideoStats
本地视频统计信息。
参数 | 类型 | 描述 |
track | AliEngineVideoTrack | 流类型。 |
sentBitrate | unsigned int | 发布比特率。 |
sentFps | unsigned int | 发布帧率。 |
encodeFps | unsigned int | 编码帧率。 |
targetEncodeBitrate | unsigned int | 目标编码码率。 |
actualEncodeBitrate | unsigned int | 实际编码码率。 |
captureFps | unsigned int | 采集帧率。 |
avgQpPerSec | unsigned int | 编码平均qp质量。 |
AliEngineRemoteVideoStats
远端视频统计信息。
参数 | 类型 | 描述 |
userId | const char* | 远端用户ID。 |
track | AliEngineVideoTrack | 视频流类型。 |
width | unsigned int | 视频帧的宽。 |
height | unsigned int | 视频帧的高。 |
decodeFps | unsigned int | 编码器输出帧率。 |
renderFps | unsigned int | 渲染器输出帧率。 |
frozenTimes | unsigned int | 卡顿次数。 |
AliEngineLocalAudioStats
本地音频统计信息。
参数 | 类型 | 描述 |
track | AliEngineAudioTrack | 音频流类型。 |
scene | AliEngineAudioScenario | 音频场景。 |
sentBitrate | unsigned int | 发送码率。 |
sentSamplerate | unsigned int | 发送的采样率。 |
numChannel | unsigned int | 声道数。 |
inputLevel | unsigned int | 输入等级。 |
AliEngineRemoteAudioStats
远端音频统计信息。
参数 | 类型 | 描述 |
userId | const char* | 用户ID。 |
track | AliEngineAudioTrack | 音频流类型。 |
networkTransportDelay | int | 音频发送端到接收端的网络延迟,单位:毫秒。 |
quality | int | 音质。 |
audioLossRate | int | 音频丢包率。 |
rcvdBitrate | int | 接收码率。 |
totalFrozenTimes | int | 卡顿次数。 |
audioTotalFrozenTime | int | 音频播放的累计卡顿时长,单位ms。 |
audioTotalFrozenRate | int | 音频播放卡顿率,单位%。 |
AliEngineVideoObserPosition
视频数据输出位置。
枚举名 | 描述 |
AliEnginePositionPostCapture | 采集数据。 |
AliEnginePositionPreRender | 拉流数据。 |
AliEnginePositionPreEncoder | 编码前数据。 |
AliEngineVideoFormat
视频数据输出格式。
枚举名 | 描述 |
AliEngineVideoFormatBGRA | BGRA。 |
AliEngineVideoFormatUnknow | unkown。 |
AliEngineVideoFormatI420 | I420。 |
AliEngineVideoFormatNV21 | NV21。 |
AliEngineVideoFormatNV12 | NV12。 |
AliEngineVideoFormatRGBA | RGBA。 |
AliEngineVideoFormatI422 | I422。 |
AliEngineVideoFormatARGB | ARGB。 |
AliEngineVideoFormatABGR | ABGR。 |
AliEngineVideoFormatRGB24 | RGB24。 |
AliEngineVideoFormatBGR24 | BGR24。 |
AliEngineVideoFormatRGB565 | RGB565。 |
AliEngineVideoFormatTextureOES | TextureOES。 |
AliEngineVideoFormatTexture2D | Texture2D。 |
AliEngineVideoFormatH264 | H264。 |
AliEngineExternalDeviceType
外接设备类型。
枚举名 | 描述 |
AliEngineExternalTypeUnknown | 未知类型。 |
AliEngineExternalTypeAudioCapture | 音频采集设备。 |
AliEngineExternalTypeAudioPlayout | 音频播放设备。 |
AliEngineExternalTypeVideoCapture | 视频采集设备。 |
AliEngineExternalDeviceState
外接设备状态。
枚举名 | 描述 |
AliEngineExternalDeviceAdd | 新增外接设备。 |
AliEngineExternalDeviceRemove | 移除外接设备。 |
AliEngineConnectionStatusChangeReason
网络连接状态变更原因。
枚举名 | 描述 |
AliEngineConnectionChangedDummyReason | 未知原因。 |
AliEngineConnectionMediaPathChanged | 移媒体通道变更。 |
AliEngineConnectionSignalingHeartbeatTimeout | 心跳超时。 |
AliEngineConnectionSignalingHeartbeatAlive | 心跳恢复。 |
AliEngineConnectionSignalingHttpdnsResolved | DNS解析成功。 |
AliEngineConnectionSignalingHttpdnsFailure | DNS解析失败。 |
AliEngineConnectionSignalingGslbFailure | GSLB请求失败。 |
AliEngineConnectionSignalingGslbSucccess | GSLB请求成功。 |
AliEngineConnectionSignalingJoinChannelFailure | 加入频道失败。 |
AliEngineConnectionSignalingJoinChannelSuccess | 加入频道成功。 |
AliEngineConnectionSignalingLeaveChannel | 离开频道。 |
AliEngineConnectionSignalingConnecting | 信令建立连接。 |
AliRtcConnectionChangedNetworkInterrupted | 网络连接中断。 |
AliEngineVideoTrack
视频流类型。
枚举名 | 描述 |
AliEngineVideoTrackNo | 无视频流。 |
AliEngineVideoTrackCamera | 摄像头流。 |
AliEngineVideoTrackScreen | 屏幕共享流。 |
AliEngineVideoTrackBoth | 摄像头和屏幕共享。 |
AliEnginePublishState
推流状态。
枚举名 | 描述 |
AliEngineStatsPublishIdle | 初始状态。 |
AliEngineStatsNoPublish | 未推流。 |
AliEngineStatsPublishing | 推流中。 |
AliEngineStatsPublished | 已推流。 |
AliEngineSubscribeState
订阅状态。
枚举名 | 描述 |
AliEngineStatsSubscribeIdle | 初始状态。 |
AliEngineStatsNoSubscribe | 未订阅。 |
AliEngineStatsSubscribing | 订阅中。 |
AliEngineStatsSubscribed | 已订阅。 |
AliEngineUserOfflineReason
用户离线原因。
枚举名 | 描述 |
AliEngineUserOfflineQuit | 用户主动离开。 |
AliEngineUserOfflineDropped | 因过长时间收不到对方数据包,超时掉线。 |
AliEngineUserOfflineBecomeAudience | 用户身份从主播切换为观众时触发。 |
AliEngineVideoStreamType
相机大小流类型。
枚举名 | 描述 |
AliEngineVideoStreamTypeNone | 无视频流。 |
AliEngineVideoStreamTypeHigh | 大流。 |
AliEngineVideoStreamTypeLow | 小流。 |
AliEngineAudioTrack
音频流类型。
枚举名 | 描述 |
AliEngineAudioTrackNo | 无音频流。 |
AliEngineAudioTrackMic | 麦克风流。 |
AliEngineNetworkQuality
网络质量。
枚举名 | 描述 |
AliEngineNetworkQualityExcellent | 网络极好,流程度清晰度质量好。 |
AliEngineNetworkQualityGood | 网络好,流畅度清晰度和极好差不多。 |
AliEngineNetworkQualityPoor | 网络较差,音视频流畅度清晰度有瑕疵,不影响沟通。 |
AliEngineNetworkQualityBad | 网络差,视频卡顿严重,音频能正常沟通。 |
AliEngineNetworkQualityVeryBad | 网络极差,基本无法沟通。 |
AliEngineNetworkQualityDisconnect | 网络中断。 |
AliEngineNetworkQualityUnknow | 未知原因。 |
AliEngineVideoEncoderOrientationMode
视频输出方向。
枚举名 | 描述 |
AliEngineVideoEncoderOrientationModeAdaptive | 0:自适应,推流方向和采集方向一致。 |
AliEngineVideoEncoderOrientationModeFixedLandscape | 1:竖屏模式。 该模式下SDK推竖屏流,始终以设置的分辨率宽和高中较小的值作为输出视频的宽,较大值作为输出视频的高 |
AliEngineVideoEncoderOrientationModeFixedPortrait | 2:横屏模式。 该模式下SDK推横屏流,始终以设置的分辨率宽和高中较大的值作为输出视频的宽,较小值作为输出视频的高 |
AliEngineRenderMode
渲染模式。
枚举名 | 描述 |
AliEngineRenderModeAuto | 自动。 |
AliEngineRenderModeStretch | 拉伸填充视图,不保持视频比例。 |
AliEngineRenderModeFill | 在保持视频宽高比的同时缩放,填充黑边。 |
AliEngineRenderModeCrop | 在保持视频宽高比的同时缩放,并裁剪以适合视图。 |
AliEngineRenderModeNoChange | 沿用之前的显示模式。 |
AliEngineRenderMirrorMode
镜像模式。
枚举名 | 描述 |
AliEngineRenderMirrorModeOnlyFrontMirror | 只有前置摄像头预览镜像,其余不镜像。 |
AliEngineRenderMirrorModeAllMirror | 全部镜像。 |
AliEngineRenderMirrorModeAllNoMirror | 全部不镜像。 |
AliEngineRotationMode
旋转角度。
枚举名 | 描述 |
AliEngineRotationModeNoChange | 沿用之前的旋转角度 |
AliEngineRotationMode_0 | 不旋转。 |
AliEngineRotationMode_90 | 旋转90度。 |
AliEngineRotationMode_180 | 旋转180度。 |
AliEngineRotationMode_270 | 旋转270度。 |
AliEngineLogLevel
日志级别。
枚举名 | 描述 |
AliEngineLogLevelInfo | 普通。 |
AliEngineLogLevelWarn | 警告。 |
AliEngineLogLevelError | 错误。 |
AliEngineLogLevelFatal | 严重。 |
AliEngineLogLevelNone | 无。 |
AliEngineAudioNumChannelType
音频声道类型。
枚举名 | 描述 |
AliEngineMonoAudio | 单声道。 |
AliEngineStereoAudio | 双声道。 |
AliEngineAudioSampleRate
音频采样率类型。
枚举名 | 描述 |
AliEngineAudioSampleRate_8000 | 采样率8000。 |
AliEngineAudioSampleRate_11025 | 采样率11025。 |
AliEngineAudioSampleRate_16000 | 采样率16000。 |
AliEngineAudioSampleRate_22050 | 采样率22050。 |
AliEngineAudioSampleRate_32000 | 采样率32000。 |
AliEngineAudioSampleRate_44100 | 采样率44100。 |
AliEngineAudioSampleRate_48000 | 采样率48000。 |
AliEngineRecordType
录制类型。
枚举名 | 描述 |
AliEngineRecordTypeAudio | 纯音频录制。 |
AliEngineRecordTypeVideo | 录制单个音视频文件 |
AliEngineRecordTypeBoth | 录制纯音频和音视频文件 |
AliEngineRecordFormat
录制格式。
枚举名 | 描述 |
AliEngineRecordFormatAAC | AAC文件。 |
AliEngineRecordFormatWAV | WAV文件。 |
AliEngineRecordFormatMP4 | MP4文件. |
AliEngineAudioQuality
录制音频文件的音频质量。
枚举名 | 描述 |
AliEngineAudioQualityLow | 低。 |
AliEngineAudioQualityMidium | 中。 |
AliEngineAudioQualityHigh | 高。 |
AliEngineVideoQuality
录制视频文件的视频质量。
枚举名 | 描述 |
AliEngineVideoQualityDefault | 默认和视频采集质量保持一致(移动端不提供视频录制)。 |
AliEngineAudioProfile
音频质量模式。
枚举名 | 描述 |
AliEngineLowQualityMode | 音频低音质模式。 |
AliEngineBasicQualityMode | 标准音质模式。 |
AliEngineHighQualityMode | 高音质模式。 |
AliEngineStereoHighQualityMode | 立体声高音质模式。 |
AliEngineSuperHighQualityMode | 超高音质模式。 |
AliEngineStereoSuperHighQualityMode | 立体声超高音质模式。 |
AliEngineAudioScenario
音频场景模式。
枚举名 | 描述 |
AliEngineSceneDefaultMode | 默认场景,一般的音视频通信场景推荐使用。 |
AliEngineSceneEducationMode | 教育场景,优先保证音频连续性与稳定性。 |
AliEngineSeneMediaMode | 媒体场景,保真人声与音乐音质,连麦直播间推荐使用。 |
AliEngineSceneMusicMode | 音乐场景,高保真音乐音质,乐器教学等对音乐音质有要求的场景推荐使用。 |
AliEngineSceneChatRoomMode | 聊天室场景,适用于频繁上下麦的聊天场景,音量条始终为语音通话音量条。 |
AliEngineSceneShowRoomMode | 秀场场景,适用于需要高音质的单主播场景。 |
AliEngineMuteLocalAudioMode
本地静音模式。
枚举名 | 描述 |
AliEngineMuteLocalAudioModeDefault | 默认模式(静音全部,包括麦克风及外部输入音频)。 |
AliEngineMuteLocalAudioModeMuteAll | 静音全部(包括麦克风及外部输入音频)。 |
AliEngineMuteLocalAudioModeMuteOnlyMic | 只静音麦克风。 |
AliEngineRecordAudioConfig
录制音频文件参数配置。
参数 | 类型 | 描述 |
sampleRate | AliEngineAudioSampleRate | 音频采样率。 |
quality | AliEngineAudioQuality | 音频质量。 |
externalPcmCaptureRecording | bool | 是否允许录制外部PCM输入渲染数据。 |
externalPcmRenderRecording | bool | 是否允许录制外部pcm输入渲染数据 |
AliEngineRecordVideoConfig
录制视频设置。
参数 | 类型 | 描述 |
quality | AliEngineVideoQuality | 视频质量。 |
fps | int | 帧率。 |
bitrate | int | 码率。 |
sourceType | AliEngineVideoRecordSource | 录制视频数据源。 |
canvas | AliEngineVideoRecordCanvasConfig | 视频录制分辨率设置。 |
AliEngineVideoRecordCanvasConfig
录制视频分辨率。
参数 | 类型 | 描述 |
canvasWidth | int | 录制视频宽。 |
canvasHeight | int | 录制视频高。 |
AliEngineRecordVideoLayoutMode
录制视频布局。
枚举名 | 描述 |
AliEngineRecordVideoLayoutModeGrid | 网格布局。 |
AliEngineRecordVideoLayoutModeSpeaker | 演讲者布局。 |
AliEngineRecordVideoLayoutModeUnique | 只有一个画面布局 。 |
AliEngineRecordVideoLayoutModeCustom | 自定义布局。 |
AliEngineRecordVideoBgColor
录制视频背景色。
参数 | 类型 | 描述 |
r | unsigned char | 红色分量。 |
g | unsigned char | 绿色分量。 |
b | unsigned char | 蓝色分量。 |
AliEngineRecordVideoRegion
录制视频用户布局。
参数 | 类型 | 描述 |
userId | char* | 用户信息。 |
sourceType | AliEngineVideoSource | 视频源类型。 |
area | AliEngineRecordVideoRectangle | 录制区域。 |
AliEngineRecordVideoRectangle
录制视频坐标。
参数 | 类型 | 描述 |
left | AliEngineRecordVideoRational | 左边坐标。 |
top | AliEngineRecordVideoRational | 上侧坐标。 |
width | AliEngineRecordVideoRational | 宽度。 |
height | AliEngineRecordVideoRational | 高度。 |
AliEngineRecordVideoRational
录制视频坐标值。
参数 | 类型 | 描述 |
numerator | unsigned int | 分子。 |
denominator | unsigned int | 分母。 |
AliEngineRecordTemplate
录制模板。
参数 | 类型 | 描述 |
recordType | AliEngineRecordType | 录制类型。 |
recordFormat | AliEngineRecordFormat | 录制格式。 |
sampleRate | AliEngineAudioSampleRate | 录制音频采样率。 |
audioQuality | AliEngineAudioQuality | 录制音频质量。 |
externalPcmCaptureRecording | bool | 是否混音录制外部输入音频。 |
externalPcmRenderRecording | bool | 是否混音录制外部输入渲染后的音频。 |
canvas | AliEngineVideoRecordCanvasConfig | 录制视频的画布大小。 |
fps | int | 帧率。 |
bitrate | int | 码率。 |
isFragment | bool | 是否录制分段MP4,默认true。 |
AliEngineDeviceInfo
设备信息。
参数 | 类型 | 描述 |
deviceName | String | 设备名称。 |
deviceID | String | 设备ID。 |
deviceTransportType | AliEngineDeviceTransportType | 设备传输方式。 |
AliEngineBeautyConfig
基础美颜设置。
参数 | 类型 | 描述 |
whiteningLevel | float | 美白,取值范围:[0,1],数值越大美白效果越好。 |
smoothnessLevel | float | 磨皮,取值范围:[0,1],数值越大磨皮效果越好。 |
AliEngineOnByeType
OnBye类型枚举。
枚举名 | 描述 |
AliEngineOnByeBeKickOut | 被踢出。 |
AliEngineOnByeChannelTerminated | 频道已结束,需要离开会议。 |
AliEngineOnByeUserReplaced | 相同用户ID在其他设备加入频道,当前设备被下线。 |
AliEngineAudioEffectVoiceChangerMode
变声音效模式。
枚举名 | 描述 |
AliEngineAudioEffectVoiceChangerOff | 关闭。 |
AliEngineAudioEffectVoiceChangerOldMan | 老人。 |
AliEngineAudioEffectVoiceChangerBabyBoy | 男孩。 |
AliEngineAudioEffectVoiceChangerBabGirl | 女孩。 |
AliEngineAudioEffectVoiceChangerRobot | 机器人。 |
AliEngineAudioEffectVoiceChangerDaimo | 大魔王。 |
AliEngineAudioEffectVoiceChangerKTV | KTV。 |
AliEngineAudioEffectVoiceChangerEcho | 回声。 |
AliEngineAudioEffectReverbMode
音效混响模式。
枚举名 | 描述 |
AliEngineAudioEffectReverbOff | 关闭。 |
AliEngineAudioEffectReverbVocal_I | 人声 I。 |
AliEngineAudioEffectReverbVocal_II | 人声 II。 |
AliEngineAudioEffectReverbBathroom | 澡堂。 |
AliEngineAudioEffectReverbSmallRoomBright | 明亮小房间。 |
AliEngineAudioEffectReverbSmallRoomDark | 黑暗小房间。 |
AliEngineAudioEffectReverbMediumRoom | 中等房间。 |
AliEngineAudioEffectReverbLargeRoom | 大房间。 |
AliEngineAudioEffectReverbChurchHall | 教堂走廊。 |
AliEngineAudioEffectReverbParamType
混响参数类型枚举。
枚举名 | 描述 |
AliEngineAudioEffectReverbRoomSize | 房间大小,取值范围:[0,100]。 |
AliEngineAudioEffectReverbPreDelay | 预延时,单位:ms,取值范围:[0,200]。 |
AliEngineAudioEffectReverbPreDelay | 混响感,取值范围:[0,100]。 |
AliEngineAudioEffectReverbHfDamping | 消声,取值范围:[0,100]。 |
AliEngineAudioEffectReverbToneLow | 低音调,取值范围:[0,100]。 |
AliEngineAudioEffectReverbToneHigh | 高音调,取值范围:[0,100]。 |
AliEngineAudioEffectReverbDryGain | 干增益,取值范围:[-20,10]。 |
AliEngineAudioEffectReverbWetGain | 湿增益,取值范围:[-20,10]。 |
AliEngineVideoCanvas
渲染画布。
参数 | 类型 | 描述 |
displayView | void * | 渲染view,不可为nil。 |
renderMode | AliEngineRenderMode | 渲染模式,默认AliEngineRenderModeAuto。 |
mirrorMode | AliEngineRenderMirrorMode | 镜像模式。默认AliEngineRenderMirrorModeOnlyFrontMirror。 |
backgroundColor | int | 背景颜色,格式为RGB的Hex。 |
rotationMode | AliEngineRotationMode | 视频旋转角度,默认不旋转。 |
renderId | int | ID。 |
width | int | 宽。 |
height | int | 高。 |
scaleMode | AliEngineVideoScale | 视频宽高比,默认值为AliEngineVideoScale_16_9 。 |
AliEngineLiveTranscodingErrorCode
旁路推流错误码。
枚举名 | 描述 |
AliEngineLiveTranscodingErrorPublishOk | 推流成功。 |
AliEngineLiveTranscodingErrorStreamNotFound | 错误:找不到流。 |
AliEngineLiveTranscodingErrorStreamAlreadyExist | 错误:目标流已存在。 |
AliEngineLiveTranscodingErrorInvalidParam | 错误:非法的参数。 |
AliEngineLiveTranscodingErrorInternalError | 错误:内部错误。 |
AliEngineLiveTranscodingErrorRtmpServerError | 错误:RTMP服务异常。 |
AliEngineLiveTranscodingErrorRtmpStreamUrlError | 错误:URL异常。 |
AliEngineLiveTranscodingErrorPublishTimeout | 错误:任务超时。 |
AliEngineLiveTranscodingErrorNotAuthorized | 错误:操作未授权。 |
AliEngineWaterMarkConfig
水印图片的设置。
参数 | 类型 | 描述 |
visibleInPreview | bool | 是否将水印设置为预览时本地可见。 |
positionInLandscapeMode | AliEngineWaterMarkPosition | 横屏时的水印坐标。 |
positionInPortraitMode | AliEngineWaterMarkPosition | 竖屏时的水印坐标。 |
alpha | float | 透明度。 |
normalized | bool | 是否归一化。 |
AliEngineCameraCapturerConfiguration
相机采集偏好属性。
参数 | 类型 | 描述 |
preference | AliEngineCaptureOutputPreference | 采集偏好。 |
AliEngineCaptureOutputPreference
摄像头采集偏好。
枚举名 | 描述 |
AliEngineCaptureOutputPreferenceAuto | 自动调整采集参数。 |
AliEngineCaptureOutputPreferencePerformance | 优先保证设备性能,根据setVideoProfile设置参数选择最接近的摄像头输出参数。 |
AliEngineCaptureOutputPreferencePreview | 优先保证视频预览质量,选择较高的摄像头输出参数。 |
AliEngineFrameRate
视频编码帧率。
枚举名 | 描述 |
AliEngineFrameRateFps5 | 5 FPS。 |
AliEngineFrameRateFps10 | 10 FPS。 |
AliEngineFrameRateFps15 | 15 FPS。 |
AliEngineFrameRateFps20 | 20 FPS。 |
AliEngineFrameRateFps30 | 30 FPS。 |
AliEngineVideoEncoderBitrate
视频编码码率。
枚举名 | 描述 |
AliEngineVideoStandardBitrate | 标准码率模式。 |
AliEngineVideoMirrorMode
编码视频镜像模式。
枚举名 | 描述 |
AliEngineVideoMirrorModeDisabled | 编码视频镜像。 |
AliEngineVideoMirrorModeEnable | 编码视频不镜像。 |
AliEngineVideoEncoderConfiguration
视频编码偏好。
参数 | 类型 | 描述 |
dimensions | AliEngineVideoDimensions | 视频分辨率。 |
frameRate | AliEngineFrameRate | 视频编码帧率。 |
bitrate | int | 视频编码码率。 |
mirrorMode | AliEngineVideoMirrorMode | 编码视频镜像模式。 |
orientationMode | AliEngineVideoEncoderOrientationMode | 编码视频旋转模式。 |
rotationMode | AliEngineRotationMode | 视频旋转角度。 |
keyFrameInterval | int | 关键帧间隔,单位毫秒。默认值0,表示SDK内部控制关键帧间隔。 |
forceStrictKeyFrameInterval | bool | 是否强制编码器严格按照设置的关键帧间隔产生关键帧。默认值false。
|
AliEngineScreenShareEncoderConfiguration
屏幕分享编码偏好。
参数 | 类型 | 描述 |
dimensions | AliEngineVideoDimensions | 视频分辨率。 |
frameRate | AliEngineFrameRate | 视频编码帧率。 |
bitrate | int | 视频编码码率。 |
rotationMode | AliEngineRotationMode | 屏幕旋转角度。 |
keyFrameInterval | int | 关键帧间隔,单位毫秒。默认值0,表示SDK内部控制关键帧间隔。 |
forceStrictKeyFrameInterval | bool | 是否强制编码器严格按照设置的关键帧间隔产生关键帧。默认值为false。
|
AliEngineScreenShareConfig
屏幕分享配置。
参数 | 类型 | 描述 |
isShareByRegion | bool | 是否是区域分享。 |
shareRegion | AliEngineScreenShareRegion | 区域分享的布局信息。 |
AliEngineScreenShareRegion
屏幕分享区域。
参数 | 类型 | 描述 |
originX | float | x坐标。 |
originY | float | y坐标。 |
width | float | 宽度。 |
heigh | foat | 高度。 |
AliEngineScreenSourcInfo
屏幕分享源信息。
参数 | 类型 | 描述 |
sourceId | String | 分享源ID。 |
sourceName | String | 分享源名称。 |
AliEngineScreenShareInfo
屏幕分享配置信息。
参数 | 类型 | 描述 |
shareType | AliEngineScreenShareType | 分享类型。 |
shareSourceId | unsigned int | 分享源ID。 |
shareConfig | AliEngineScreenShareConfig | 屏幕分享配置。 |
AliEngineScreenShareType
屏幕分享类型。
枚举名 | 描述 |
AliEngineScreenShareDesktop | 桌面分享。 |
AliEngineScreenShareWindow | 窗口分享。 |
AliEngineAuthInfo
鉴权信息。
参数 | 类型 | 描述 |
channelId | char* | 频道ID。 |
userId | char* | 用户ID。 |
appId | char* | 应用ID。 |
nonce | char* | 随机串。 |
token | char* | 令牌。 |
gslb | char** | GSLB地址指针数组。 |
session | char* | 会话id(可不填)。 |
role | char* | 角色(可不填)。 |
timestamp | long long | 时间戳。 |
gslbCount | int | GSLB地址指针数组个数。 |
agent | char** | agent地址指针数组。 |
agentCount | int | agent地址指针数组个数。 |
tokenType | char* | token类型(可不填)。 |
AliEngineVideoSource
视频裸数据源类型。
枚举名 | 描述 |
AliEngineVideoSourceCamera | 视频流。 |
AliEngineVideoSourceScreenShare | 屏幕共享流。 |
AliEngineAudioSource
音频裸数据源类型。
枚举名 | 描述 |
AliEngineAudioSourceCaptured | 采集的音频数据。 |
AliEngineAudioSourceProcessCaptured | 3A后的音频数据。 |
AliEngineAudioSourcePub | 推流音频数据。 |
AliEngineAudioSourcePlayback | 播放的音频数据。 |
AliEngineAudioSourceRemoteUser | 拉流的远端音频数据。 |
AliEngineAudioSourceMixedAll | 推流和播放混音后的音频数据。 |
AliEngineBufferType
视频数据类型。
枚举名 | 描述 |
AliEngineBufferTypeRawData | YUV裸数据。 |
AliEngineBufferTypeTexture | CVPixelBuffer数据。 |
AliEngineErrorCode
错误码。
枚举名 | 描述 |
AliEngineErrorJoinBadAppId | App ID不存在。 |
AliEngineErrorJoinInvaildAppId | App ID已失效。 |
AliEngineErrorJoinBadChannel | 频道不存在。 |
AliEngineErrorJoinInvaildChannel | 频道已失效。 |
AliEngineErrorJoinBadToken | token不存在。 |
AliEngineErrorJoinTimeout | 加入频道超时。 |
AliEngineErrorJoinBadParam | 参数错误。 |
AliEngineErrorMicOpenFail | 采集设备初始化失败。 |
AliEngineErrorSpeakerOpenFail | 播放设备初始化失败。 |
AliEngineErrorMicInterrupt | 采集过程中出现异常。 |
AliEngineErrorSpeakerInterrupt | 播放过程中出现异常。 |
AliEngineErrorMicAuthFail | 麦克风设备未授权。 |
AliEngineErrorMicNotAvailable | 无可用的音频采集设备。 |
AliEngineErrorSpeakerNotAvailable | 无可用的音频播放设备。 |
AliEngineErrorCameraOpenFail | 采集设备初始化失败。 |
AliEngineErrorCameraInterrupt | 采集过程中出现异常。 |
AliEngineErrorVideoDisplayOpenFail | 染设备初始化失败。 |
AliEngineErrorVideoDisplayInterrupt | 渲染过程中出现异常。 |
AliEngineErrorIceConnectionConnectFail | 媒体通道建立失败。 |
AliEngineErrorIceConnectionReconnectFail | 媒体通道重连失败。 |
AliEngineErrorIceConnectionHeartbeatTimeout | 信令心跳超时。 |
AliEngineErrorPublishInvaild | 推流无效。 |
AliEngineErrorPublishNotJoinChannel | 未进入频道推流失败。 |
AliEngineErrorPublishAudioStreamFailed | 推送音频流失败。 |
AliEngineErrorPublishVideoStreamFailed | 推送视频流失败。 |
AliEngineErrorPublishDualStreamFailed | 推送双流失败。 |
AliEngineErrorPublishScreenShareFailed | 推送屏幕共享失败。 |
AliEngineErrorPublishScreenShareConfigError | 屏幕共享配置错误。 |
AliEngineErrorSubscribeInvaild | 订阅无效。 |
AliEngineErrorSubscribeNotJoinChannel | 未进入频道订阅错误。 |
AliEngineErrorSubscribeAudioStreamFailed | 订阅音频流失败。 |
AliEngineErrorSubscribeVideoStreamFailed | 订阅视频流失败。 |
AliEngineErrorSubscribeDualStreamFailed | 订阅双流失败。 |
AliEngineErrorSubscribeScreenShareFailed | 订阅屏幕共享失败。 |
AliEngineErrorLowLatencyLiveCommunicationFail | 低延时实时音视频信令失败。 |
AliEngineErrorLowLatencyLiveMediaSettingFail | 低延时实时音视频媒体设置错误。 |
AliEngineErrorLowLatencyLiveNoneBroadcaster | 低延时实时音视频当前房间没有主播推流。 |
AliEngineErrorLowLatencyLiveNeedRestart | 低延时实时音视频错误,应用层需要重新创建新的SDK实例。 |
AliEngineErrorLowLatencyLiveNeedRestartAgainLater | 低延时实时音视频错误,应用层需要稍等一定时间(自定义间隔)重新创建新的SDK实例。 |
AliEngineErrorLowLatencyLiveServiceUnavailable | 低延时实时音视频服务不可用或者服务降级。 |
AliEngineErrorLowLatencyLiveMediaConnectionInterrruption | 低延时实时音视频网络中断错误。 |
AliEngineErrorInvaildState | SDK状态错误。 |
AliEngineErrorSessionRemoved | Session已经被移除。 |
AliEngineErrorInvaildArgument | 参数不匹配。 |
AliEngineErrorAudioBufferFull | buffer队列饱和,用于外部输送裸数据功能。 |
AliEngineErrorVideoBufferFull | buffer队列饱和,用于外部输送裸数据功能。 |
AliEngineErrorUpdateRoleChannel | 互动模式下设置角色错误。 |
AliEngineErrorInner | 其他错误。 |
AliEngineVideoObserAlignment
视频输出宽度对齐方式。
枚举名 | 描述 |
AliEngineAlignmentDefault | 保持原有视频宽度(默认值)。 |
AliEngineAlignmentEven | 宽度偶数对齐。 |
AliEngineAlignment4 | 宽度是4的倍数。 |
AliEngineAlignment8 | 宽度是8的倍数。 |
AliEngineAlignment16 | 宽度是16的倍数。 |
AliEngineShowDebugViewType
显示仪表盘类型。
枚举名 | 描述 |
AliEngineShowTypeNone | 不显示。 |
AliEngineShowTypeAudio | 音频。 |
AliEngineShowTypeVideo | 视频。 |
AliEngineShowTypeNetwork | 网络。 |
AliEngineShowTypeAll | 全部。 |
AliEngineTrascodingPublishTaskStatus
旁路推流LiveStream状态。
枚举名 | 描述 |
AliEngineTrascodingPublishTaskStatusStart | 任务开始。 |
AliEngineTrascodingPublishTaskStatusUpdate | 任务更新。 |
AliEngineTrascodingPublishTaskStatusStop | 任务已停止。 |
DisplayType
旁路直播图片显示类型。
枚举名 | 描述 |
NOT_DISPLAY | 不显示。 |
ALWAYS | 一直显示。 |
WHEN_NO_VIDEO | 当没有视频时候显示。 |
AliEngineLiveTranscodingFontType
旁路直播文字类型。
枚举名 | 描述 |
NOTO_SERIF_CJKSC_REGULAR | 思源宋体NotoSerifCJKsc-REGULAR。 |
ALIBABA_PUHUITI_REGULAR | 阿里巴巴-普惠体-REGULAR。 |
ALIBABA_PUHUITI_BOLD | 阿里巴巴-普惠体-BOLD。 |
ALIBABA_PUHUITI_Heavy | 阿里巴巴-普惠体-Heavy。 |
ALIBABA_PUHUITI_LIGHT | 阿里巴巴-普惠体-LIGHT。 |
ALIBABA_PUHUITI_MEDIUM | 阿里巴巴-普惠体-MEDIUM。 |
AliEngineLiveTranscodingSegmentType
旁路直播输入类型。
枚举名 | 描述 |
AliEngineLiveTranscodingNoBody | 无人像分割。 |
AliEngineLiveTranscodingBody | 人像分割。 |
AliEngineLiveTranscodingSourceType
旁路直播输入类型。
枚举名 | 描述 |
AliEngineLiveTranscodingCamera | 相机。 |
AliEngineLiveTranscodingShareScreen | 共享屏幕。 |
AliEngineVideoState
视频流状态变化。
枚举名 | 描述 |
AliEngineVideoClose | 关闭视频流。 |
AliEngineVideoOpen | 恢复视频流。 |
AliEngineVideoReason
触发视频流状态变化的原因。
枚举名 | 描述 |
AliEngineVideoChangeByClient | 客户端。 |
AliEngineVideoChangeByServer | 服务器。 |
AliEngineLiveTranscodingCropMode
旁路直播裁剪模式。
枚举名 | 描述 |
AliEngineLiveTranscodingCrop | 保持比例裁剪。 |
AliEngineLiveTranscodingFill | 保持比例留边(默认值)。 |
AliEngineLiveTranscodingMediaProcessMode
旁路直播媒体处理模式。
枚举名 | 描述 |
AliEngineLiveTranscodingNormal | 通用模式。 |
AliEngineLiveTranscodingVirtualBackground | 虚拟背景模式。 |
AliEngineLiveTranscodingStreamType
旁路直播转推流类型。
枚举名 | 描述 |
AliEngineLiveTranscodingOrigin | 转推原始流。 |
AliEngineLiveTranscodingAudio | 仅转推音频流。 |
AliEngineLiveTranscodingVideo | 仅转推视频流。 |
AliEngineLiveTranscodingMixMode
旁路直播模式。
枚举名 | 描述 |
AliEngineLiveTranscodingSINGLE | 单路转推,不混流转码,仅转推原始单路流,无需配置混流转码参数。 |
AliEngineLiveTranscodingMIX | 混流转码(默认值),支持混流转码输出。 |
AliEngineLiveTranscodingState
旁路直播状态。
枚举名 | 描述 |
AliEngineLiveTranscodingState_IDLE | 推流空闲。 |
AliEngineLiveTranscodingState_CONNNECT | 正在连接推流服务器。 |
AliEngineLiveTranscodingState_RUNNING | 推流正在进行。 |
AliEngineLiveTranscodingState_RECOVERING | 正在恢复推流。 |
AliEngineLiveTranscodingState_FAILURE | 推流失败。 |
AliEngineLiveTranscodingState_END | 推流结束。 |
AliEngineLiveTranscodingText
旁路直播文本信息。
参数 | 类型 | 描述 |
text | String | 文本信息。 |
x | int | 坐标X(像素)。 |
y | int | 坐标Y(像素)。 |
fontType | AliEngineLiveTranscodingFontType | 旁路直播字体。 |
fontSize | int | 字体大小。 |
zOrder | int | 叠放顺序,0为最底层,1层在0层之上,以此类推。 |
fontColor | int | 字体颜色。 |
AliEngineLiveTranscodingImage
旁路直播图片信息。
参数 | 类型 | 描述 |
url | String | 图片URL。 |
alpha | float | 透明度。0.0表示透明,1.0表示完全不透明。 |
display | DisplayType | 图片显示。 |
x | int | 坐标X(像素)。 |
y | int | 坐标Y(像素)。 |
width | int | 图片宽。 |
height | int | 图片高。 |
zOrder | int | 叠放顺序,0为最底层,1层0层之上,以此类推。 |
AliEngineLiveTranscodingUser
旁路直播用户自定义窗格信息。
参数 | 类型 | 描述 |
x | int | 坐标X(像素)。 |
y | int | 坐标Y(像素)。 |
width | int | 窗格宽。 |
height | int | 窗格高。 |
zOrder | int | 叠放顺序,0为最底层,1层在0层之上,以此类推。 |
userId | String | 用户ID。 |
sourceType | AliEngineLiveTranscodingSourceType | 流类型。 |
segmentType | AliEngineLiveTranscodingSegmentType | 旁路直播输入类型。 |
images | AliEngineLiveTranscodingImageArray | 旁路直播图片信息。 |
texts | AliEngineLiveTranscodingTextArray | 旁路直播文本信息。 |
AliEngineLiveTranscodingParam
旁路直播配置。
参数 | 类型 | 描述 |
mixMode | AliEngineLiveTranscodingMixMode | 旁路直播模式。 |
singleParam | AliEngineLiveTranscodingSingleParam | 旁路直播单流参数。 |
mixParam | AliEngineLiveTranscodingMixParam | 旁路直播混流参数。 |
AliEngineLiveTranscodingMixParam
旁路模式混流参数。
参数 | 类型 | 描述 |
taskProfile | AliEngineLiveTranscodingTaskProfile | 旁路直播计费规格。 |
encodeParam | AliEngineLiveTranscodingEncodeParam | 旁路直播编码参数。 |
users | AliEngineLiveTranscodingUserArray | 旁路直播用户列表。 |
backgroundColor | int | 背景色。 |
backgrounds | AliEngineLiveTranscodingImageArray | 背景图片列表。 |
watermarks | AliEngineLiveTranscodingImageArray | 水印图片列表。 |
clockWidgets | AliEngineLiveTranscodingClockWidgetArray | 时钟小部件列表。 |
cropMode | AliEngineLiveTranscodingCropMode | 旁路直播裁剪模式。 |
mediaProcessMode | AliEngineLiveTranscodingMediaProcessMode | 旁路直播媒体处理模式。 |
AliEngineLiveTranscodingSingleParam
旁路模式单路参数。
参数 | 类型 | 描述 |
userId | String | 用户ID。 |
streamType | AliEngineLiveTranscodingStreamType | 旁路直播转推流类型。 |
sourceType | AliEngineLiveTranscodingSourceType | 旁路直播视频流类型。 |
AliEngineLiveTranscodingTaskProfile
旁路直播计费规格。
枚举名 | 描述 |
AliEngineLiveTranscoding_Profile_1IN_1080P | 1IN_1080P。 |
AliEngineLiveTranscoding_Profile_1IN_720P | 1IN_720P。 |
AliEngineLiveTranscoding_Profile_1IN_360P | 1IN_360P。 |
AliEngineLiveTranscoding_Profile_2IN_1080P | 2IN_1080P。 |
AliEngineLiveTranscoding_Profile_2IN_720P | 2IN_720P。 |
AliEngineLiveTranscoding_Profile_2IN_360P | 2IN_360P。 |
AliEngineLiveTranscoding_Profile_4IN_1080P | 4IN_1080P。 |
AliEngineLiveTranscoding_Profile_4IN_720P | 4IN_720P。 |
AliEngineLiveTranscoding_Profile_4IN_360P | 4IN_360P。 |
AliEngineLiveTranscoding_Profile_9IN_1080P | 9IN_1080P。 |
AliEngineLiveTranscoding_Profile_9IN_720P | 9IN_720P。 |
AliEngineLiveTranscoding_Profile_9IN_360P | 9IN_360P。 |
AliEngineLiveTranscoding_Profile_12IN_1080P | 12IN_1080P。 |
AliEngineLiveTranscoding_Profile_12IN_720P | 12IN_720P。 |
AliEngineLiveTranscoding_Profile_12IN_360P | 12IN_360P。 |
AliEngineLiveTranscoding_Profile_16IN_1080P | 16IN_1080P。 |
AliEngineLiveTranscoding_Profile_16IN_720P | 16IN_720P。 |
AliEngineLiveTranscoding_Profile_16IN_360P | 16IN_360P。 |
AliEngineLiveTranscoding_Profile_Mixed | 纯音频。 |
AliEngineLiveTranscodingEncodeParam
旁路直播编码参数。
参数 | 类型 | 描述 |
videoWidth | int | 宽。 |
videoHeight | int | 高。 |
videoFramerate | int | 帧率。 |
videoBitrate | int | 码率。 |
videoGop | int | GOP。 |
audioSamplerate | AliEngineLiveTranscodingAudioSampleRate | 旁路直播音频采样率。 |
audioBitrate | int | 音频码率。 |
audioChannels | int | 音频声道数。 |
AliEngineLiveTranscodingAudioSampleRate
旁路直播音频采样率。
枚举名 | 描述 |
AliEngineLiveTranscoding_HZ_48000 | 采样率48000Hz。 |
AliEngineLiveTranscoding_HZ_44100 | 采样率44100Hz。 |
AliEngineLiveTranscoding_HZ_32000 | 采样率32000Hz。 |
AliEngineLiveTranscoding_HZ_16000 | 采样率16000Hz。 |
AliEngineLiveTranscoding_HZ_8000 | 采样率8000Hz。 |
AliEngineLiveTranscodingClockWidget
旁路直播时钟小工具。
参数 | 类型 | 描述 |
x | int | 坐标X(像素)。 |
y | int | 坐标Y(像素)。 |
fontSize | int | 旁路直播字体大小。 |
zOrder | int | 叠放顺序,0为最底层,1层在0层之上,以此类推。 |
fontColor | int | 旁路直播字体颜色。 |
fontType | AliEngineLiveTranscodingFontType | 旁路直播字体。 |
AliEngineBokehScaleModel
背景替换缩放模式。
枚举名 | 描述 |
AliEngineBokehScaleModelCrop | 等比裁剪。 |
AliEngineBokehScaleModelFill | 填充黑边。 |
AliEngineAudioAccompanyStateCode
音乐伴奏播放状态。
枚举名 | 描述 |
AliEngineAudioAccompanyStarted | 开始播放。 |
AliEngineAudioAccompanyStopped | 停止播放。 |
AliEngineAudioAccompanyPaused | 播放暂停。 |
AliEngineAudioAccompanyResumed | 播放恢复。 |
AliEngineAudioAccompanyEnded | 播放完毕。 |
AliEngineAudioAccompanyBuffering | 正在缓冲。 |
AliEngineAudioAccompanyBufferingEnd | 缓冲结束。 |
AliEngineAudioAccompanyFailed | 播放失败。 |
AliEngineAudioAccompanyErrorCode
音乐伴奏播放错误码。
枚举名 | 描述 |
AliEngineAudioAccompanyNoError | 没有错误。 |
AliEngineAudioAccompanyOpenFailed | 打开文件错误。 |
AliEngineAudioAccompanyDecodeFailed | 解码文件错误。 |