数据类型

目录

详情

• AliRtcVideoTrack：视频Track的类型。

  枚举名	描述
  AliRtcVideoTrackNo	无视频流。
  AliRtcVideoTrackCamera	摄像头流。
  AliRtcVideoTrackScreen	屏幕共享流。
  AliRtcVideoTrackBoth	摄像头和屏幕共享。

• AliRtcAudioTrack：音频Track的类型。

  枚举名	描述
  AliRtcAudioTrackNo	无音频流。
  AliRtcAudioTrackMic	麦克风流。

• AliRtcNetworkQuality：网络质量。

  枚举名	描述
  AliRtcNetworkQualityExcellent	网络极好，流畅度清晰度质量好。
  AliRtcNetworkQualityGood	网络质量好，流畅度清晰度和极好差不多。
  AliRtcNetworkQualityPoor	网络质量较差，音视频流畅度清晰度有瑕疵，不影响沟通。
  AliRtcNetworkQualityBad	网络质量差，视频卡顿严重，音频能正常沟通。
  AliRtcNetworkQualityVeryBad	网络质量极差，基本无法沟通。
  AliRtcNetworkQualityDisconnect	网络中断。
  AliRtcNetworkQualityUnknow	未知。

• AliRtcRenderMode：渲染模式。

  枚举名	描述
  AliRtcRenderModeAuto	自动模式。
  AliRtcRenderModeStretch	拉伸填充视图，不保持视频比例。
  AliRtcRenderModeFill	在保持视频宽高比的同时缩放，填充黑边。
  AliRtcRenderModeCrop	在保持视频宽高比的同时缩放，并裁剪以适合视图。
  AliRtcRenderModeScroll	滚动视图以显示更多内容。

• AliRtcLogLevel：日志级别。

  枚举名	描述
  AliRtcLogLevelDump	全量。
  AliRtcLogLevelDebug	调试。
  AliRtcLogLevelVerbose	详细。
  AliRtcLogLevelInfo	普通。
  AliRtcLogLevelWarn	警告。
  AliRtcLogLevelError	错误。
  AliRtcLogLevelFatal	严重。
  AliRtcLogLevelNone	无。

• AliRtcAuthInfo：鉴权信息。

  重要 在1.9及以上版本移除session id字段。

  参数	类型	描述
  channel	AliRtc::String	频道号。
  user_id	AliRtc::String	用户ID。
  appid	AliRtc::String	应用ID。
  nonce	AliRtc::String	令牌随机码。
  token	AliRtc::String	令牌。
  gslb	AliRtc::String	服务器地址。
  timestamp	long long	时间戳。
  agent	AliRtc::StringArray	Agent服务器地址（默认不传递此参数）。
  role	AliRtc::String	角色类型。默认值为空，表示不涉及此功能。取值： pub：主播角色。 sub：观众角色。 更多信息，请参见如何进行角色鉴权。

• AliVideoCanvas：渲染画布。

  参数	类型	描述
  hWnd	HWND	渲染窗口句柄。
  renderMode	AliRtcRenderMode	渲染模式。
  flip	bool	true表示镜像画面，false表示正常画面。
  backgroundColor	int	背景颜色，格式为RGB的Hex。
  rotation	AliRtcRotationMode	视频旋转角度。
  scaleRatio	AliRtcScaleRatio	预览缩放比例。

• AliRtcOnByeType：OnBye类型。

  枚举名	描述
  AliRtcOnByeBeKickOut	当前用户被踢出频道。
  AliRtcOnByeChannelTerminated	频道结束。
  AliRtcOnByeUserReplaced	相同用户在其他设备加入频道，当前设备被下线。

• AliRtcScreenShareType：桌面分享类型。

  枚举名	描述
  AliRtcScreenShareDesktop	桌面分享。
  AliRtcScreenShareWindow	窗口分享。

• AliRtcClientRole：角色类型。

  枚举名	描述
  AliRtcClientRoleInteractive	参与互动角色。
  AliRtcClientRoleLive	仅观看角色。

• AliRtcExternalDeviceState：外接设备状态。

  枚举名	描述
  AliRtcExternalDeviceAdd	新增外接设备。
  AliRtcExternalDeviceRemove	移除外接设备。

• AliRtcScaleRatio：视频缩放比例。

  枚举名	描述
  AliRtcScaleRatio_16_9	16:9。
  AliRtcScaleRatio_4_3	4:3。

• AliRtcAudioNumChannelType：音频声道类型。

  枚举名	描述
  AliRtcMonoAudio	单声道音频。
  AliRtcStereoAudio	立体声音频。

• AliRtcAudioSampleRate：录制音频采样率。

  枚举名	描述
  AliRtcAudioSampleRate_8000	8000Hz。
  AliRtcAudioSampleRate_11025	11025Hz。
  AliRtcAudioSampleRate_16000	16000Hz。
  AliRtcAudioSampleRate_22050	22050Hz。
  AliRtcAudioSampleRate_32000	32000Hz。
  AliRtcAudioSampleRate_44100	44100Hz。
  AliRtcAudioSampleRate_48000	48000Hz。

• AliRtcAudioSource：音频裸数据源类型。

  枚举名	描述
  AliRtcAudiosourcePub	发布。
  AliRtcAudiosourceSub	订阅。
  AliRtcAudiosourceRawData	原始数据。
  AliRtcAudioSourceVolume	音量。

• AliRtcVideoSource：视频裸数据源类型。

  枚举名	描述
  AliRtcVideoSourceCamera	相机流。
  AliRtcVideoSourceScreenShare	共享流。

• AliRtcVideoFormat：视频数据格式。

  枚举名	描述
  AliRtcVideoFormatUnknow	未知。
  AliRtcVideoFormatBGRA	BGRA格式。
  AliRtcVideoFormatI420	I420格式。
  AliRtcVideoFormatNV21	NV21格式。
  AliRtcVideoFormatNV12	NV12格式。

• AliRtcBufferType：视频数据类型。

  枚举名	描述
  AliRtcBufferTypeRawData	原始数据。
  AliRtcBufferTypeCVPixelBuffer	水印。
  AliRtcBufferTypeTexture	纹理。

• AliRtcMuteLocalAudioMode：本地静音模式。

  枚举名	描述。
  AliRtcMuteLocalAudioModeDefault	默认静音。
  AliRtcMuteAllLocalAudioMode	禁止本地所有音。
  AliRtcMuteOnlyMicAudioMode	禁止麦克风。

• AliRtcScreenSourceList：共享源列表。

  参数	类型	描述
  sourceNum	long long	共享源数量。
  sourceId	AliRtc::StringArray	共享源ID数组。
  sourceTitle	AliRtc::StringArray	共享源名数组。

• AliRtcScreenShareRegion：屏幕共享区域。

  参数	类型	描述
  originX	float	x轴。
  originY	float	y轴。
  width	float	宽度。
  height	float	高度。

• AliRtcScreenSource：共享源。

  参数	类型	描述
  eType	AliRtcScreenShareType	桌面分享类型。
  sourceId	AliRtc::String	共享源ID。
  sourceTitle	AliRtc::String	共享源名。
  isShareByRegion	bool	是否启用共享区域。
  shareRegion	AliRtcScreenShareRegion	共享区域。

• AliRtcDeviceList：设备列表。

  参数	类型	描述
  deviceCount	long long	设备数量。
  deviceIds	AliRtc::StringArray	设备ID数组。
  deviceNames	AliRtc::StringArray	设备名数组。

• AliRtcStats：会话数据统计信息。

  参数	类型	描述
  sent_kbitrate	int64_t	发送码率。
  rcvd_kbitrate	int64_t	接收码率。
  sent_bytes	int64_t	发送字节数。
  rcvd_bytes	int64_t	接收字节数。
  system_cpu	uint32_t	电脑CPU使用率。
  app_cpu	uint32_t	RTC进程CPU使用率。
  video_rcvd_kbitrate	int64_t	视频接收码率。
  video_sent_kbitrate	int64_t	视频发送码率。
  call_duration	int64_t	通话时长，单位：秒。
  sent_loss_rate	int8_t	发送丢包率。
  lastmile_delay	int64_t	延时时长，单位：毫秒。

• AliRtcVideoDataSample：视频数据。

  参数	类型	描述
  format	AliRtcVideoFormat	视频数据格式。
  bufferType	AliRtcBufferType	视频数据类型。
  char *data	unsigned char *	存储数据指针。
  size_t dataLen	size_t	数据长度。
  strideY	int	明亮度。
  strideU	int	色度。
  strideV	int	浓度。
  height	int	高。
  width	int	宽。
  rotation	int	旋转度。
  timeStamp	long long	时间戳。

• AliRtcAudioDataSample：音频数据。

  参数	类型	描述
  data	unsigned char *	音频数据。
  numOfSamples	int	采集数。
  bytesPerSample	int	采样位数（字节）。
  numOfChannels	int	声道数。
  samplesPerSec	int	采样率。

• AliRtcAudioEffectReverbMode：混响音效模式。

  枚举名	描述
  AliRtcAudioEffect_Reverb_Off	关闭。
  AliRtcAudioEffect_Reverb_Vocal_I	人声I。
  AliRtcAudioEffect_Reverb_Vocal_II	人声II。
  AliRtcAudioEffect_Reverb_Bathroom	澡堂。
  AliRtcAudioEffect_Reverb_Small_Room_Bright	明亮小房间。
  AliRtcAudioEffect_Reverb_Small_Room_Dark	黑暗小房间。
  AliRtcAudioEffect_Reverb_Medium_Room	中等房间。
  AliRtcAudioEffect_Reverb_Large_Room	大房间。
  AliRtcAudioEffect_Reverb_Church_Hall	教堂走廊。
  AliRtcAudioEffect_Reverb_Cathedral	大教堂。

• AliRtcAudioEffectReverbParamType：混响音效类型。

  枚举名	描述
  AliRtcAudioEffect_Reverb_Room_Size	房间大小，范围：[0,100]。
  AliRtcAudioEffect_Reverb_Pre_Delay	预延时，单位：ms，范围：[0, 200]。
  AliRtcAudioEffect_Reverb_Reverberance	混响感，范围：[0,100]。
  AliRtcAudioEffect_Reverb_Hf_Damping	消声，范围：[0,100]。
  AliRtcAudioEffect_Reverb_Tone_Low	低音调，范围：[0,100]。
  AliRtcAudioEffect_Reverb_Tone_High	高音调，范围：[0,100]。
  AliRtcAudioEffect_Reverb_Dry_Gain	干增益，范围：[-20,10]。
  AliRtcAudioEffect_Reverb_Wet_Gain	湿增益，范围：[-20,10]。

• AliRtcRecordType：录制类型。

  枚举名	描述
  AliRtcRecordTypeAudio	纯音频录制。
  AliRtcRecordTypeVideo	纯视频录制。
  AliRtcRecordTypeBoth	音视频录制。

• AliRtcRecordFormat：录制格式。

  枚举名	描述
  AliRtcRecordFormatAAC	AAC文件。
  AliRtcRecordFormatWAV	WAV文件。
  AliRtcRecordFormatMP4	MP4文件。

• AliRtcAudioQuality：录制音频质量。

  枚举名	描述
  AliRtcAudioQualityLow	低。
  AliRtcAudioQualityMidium	中。
  AliRtcAudioQualityHigh	高。

• AliRtcVideoQuality：录制视频质量。

  枚举名	描述
  AliRtcVideoQualityDefault	默认，和采集保持一致（例如：采集能力1080P，那么默认就录制1080P的视频流）。

• AliRtcRecordAudioConfig：录制音频设置。

  参数	类型	描述
  sampleRate	AliRtcAudioSampleRate	音频采样率。
  quality	AliRtcAudioQuality	音频质量。
  externalPcmCaptureRecording	bool	外部PCM输入录制。
  externalPcmRenderRecording	bool	外部PCM渲染录制。

• AliRtcRecordVideoConfig：录制视频设置。

  参数	类型	描述
  quality	AliRtcVideoQuality	视频质量。
  sourceType	AliRtcVideoSource	视频源类型。

• AliRtcLocalVideoStats：本地视频统计信息。

  参数	类型	描述
  track	AliRtcVideoTrack	视频流类型。
  sent_bitrate	uint32_t	发送码率。
  sent_fps	uint32_t	发送帧率。
  encode_fps	uint32_t	编码器输出帧率。

• AliRtcRemoteVideoStats：远端视频统计信息。

  参数	类型	描述
  user_id	AliRtc::String	用户ID。
  track	AliRtcVideoTrack	视频流类型。
  width	uint32_t	宽。
  height	uint32_t	高。
  decode_fps	uint32_t	编码器输出帧率。
  render_fps	uint32_t	渲染器输出帧率。
  frozen_times	uint32_t	卡顿次数。

• AliRtcVideoProfile：视频流参数。

  视频流参数，默认为AliRtcVideoProfile_Default，可以在加入频道之前或者之后设置，但必须在发布流之前通过setVideoProfile方法设置。

  枚举名	描述
  AliRtcVideoProfile_Default	默认，分辨率480*640，帧率15。
  AliRtcVideoProfile_180_240P_15	分辨率180*240，帧率15。
  AliRtcVideoProfile_180_320P_15	分辨率180*320，帧率15。
  AliRtcVideoProfile_180_320P_30	分辨率180*320，帧率30。
  AliRtcVideoProfile_240_320P_15	分辨率240*320，帧率15。
  AliRtcVideoProfile_360_480P_15	分辨率360*480，帧率15。
  AliRtcVideoProfile_360_480P_30	分辨率360*480，帧率30。
  AliRtcVideoProfile_360_640P_15	分辨率360*640，帧率15。
  AliRtcVideoProfile_360_640P_30	分辨率360*640，帧率30。
  AliRtcVideoProfile_480_640P_15	分辨率480*640，帧率15。
  AliRtcVideoProfile_480_640P_30	分辨率480*640，帧率30。
  AliRtcVideoProfile_720_960P_15	分辨率720*960，帧率15。
  AliRtcVideoProfile_720_960P_30	分辨率720*960，帧率30。
  AliRtcVideoProfile_720_1280P_15	分辨率720*1280，帧率15。
  AliRtcVideoProfile_720_1280P_30	分辨率720*1280，帧率30。
  AliRtcVideoProfile_1080_1920P_15	分辨率1080*1920，帧率15。
  AliRtcVideoProfile_1080_1920P_30	分辨率1080*1920，帧率30。
  AliRtcVideoProfile_480_640P_15_1500Kb	分辨率480*640，帧率15，1500Kb码率。
  AliRtcVideoProfile_900_1600P_20	分辨率900*1600，帧率20。
  AliRtcVideoProfile_360_640P_15_800Kb	分辨率360*640，帧率15，800Kb码率。
  AliRtcVideoProfile_480_840P_15_500Kb	分辨率480*840，帧率15，500Kb码率。
  AliRtcVideoProfile_480_840P_15_800Kb	分辨率480*840，帧率15，800Kb码率。
  AliRtcVideoProfile_540_960P_15_800Kb	分辨率540*960，帧率15，800Kb码率。
  AliRtcVideoProfile_540_960P_15_1200Kb	分辨率540*960，帧率15，1200Kb码率。
  AliRtcVideoProfile_540_960P_20	分辨率540*960，帧率20。
  AliRtcVideoProfile_720_1280P_20	分辨率720*1280，帧率20。
  AliRtcVideoProfile_1080_1920P_20	分辨率1080*1920，帧率20。

• AliRtcUserVolumeInfo：用户音量信息。

  参数	类型	描述
  user_id	AliRtc::String	用户ID（从AppServer下发的唯一标示符）。
  volume	int	用户音量，取值范围：0～255。
  speech_state	int	等于1时表示正在说话。

• AliRtcBeautyConfig：美颜设置。

  参数	类型	描述
  whiteningLevel	float	美白[0,1]数值越大美白效果越好。
  smoothnessLevel	float	磨皮[0,1]数值越大磨皮效果越好。

• AliRtcChannelProfile：频道类型。

  枚举名	描述
  AliRtcCommunication	通信模式。
  AliRtcInteractiveLive	互动模式。

• AliRtcFeedbackType： SDK反馈问题类型。

  枚举名	描述
  AliRtcFeedbackVideoDeviceFail	视频设备问题。
  AliRtcFeedbackVideoNotRender	视频无画面。
  AliRtcFeedbackAudioDeviceFail	音频设备问题。
  AliRtcFeedbackAudioNotRender	音频无声音。
  AliRtcFeedbackAudioEchoError	音频回声异常。
  AliRtcFeedbackChannelTypeError	会议状态异常：入会异常、离会异常等。
  AliRtcFeedbackSDKTypeError	SDK其他状态异常。
  AliRtcFeedbackNetworkUnfluent	网络卡顿问题。
  AliRtcFeedbackVideoBlurring	视频清晰问题。
  AliRtcFeedbackUnkonw	未知类型。

• ErrorCodeEnum：SDK错误码。

  枚举名	描述
  ERR_JOIN_BAD_APPID = 0x02010201	AppId不存在。
  ERR_JOIN_INVALID_APPID = 0x02010202	AppId已失效。
  ERR_JOIN_BAD_CHANNEL = 0x02010204	频道不存在。
  ERR_JOIN_INVALID_CHANNEL = 0x02010203	频道已失效。
  ERR_JOIN_BAD_TOKEN = 0x02010205	Token不存在。
  ERR_JOIN_TIMEOUT = 0x01020204	加入频道超时。
  ERR_JOIN_BAD_PARAM = 0x01030101	加入频道参数错误。
  ERR_MIC_OPEN_FAIL = 0x01040404	采集设备初始化失败。
  ERR_SPEAKER_OPEN_FAIL = 0x01040405	播放设备初始化失败。
  ERR_MIC_INTERRUPT = 0x01040406	采集过程中出现异常。
  ERR_SPEAKER_INTERRUPT = 0x01040407	播放过程中出现异常。
  ERR_MIC_AUTH_FAIL = 0x01040408	麦克风设备授权失败。
  ERR_MIC_NOT_AVAILABLE = 0x01040409	麦克风设备未授权。
  ERR_SPEAKER_NO_AVAILABLE = 0x01040410	无可用的音频采集设备。
  ERR_CAMERA_OPEN_FAIL = 0x01040104	相机设备初始化失败。
  ERR_CAMERA_INTERRUPT = 0x01040106	相机采集中发生异常。
  ERR_VIDEO_DISPLAY_OPEN_FAIL = 0x01040201	渲染设备初始化失败。
  ERR_VIDEO_DISPLAY_INTERRUPT = 0x01040202	渲染过程中出现异常。
  ERR_AUDIO_BUFFER_FULL = 0x01070101	音频输入的buffer已满。
  ERR_ICE_CONNECTION_CONNECT_FAIL = 0x01050201	媒体通道建立失败。
  ERR_ICE_CONNECTION_RECONNECT_FAI = 0x01050202	媒体通道重连失败。
  ERR_ICE_CONNECTION_HEARTBEAT_TIMEOUT = 0x0102020C	信令心跳超时。
  ERR_LOWLATENCY_LIVE_COMMUNICATION_FAIL = 0x01070003	低延时互动直播信令失败。
  ERR_LOWLATENCY_LIVE_MEDIA_SETTING_FAIL = 0x01070004	低延时互动直播媒体设置错误。
  ERR_LOWLATENCY_LIVE_NONE_BROADCASTER = 0x01070005	低延时互动直播当前房间没有主播推流。
  ERR_LOWLATENCY_LIVE_NEED_RESTART = 0x01070006	低延时互动直播错误，应用层需要重新创建新的SDK实例。
  ERR_LOWLATENCY_LIVE_NEEDRESTART_AGAIN_LATER = 0x01070007	低延时互动直播错误，应用层需要稍等一定时间（自定义间隔）重新创建新的SDK实例。
  ERR_LOWLATENCY_LIVE_SERVICE_UNAVAILABLE = 0x01070008	低延时互动直播服务不可用或者服务降级。
  ERR_LOWLATENCY_LIVE_MEDIA_CONNECTION_INTERRUPTION = 0x01070009	低延时互动直播网络中断错误。
  ERR_SDK_INVALID_STATE = 0x01030204	SDK内部状态错误。
  ERR_SESSION_REMOVED = 0x02010105	session已经被移除。
  ERR_INNER = -1	SDK内部错误。

• AliRtcRotationMode：视频旋转角度。

  枚举名	描述
  AliRtcRotationMode_0	旋转0度。
  AliRtcRotationMode_90	旋转90度。
  AliRtcRotationMode_180	旋转180度。
  AliRtcRotationMode_270	旋转270度。

• AliRtcVideoEncoderMirrorMode：编码视频镜像模式。

  枚举名	描述
  AliRtcVideoEncoderMirrorModeDisabled	编码视频镜像。
  AliRtcVideoEncoderMirrorModeEnabled	编码视频不镜像。

• AliRtcVideoEncoderConfiguration：视频编码偏好。

  参数	类型	描述
  mirrorMode	AliRtcVideoEncoderMirrorMode	编码视频镜像模式。