通过阅读本文,您可以了解Android SDK涉及的数据类型。
目录
详情
- AliRtcPluginErrorCode:插件错误码。
枚举名 描述 AliRtcPluginErrorCodeSucces 成功。 AliRtcPluginErrorCodeFailed 失败。 AliRtcPluginErrorNoFindPlugin 没有找到插件。 AliRtcPluginErrorParameterError 参数错误。 AliRtcPluginErrorLoadError 插件加载失败。 AliRtcPluginErrorCreateError 插件初始化失败。 AliRtcPluginErrorInitTokenError 鉴权失败。 - AliRtcPluginProcessCode:插件数据处理返回码。
枚举名 描述 AliRtcPluginProcessCodeFailed 数据处理失败。 AliRtcPluginProcessCodeSuccess 数据处理成功。 AliRtcPluginProcessCodeMemoryChange 数据处理成功,数据内存大小有变化。 - AliRtcPluginDataType:插件数据类型。
枚举名 描述 AliRtcPluginDataTypeShared 共享型。 AliRtcPluginDataTypeVideo 视频。 AliRtcPluginDataTypeAudio 音频。 AliRtcPluginDataTypeEncryption 加密。 AliRtcPluginDataTypeMax 占位符,无意义。 - AliRtcPluginOperationType:插件数据处理类型。
枚举名 描述 AliRtcPluginShared 共享型。 AliRtcPluginPreOperation 前处理。 AliRtcPluginPostOperation 后处理。 AliRtcPluginEncodeOperation 编码器。 AliRtcPluginDecodeOperation 解码器。 AliRtcPluginRecord 采集。 AliRtcPluginRender 渲染。 - AliRtcAudioType:音频类型。
枚举名 描述 AliRtcPubObserver 经过音频3A处理后的音频数据。 AliRtcSubObserver 当前订阅到的远端用户混音后的音频数据。 AliRtcRawDataObserver 本地采集的原始音频数据。 AliRtcVolumeDataObserver 音量原始数据。 - AliRtcAudioPlayingErrorCode:音乐伴奏播放错误码。
枚举名 描述 AliRtcAudioPlayingNoError 正常状态。 AliRtcAudioPlayingOpenFailed 打开文件失败。 AliRtcAudioPlayingDecodeFailed 编码失败。 - AliRtcAudioPlayingStateCode:音乐伴奏播放状态。
枚举名 描述 AliRtcAudioPlayingStarted 正在播放。 AliRtcAudioPlayingStopped 停止播放。 AliRtcAudioPlayingPaused 暂停播放。 AliRtcAudioPlayingResumed 恢复播放。 AliRtcAudioPlayingEnded 播放结束。 AliRtcAudioPlayingBuffering 正在缓冲。 AliRtcAudioPlayingBufferingEnd 缓冲结束。 AliRtcAudioPlayingFailed 播放失败。 - AliRtcAudioVolume:用户音量信息。
参数 类型 描述 mUserId String 当前用户ID,取值: - 0:本地。
- 1:远端混音。
- 其他表示远端用户的ID。
mVolume int 当前回调的音量。 mSpeechstate int 当前用户说话状态,取值: - 0:没有说话。
- 1:正在说话。
- AliRtcAudioSample:音频样本。
参数 类型 描述 dataPtr long 音频数据。 data byte[] 该音频帧的采样数据。 numSamples int 每个声道的采样点数。 bytesPerSample int 每个采样点的字节数。对于PCM来说,一般使用16bit,即两个字节。 numChannels int 声道数量,取值: - 1:单声道。
- 2:双声道。
sampleRate int 每个声道的采样率。 samplesPerSec int 每声道每秒的采样点数,即采样率。 - AliRtcVideoSample:视频样本。
参数 类型 描述 dataFrameY long Y分量指针。 dataFrameU long U分量指针。 dataFrameV long V分量指针。 format AliRtcVideoFormat 视频帧格式。 width int 视频帧的宽。 height int 视频帧的高。 strideY int YUV数据中的Y缓冲区的行跨度。 strideU int YUV数据中的U缓冲区的行跨度。 strideV int YUV数据中的V缓冲区的行跨度。 rotate int 视频帧的旋转角度。 extraData long 附加字段(非定制化可忽略)。 - AliRtcVideoSourceType:视频源类型。
枚举名 描述 AliRTCSdkVideoSourceCameraType 相机流。 AliRTCSdkVideoSourceScreenShareType 屏幕分享流。 - AliRTCSdkChannelProfile:频道类型。
枚举名 描述 AliRTCSdkCommunication 通信模式。 AliRTCSdkInteractiveLive 互动模式。 AliRTCSdkInteractiveWithLowLatencyLive 低延迟互动直播模式。 - AliRTCSdkClientRole:用户角色。
枚举名 描述 AliRTCSdkInteractive 主播角色。 AliRTCSdkLive 观众角色。 - AliRtcRawDataStreamType:原始数据流类型。
枚举名 描述 AliRTCSdkStreameTypeCapture 相机流。 AliRTCSdkStreameTypeScreen 屏幕流。 - AliRtcRawDataFrame:外部视频帧数据。
参数名 类型 描述 format AliRtcVideoFormat 视频数据类型。 width int 该帧的宽。 height int 该帧的高。 rotation int 该帧的角度。 videoFrameLength int 该帧的长度。 lineSize int[] 视频帧的存储,详情请参见下表。 frame byte[] 视频的YUV字节数据。 cropLeft int 左侧的裁剪像素点数。 cropTop int 顶部的裁剪像素点数。 cropRight int 右侧的裁剪像素点数。 cropBottom int 底部的裁剪像素点数。 timeStamp long 该帧的时间戳,单位:毫秒。 textureId int 该帧的Texture ID。 transformMatrix float[] Texture帧额外的转换。 eglContext14 EGLContext opengl的线程相关上下文变量。 视频帧格式 视频帧存储 YUV - lineSize[0] = width; // Y
- lineSize[1] = width/2; // U
- lineSize[2] = width/2; // V
- lineSize[3] = 0;
RGBA - lineSize[0] = width; // R
- lineSize[1] = width; // G
- lineSize[2] = width; // B
- lineSize[3] = width; // A
- AliRtcStats:会话数据统计信息。
参数 类型 描述 sentKbitrate long 发送码率。 rcvdKbitrate long 接收码率。 sentBytes long 发送字节数。 rcvdBytes long 接收字节数。 systemCpuUsage float 系统CPU使用率。 cpuUsage float RTC进程CPU使用率。 videoRcvdKbitrate long 视频接收码率。 videoSentKbitrate long 视频发送码率。 callDuration long 通话时长,单位:秒。 sentLossRate long 客户端到服务器的丢包率。 sentLossPkts long 客户端到服务器的丢包数。 sentExpectedPkts long 客户端到服务器的总包数。 rcvdLossRate long 客户端到服务器的下行丢包率。 rcvdLossPkts long 客户端到服务器的下行丢包数。 rcvdExpectedPkts long 客户端到服务器的下行总包数。 lastmileDelay long 延时时长,单位:毫秒。 - AliRtcLocalVideoStats:本地视频统计信息。
参数 类型 描述 userId String 本地用户ID。 track AliRtcVideoTrack 流类型。 sentBitrate int 发布比特率。 sentFps int 发布帧率。 encodeFps int 编码帧率。 - AliRtcRemoteVideoStats:远端视频统计信息。
参数 类型 描述 userId String 远端用户ID。 track AliRtcVideoTrack 视频流类型。 width int 视频帧的宽。 height int 视频帧的高。 decodeFps int 编码器输出帧率。 renderFps int 渲染器输出帧率。 frozenTimes int 卡顿次数。 - AliRtcLocalAudioStats:本地音频统计信息。
参数 类型 描述 track AliRtcVideoTrack 音频流类型。 sentBitrate int 发送码率。 sentSamplerate int 发送的采样率。 numChannel int 声道数。 - AliRtcRemoteAudioStats:远端音频统计信息。
参数 类型 描述 userId String 用户ID。 track AliRtcVideoTrack 音频流类型。 quality int 音质。 audioLossRate int 音频丢包率。 rcvdBitrate int 接收码率。 totalFrozenTimes int 卡顿次数。 network_transport_delay int 音频发送端到接收端的网络延迟,单位:毫秒。 jitter_buffer_delay int 接收端到网络抖动缓冲的网络延迟,单位:毫秒。 - AliRtcFeedbackType:SDK反馈问题类型。
枚举名 描述 AliRtcFeedbackVideoDeviceFail 视频设备问题。 AliRtcFeedbackVideoNotRender 视频无画面。 AliRtcFeedbackAudioDeviceFail 音频设备问题。 AliRtcFeedbackAudioNotRender 音频无声音。 AliRtcFeedbackAudioEchoError 音频回声异常。 AliRtcFeedbackChannelTypeError 会议状态异常:入会异常、离会异常等。 AliRtcFeedbackSdkTypeError SDK其他状态异常。 AliRtcFeedbackNetworkUnfluent 网络卡顿问题。 AliRtcFeedbackVideoBlurring 视频清晰问题。 AliRtcFeedbackUnkonw 未知类型。 - AliRtcChannelRelayEvent:跨频道转发事件。
枚举名 描述 AliRtcChannelRelayStart 开启。 AliRtcChannelRelayUpdate 更新。 AliRtcChannelRelayStop 停止。 - AliRtcChannelRelayState:跨频道转发状态。
枚举名 描述 AliRtcChannelRelayStateInit 初始化。 AliRtcChannelRelayStateConnecting 连接中。 AliRtcChannelRelayStateRunning 转发中。 AliRtcChannelRelayStateFailure 转发失败。 - AliRtcChannelRelayConfiguration:跨频道转推设置。
参数 类型 描述 mDestChannelInfos Map<String,AliRtcAuthInfo> 转推频道的鉴权信息集合。 - AliRtcVideoObserPosition:视频数据输出位置。
枚举名 描述 AliRtcPositionPostCapture 采集数据。 AliRtcPositionPreRender 拉流数据。 AliRtcPositionPreEncoder 编码前数据。 - AliRtcVideoFormat:视频数据输出格式。
枚举名 描述 AliRtcVideoFormatBGRA BGRA。 AliRtcVideoFormatI420 I420。 AliRtcVideoFormatNV21 NV21。 AliRtcVideoFormatNV12 NV12。 AliRtcVideoFormatRGBA RGBA。 AliRtcVideoFormatI422 I422。 AliRtcVideoFormatARGB ARGB。 AliRtcVideoFormatABGR ABGR。 AliRtcVideoFormatRGB24 RGB24。 AliRtcVideoFormatBGR24 BGR24。 AliRtcVideoFormatRGB565 RGB565。 AliRtcVideoFormatTextureOES TextureOES。 AliRtcVideoFormatTexture2D Texture2D。 - AliRtcConnectionStatus:网络连接状态。
枚举名 描述 AliRtcConnectionStatusInit 初始化完成。 AliRtcConnectionStatusDisconnected 网络连接断开。 AliRtcConnectionStatusConnecting 建立网络连接中。 AliRtcConnectionStatusConnected 网络已连接。 AliRtcConnectionStatusReconnecting 重新建立网络连接中。 AliRtcConnectionStatusFailed 网络连接失败。 - AliRtcConnectionStatusChangeReason:网络连接状态变更原因。
枚举名 描述 AliRtcConnectionChangedDummyReason 未知原因。 AliRtcConnectionMediaPathChanged 媒体通道变更。 AliRtcConnectionSignalingHeartbeatTimeout 心跳超时。 AliRtcConnectionSignalingHeartbeatAlive 心跳恢复。 AliRtcConnectionSignalingHttpDnsResolved DNS解析成功。 AliRtcConnectionSignalingHttpDnsFailure DNS解析失败。 AliRtcConnectionSignalingGslbFailure GSLB请求失败。 AliRtcConnectionSignalingGslbSucccess GSLB请求成功。 AliRtcConnectionSignalingJoinRoomFailure 加入频道失败。 AliRtcConnectionSignalingJoinRoomSuccess 加入频道成功。 AliRtcConnectionSignalingLeaveRoom 离开频道。 AliRtcConnectionSignalingConnecting 信令建立连接。 - AliRtcVideoTrack:视频流类型。
枚举名 描述 AliRtcVideoTrackNo 无视频流。 AliRtcVideoTrackCamera 摄像头流。 AliRtcVideoTrackScreen 屏幕共享流。 AliRtcVideoTrackBoth 摄像头和屏幕共享。 - AliRtcPublishState:推流状态。
枚举名 描述 AliRtcStatsPublishIdle 初始状态。 AliRtcStatsNoPublish 未推流。 AliRtcStatsPublishing 推流中。 AliRtcStatsPublished 已推流。 - AliRtcSubscribeState:订阅状态。
枚举名 描述 AliRtcStatsSubscribeIdle 初始状态。 AliRtcStatsNoSubscribe 未订阅。 AliRtcStatsSubscribing 订阅中。 AliRtcStatsSubscribed 已订阅。 - AliRtcUserOfflineReason:用户离线原因。
枚举名 描述 AliRtcUserOfflineQuit 用户主动离开。 AliRtcUserOfflineDropped 因过长时间收不到对方数据包,超时掉线。 AliRtcUserOfflineBecomeAudience 用户身份从主播切换为观众时触发。 - AliRtcVideoStreamType:相机大小流类型。
枚举名 描述 AliRtcVideoStreamTypeNone 无视频流。 AliRtcVideoStreamTypeHigh 大流。 AliRtcVideoStreamTypeLow 小流。 - AliRtcAudioTrack:音频流类型。
枚举名 描述 AliRtcAudioTrackNo 无音频流。 AliRtcAudioTrackMic 麦克风流。 - AliRTCCameraType:摄像头方向。
枚举名 描述 AliRTCCameraBack 后置摄像头。 AliRTCCameraFront 前置摄像头。 AliRTCCameraUsb USB摄像头。 AliRTCCameraInvalid 无效摄像头。 - AliRtcNetworkQuality:网络质量。
枚举名 描述 AliRtcNetworkExcellent 网络极好,流程度清晰度质量好。 AliRtcNetworkGood 网络好,流畅度清晰度和极好差不多。 AliRtcNetworkPoor 网络较差,音视频流畅度清晰度有瑕疵,不影响沟通。 AliRtcNetworkBad 网络差,视频卡顿严重,音频能正常沟通。 AliRtcNetworkVeryBad 网络极差,基本无法沟通。 AliRtcNetworkDisconnected 网络中断。 AliRtcNetworkUnknow 未知原因。 - AliRtcRenderMode:渲染模式。
枚举名 描述 AliRtcRenderModeAuto 自动。 AliRtcRenderModeStretch 拉伸填充视图,不保持视频比例。 AliRtcRenderModeFill 在保持视频宽高比的同时缩放,填充黑边。 AliRtcRenderModeClip 在保持视频宽高比的同时缩放,并裁剪以适合视图。 - AliRtcRenderMirrorMode:镜像模式。
枚举名 描述 AliRtcRenderMirrorModeOnlyFront 只有前置摄像头预览镜像,其余不镜像。 AliRtcRenderMirrorModeAllEnabled 全部镜像。 AliRtcRenderMirrorModeAllDisable 全部不镜像。 - AliRtcRotationMode:旋转角度。
枚举名 描述 AliRtcRotationMode_0 不旋转。 AliRtcRotationMode_90 旋转90度。 AliRtcRotationMode_180 旋转180度。 AliRtcRotationMode_270 旋转270度。 - AliRtcLogLevel:日志级别。
枚举名 描述 AliRtcLogLevelInfo 普通。 AliRtcLogLevelWarn 警告。 AliRtcLogLevelError 错误。 AliRtcLogLevelFatal 严重。 AliRtcLogLevelNone 无。 - AliRtcAudioNumChannel:音频声道类型。
枚举名 描述 AliRtcMonoAudio 单声道。 AliRtcStereoAudio 双声道。 - AliRtcAudioSampleRate:音频采样率类型。
枚举名 描述 AliRtcAudioSampleRate_8000 采样率8000。 AliRtcAudioSampleRate_11025 采样率11025。 AliRtcAudioSampleRate_16000 采样率16000。 AliRtcAudioSampleRate_22050 采样率22050。 AliRtcAudioSampleRate_32000 采样率32000。 AliRtcAudioSampleRate_44100 采样率44100。 AliRtcAudioSampleRate_48000 采样率48000。 - AliRtcRecordType:录制类型。
枚举名 描述 AliRtcRecordTypeAudio 纯音频录制。 - AliRtcRecordFormat:录制格式。
枚举名 描述 AliRtcRecordFormatAAC AAC文件。 AliRtcRecordFormatWAV WAV文件。 - AliRtcAudioQuality:录制音频文件的音频质量。
枚举名 描述 AliRtcAudioQualityLow 低。 AliRtcAudioQualityMidium 中。 AliRtcAudioQualityHigh 高。 - AliRtcVideoQuality:录制视频文件的视频质量。
枚举名 描述 AliRtcVideoQualityDefault 默认和视频采集质量保持一致(移动端不提供视频录制)。 - AliRtcAudioProfile:音频质量模式。
枚举名 描述 AliRtcEngineLowQualityMode 音频低音质模式。 AliRtcEngineBasicQualityMode 标准音质模式。 AliRtcEngineHighQualityMode 高音质模式。 AliRtcEngineStereoHighQualityMode 立体声高音质模式。 AliRtcEngineSuperHighQualityMode 超高音质模式。 AliRtcEngineStereoSuperHighQualityMode 立体声超高音质模式。 - AliRtcAudioScenario:音频场景模式。
枚举名 描述 AliRtcSceneDefaultMode 默认场景,一般的音视频通信场景推荐使用。 AliRtcSceneEducationMode 教育场景,优先保证音频连续性与稳定性。 AliRtcSceneMediaMode 媒体场景,保真人声与音乐音质,连麦直播间推荐使用。 AliRtcSceneMusicMode 音乐场景,高保真音乐音质,乐器教学等对音乐音质有要求的场景推荐使用。 AliRtcSceneChatroomMode 聊天室场景,适用于频繁上下麦的聊天场景,音量条始终为语音通话音量条。 - AliRtcMuteLocalAudioMode:本地静音模式。
枚举名 描述 AliRtcMuteAudioModeDefault 默认模式(静音全部,包括麦克风及外部输入音频)。 AliRtcMuteAllAudioMode 静音全部(包括麦克风及外部输入音频)。 AliRtcMuteOnlyMicAudioMode 只静音麦克风。 AliRtcMuteLocalAudioMax 占位符。 - AliRtcRecordAudioConfig:录制音频文件参数配置。
枚举名 描述 AliRtcAudioSampleRate 录制音频文件采样率。 AliRtcAudioQuality 录制音频文件质量。 - AliRtcRecordVideoConfig:录制视频文件参数配置。
枚举名 描述 AliRtcVideoQuality 录制视频文件质量。 - AliRtcBeautyConfig:基础美颜设置。
参数 类型 描述 whiteningLevel float 美白,取值范围:[0,1]。数值越大美白效果越好。 smoothnessLevel float 磨皮,取值范围:[0,1]。数值越大磨皮效果越好。 - AliRtcOnByeType:OnBye类型枚举。
枚举名 描述 AliRtcByeTypeKickOff 被踢出。 AliRtcByeTypeDelChannel 频道被删除。 AliRtcByeTypeRestoreSession 被动离开需要恢复Session。 - AliRtcAudioEffectVoiceChangerMode:变声音效模式。
枚举名 描述 AliRtcSdk_AudioEffect_Voice_Changer_OFF 关闭。 AliRtcSdk_AudioEffect_Voice_Changer_Oldman 老人。 AliRtcSdk_AudioEffect_Voice_Changer_Babyboy 男孩。 AliRtcSdk_AudioEffect_Voice_Changer_Babygirl 女孩。 AliRtcSdk_AudioEffect_Voice_Changer_Robot 机器人。 AliRtcSdk_AudioEffect_Voice_Changer_Daimo 大魔王。 AliRtcSdk_AudioEffect_Voice_Changer_Ktv KTV。 AliRtcSdk_AudioEffect_Voice_Changer_Echo 回声。 AliRtcSdk_AudioEffect_Voice_Changer_MAX 占位符,无含义。 - AliRtcAudioEffectReverbMode:音效混响模式。
枚举名 描述 AliRtcAudioEffectReverb_Off 关闭。 AliRtcAudioEffectReverb_Vocal_I 人声 I。 AliRtcAudioEffectReverb_Vocal_II 人声 II。 AliRtcAudioEffectReverb_Bathroom 澡堂。 AliRtcAudioEffectReverb_Small_Room_Bright 明亮小房间。 AliRtcAudioEffectReverb_Small_Room_Dark 黑暗小房间。 AliRtcAudioEffectReverb_Medium_Room 中等房间。 AliRtcAudioEffectReverb_Large_Room 大房间。 AliRtcAudioEffectReverb_Church_Hall 教堂走廊。 AliRtcAudioEffectReverb_Cathedral 大教堂。 AliRtcAudioEffectReverb_Mode_Max 占位符,无含义。 - AliRtcAudioEffectReverbParamType:音效混响参数。
枚举名 描述 AliRtcAudioEffectReverb_Room_Size 房间大小,取值范围:[0,100]。 AliRtcAudioEffectReverb_Pre_Delay 预延时,单位:毫秒。取值范围:[0,200]。 AliRtcAudioEffectReverb_Revetberance 混响感,取值范围:[0,100]。 AliRtcAudioEffectReverb_Hf_Damping 消声,取值范围:[0,100]。 AliRtcAudioEffectReverb_Tone_Low 低音调,取值范围:[0,100]。 AliRtcAudioEffectReverb_Tone_High 高音调,取值范围:[0,100]。 AliRtcAudioEffectReverb_Dry_Gain 干增益,取值范围:[-20,10]。 AliRtcAudioEffectReverb_Wet_Gain 湿增益,取值范围:[-20,10]。 AliRtcAudioEffectReverb_Type_Max 占位符,无含义。 - AliRtcAudioRouteType:语音路由。
枚举名 描述 AliRtcAudioRouteType_Default 默认的语音路由。 AliRtcAudioRouteType_Headset 耳机。 AliRtcAudioRouteType_Earpiece 听筒。 AliRtcAudioRouteType_HeadsetNoMic 不带麦的耳机。 AliRtcAudioRouteType_Speakerphone 手机扬声器。 AliRtcAudioRouteType_LoudSpeaker 外接扬声器。 AliRtcAudioRouteType_BlueTooth 蓝牙耳机。 - AliRtcRemoteTextureInfo:远端用户纹理信息。
参数 类型 描述 AliRtcVideoCanvas AliRtcVideoCanvas 渲染画布。 userId String 远端用户ID。 videoTrack int 视频流类型。 - AliRtcVideoCanvas:渲染画布。
参数 类型 描述 textureId int 视频数据纹理类型ID。 textureWidth int 纹理宽。 textureHeight int 纹理高。 sharedContext long opengl的线程相关上下文变量。 enableBeauty boolean 是否开启美颜。取值: - true:开启。
- false:未开启。
view View 视频显示视窗。必须是通过createRenderSurfaceView接口创建出来的SurfaceView渲染视图,或者createRenderTextureView创建出来的TextureView渲染视图。 renderMode AliRtcRenderMode 视图渲染模式,默认AliRtcRenderModeAuto。 mirrorMode AliRtcRenderMirrorMode 视图镜像模式,默认AliRtcRenderMirrorModeOnlyFront。 rotationMode AliRtcRotationMode 视图旋转角度,默认AliRtcRotationMode_0。 backgroundColor int 视图背景颜色。 - AliRtcAudioRouteType:旁路转推任务状态。
枚举名 描述 AliRtcMpuStateStart 旁路任务启动。 AliRtcMpuStateUpdate 旁路任务更新。 AliRtcMpuStateStop 旁路任务停止。 AliRtcMpuStateEnd 旁路任务结束。 AliRtcMpuStateConnect 旁路任务连接中。 AliRtcMpuStateRunning 旁路任务正在运行。 AliRtcMpuStateRecovering 旁路任务重新恢复。 AliRtcMpuStateFailed 旁路任务失败。 AliRtcMpuStateUnknow 旁路任务未知状态。 - AliRtcRectPosition:水印图片的位置和大小。
参数名 类型 描述 x float 左上角的横向偏移。 y float 左上角的纵向偏移。 width float 水印图片的宽。 height float 水印图片的高。 - AliRtcWatermarkConfig:水印图片的设置选项。
参数名 类型 描述 visibleInPreview boolean 设置是否将水印设为预览时本地可见。 positionInLandscapeMode AliRtcRectPosition 横屏时的水印坐标。 positionInPortraitMode AliRtcRectPosition 竖屏时的水印坐标。 alpha float 透明度。 normalized boolean 归一化。 - AliRtcTextureInfo:纹理信息。
参数 类型 描述 textureId int 纹理ID。 mirrorMode AliRtcRenderMirrorMode 镜像模式。 - AliEngineCameraCapturerConfiguration:相机采集偏好属性。
参数 类型 描述 preference AliRtcCaptureOutputPreference 采集偏好。 cameraDirection AliRtcCameraDirection 相机方向(只支持Android和iOS)。 - AliRtcCaptureOutputPreference:摄像头采集偏好。
枚举名 描述 CAPTURER_OUTPUT_PREFERENCE_AUTO 自动调整采集参数。 CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE 优先保证设备性能,根据setVideoProfile设置参数选择最接近的摄像头输出参数。 CAPTURER_OUTPUT_PREFERENCE_PREVIEW 优先保证视频预览质量,选择较高的摄像头输出参数。 - AliRtcCameraDirection:摄像头方向。
枚举名 描述 CAMERA_REAR 使用后置摄像头。 CAMERA_FRONT 使用前置摄像头。 - AliRtcVideoEncoderFrameRate:视频编码帧率。
枚举名 描述 AliRtcVideoEncoderFrameRate_FPS_5 5 FPS。 AliRtcVideoEncoderFrameRate_FPS_10 10 FPS。 AliRtcVideoEncoderFrameRate_FPS_15 15 FPS。 AliRtcVideoEncoderFrameRate_FPS_20 20 FPS。 AliRtcVideoEncoderFrameRate_FPS_30 30 FPS。 - AliRtcVideoEncoderBitrate:视频编码码率。
枚举名 描述 AliRtcVideoEncoderStandardBitrate 标准码率模式。 - AliRtcVideoEncoderMirrorMode:编码视频镜像模式。
枚举名 描述 AliRtcVideoEncoderMirrorModeDisabled 编码视频镜像。 AliRtcVideoEncoderMirrorModeEnabled 编码视频不镜像。 - AliRtcVideoEncoderOrientationMode:编码视频旋转模式。
枚举名 描述 AliRtcVideoEncoderOrientationModeAdaptive 自适应,和采集视频角度保持一致。 AliRtcVideoEncoderOrientationModeFixedLandscape 固定横屏。 AliRtcVideoEncoderOrientationModeFixedPortrait 固定竖屏。 - AliRtcVideoDimensions:视频分辨率。
参数名 类型 描述 width int 视频宽度。 height int 视频高度。 - AliRtcVideoEncoderConfiguration:视频编码偏好。
参数名 类型 描述 dimensions AliRtcVideoDimensions 视频分辨率。 frameRate int 视频编码帧率。 bitrate int 视频编码码率。 mirrorMode AliRtcVideoEncoderMirrorMode 编码视频镜像模式。 orientationMode AliRtcVideoEncoderOrientationMode 编码视频旋转模式。 rotation AliRtcRotationMode 视频旋转角度。 - AliRtcScreenShareEncoderConfiguration:屏幕编码偏好。
参数名 类型 描述 dimensions AliRtcVideoDimensions 视频分辨率。 frameRate int 视频编码帧率。 bitrate int 视频编码码率。 rotationMode AliRtcRotationMode 推流旋转角度。 - AliRtcAuthInfo:鉴权信息。
参数名 类型 描述 channelId String 频道ID。 userId String 用户ID。 appId String 应用ID。 nonce String 随机串。 role String 角色类型,默认值为空,表示不涉及此功能。取值: - pub:主播角色。
- sub:观众角色。
- relay:跨频道转推。
timestamp long 时间戳。 session String 会话。 token String 令牌。 gslb String[] GSLB地址。 agent String[] 设置Agent服务器的地址。 - AliRtcTranscodingUser:旁路直播用户信息。
参数名 类型 描述 userId String 用户ID。 - AliRtcTranscodingUserPane:旁路直播用户窗格信息。
参数名 类型 描述 paneId int 窗格ID。 userId String 用户ID。 sourceType String 流类型,取值: - camera:摄像头。
- shareScreen:屏幕共享。
- AliRtcTranscodingPane:旁路直播用户自定义窗格信息。
参数名 类型 描述 paneId int 窗格ID。 userId String 用户ID。 majorPane Integer 指定主窗格,取值: - 0:副窗格。
- 1:主窗格。
x float 该区域相对左上角的横坐标,归一化百分比。 y float 该区域相对左上角的纵坐标,归一化百分比。 width float 窗格宽度。 height float 窗格高度。 zorder int 叠放顺序,0为最底层,1层在0层之上,以此类推。 sourceType String 流类型,取值: - camera:摄像头。
- shareScreen:屏幕共享。
segmentType int 人像分割类型,取值: - 0:无人像分割。
- 1:人像分割。
- AliRtcTranscodingLayout:旁路直播用户自定义布局信息。
参数名 类型 描述 audioMixCount int 最大混音个数。 panes List<AliRtcTranscodingPane> 自定义布局窗格参数。 - AliRtcLiveTranscoding:旁路直播配置。
参数名 类型 描述 mixMode int 混流模式。取值: - 0:单路转推,不混流转码仅转推原始单路流,无需配置混流转码参数。
- 1:混流转码,支持混流转码输出。
layoutIds List<String> 布局ID数组。 subSpecUsers List<AliRtcTranscodingUser> 指定混流用户列表。 userPanes List<AliRtcTranscodingUserPane> 用户窗格列表。 layouts List<AliRtcTranscodingLayout> 用户自定义布局列表。 taskProfile String 任务计费配置。 backgroundColor int 背景色RGB,默认值为0(黑色)。计算公式为R + G × 256 + B × 65536,R(红)、G(绿)、B(蓝)的取值范围:0~255。 mediaEncode int 编码选项。 cropMode int 视频的裁剪方式。取值: - 1:保持比例裁剪。
- 2:保持比例留边。
streamType int 单路转推模式下转推音频流。取值: - 0:转推原始流。
- 1:仅转推音频流。
- 2:仅转推视频流。
sourceType String 单路转推模式下用户视频输入流。取值: - camera:摄像头。
- shareScreen:屏幕共享。
externalParam String 拓展字段。 - AliRtcRemoteUserInfo:远端用户信息。
参数名 类型 描述 userID String 远端用户的ID。 sessionID String 远端用户的会话ID。 displayName String 远端用户的名称。 muteAudioPlaying boolean 本端是否静音了此远端用户。 isOnline boolean 远端用户是否在线。 cameraCanvas AliRtcVideoCanvas 相机流画布。 screenCanvas AliRtcVideoCanvas 屏幕流画布。 hasAudio boolean 远端用户是否推送了音频流。 hasCameraMaster boolean 远端用户是否推送了相机大流。 hasCameraSlave boolean 远端用户是否推送了相机小流。 hasScreenSharing boolean 远端用户是否推送了屏幕流。 subScribedAudio boolean 本端是否拉到了此远端用户的音频流。 subScribedCamearSlave boolean 本端是否拉到了此远端用户的相机小流。 subScribedCameraMaster boolean 本端是否拉到了此远端用户的相机大流。 subScribedScreenSharing boolean 本端是否拉到了此远端用户的屏幕流。 requestAudio boolean 本端是否订阅了此远端用户的音频流。 requestCameraSlave boolean 本端是否订阅了此远端用户的相机小流。 requestCameraMaster boolean 本端是否订阅了此远端用户的相机大流。 requestScreenSharing boolean 本端是否订阅了此远端用户的屏幕流。 preferCameraMaster boolean 远端用户是否开启了大流优先。 hasCameraView boolean 本端是否设置了此远端用户相机流的view。 hasScreenView boolean 本端是否设置了此远端用户屏幕流的view。 - AliRtcVideoReason:触发视频流状态变化的原因。
枚举名 描述 AliRTCVideoChangedByClient 客户端。 AliRTCVideoChangedByServer 服务器。 - AliRtcVideoState:视频流状态变化。
枚举名 描述 AliRtcVideoVideoClose 关闭视频流。 AliRtcVideoVideoOpen 恢复视频流。 - AliRtcTrascodingPublishTaskStatus:旁路直播推流任务状态。
枚举名 描述 AliRtcTrascodingPublishTaskStatusStart 旁路直播推流任务开始。 AliRtcTrascodingPublishTaskStatusUpdate 旁路直播推流任务更新。 AliRtcTrascodingPublishTaskStatusStop 旁路直播推流任务停止。 - AliEngineLiveTranscodingErrorCode:旁路直播推流错误码。
枚举名 描述 AliEngineLiveTranscodingErrorPublishOk 旁路直播准备完成。 AliEngineLiveTranscodingErrorStreamNotFound 旁路直播推流地址未找到。 - AliRtcLiveTranscodingState:旁路直播状态。
枚举名 描述 AliRtcLiveTranscodingState_IDLE 推流空闲。 AliRtcLiveTranscodingState_CONNNECT 正在连接推流服务器。 AliRtcLiveTranscodingState_RUNNING 推流正在进行。 AliRtcLiveTranscodingState_RECOVERING 正在恢复推流。 AliRtcLiveTranscodingState_FAILURE 推流失败。 AliRtcLiveTranscodingState_END 推流结束。 - AliRtcLiveTranscodingMediaProcessMode:旁路直播媒体处理模式。
枚举名 描述 AliRtcLiveTranscodingNormal 通用模式。 AliRtcLiveTranscodingVirtualBackground 虚拟背景模式。 - AliRtcLiveTranscodingCropMode:旁路直播裁剪模式。
枚举名 描述 AliRtcLiveTranscodingCrop 保持比例裁剪。 AliRtcLiveTranscodingFill 保持比例留边(默认值)。 - AliRtcLiveTranscodingFontType:旁路直播字体。
枚举名 描述 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。 - AliRtcLiveTranscodingSegmentType:旁路直播输入类型。
枚举名 描述 AliRtcLiveTranscodingNoBody 无人像分割。 AliRtcLiveTranscodingBody 人像分割。 - AliRtcLiveTranscodingAudioSampleRate:旁路直播音频采样率。
枚举名 描述 AliRtcLiveTranscoding_HZ_48000 采样率48000Hz。 AliRtcLiveTranscoding_HZ_44100 采样率44100Hz。 AliRtcLiveTranscoding_HZ_32000 采样率32000Hz。 AliRtcLiveTranscoding_HZ_16000 采样率16000Hz。 AliRtcLiveTranscoding_HZ_8000 采样率8000Hz。 - AliRtcLiveTranscodingTaskProfile:旁路直播计费规格。
枚举名 描述 AliRtcLiveTranscoding_Profile_1IN_1080P 1IN_1080P。 AliRtcLiveTranscoding_Profile_1IN_720P 1IN_720P。 AliRtcLiveTranscoding_Profile_1IN_360P 1IN_360P。 AliRtcLiveTranscoding_Profile_2IN_1080P 2IN_1080P。 AliRtcLiveTranscoding_Profile_2IN_720P 2IN_720P。 AliRtcLiveTranscoding_Profile_2IN_360P 2IN_360P。 AliRtcLiveTranscoding_Profile_4IN_1080P 4IN_1080P。 AliRtcLiveTranscoding_Profile_4IN_720P 4IN_720P。 AliRtcLiveTranscoding_Profile_4IN_360P 4IN_360P。 AliRtcLiveTranscoding_Profile_9IN_1080P 9IN_1080P。 AliRtcLiveTranscoding_Profile_9IN_720P 9IN_720P。 AliRtcLiveTranscoding_Profile_9IN_360P 9IN_360P。 AliRtcLiveTranscoding_Profile_12IN_1080P 12IN_1080P。 AliRtcLiveTranscoding_Profile_12IN_720P 12IN_720P。 AliRtcLiveTranscoding_Profile_12IN_360P 12IN_360P。 AliRtcLiveTranscoding_Profile_16IN_1080P 16IN_1080P。 AliRtcLiveTranscoding_Profile_16IN_720P 16IN_720P。 AliRtcLiveTranscoding_Profile_16IN_360P 16IN_360P。 AliRtcLiveTranscoding_Profile_Mixed 纯音频。 - AliRtcLiveTranscodingSourceType:旁路直播视频流类型。
枚举名 描述 AliRtcLiveTranscodingCamera 摄像头。 AliRtcLiveTranscodingShareScreen 屏幕共享。 - AliRtcLiveTranscodingStreamType:旁路直播转推流类型。
枚举名 描述 AliRtcLiveTranscodingOrigin 转推原始流。 AliRtcLiveTranscodingAudio 仅转推音频流。 AliRtcLiveTranscodingVideo 仅转推视频流。 - AliRtcLiveTranscodingMixMode:旁路直播模式。
枚举名 描述 AliRtcLiveTranscodingSINGLE 单路转推,不混流转码,仅转推原始单路流,无需配置混流转码参数。 AliRtcLiveTranscodingMIX 混流转码(默认值),支持混流转码输出。 - AliRtcVideoObserAlignment:裸数据回调数据对齐类型。
枚举名 描述 AliRtcAlignmentDefault 不处理,直接原始数据回调。 AliRtcAlignmentEven 宽处理成偶数。 AliRtcAlignment4 宽处理成4的倍数。 AliRtcAlignment8 宽处理成8的倍数。 AliRtcAlignment16 宽处理成16的倍数。 - AliRtcLiveTranscodingEncodeParam:旁路直播编码参数。
参数 类型 描述 videoWidth int 宽。 videoHeight int 高。 videoFramerate int 帧率。 videoBitrate int 码率。 videoGop int GOP。 audioSamplerate AliRtcLiveTranscodingAudioSampleRate 旁路直播音频采样率。 audioBitrate int 音频码率。 audioChannels int 音频声道数。 - AliRtcLiveTranscodingMixParam:旁路直播混流参数。
参数 类型 描述 taskProfile AliRtcLiveTranscodingTaskProfile 旁路直播计费规格。 encodeParam AliRtcLiveTranscodingEncodeParam 旁路直播编码参数。 users List<TranscodingUser> 旁路直播用户列表。 backgroundColor int 背景色。 backgrounds List<TranscodingImage> 背景图片列表。 watermarks List<TranscodingImage> 水印图片列表。 clockWidgets List<TranscodingClockWidget> 时钟小部件列表。 cropMode AliRtcLiveTranscodingCropMode 旁路直播裁剪模式。 mediaProcessMode AliRtcLiveTranscodingMediaProcessMode 旁路直播媒体处理模式。 - AliRtcLiveTranscodingParam:旁路直播参数。
参数 类型 描述 mixMode AliRtcLiveTranscodingMixMode 旁路直播模式。 singleParam AliRtcLiveTranscodingSingleParam 旁路直播单流参数。 mixParam AliRtcLiveTranscodingMixParam 旁路直播混流参数。 - AliRtcLiveTranscodingSingleParam:旁路直播单流参数。
参数 类型 描述 userId String 用户ID。 streamType AliRtcLiveTranscodingStreamType 旁路直播转推流类型。 sourceType AliRtcLiveTranscodingSourceType 旁路直播视频流类型。 - TranscodingClockWidget:旁路直播时钟小工具。
参数 类型 描述 mX int 坐标X(像素)。 mY int 坐标Y(像素)。 mFontSize int 旁路直播字体大小。 mZorder int 叠放顺序,0为最底层,1层在0层之上,以此类推。 mFontColor int 旁路直播字体颜色。 mFontType AliRtcLiveTranscodingFontType 旁路直播字体。 - TranscodingUser:旁路直播用户信息。
参数 类型 描述 mUserId String 用户ID。 x int 坐标X(像素)。 y int 坐标Y(像素)。 width int 窗格宽。 height int 窗格高。 zOrder int 叠放顺序,0为最底层,1层在0层之上,以此类推。 sourceType AliRtcLiveTranscodingSourceType 旁路直播视频流类型。 segmentType AliRtcLiveTranscodingSegmentType 旁路直播输入类型。 images List<TranscodingImage> 图片列表。 texts List<TranscodingText> 文本列表。 - TranscodingText:旁路直播文本信息。
参数 类型 描述 mText String 文本信息。 mX int 坐标X(像素)。 mY int 坐标Y(像素)。 mFontSize int 字体大小。 mZorder int 叠放顺序,0为最底层,1层在0层之上,以此类推。 mFontColor int 字体颜色。 mFontType AliRtcLiveTranscodingFontType 旁路直播字体。 - TranscodingImage:旁路直播图片信息。
参数 类型 描述 mUrl String 图片URL。 mAlpha float 透明度。0.0表示透明,1.0表示完全不透明。 mDisplay DisplayType 图片显示。 mX int 坐标X(像素)。 mY int 坐标Y(像素)。 mWidth int 窗格宽。 mHeight int 窗格高。 mZorder int 叠放顺序,0为最底层,1层在0层之上,以此类推。 - DisplayType:图片显示模式。
枚举名 描述 NOT_DISPLAY 不显示。 ALWAYS 总是显示。 WHEN_NO_VIDEO 没有视频时显示。