通过阅读本文,您可以了解Windows SDK涉及的数据类型。

目录

数据类型 描述 支持的最低版本
AliEngineInterfaceIdType 功能接口类型。 2.1
AliEngineCameraDirection 相机方向。 2.1
AliEngineCaptureOutputPreference 采集偏好。 2.1
AliEngineCameraCapturerConfiguration 相机采集偏好。 2.1
AliEngineOrientationMode 设备方向。 2.1
AliEngineAudioSessionOperationRestriction AVAudioSession控制权限设置(适用于Mac端)。 2.1
AliEngineAudioEffectVoiceChangerMode 变声音效模式。 2.2
AliEngineAudioPlayingType 音乐伴奏播放状态。 2.1
AliEngineAudioPlayingErrorCode 音乐伴奏播放错误码。 2.1
AliEngineConnectionStatus 网络连接状态。 2.1
AliEngineConnectionStatusChangeReason 网络连接状态变更原因。 2.1
AliEngineAudioRouteType 语音路由类型。 2.1
AliEnginePublishState 推流状态。 2.1
AliEngineSubscribeState 订阅状态。 2.1
AliEngineMpuTaskPane 旁路直播自定义窗格。 2.2
AliEngineTranscodingUserArray 旁路直播用户列表。 2.1
AliEngineTrascodingLiveStreamErrorCode 旁路推流错误码。 2.1
AliEngineTrascodingPublsihTaskStatus 旁路推流PublishTask状态。 2.1
AliEngineChannelRelayEvent 跨频道转发事件。 2.1
AliEngineChannelRelayState 跨频道转发状态。 2.1
AliEngineChannelRelayErrorCode 跨频道转发错误码。 2.1
AliEngineChannelRelayConfiguration 跨频道转推设置。 2.2
AliEngineVideoTrack 视频流类型。 2.1
AliEngineAudioTrack 音频流类型。 2.1
AliEngineVideoStreamType 相机流类型。 2.1
AliEngineVideoSource 视频数据源。 2.1
AliEngineVideoRecordSource 录制视频数据源。 2.1
AliEngineVideoFormat 视频数据类型。 2.1
AliEngineBufferType 视频数据格式。 2.1
AliEngineRenderMode 视频窗口填充方式。 2.1
AliEngineRotationMode 视频旋转角度。 2.1
AliEngineAudioNumChannelType 音频声道类型。 2.1
AliEngineAudioSampleRate 音频采样率类型。 2.1
AliEngineAudioSource 音频裸数据源类型。 2.1
AliEngineAudioRawData 音频裸数据。 2.1
AliEngineVideoRawData 视频裸数据。 2.1
AliEngineNetworkQuality 网络质量。 2.1
AliEngineLogLevel 日志级别。 2.2
AliEngineAuthInfo 鉴权信息。 2.1
AliEngineAuthInfoList 鉴权列表。 2.2
AliEngineVideoCanvas 渲染画布。 2.1
AliEngineOnByeType OnBye类型。 2.1
AliEngineUserOfflineReason 用户离线原因。 2.1
AliEngineScreenShareType 桌面分享类型。 2.1
AliEngineClientRole 角色类型。 2.1
AliEngineExternalDeviceType 外接设备类型。 2.1
AliEngineExternalDeviceState 外接设备状态。 2.1
AliEngineVideoScale 视频缩放比例。 2.1
AliEngineMuteLocalAudioMode 本地静音模式。 2.1
AliEngineUserVolumeInfo 用户音量信息。 2.2
AliEngineScreenSourceList 屏幕分享源列表。 2.2
AliEngineScreenShareRegion 屏幕共享区域。 2.1
AliEngineScreenSourcInfo 屏幕分享源信息。 2.1
AliEngineScreenShareEncoderConfiguration 屏幕流码属性设置。 2.1
AliEngineScreenShareConfig 屏幕共享参数配置。 2.1
AliEngineScreenShareInfo 屏幕共享配置信息。 2.1
AliEngineStats 会话数据统计信息。 2.2
AliEngineLocalVideoStats 本地视频统计信息。 2.2
AliEngineRemoteVideoStats 远端视频统计信息。 2.2
AliEngineLocalAudioStats 本地音频统计信息。 2.2
AliEngineRemoteAudioStats 远端音频统计信息。 2.2
AliEngineAudioEffectReverbMode 音效模式。 2.2
AliEngineAudioEffectReverbParamType 音效混响模式。 2.2
AliEngineAudioProfile 音频编码配置。 2.1
AliEngineAudioScenario 音频场景。 2.1
AliEngineRecordType 录制类型。 2.1
AliEngineRecordFormat 录制格式。 2.1
AliEngineAudioQuality 录制音频质量。 2.1
AliEngineVideoQuality 录制视频质量。 2.1
AliEngineRecordAudioConfig 录制音频设置。 2.1
AliEngineRecordVideoConfig 录制视频设置。 2.1
AliEngineVideoRecordCanvasConfig 录制视频分辨率。 2.1
AliEngineRecordVideoBgColor 录制视频背景色。 2.2
AliEngineRecordVideoRational 录制视频坐标值。 2.2
AliEngineRecordVideoLayoutMode 录制视频布局模板。 2.2
AliEngineRecordVideoRectangle 录制视频坐标。 2.1
AliEngineRecordVideoRegion 录制视频用户布局。 2.1
AliEngineRecordVideoLayout 录制视频布局。 2.2
AliEngineRecordVideoRegionArray 本地录制布局列表。 2.1
AliEngineRecordTemplate 录制视频模板。 2.1
AliEngineFrameRate 视频帧率。 2.1
AliEngineVideoEncoderBitrate 视频编码码率。 2.1
AliEngineVideoEncoderOrientationMode 视频输出模式。 2.1
AliEngineVideoMirrorMode 视频镜像模式。 2.1
AliEngineRenderMirrorMode 视频窗口镜像模式。 2.1
AliEngineVideoDimensions 视频分辨率。 2.1
AliEngineVideoEncoderConfiguration 视频编码属性设置。 2.1
AliEngineChannelProfile 频道类型。 2.1
AliEngineFeedbackType SDK反馈问题类型。 2.1
AliEngineErrorCode SDK错误码。 2.1
AliEngineBeautyConfig 美颜设置。 2.1
AliEngineWaterMarkPosition 水印坐标系。 2.1
AliEngineWaterMarkConfig 水印配置。 2.1
AliEngineDeviceInfo 设备信息。 2.1
AliEngineDeviceInfoList 设备列表。 2.1
AliEngineVideoObserPosition 视频数据输出位置。 2.1
AliEngineShowDebugViewType 显示仪表盘类型。 2.4
AliEngineLiveTranscodingState 旁路直播状态。 2.4
AliEngineLiveTranscodingMixMode 旁路模式。 2.4
AliEngineLiveTranscodingStreamType 旁路直播转推流模式。 2.4
AliEngineLiveTranscodingSourceType 旁路直播输入类型。 2.4
AliEngineLiveTranscodingTaskProfile 旁路直播计费规格。 2.4
AliEngineLiveTranscodingAudioSampleRate 旁路直播音频采样率。 2.4
AliEngineLiveTranscodingFontType 旁路直播文字类型。 2.4
AliEngineLiveTranscodingCropMode 旁路直播裁剪模式。 2.4
AliEngineLiveTranscodingMediaProcessMode 旁路直播媒体处理模式。 2.4
AliEngineLiveTranscodingSegmentType 人像分割类型。 2.4
AliEngineVideoState 视频流的状态。 2.4
AliEngineVideoReason 触发视频流状态变化的原因。 2.4
AliEngineBokehScaleModel 虚拟背景图缩放模式。 2.4
AliEngineVideoObserAlignment 视频输出宽度对齐方式。 2.4
AliEngineLiveTranscodingErrorCode 旁路推流错误码。 2.4
AliEngineTrascodingPublishTaskStatus 旁路推流PublishTask状态。 2.4
AliEngineLiveTranscodingEncodeParam 旁路直播编码参数。 2.4
AliEngineLiveTranscodingImage 旁路直播图片。 2.4
AliEngineLiveTranscodingClockWidget 旁路直播时钟小工具。 2.4
AliEngineLiveTranscodingText 旁路直播文字格式。 2.4
AliEngineLiveTranscodingUser 旁路直播用户信息。 2.4
AliEngineLiveTranscodingSingleParam 旁路模式单路参数。 2.4
AliEngineLiveTranscodingMixParam 旁路模式混流参数。 2.4
AliEngineLiveTranscodingParam 旁路直播参数。 2.4

详情

  • AliEngineInterfaceIdType:功能接口类型。
    枚举名 描述
    AliEngineInterfaceAudioDeviceManger 音频设备管理类。
    AliEngineInterfaceVideoDeviceManger 视频设备管理类。
    AliEngineInterfaceMediaEngine 媒体引擎类。
  • AliEngineCameraDirection:相机方向。
    枚举名 描述
    AliEngineCameraDirectionInvalid 无效相机方向。
    AliEngineCameraDirectionBack 后摄像头。
    AliEngineCameraDirectionFront 前摄像头。
  • AliEngineCaptureOutputPreference:采集偏好。
    枚举名 描述
    AliEngineCaptureOutputPreferenceAuto 自动调整采集参数(默认)。
    AliEngineCaptureOutputPreferencePerformance 根据设置的发布profile分辨率和帧率,选择最接近的摄像头输出参数。
    AliEngineCaptureOutputPreferencePreview 选择较高的摄像头输出参数。
  • AliEngineCameraCapturerConfiguration:相机采集偏好。
    参数 类型 描述
    preference AliEngineCaptureOutputPreference 采集偏好。
    cameraDirection AliEngineCameraDirection 相机方向(只支持Android和iOS)。
  • AliEngineOrientationMode:设备方向。
    枚举名 描述
    AliEngineOrientationModePortrait 固定竖屏模式(默认值)。
    AliEngineOrientationModeLandscapeLeft 固定左横屏模式。
    AliEngineOrientationModePortraitUpsideDown 固定竖屏倒置模式。
    AliEngineOrientationModeLandscapeRight 固定右横屏模式。
    AliEngineOrientationModeAuto 自适应横竖屏模式。
  • AliEngineAudioSessionOperationRestriction:AVAudioSession控制权限设置(适用于Mac端)。
    枚举名 描述
    AliEngineAudioSessionOperationRestrictionNone 没有限制,SDK完全控制AVAudioSession。
    AliEngineAudioSessionOperationRestrictionSetCategory SDK不能修改AVAudioSession的Category。
    AliEngineAudioSessionOperationRestrictionConfigureSession SDK不能修改AVAudioSession的配置,包括Category、Mode、CategoryOptions。
    AliEngineAudioSessionOperationRestrictionDeactivateSession SDK不能关闭AVAudioSession的活动状态,离开频道时,AVAudioSession依然处于活动状态。
  • AliEngineAudioEffectVoiceChangerMode:变声音效模式。
    枚举名 描述
    AliEngineAudioEffectVoiceChangerOff 关闭。
    AliEngineAudioEffectVoiceChangerOldMan 老人。
    AliEngineAudioEffectVoiceChangerBabyBoy 男孩。
    AliEngineAudioEffectVoiceChangerBabGirl 女孩。
    AliEngineAudioEffectVoiceChangerRobot 机器人。
    AliEngineAudioEffectVoiceChangerDaimo 大魔王。
    AliEngineAudioEffectVoiceChangerKTV KTV。
    AliEngineAudioEffectVoiceChangerEcho 回声。
  • AliEngineAudioPlayingType:音乐伴奏播放状态。
    枚举名 描述
    AliEngineAudioPlayingStarted 开始播放。
    AliEngineAudioPlayingStopped 停止播放。
    AliEngineAudioPlayingPaused 暂停播放。
    AliEngineAudioPlayingResumed 重启播放。
    AliEngineAudioPlayingEnded 播放结束。
    AliEngineAudioPlayingBuffering 播放缓冲中。
    AliEngineAudioPlayingBufferingEnd 播放缓冲完。
    AliEngineAudioPlayingFailed 播放失败。
  • AliEngineAudioPlayingErrorCode:音乐伴奏播放错误码。
    枚举名 描述
    AliEngineAudioPlayingNoError 伴奏播放正常。
    AliEngineAudioPlayingOpenFailed 伴奏播放打开失败。
    AliEngineAudioPlayingDecodeFailed 伴奏播放解码失败。
  • AliEngineConnectionStatus:网络连接状态。
    枚举名 描述
    AliEngineConnectionInit 初始化完成。
    AliEngineConnectionDisconnected 网络连接断开。
    AliEngineConnectionConnecting 建立网络连接中。
    AliEngineConnectionConnected 网络已连接。
    AliEngineConnectionReconnecting 重新建立网络连接中。
    AliEngineConnectionFailed 网络连接失败。
  • AliEngineConnectionStatusChangeReason:网络连接状态变更原因。
    枚举名 描述
    AliEngineConnectionChangedDummyReason 未知原因。
    AliEngineConnectionMediaPathChanged 媒体通道变更。
    AliEngineConnectionSignalingHeartbeatTimeout 心跳超时。
    AliEngineConnectionSignalingHeartbeatAlive 心跳恢复。
    AliEngineConnectionSignalingHttpdnsResolved DNS解析成功。
    AliEngineConnectionSignalingHttpdnsFailure DNS解析失败。
    AliEngineConnectionSignalingGslbFailure GSLB请求失败。
    AliEngineConnectionSignalingGslbSucccess GSLB请求成功。
    AliEngineConnectionSignalingJoinChannelFailure 加入频道失败。
    AliEngineConnectionSignalingJoinChannelSuccess 加入频道成功。
    AliEngineConnectionSignalingLeaveChannel 离开频道。
    AliEngineConnectionSignalingConnecting 信令建立连接。
  • AliEngineAudioRouteType:语音路由类型。
    枚举名 描述
    AliEngineAudioRouteTypeDefault 默认的语音路由。
    AliEngineAudioRouteTypeHeadset 耳机。
    AliEngineAudioRouteTypeEarpiece 听筒。
    AliEngineAudioRouteTypeHeadsetNoMic 不带麦的耳机。
    AliEngineAudioRouteTypeSpeakerphone 手机扬声器。
    AliEngineAudioRouteTypeLoudSpeaker 外接扬声器。
    AliEngineAudioRouteTypeBlueTooth 蓝牙耳机。
  • AliEnginePublishState:推流状态。
    枚举名 描述
    AliEngineStatsPublishIdle 初始状态。
    AliEngineStatsNoPublish 未推流。
    AliEngineStatsPublishing 推流中。
    AliEngineStatsPublished 已推流。
  • AliEngineSubscribeState:订阅状态。
    枚举名 描述
    AliEngineStatsSubscribeIdle 初始状态。
    AliEngineStatsNoSubscribe 未订阅。
    AliEngineStatsSubscribing 订阅中。
    AliEngineStatsSubscribed 已订阅。
  • AliEngineMpuTaskPane:旁路直播自定义窗格。
    参数 类型 描述
    paneId int 布局ID。
    majorPane int 主布局,默认0。
    x float 坐标X,归一化百分比。
    y float 坐标Y,归一化百分比。
    width float 窗格宽,归一化百分比。
    height float 窗格高,归一化百分比。
    zorder int 叠放顺序,0为最底层,1层在0层之上,以此类推。
    userId String 用户ID。
    sourceType String 源类型,取值:
    • camera(默认值):视频流。
    • shareScreen:共享屏幕流。
    segmentType int 布局类型,默认0。
  • AliEngineTranscodingUserArray:旁路直播用户列表。
    返回类型 方法 参数 类型 描述
    void AddTranscodingUser item AliEngineLiveTranscodingUser 添加直播用户。
    void RemoveTranscodingUser item AliEngineLiveTranscodingUser 移除直播用户。
    AliEngineLiveTranscodingUser GetTranscodingUser index int 获取指定直播用户。
    void Clear 清空。
    int Count 统计。
  • AliEngineTrascodingLiveStreamErrorCode:旁路推流错误码。
    枚举名 描述
    AliEngineTrascodingLiveStreamErrorUserStop 用户停止任务。
    AliEngineTrascodingLiveStreamErrorChannelStop channel已停止。
    AliEngineTrascodingLiveStreamErrorInvalidNetwork 网络或CDN问题,直播停止。
    AliEngineTrascodingLiveStreamErrorInvalidSteamURL 直播URL问题,直播停止。
  • AliEngineTrascodingPublsihTaskStatus:旁路推流PublishTask状态。
    枚举名 描述
    AliEngineTrascodingPublsihTaskStatusStart 用户停止任务。
    AliEngineTrascodingLiveStreamErrorChannelStop channel已停止。
    AliEngineTrascodingLiveStreamErrorInvalidNetwork 网络或CDN问题,直播停止。
    AliEngineTrascodingLiveStreamErrorInvalidSteamURL 直播URL问题,直播停止。
  • AliEngineChannelRelayEvent:跨频道转发事件。
    枚举名 描述
    AliEngineChannelRelayEventStart 开启。
    AliEngineChannelRelayEventUpdate 更新。
    AliEngineChannelRelayEventStop 停止。
  • AliEngineChannelRelayState:跨频道转发状态。
    枚举名 描述
    AliEngineChannelRelayStateInit 初始化。
    AliEngineChannelRelayStateConnecting 连接中。
    AliEngineChannelRelayStateRunning 转发中。
    AliEngineChannelRelayStateFailure 转发失败。
  • AliEngineChannelRelayErrorCode:跨频道转发错误码。
    枚举名 描述
    AliEngineChannelRelayErrorStateError 检测到本地状态不对,没入会,角色错误,频道模式错误。
    AliEngineChannelRelayErrorSrcNotAllow 服务端返回436,源通道模式不匹配。
    AliEngineChannelRelayErrorJoinDestFailed 服务端返回437,目标通道不存在或者模式不匹配。
    AliEngineChannelRelayErrorTokenInvalid 服务端返回438,token无效。
    AliEngineChannelRelayErrorRoleError 服务端返651,session不是主播。
    AliEngineChannelRelayErrorInvalidParam 服务端400,参数错误。
    AliEngineChannelRelayErrorToSelf 服务端返回440,不能转推到本频道。
  • AliEngineChannelRelayConfiguration:跨频道转推设置。
    参数 类型 描述
    dests AliEngineAuthInfo* 鉴权信息。
    destsSize int 鉴权信息数量。
  • AliEngineVideoTrack:视频流的类型。
    枚举名 描述
    AliEngineVideoTrackNo 无视频流。
    AliEngineVideoTrackCamera 摄像头流。
    AliEngineVideoTrackScreen 屏幕共享流。
    AliEngineVideoTrackBoth 摄像头和屏幕共享。
  • AliEngineAudioTrack:音频流的类型。
    枚举名 描述
    AliEngineAudioTrackNo 无音频流。
    AliEngineAudioTrackMic 麦克风流。
  • AliEngineVideoStreamType:相机流类型。
    枚举名 描述
    AliEngineVideoStreamTypeNone 无视频流。
    AliEngineVideoStreamTypeHigh 大流。
    AliEngineVideoStreamTypeLow 小流。
  • AliEngineVideoSource:视频数据源。
    枚举名 描述
    AliEngineVideoSourceCamera 摄像头流。
    AliEngineVideoSourceScreenShare 共享流。
  • AliEngineVideoRecordSource:录制视频数据源。
    枚举名 描述
    AliEngineVideoRecordSourceCamera 摄像头流。
    AliEngineVideoRecordSourceScreenShare 屏幕共享流。
    AliEngineVideoRecordSourceBoth 摄像头和屏幕共享流。
  • AliEngineVideoFormat:视频数据类型。
    枚举名 描述
    AliEngineVideoFormatUnknow 未知。
    AliEngineVideoFormatBGRA BGRA。
    AliEngineVideoFormatI420 I420。
    AliEngineVideoFormatNV21 NV21。
    AliEngineVideoFormatNV12 NV12。
    AliEngineVideoFormatRGBA RGBA。
    AliEngineVideoFormatI422 I422。
    AliEngineVideoFormatARGB ARGB。
    AliEngineVideoFormatABGR ABGR。
    AliEngineVideoFormatRGB24 RGB24。
    AliEngineVideoFormatBGR24 BGR24。
    AliEngineVideoFormatRGB565 RGB565。
    AliEngineVideoFormatTextureOES TextureOES。
    AliEngineVideoFormatTexture2D Texture2D。
  • AliEngineBufferType:视频数据格式。
    枚举名 描述
    AliEngineBufferTypeRawData 视频裸数据。
    AliEngineBufferTypeTexture 视频Texture数据。
  • AliEngineRenderMode:视频窗口填充方式。
    枚举名 描述
    AliEngineRenderModeAuto 自动模式。
    AliEngineRenderModeStretch 拉伸填充视图,不保持视频比例。
    AliEngineRenderModeFill 在保持视频宽高比的同时缩放,填充黑边。
    AliEngineRenderModeCrop 在保持视频宽高比的同时缩放,并裁剪以适合视图。
    AliEngineRenderModeScroll 滚动视图以显示更多内容。
  • AliEngineRotationMode:视频旋转角度。
    枚举名 描述
    AliEngineRotationMode_0 旋转0度。
    AliEngineRotationMode_90 旋转90度。
    AliEngineRotationMode_180 旋转180度。
    AliEngineRotationMode_270 旋转270度。
  • AliEngineAudioNumChannelType:音频声道类型。
    枚举名 描述
    AliEngineMonoAudio 单声道音频。
    AliEngineStereoAudio 立体声音频。
  • AliEngineAudioSampleRate:音频采样率类型。
    枚举名 描述
    AliEngineAudioSampleRate_8000 8000Hz。
    AliEngineAudioSampleRate_11025 11025Hz。
    AliEngineAudioSampleRate_16000 16000Hz。
    AliEngineAudioSampleRate_22050 22050Hz。
    AliEngineAudioSampleRate_32000 32000Hz。
    AliEngineAudioSampleRate_44100 44100Hz。
    AliEngineAudioSampleRate_48000 48000Hz。
  • AliEngineAudioSource:音频裸数据源类型。
    枚举名 描述
    AliEngineAudiosourcePub 发布。
    AliEngineAudiosourceSub 订阅。
    AliEngineAudiosourceRawData 原始数据。
  • AliEngineAudioRawData:音频裸数据。
    参数 类型 描述
    dataPtr void* 音频数据指针。
    numOfSamples int 样本数。
    bytesPerSample int 样本字节数。
    numOfChannels int 音频声道数。
    sampleRate int 音频采样率。
    samplesPerSec int 每秒采样数。
  • AliEngineVideoRawData:视频裸数据。
    参数 类型 描述
    dataPtr void* 视频数据指针。
    dataYPtr void* 指向YUV数据中的Y缓冲区指针的指针。
    dataUPtr void* 指向YUV数据中的U缓冲区指针的指针。
    dataVPtr void* 指向YUV数据中的V缓冲区指针的指针。
    format AliEngineVideoFormat 视频数据类型。
    type AliEngineBufferType 视频数据格式。
    dataLength long 数据长度。
    pixelBuffer int 像素缓冲区。
    strideY int 明亮度。
    strideU int 色度。
    strideV int 浓度。
    height int 视频像素高度。
    width int 视频像素宽度。
    rotation int 在渲染视频前设置该帧的顺时针旋转角度,目前支持0度、90度、180度和270度。
    stride int YUV数据中的行跨度。
    timeStamp long long 时间戳。
    textureId int 纹理ID。
    transformMatrix float 变换矩阵。
  • AliEngineNetworkQuality:网络质量。
    枚举名 描述
    AliEngineNetworkQualityExcellent 网络极好,流畅度清晰度质量好。
    AliEngineNetworkQualityGood 网络质量好,流畅度清晰度和极好差不多。
    AliEngineNetworkQualityPoor 网络质量较差,音视频流畅度清晰度有瑕疵,不影响沟通。
    AliEngineNetworkQualityBad 网络质量差,视频卡顿严重,音频能正常沟通。
    AliEngineNetworkQualityVeryBad 网络质量极差,基本无法沟通。
    AliEngineNetworkQualityDisconnect 网络中断。
    AliEngineNetworkQualityUnknow 未知。
  • AliEngineLogLevel:日志级别。
    枚举名 描述
    AliEngineLogLevelInfo = 3 普通。
    AliEngineLogLevelWarn 警告。
    AliEngineLogLevelError 错误。
    AliEngineLogLevelFatal 严重。
    AliEngineLogLevelNone 无。
  • AliEngineAuthInfo:鉴权信息
    参数 类型 描述
    channel char* 频道号。
    user_id char* 用户ID。
    appid char* 应用ID。
    nonce char* 令牌随机码。
    token char* 令牌。
    role char* 角色类型。默认值为空,表示不涉及此功能。取值:
    • pub:主播角色。
    • sub:观众角色。
    更多信息,请参见如何进行角色鉴权
    session char* 会话。
    gslb char** 服务器地址。
    gslbCount int 服务器地址个数。
    timestamp unsigned long long 时间戳。
    agent char** Agent服务器地址(默认不传递此参数)。
    agentCount int Agent服务器地址个数。
  • AliEngineAuthInfoList:鉴权列表。
    参数 类型 描述
    infoList AliEngineAuthInfo* 鉴权信息存储指针。
    count int 鉴权信息存储数量。
  • AliEngineVideoCanvas:渲染画布。
    参数 类型 描述
    displayView void * 渲染窗口句柄。
    renderMode AliEngineRenderMode 渲染模式,默认AliEngineRenderModeAuto。
    mirrorMode AliEngineRenderMirrorMode 镜像,默认AliEngineRenderMirrorModeOnlyFrontMirror。
    backgroundColor int 背景颜色,格式为RGB的Hex。
    rotation AliEngineRotationMode 视频旋转角度,默认AliEngineRotationMode_0。
    scaleMode AliEngineVideoScale 预览缩放比例。
    renderId long long 渲染的唯一ID,等同windows下displayView。
    width int 显示宽度。
    height int 显示高度。
    enableGL bool 是否开启GL,默认true(开启)。
  • AliEngineOnByeType:OnBye类型。
    枚举名 描述
    AliEngineOnByeBeKickOut 当前用户被踢出频道。
    AliEngineOnByeChannelTerminated 频道结束。
    AliEngineOnByeUserReplaced 相同用户在其他设备加入频道,当前设备被下线。
  • AliEngineUserOfflineReason:用户离线原因。
    枚举名 描述
    AliEngineUserOfflineQuit 用户主动离开。
    AliEngineUserOfflineDropped 因过长时间收不到对方数据包,超时掉线。
    AliEngineUserOfflineBecomeAudience 用户身份从主播切换为观众时触发。
  • AliEngineScreenShareType:桌面分享类型。
    枚举名 描述
    AliEngineScreenShareDesktop 桌面分享。
    AliEngineScreenShareWindow 窗口分享。
  • AliEngineClientRole:角色类型。
    枚举名 描述
    AliEngineClientRoleInteractive 参与互动角色。
    AliEngineClientRoleLive 仅观看角色。
  • AliEngineExternalDeviceType:外接设备类型。
    枚举名 描述
    AliEngineExternalTypeUnknown 未知类型。
    AliEngineExternalTypeAudioCapture 音频采集设备。
    AliEngineExternalTypeAudioPlayout 音频播放设备。
    AliEngineExternalTypeVideoCapture 视频采集设备。
  • AliEngineExternalDeviceState:外接设备状态。
    枚举名 描述
    AliEngineExternalDeviceAdd 新增外接设备。
    AliEngineExternalDeviceRemove 移除外接设备。
  • AliEngineVideoScale:视频缩放比例。
    枚举名 描述
    AliEngineVideoScale_16_9 16:9。
    AliEngineVideoScale_4_3 4:3。
  • AliEngineMuteLocalAudioMode:本地静音模式。
    枚举名 描述。
    AliEngineMuteLocalAudioModeDefault 默认静音。
    AliEngineMuteLocalAudioModeMuteAll 禁止本地所有音。
    AliEngineMuteLocalAudioModeMuteOnlyMic 禁止麦克风。
  • AliEngineUserVolumeInfo:用户音量信息。
    参数 类型 描述
    uid String 用户ID(从AppServer下发的唯一标示符)。
    volume int 用户音量,取值范围:[0,255]。
    sumVolume int 回调周期内累计的音量,用于判别当前说话人。
    speechState int 语音状态,取值:
    • 0:当前未说话。
    • 1:当前在说话。
  • AliEngineScreenSourceList:屏幕分享源列表。
    返回类型 方法 参数 类型 描述
    unsigned int GetCount 屏幕分享源数量。
    AliEngineScreenSourcInfo GetSourceInfo index unsigned int 获取指定屏幕分享源。
    void Release 释放。
  • AliEngineScreenShareRegion:屏幕共享区域。
    参数 类型 描述
    originX float x轴。
    originY float y轴。
    width float 宽度。
    height float 高度。
  • AliEngineScreenSourcInfo:屏幕分享源信息。
    参数 类型 描述
    sourceId String 共享源ID。
    sourceTitle String 共享源名。
  • AliEngineScreenShareEncoderConfiguration:屏幕流码属性设置。
    参数 类型 描述
    dimensions AliEngineVideoDimensions 视频分辨率。
    frameRate AliEngineFrameRate 视频帧率。
    bitrate int 码率。
    rotationMode AliEngineRotationMode 视频旋转角度。
  • AliEngineScreenShareConfig:屏幕共享参数配置。
    参数 类型 描述
    isShareByRegion bool 是否指定区域,默认false。
    shareRegion AliEngineScreenShareRegion 屏幕分享区域。
  • AliEngineScreenShareInfo:屏幕共享配置信息。
    参数 类型 描述
    shareType AliEngineScreenShareType 桌面分享类型。
    shareSourceId unsigned int 共享源ID。
    shareConfig AliEngineScreenShareConfig 屏幕共享参数配置。
  • 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 int64_t 延时时长,单位:毫秒。
  • AliEngineLocalVideoStats:本地视频统计信息。
    参数 类型 描述
    track AliEngineVideoTrack 视频流类型。
    sentBitrate unsigned int 发送码率。
    sentFps unsigned int 发送帧率。
    encodeFps unsigned int 编码器输出帧率。
  • 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 音频流类型。
    sentBitrate unsigned int 发送码率。
    sentSamplerate unsigned int 发送的采样率。
    numChannel unsigned int 声道数。
    inputLevel unsigned int 输入音量。
  • AliEngineRemoteAudioStats:远端音频统计信息。
    参数 类型 描述
    userId const char* 远端用户UID。
    track AliEngineAudioTrack 音频流类型。
    quality int 音质。
    networkTransportDelay int 发送端到接收端的网络延时,单位:毫秒。
    jitterBufferDelay int 接受端到网络抖动缓存的网络延时,单位:毫秒。
    audioLossRate int 音频丢包率。
    rcvdBitrate int 接收码率。
    totalFrozenTimes int 卡顿次数。
  • AliEngineAudioEffectReverbMode:音效模式。
    枚举名 描述
    AliEngineAudioEffectReverbOff 关闭。
    AliEngineAudioEffectReverbVocal_I 人声I。
    AliEngineAudioEffectReverbVocal_II 人声II。
    AliEngineAudioEffectReverbBathroom 澡堂。
    AliEngineAudioEffectReverbSmallRoomBright 明亮小房间。
    AliEngineAudioEffectReverbSmallRoomDark 黑暗小房间。
    AliEngineAudioEffectReverbMediumRoom 中等房间。
    AliEngineAudioEffectReverbLargeRoom 大房间。
    AliEngineAudioEffectReverbChurchHall 教堂走廊。
  • AliEngineAudioEffectReverbParamType:音效混响模式。
    枚举名 描述
    AliEngineAudioEffectReverbRoomSize 房间大小,范围:[0,100]。
    AliEngineAudioEffectReverbPreDelay 预延时,单位:ms,范围:[0,200]。
    AliEngineAudioEffectReverbReverberance 混响感,范围:[0,100]。
    AliEngineAudioEffectReverbHfDamping 消声,范围:[0,100]。
    AliEngineAudioEffectReverbToneLow 低音调,范围:[0,100]。
    AliEngineAudioEffectReverbToneHigh 高音调,范围:[0,100]。
    AliEngineAudioEffectReverbDryGain 干增益,范围:[-20,10]。
    AliEngineAudioEffectReverbWetGain 湿增益,范围:[-20,10]。
  • AliEngineAudioProfile:音频编码配置。
    枚举名 描述
    AliEngineLowQualityMode 低音质。
    AliEngineBasicQualityMode 标准音质。
    AliEngineHighQualityMode 高音质。
    AliEngineStereoHighQualityMode 立体高音质。
    AliEngineSuperHighQualityMode 超高音质。
    AliEngineStereoSuperHighQualityMode 立体超高音质。
  • AliEngineAudioScenario:音频场景。
    枚举名 描述
    AliEngineSceneDefaultMode 默认场景。
    AliEngineSceneEducationMode 教育场景。
    AliEngineSeneMediaMode 媒体场景。
    AliEngineSceneMusicMode 音乐场景。
    AliEngineSceneChatroomMode 聊天室场景,适用于频繁上下麦的聊天场景,音量条始终为语音通话音量条。
  • AliEngineRecordType:录制类型。
    枚举名 描述
    AliEngineRecordTypeAudio 纯音频录制。
    AliEngineRecordTypeVideo 纯视频录制。
    AliEngineRecordTypeBoth 音视频录制。
  • AliEngineRecordFormat:录制格式。
    枚举名 描述
    AliEngineRecordFormatAAC AAC文件。
    AliEngineRecordFormatWAV WAV文件。
    AliEngineRecordFormatMP4 MP4文件。
  • AliEngineAudioQuality:录制音频质量。
    枚举名 描述
    AliEngineAudioQualityLow 低。
    AliEngineAudioQualityMidium 中。
    AliEngineAudioQualityHigh 高。
  • AliEngineVideoQuality:录制视频质量。
    枚举名 描述
    AliEngineVideoQualityDefault 默认,和采集保持一致(例如采集能力为1080P,默认就录制1080P的视频流)。
  • AliEngineRecordAudioConfig:录制音频设置。
    参数 类型 描述
    sampleRate AliEngineAudioSampleRate 音频采样率。
    quality AliEngineAudioQuality 音频质量。
    externalPcmCaptureRecording bool 外部PCM输入录制。
    externalPcmRenderRecording bool 外部PCM渲染录制。
  • AliEngineRecordVideoConfig:录制视频设置。
    参数 类型 描述
    fps int 帧率。
    bitrate int 码率。
    quality AliEngineVideoQuality 视频质量。
    sourceType AliEngineVideoRecordSource 视频源类型。
  • AliEngineVideoRecordCanvasConfig:录制视频分辨率。
    参数 类型 描述
    canvasWidth int 分辨率宽。
    canvasHeight int 分辨率高。
  • AliEngineRecordVideoBgColor:录制视频背景色。
    参数 类型 描述
    r unsigned char r(红)。
    g unsigned char g(绿)。
    b unsigned char b(蓝)。
  • AliEngineRecordVideoRational:录制视频坐标值。
    参数 类型 描述
    numerator unsigned int 分子。
    denominator unsigned int 分母。
  • AliEngineRecordVideoLayoutMode:录制视频布局模板。
    枚举名 描述
    AliEngineRecordVideoLayoutModeGrid GRID布局。
    AliEngineRecordVideoLayoutModeSpeaker SPEAKER布局。
    AliEngineRecordVideoLayoutModeUnique UNIQUE布局。
    AliEngineRecordVideoLayoutModeCustom CUSTOM布局。
  • AliEngineRecordVideoRectangle:录制视频坐标。
    参数 类型 描述
    left AliEngineRecordVideoRational 左。
    top AliEngineRecordVideoRational 上。
    width AliEngineRecordVideoRational 宽度。
    height AliEngineRecordVideoRational 高度。
  • AliEngineRecordVideoRegion:录制视频用户布局。
    参数 类型 描述
    userId char* 用户ID。
    sourceType AliEngineVideoSource 视频源类型。
    area AliEngineRecordVideoRectangle 录制视频坐标。
  • AliEngineRecordVideoLayout:录制视频布局。
    参数 类型 描述
    mode AliEngineRecordVideoLayoutMode 录制视频布局,默认值为AliEngineRecordVideoLayoutModeGrid。
    shapes AliEngineRecordVideoRegionArray 本地录制布局列表。
    backColor AliEngineRecordVideoBgColor 录制视频背景色。
  • AliEngineRecordVideoRegionArray:本地录制布局列表。
    返回类型 方法 参数 类型 描述
    void AddRecordVideoRegion item const AliEngineRecordVideoRegion & 添加用户布局。
    const AliEngineRecordVideoRegion & GetRecordVideoRegion index int 获取指定用户布局。
    void Clear 清空。
    int Count 统计用户布局数量。
  • AliEngineRecordTemplate:录制视频模板。
    参数 类型 描述
    recordType AliEngineRecordType 录制类型。
    recordFormat AliEngineRecordFormat 录制格式。
    sampleRate AliEngineAudioSampleRate 音频采样率类型。
    audioQuality AliEngineAudioQuality 录制音频质量。
    externalPcmCaptureRecording bool 是否录制外部音频采集。
    externalPcmRenderRecording bool 是否录制外部音频渲染。
    canvas AliEngineVideoRecordCanvasConfig 录制视频分辨率。
    isFragment bool MP4是否分段。
    fps int 帧率。
    bitrate int 码率。
  • AliEngineFrameRate:视频帧率。
    枚举值 描述
    AliEngineFrameRateFps5 5 fps。
    AliEngineFrameRateFps10 10 fps。
    AliEngineFrameRateFps15 15 fps。
    AliEngineFrameRateFps20 20 fps。
    AliEngineFrameRateFps25 25 fps。
    AliEngineFrameRateFps30 30 fps。
  • AliEngineVideoEncoderBitrate:视频编码码率。
    枚举值 描述
    AliEngineVideoStandardBitrate 标准编码码率。
  • AliEngineVideoEncoderOrientationMode:视频输出模式。
    枚举值 描述
    AliEngineVideoEncoderOrientationModeAdaptive 自适应模式(默认值)。
    AliEngineVideoEncoderOrientationModeFixedLandscape 横向模式。
    AliEngineVideoEncoderOrientationModeFixedPortrait 纵向模式。
  • AliEngineVideoMirrorMode:视频镜像模式。
    枚举值 描述
    AliEngineVideoMirrorModeDisabled 无镜像。
    AliEngineVideoMirrorModeEnable 镜像。
  • AliEngineRenderMirrorMode:视频窗口镜像模式。
    枚举值 描述
    AliEngineRenderMirrorModeOnlyFrontMirror 只有前置摄像头预览镜像,其余不镜像。
    AliEngineRenderMirrorModeAllMirror 全部镜像。
    AliEngineRenderMirrorModeAllNoMirror 全部不镜像。
    AliEngineRenderMirrorModeNoChange 镜像未改变
  • AliEngineVideoDimensions:视频分辨率。
    参数 类型 描述
    width int 宽。
    height int 高。
  • AliEngineVideoEncoderConfiguration:视频编码属性设置。
    参数 类型 描述
    dimensions AliEngineVideoDimensions 视频分辨率。
    frameRate AliEngineFrameRate 视频帧率。
    bitrate int 码率。
    orientationMode AliEngineVideoEncoderOrientationMode 视频输出模式。
    mirrorMode AliEngineVideoMirrorMode 视频镜像模式。
    rotationMode AliEngineRotationMode 视频旋转模式。
  • AliEngineChannelProfile:频道类型。
    枚举名 描述
    AliEngineCommunication 通信模式。
    AliEngineInteractiveLive 互动模式。
  • AliEngineFeedbackType:SDK反馈问题类型。
    枚举名 描述
    AliEngineFeedbackVideoDeviceFail 视频设备问题。
    AliEngineFeedbackVideoNotRender 视频无画面。
    AliEngineFeedbackAudioDeviceFail 音频设备问题。
    AliEngineFeedbackAudioNotRender 音频无声音。
    AliEngineFeedbackAudioEchoError 音频回声异常。
    AliEngineFeedbackChannelTypeError 会议状态异常,例如入会异常、离会异常等。
    AliEngineFeedbackSDKTypeError SDK其他状态异常。
    AliEngineFeedbackNetworkUnfluent 网络卡顿问题。
    AliEngineFeedbackVideoBlurring 视频清晰问题。
    AliEngineFeedbackUnkonw 未知类型。
  • AliEngineErrorCode:SDK错误码。
    枚举名 描述
    AliEngineErrorJoinBadAppId App ID不存在。
    AliEngineErrorJoinInvaildAppId App ID已失效。
    AliEngineErrorJoinBadChannel 频道不存在。
    AliEngineErrorJoinInvaildChannel 频道已失效。
    AliEngineErrorJoinBadToken Token不存在。
    AliEngineErrorJoinTimeout 加入频道超时。
    AliEngineErrorJoinBadParam 加入频道参数错误。
    AliEngineErrorJoinChannelFailed 加入频道失败。
    AliEngineErrorMicOpenFail 采集设备初始化失败。
    AliEngineErrorSpeakerOpenFail 播放设备初始化失败。
    AliEngineErrorMicInterrupt 采集过程中出现异常。
    AliEngineErrorSpeakerInterrupt 播放过程中出现异常。
    AliEngineErrorMicAuthFail 麦克风设备授权失败。
    AliEngineErrorMicNotAvailable 麦克风设备未授权。
    AliEngineErrorSpeakerNotAvailable 无可用的音频采集设备。
    AliEngineErrorCameraOpenFail 相机设备初始化失败。
    AliEngineErrorCameraInterrupt 相机采集中发生异常。
    AliEngineErrorVideoDisplayOpenFail 渲染设备初始化失败。
    AliEngineErrorVideoDisplayInterrupt 渲染过程中出现异常。
    AliEngineErrorAudioBufferFull 音频输入的buffer已满。
    AliEngineErrorVideoBufferFull 视频输入的buffer已满。
    AliEngineErrorAudioStreamError 音频流错误。
    AliEngineErrorAudioFileOpenFail 音频文件打开失败。
    AliEngineErrorAudioFormatNotSupported 音频格式不支持。
    AliEngineErrorIceConnectionConnectFail 媒体通道建立失败。
    AliEngineErrorIceConnectionReconnectFail 媒体通道重连失败。
    AliEngineErrorIceConnectionHeartbeatTimeout 信令心跳超时。
    AliEngineErrorLowLatencyLiveCommunicationFail 低延时互动直播信令失败。
    AliEngineErrorLowLatencyLiveMediaSettingFail 低延时互动直播媒体设置错误。
    AliEngineErrorLowLatencyLiveNoneBroadcaster 低延时互动直播当前房间没有主播推流。
    AliEngineErrorLowLatencyLiveNeedRestart 低延时互动直播错误,应用层需要重新创建新的SDK实例。
    AliEngineErrorLowLatencyLiveNeedRestartAgainLater 低延时互动直播错误,应用层需要稍等一定时间(自定义间隔)重新创建新的SDK实例。
    AliEngineErrorLowLatencyLiveServiceUnavailable 低延时互动直播服务不可用或者服务降级。
    AliEngineErrorLowLatencyLiveMediaConnectionInterrruption 低延时互动直播网络中断错误。
    AliEngineErrorUpdateRoleChannel 更新频道角色失败。
    AliEngineErrorPublishInvaild 推流无效。
    AliEngineErrorPublishNotJoinChannel 未入会推流错误。
    AliEngineErrorPublishAudioStreamFailed 推音频流失败。
    AliEngineErrorPublishVideoStreamFailed 推视频流失败。
    AliEngineErrorPublishDualStreamFailed 推双流失败。
    AliEngineErrorPublishScreenShareFailed 推共享流失败。
    AliEngineErrorPublishScreenShareConfigError 推共享流配置失败。
    AliEngineErrorSubscribeInvaild 订阅无效。
    AliEngineErrorSubscribeNotJoinChannel 未入会订阅错误。
    AliEngineErrorSubscribeAudioStreamFailed 订阅音频流失败。
    AliEngineErrorSubscribeVideoStreamFailed 订阅视频流失败。
    AliEngineErrorSubscribeDualStreamFailed 订阅双流失败。
    AliEngineErrorSubscribeScreenShareFailed 订阅共享流失败。
    AliEngineErrorInvaildState SDK内部状态错误。
    AliEngineErrorSessionRemoved session已经被移除。
    AliEngineErrorInvaildArgument 无效的参数。
    AliEngineErrorInner SDK内部错误。
  • AliEngineBeautyConfig:美颜设置。
    参数 类型 描述
    whiteningLevel float 美白,范围:[0,1],数值越大美白效果越好。
    smoothnessLevel float 磨皮,范围:[0,1],数值越大磨皮效果越好。
  • AliEngineWaterMarkPosition:水印坐标系。
    参数 类型 描述
    x float 起点x。
    y float 起点y。
    w float 宽度。
    h float 高度。
  • AliEngineWaterMarkConfig:水印配置。
    参数 类型 描述
    visibleInPreview bool 是否预览显示。
    positionInPortraitMode AliEngineWaterMarkPosition 纵向水印模式。
    positionInLandscapeMode AliEngineWaterMarkPosition 横向水印模式。
    alpha float 透明度。
    normalized bool 归一化。
  • AliEngineDeviceInfo:设备信息。
    参数 类型 描述
    deviceName String 设备名称。
    deviceID String 设备ID。
  • AliEngineDeviceInfoList:设备列表。
    返回类型 方法 参数 类型 描述
    unsigned int GetCount 设备数量。
    AliEngineDeviceInfo GetDeviceInfo index unsigned int 获取指定设备信息。
    void Release 释放。
  • AliEngineVideoObserPosition:视频数据输出位置。
    枚举名 描述
    AliEnginePositionPostCapture 采集视频数据,对应输出回调onCaptureVideoSample
    AliEnginePositionPreRender 渲染视频数据,对应输出回调onRemoteVideoSample
    AliEnginePositionPreEncoder 编码前视频数据,对应输出回调onPreEncodeVideoSample
  • AliEngineShowDebugViewType:显示仪表盘类型。
    枚举名 描述
    AliEngineShowTypeNone 不显示。
    AliEngineShowTypeAudio 音频。
    AliEngineShowTypeVideo 视频。
    AliEngineShowTypeNetwork 网络。
    AliEngineShowTypeAll 全部。
  • AliEngineLiveTranscodingState:旁路直播状态。
    枚举名 描述
    AliEngineLiveTranscodingState_IDLE 推流空闲。
    AliEngineLiveTranscodingState_CONNNECT 正在连接推流服务器。
    AliEngineLiveTranscodingState_RUNNING 正在连接推流服务器。
    AliEngineLiveTranscodingState_RECOVERING 正在恢复推流。
    AliEngineLiveTranscodingState_FAILURE 推流失败。
    AliEngineLiveTranscodingState_END 推流结束。
  • AliEngineLiveTranscodingMixMode:旁路模式。
    枚举名 描述
    AliEngineLiveTranscodingSINGLE 单路模式。
    AliEngineLiveTranscodingMIX 混流模式。
  • AliEngineLiveTranscodingStreamType:旁路直播转推流模式。
    枚举名 描述
    AliEngineLiveTranscodingOrigin 转推原始流。
    AliEngineLiveTranscodingAudio 仅转推音频流。
    AliEngineLiveTranscodingVideo 仅转推视频流。
  • AliEngineLiveTranscodingSourceType:旁路直播输入类型。
    枚举名 描述
    AliEngineLiveTranscodingCamera 相机。
    AliEngineLiveTranscodingShareScreen 共享屏幕。
  • 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 纯音频。
  • AliEngineLiveTranscodingAudioSampleRate:旁路直播音频采样率。
    枚举名 描述
    AliEngineLiveTranscoding_HZ_48000 采样率48000Hz。
    AliEngineLiveTranscoding_HZ_44100 采样率44100Hz。
    AliEngineLiveTranscoding_HZ_32000 采样率32000Hz。
    AliEngineLiveTranscoding_HZ_16000 采样率16000Hz。
    AliEngineLiveTranscoding_HZ_8000 采样率8000Hz。
  • 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。
  • AliEngineLiveTranscodingCropMode:旁路直播裁剪模式。
    枚举名 描述
    AliEngineLiveTranscodingCrop 保持比例裁剪。
    AliEngineLiveTranscodingFill 保持比例留边(默认值)。
  • AliEngineLiveTranscodingMediaProcessMode:旁路直播媒体处理模式。
    枚举名 描述
    AliEngineLiveTranscodingNormal 通用模式。
    AliEngineLiveTranscodingVirtualBackground 虚拟背景模式。
  • AliEngineLiveTranscodingSegmentType:人像分割类型。
    枚举名 描述
    AliEngineLiveTranscodingNoBody 无人像分割。
    AliEngineLiveTranscodingBody 人像分割。
  • AliEngineVideoState:视频流的状态。
    枚举名 描述
    AliEngineVideoClose 关闭视频流。
    AliEngineVideoOpen 恢复视频流。
  • AliEngineVideoReason:触发视频流状态变化的原因。
    枚举名 描述
    AliEngineVideoChangeByClient 客户端触发。
    AliEngineVideoChangeByServer 服务端触发。
  • AliEngineBokehScaleModel:虚拟背景图缩放模式。
    枚举名 描述
    AliEngineBokehScaleModelCrop 等比裁剪。
    AliEngineBokehScaleModelFill 填充黑边。
  • AliEngineVideoObserAlignment:视频输出宽度对齐方式。
    枚举名 描述
    AliEngineAlignmentDefault 保持原有视频宽度。
    AliEngineAlignmentEven 宽度偶数对齐。
    AliEngineAlignment4 宽度是4的倍数。
    AliEngineAlignment8 宽度是8的倍数。
    AliEngineAlignment16 宽度是16的倍数。
  • AliEngineLiveTranscodingErrorCode:旁路推流错误码。
    枚举名 描述
    AliEngineLiveTranscodingErrorPublishOk 推流成功。
    AliEngineLiveTranscodingErrorStreamNotFound 流未找到。
    AliEngineLiveTranscodingErrorStreamAlreadyExist 流已经存在。
    AliEngineLiveTranscodingErrorInvalidParam 无效参数。
    AliEngineLiveTranscodingErrorInternalError 内部错误。
    AliEngineLiveTranscodingErrorRtmpServerError RTMP服务器错误。
    AliEngineLiveTranscodingErrorRtmpStreamUrlError RTMP流URL错误。
    AliEngineLiveTranscodingErrorPublishTimeout 推流超时。
    AliEngineLiveTranscodingErrorNotAuthorized 未授权。
  • AliEngineTrascodingPublishTaskStatus:旁路推流PublishTask状态。
    枚举名 描述
    AliEngineTrascodingPublishTaskStatusStart 任务开始。
    AliEngineTrascodingPublishTaskStatusUpdate 任务更新。
    AliEngineTrascodingPublishTaskStatusStop 任务已停止。
  • AliEngineLiveTranscodingEncodeParam:旁路直播编码参数。
    参数 类型 描述
    videoWidth int 宽。
    videoHeight int 高。
    videoFramerate int 帧率。
    videoBitrate int 码率。
    videoGop int GOP。
    audioSamplerate AliEngineLiveTranscodingAudioSampleRate 旁路直播音频采样率。
    audioBitrate int 音频码率。
    audioChannels int 音频声道数。
  • AliEngineLiveTranscodingImage:旁路直播图片。
    参数 类型 描述
    url String 图片的HTTP或HTTPS地址。
    alpha float 当前水印框格对应图片的透明度。
    display DisplayType 图片显示。
    x int 坐标X(像素)。
    y int 坐标Y(像素)。
    width int 窗格宽(像素)。
    height int 窗格高(像素)。
    zOrder int 叠放顺序,0为最底层,1层在0层之上,以此类推。
  • DisplayType:旁路直播图片显示类型。
    枚举名 描述
    NOT_DISPLAY 不显示。
    ALWAYS 一直显示。
    WHEN_NO_VIDEO 当没有视频时候显示。
  • AliEngineLiveTranscodingClockWidget:旁路直播时钟小工具。
    参数 类型 描述
    x int 坐标X(像素)。
    y int 坐标Y(像素)。
    fontSize int 旁路直播字体大小。
    zOrder int 叠放顺序,0为最底层,1层在0层之上,以此类推。
    fontColor int 旁路直播字体颜色。
    fontType AliEngineLiveTranscodingFontType 旁路直播字体。
  • AliEngineLiveTranscodingText:旁路直播文字格式。
    参数 类型 描述
    text String 文本内容。
    x int 坐标X(像素)。
    y int 坐标Y(像素)。
    fontType AliEngineLiveTranscodingFontType 文字类型。
    fontSize int 字体大小,字体合理范围:(0, 72]。
    zOrder int 文字颜色(RGB)。计算公式为R + G × 256 + B × 65536,R(红)、G(绿)、B(蓝)的取值:0~255
    fontColor int 叠放顺序,0为最底层,1层在0层之上,以此类推。
  • AliEngineLiveTranscodingUser:旁路直播用户信息。
    参数 类型 描述
    userId String 对应布局框格的用户ID。
    x int 坐标X(像素)。
    y int 坐标Y(像素)。
    width int 窗格宽(像素)。
    height int 窗格高(像素)。
    zOrder int 叠放顺序,0为最底层,1层在0层之上,以此类推。
    sourceType AliEngineLiveTranscodingSourceType 旁路直播输入类型。
    segmentType AliEngineLiveTranscodingSegmentType 人像分割类型。
    images AliEngineLiveTranscodingImageArray 归属于当前Pane的图片框位列表,最多支持1张图片。
    texts AliEngineLiveTranscodingTextArray 归属于当前Pane的文字框位列表,最多支持16个文本。
  • AliEngineLiveTranscodingImageArray:旁路直播图片列表。
    返回类型 方法 参数 类型 描述
    void Add item AliEngineLiveTranscodingImage & 添加图片。
    AliEngineLiveTranscodingImage Get index int 获取图片。
    void Clear 清空。
    int Count 统计。
  • AliEngineLiveTranscodingTextArray:旁路直播文字列表。
    返回类型 方法 参数 类型 描述
    void Add item AliEngineLiveTranscodingText & 添加文字。
    AliEngineLiveTranscodingText Get index int 获取文字。
    void Clear 清空。
    int Count 统计。
  • AliEngineLiveTranscodingSingleParam:旁路模式单路参数。
    参数 类型 描述
    userId String 用户ID。
    streamType AliEngineLiveTranscodingStreamType 旁路直播转推流类型。
    sourceType AliEngineLiveTranscodingSourceType 旁路直播视频流类型。
  • AliEngineLiveTranscodingMixParam:旁路模式混流参数。
    参数 类型 描述
    taskProfile AliEngineLiveTranscodingTaskProfile 旁路直播计费规格。
    encodeParam AliEngineLiveTranscodingEncodeParam 旁路直播编码参数。
    users AliEngineLiveTranscodingUserArray 旁路直播用户列表。
    backgroundColor int 背景色。
    backgrounds AliEngineLiveTranscodingImageArray 背景图片列表。
    watermarks AliEngineLiveTranscodingImageArray 水印图片列表。
    clockWidgets AliEngineLiveTranscodingClockWidgetArray 时钟小部件列表。
    cropMode AliEngineLiveTranscodingCropMode 旁路直播裁剪模式。
    mediaProcessMode AliEngineLiveTranscodingMediaProcessMode 旁路直播媒体处理模式。
  • AliEngineLiveTranscodingUserArray:旁路直播用户列表。
    返回类型 方法 参数 类型 描述
    void AddTranscodingUser item AliEngineLiveTranscodingUser & 添加直播用户。
    AliEngineLiveTranscodingUser GetTranscodingUser index int 获取直播用户。
    void Clear 清空。
    void RemoveTranscodingUser item AliEngineLiveTranscodingUser 删除直播用户。
    int Count 统计。
  • AliEngineLiveTranscodingClockWidgetArray:旁路直播时钟格式列表。
    返回类型 方法 参数 类型 描述
    void Add item AliEngineLiveTranscodingClockWidget & 添加钟格。
    AliEngineLiveTranscodingClockWidget Get index int 获取钟格。
    void Clear 清空。
    int Count 统计。
  • AliEngineLiveTranscodingParam:旁路直播参数。
    参数 类型 描述
    mixMode AliEngineLiveTranscodingMixMode 旁路直播模式。
    singleParam AliEngineLiveTranscodingSingleParam 旁路直播单流参数。
    mixParam AliEngineLiveTranscodingMixParam 旁路直播混流参数。