Data types

Table of contents

Details

• AliRtcPluginErrorCode: Error codes for the plugin.

  Enumeration	Description
  AliRtcPluginErrorCodeSucces	Success.
  AliRtcPluginErrorCodeFailed	Failed.
  AliRtcPluginErrorNoFindPlugin	The plugin is not found.
  AliRtcPluginErrorParameterError	A parameter error occurred.
  AliRtcPluginErrorLoadError	Failed to load the plugin.
  AliRtcPluginErrorCreateError	Plugin initialization failed.
  AliRtcPluginErrorInitTokenError	Authentication failed.

• AliRtcPluginProcessCode: Return codes for plugin data processing.

  Enumeration	Description
  AliRtcPluginProcessCodeFailed	Data processing failed.
  AliRtcPluginProcessCodeSuccess	Data processing succeeded.
  AliRtcPluginProcessCodeMemoryChange	Data processing succeeded. The memory size of the data has changed.

• AliRtcPluginDataType: Data types for the plugin.

  Enumeration	Description
  AliRtcPluginDataTypeShared	Shared type.
  AliRtcPluginDataTypeVideo	Video.
  AliRtcPluginDataTypeAudio	Audio.
  AliRtcPluginDataTypeEncryption	Encryption.
  AliRtcPluginDataTypeMax	A placeholder with no specific meaning.

• AliRtcPluginOperationType: Data processing types for the plugin.

  Enumeration	Description
  AliRtcPluginShared	Shared type.
  AliRtcPluginPreOperation	Pre-processing.
  AliRtcPluginPostOperation	Post-processing.
  AliRtcPluginEncodeOperation	Encoder.
  AliRtcPluginDecodeOperation	Decoder.
  AliRtcPluginRecord	Capture.
  AliRtcPluginRender	Rendering.

• AliRtcAudioType: The types of audio.

  Enumeration	Description
  AliRtcPubObserver	Audio data that is processed using the 3A algorithm.
  AliRtcSubObserver	The mixed audio data of the remote users to which you are currently subscribed.
  AliRtcRawDataObserver	Raw audio data captured locally.
  AliRtcVolumeDataObserver	Raw volume data.

• AliRtcAudioPlayingErrorCode: Error codes for audio accompaniment playback.

  Enumeration	Description
  AliRtcAudioPlayingNoError	Normal state.
  AliRtcAudioPlayingOpenFailed	Failed to open the file.
  AliRtcAudioPlayingDecodeFailed	Encoding failed.

• AliRtcAudioPlayingStateCode: The playback state of the audio accompaniment.

  Enumeration	Description
  AliRtcAudioPlayingStarted	Playing.
  AliRtcAudioPlayingStopped	Playback is stopped.
  AliRtcAudioPlayingPaused	Playback is paused.
  AliRtcAudioPlayingResumed	Playback is resumed.
  AliRtcAudioPlayingEnded	Playback is complete.
  AliRtcAudioPlayingBuffering	Buffering.
  AliRtcAudioPlayingBufferingEnd	Buffering is complete.
  AliRtcAudioPlayingFailed	Playback failed.

• AliRtcAudioVolume: The volume information of a user.

  Parameter	Type	Description
  mUserId	String	The ID of the current user. Valid values: 0: Local 1: the mixed remote stream. Other values: the ID of a remote user.
  mVolume	int	The volume in the current callback.
  mSpeechstate	int	The speaking status of the user. Valid values: 0: The user is not speaking. 1: The user is speaking.

• AliRtcAudioSample: Audio samples.

  Parameter	Type	Description
  dataPtr	long	The audio data.
  data	byte[]	The sample data of the audio frame.
  numSamples	int	The number of sample points for each sound channel.
  bytesPerSample	int	The number of bytes per sample point. For Pulse-Code Modulation (PCM), the value is typically 16 bits, which is equivalent to 2 bytes.
  numChannels	int	The number of sound channels. Valid values: 1: mono. 2: stereo.
  sampleRate	int	The sample rate of each sound channel.
  samplesPerSec	int	The number of sample points per second for each sound channel. This is the sample rate.

• AliRtcVideoSample: Video samples.

  Parameter	Type	Description
  dataFrameY	long	A pointer to the Y component.
  dataFrameU	long	A pointer to the U component.
  dataFrameV	long	A pointer to the V component.
  format	AliRtcVideoFormat	The format of the video frame.
  width	int	The width of the video frame.
  height	int	The height of the video frame.
  strideY	int	The stride of the Y buffer in the YUV data.
  strideU	int	The stride of the U buffer in the YUV data.
  strideV	int	The stride of the V buffer in the YUV data.
  rotate	int	The rotation angle of the video frame.
  extraData	long	An additional field. You can ignore this parameter if you do not require customization.

• AliRtcVideoSourceType: The types of video sources.

  Enumeration Name	Description
  AliRTCSdkVideoSourceCameraType	Camera stream.
  AliRTCSdkVideoSourceScreenShareType	Screen sharing stream.

• AliRTCSdkChannelProfile: The modes for a channel.

  Enumeration Name	Description
  AliRTCSdkCommunication	Communication mode.
  AliRTCSdkInteractiveLive	Interactive mode.
  AliRTCSdkInteractiveWithLowLatencyLive	Low-latency interactive live streaming mode.

• AliRTCSdkClientRole: The roles of a user.

  Enumeration name	Description
  AliRTCSdkInteractive	Streamer role.
  AliRTCSdkLive	Viewer role.

• AliRtcRawDataStreamType: The types of raw data streams.

  Enumeration Name	Description
  AliRTCSdkStreameTypeCapture	Camera stream.
  AliRTCSdkStreameTypeScreen	Screen stream.

• AliRtcRawDataFrame: Data for external video frames.

  Parameter	Type	Description
  format	AliRtcVideoFormat	The video data type.
  width	int	The width of the frame.
  height	int	The height of the frame.
  rotation	int	The angle of the frame.
  videoFrameLength	int	The length of the frame.
  lineSize	int[]	The storage of the video frame. For more information, see the following table.
  frame	byte[]	The YUV byte data of the video.
  cropLeft	int	The number of pixels to crop from the left.
  cropTop	int	The number of pixels to crop from the top.
  cropRight	int	The number of pixels to crop from the right.
  cropBottom	int	The number of pixels to crop from the bottom.
  timeStamp	long	The timestamp of the frame. Unit: milliseconds.
  textureId	int	The texture ID of the frame.
  transformMatrix	float[]	The extra transformation for the texture frame.
  eglContext14	EGLContext	The thread-related context variable of OpenGL.

  Video frame format	Video frame storage
  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: Statistics for a session.

  Parameter	Type	Description
  sentKbitrate	long	The sending bitrate.
  rcvdKbitrate	long	The receiving bitrate.
  sentBytes	long	The number of bytes sent.
  rcvdBytes	long	The number of bytes received.
  systemCpuUsage	float	The system CPU usage.
  cpuUsage	float	The CPU usage of the RTC process.
  videoRcvdKbitrate	long	The video receiving bitrate.
  videoSentKbitrate	long	The video sending bitrate.
  callDuration	long	The call duration. Unit: seconds.
  sentLossRate	long	The packet loss rate from the client to the server.
  sentLossPkts	long	The number of lost packets from the client to the server.
  sentExpectedPkts	long	The total number of packets sent from the client to the server.
  rcvdLossRate	long	The downstream packet loss rate from the client to the server.
  rcvdLossPkts	long	The number of downstream lost packets from the client to the server.
  rcvdExpectedPkts	long	The total number of downstream packets from the client to the server.
  lastmileDelay	long	The latency. Unit: milliseconds.

• AliRtcLocalVideoStats: Statistics for the local video.

  Parameter	Type	Description
  userId	String	The ID of the local user.
  track	AliRtcVideoTrack	The stream type.
  sentBitrate	int	The publishing bitrate.
  sentFps	int	The publishing frame rate.
  encodeFps	int	The encoding frame rate.

• AliRtcRemoteVideoStats: Statistics for a remote video.

  Parameter	Type	Description
  userId	String	The ID of the remote user.
  track	AliRtcVideoTrack	The video stream type.
  width	int	The width of the video frame.
  height	int	The height of the video frame.
  decodeFps	int	The output frame rate of the encoder.
  renderFps	int	The output frame rate of the renderer.
  frozenTimes	int	The number of stutters.

• AliRtcLocalAudioStats: Statistics for the local audio.

  Parameter	Type	Description
  track	AliRtcVideoTrack	The audio stream type.
  sentBitrate	int	The sending bitrate.
  sentSamplerate	int	The sending sample rate.
  numChannel	int	The number of sound channels.

• AliRtcRemoteAudioStats: Statistics for a remote audio.

  Parameter	Type	Description
  userId	String	The user ID.
  track	AliRtcVideoTrack	The audio stream type.
  quality	int	The audio quality.
  audioLossRate	int	The audio packet loss rate.
  rcvdBitrate	int	The receiving bitrate.
  totalFrozenTimes	int	The number of stutters.
  network_transport_delay	int	The network latency from the audio sender to the receiver. Unit: milliseconds.
  jitter_buffer_delay	int	The network latency from the receiver to the anti-jitter buffer. Unit: milliseconds.

• AliRtcFeedbackType: The types of SDK feedback.

  Enumeration name	Description
  AliRtcFeedbackVideoDeviceFail	Video device issue.
  AliRtcFeedbackVideoNotRender	No video playback.
  AliRtcFeedbackAudioDeviceFail	Audio device issue.
  AliRtcFeedbackAudioNotRender	No audio playback.
  AliRtcFeedbackAudioEchoError	Abnormal audio echo.
  AliRtcFeedbackChannelTypeError	Abnormal meeting status: An abnormal status that occurs, for example, when joining or leaving a meeting.
  AliRtcFeedbackSdkTypeError	Other abnormal SDK states.
  AliRtcFeedbackNetworkUnfluent	Network stuttering issue.
  AliRtcFeedbackVideoBlurring	Video definition issue.
  AliRtcFeedbackUnkonw	Unknown type.

• AliRtcChannelRelayEvent: Events for cross-channel forwarding.

  Enumeration name	Description
  AliRtcChannelRelayStart	Start.
  AliRtcChannelRelayUpdate	Update.
  AliRtcChannelRelayStop	Stop.

• AliRtcChannelRelayState: The states of cross-channel forwarding.

  Enumeration name	Description
  AliRtcChannelRelayStateInit	Initialization.
  AliRtcChannelRelayStateConnecting	Connecting.
  AliRtcChannelRelayStateRunning	Forwarding.
  AliRtcChannelRelayStateFailure	Forwarding failed.

• AliRtcChannelRelayConfiguration: Settings for cross-channel stream forwarding.

  Parameter	Type	Description
  mDestChannelInfos	Map<String,AliRtcAuthInfo>	The collection of authentication information for the destination channels.

• AliRtcVideoObserPosition: The output positions of video data.

  Enumeration Name	Description
  AliRtcPositionPostCapture	Captured data.
  AliRtcPositionPreRender	Stream pulling data.
  AliRtcPositionPreEncoder	Pre-encoding data.

• AliRtcVideoFormat: The output formats of video data.

  Enumeration	Description
  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: The states of a network connection.

  Enumeration	Description
  AliRtcConnectionStatusInit	Initialization is complete.
  AliRtcConnectionStatusDisconnected	The network connection is disconnected.
  AliRtcConnectionStatusConnecting	Establishing a network connection.
  AliRtcConnectionStatusConnected	The network is connected.
  AliRtcConnectionStatusReconnecting	Re-establishing a network connection.
  AliRtcConnectionStatusFailed	The network connection failed.

• AliRtcConnectionStatusChangeReason: The reasons for changes in the network connection state.

  Enumeration	Description
  AliRtcConnectionChangedDummyReason	Unknown reason.
  AliRtcConnectionMediaPathChanged	The media channel has changed.
  AliRtcConnectionSignalingHeartbeatTimeout	Heartbeat timeout.
  AliRtcConnectionSignalingHeartbeatAlive	Heartbeat recovered.
  AliRtcConnectionSignalingHttpDnsResolved	DNS resolution succeeded.
  AliRtcConnectionSignalingHttpDnsFailure	DNS resolution failed.
  AliRtcConnectionSignalingGslbFailure	GSLB request failed.
  AliRtcConnectionSignalingGslbSucccess	GSLB request succeeded.
  AliRtcConnectionSignalingJoinRoomFailure	Failed to join the channel.
  AliRtcConnectionSignalingJoinRoomSuccess	Joined the channel.
  AliRtcConnectionSignalingLeaveRoom	Left the channel.
  AliRtcConnectionSignalingConnecting	Establishing a signaling connection.

• AliRtcVideoTrack: The types of video streams.

  Enumeration	Description
  AliRtcVideoTrackNo	No video stream.
  AliRtcVideoTrackCamera	Camera stream.
  AliRtcVideoTrackScreen	Screen sharing stream.
  AliRtcVideoTrackBoth	Share your camera and screen.

• AliRtcPublishState: The states of stream ingest.

  Enumeration Name	Description
  AliRtcStatsPublishIdle	Initial state.
  AliRtcStatsNoPublish	Not ingesting a stream.
  AliRtcStatsPublishing	Ingesting a stream.
  AliRtcStatsPublished	Stream ingested.

• AliRtcSubscribeState: The states of a subscription.

  Enumeration	Description
  AliRtcStatsSubscribeIdle	Initial state.
  AliRtcStatsNoSubscribe	Not subscribed.
  AliRtcStatsSubscribing	Subscribing.
  AliRtcStatsSubscribed	Subscribed.

• AliRtcUserOfflineReason: The reasons why a user goes offline.

  Enumeration	Description
  AliRtcUserOfflineQuit	The user chooses to leave.
  AliRtcUserOfflineDropped	The user is dropped due to a timeout. This occurs when no data packets are received from the user for an extended period.
  AliRtcUserOfflineBecomeAudience	This is triggered when the user role switches from streamer to viewer.

• AliRtcVideoStreamType: The types of camera streams, such as high-definition and low-definition.

  Enumeration	Description
  AliRtcVideoStreamTypeNone	No video stream.
  AliRtcVideoStreamTypeHigh	Large stream
  AliRtcVideoStreamTypeLow	Small stream

• AliRtcAudioTrack: The types of audio streams.

  Enumeration Name	Description
  AliRtcAudioTrackNo	No audio stream.
  AliRtcAudioTrackMic	Microphone stream.

• AliRTCCameraType: The directions of the camera.

  Enumeration name	Description
  AliRTCCameraBack	Rear camera.
  AliRTCCameraFront	Front camera.
  AliRTCCameraUsb	USB camera.
  AliRTCCameraInvalid	Invalid camera.

• AliRtcNetworkQuality: The quality of the network.

  Enumeration	Description
  AliRtcNetworkExcellent	The network quality is excellent. The stream is smooth and has high definition.
  AliRtcNetworkGood	The network quality is good. The smoothness and definition are similar to the excellent level.
  AliRtcNetworkPoor	A poor network causes minor degradation in audio and video smoothness and definition, but communication is unaffected.
  AliRtcNetworkBad	The network quality is bad. The video experiences severe stuttering, but audio communication remains normal.
  AliRtcNetworkVeryBad	The network quality is very bad. Communication is nearly impossible.
  AliRtcNetworkDisconnected	The network is disconnected.
  AliRtcNetworkUnknow	Unknown reason.

• AliRtcRenderMode: The modes for rendering.

  Enumeration name	Description
  AliRtcRenderModeAuto	Automatic.
  AliRtcRenderModeStretch	Stretches the video to fill the view. The aspect ratio is not maintained.
  AliRtcRenderModeFill	Scales the video while maintaining the aspect ratio. Black bars are added to fill the remaining space.
  AliRtcRenderModeClip	Scales the video while maintaining the aspect ratio and crops the video to fit the view.

• AliRtcRenderMirrorMode: The modes for an image.

  Enumeration	Description
  AliRtcRenderMirrorModeOnlyFront	Only the front camera preview is mirrored. Other views are not mirrored.
  AliRtcRenderMirrorModeAllEnabled	All images
  AliRtcRenderMirrorModeAllDisable	No views are mirrored.

• AliRtcRotationMode: The angles of rotation.

  Enumeration name	Description
  AliRtcRotationMode_0	No rotation.
  AliRtcRotationMode_90	Rotate 90 degrees.
  AliRtcRotationMode_180	Rotate 180 degrees.
  AliRtcRotationMode_270	Rotate 270 degrees.

• AliRtcLogLevel: The levels for logs.

  Enumeration name	Description
  AliRtcLogLevelInfo	Standard
  AliRtcLogLevelWarn	Warning.
  AliRtcLogLevelError	Error.
  AliRtcLogLevelFatal	Critical
  AliRtcLogLevelNone	None.

• AliRtcAudioNumChannel: The types of audio channels.

  Enumeration	Description
  AliRtcMonoAudio	Mono audio.
  AliRtcStereoAudio	Stereo audio.

• AliRtcAudioSampleRate: The types of audio sample rates.

  Enumeration Name	Description
  AliRtcAudioSampleRate_8000	A sample rate of 8,000.
  AliRtcAudioSampleRate_11025	A sample rate of 11,025.
  AliRtcAudioSampleRate_16000	A sample rate of 16,000.
  AliRtcAudioSampleRate_22050	A sample rate of 22,050.
  AliRtcAudioSampleRate_32000	A sample rate of 32,000.
  AliRtcAudioSampleRate_44100	A sample rate of 44,100.
  AliRtcAudioSampleRate_48000	A sample rate of 48,000.

• AliRtcRecordType: The types of records.

  Enumeration Name	Description
  AliRtcRecordTypeAudio	Audio-only recording.

• AliRtcRecordFormat: The formats of records.

  Enumeration	Description
  AliRtcRecordFormatAAC	AAC file.
  AliRtcRecordFormatWAV	WAV file.

• AliRtcAudioQuality: The audio quality of recorded audio files.

  Enumeration	Description
  AliRtcAudioQualityLow	Low.
  AliRtcAudioQualityMidium	Medium.
  AliRtcAudioQualityHigh	High.

• AliRtcVideoQuality: The video quality of recorded video files.

  Enumeration	Description
  AliRtcVideoQualityDefault	The default quality, which is the same as the video capture quality. Video recording is not available on mobile devices.

• AliRtcAudioProfile: The modes for audio quality.

  Enumeration	Description
  AliRtcEngineLowQualityMode	Low-quality audio mode.
  AliRtcEngineBasicQualityMode	Standard-quality audio mode.
  AliRtcEngineHighQualityMode	High-quality audio mode.
  AliRtcEngineStereoHighQualityMode	Stereo high-quality audio mode.
  AliRtcEngineSuperHighQualityMode	Ultra-high-quality audio mode.
  AliRtcEngineStereoSuperHighQualityMode	Stereo ultra-high-quality audio mode.

• AliRtcAudioScenario: The modes for audio scenarios.

  Enumeration Name	Description
  AliRtcSceneDefaultMode	The default scenario. This mode is recommended for general audio and video communication scenarios.
  AliRtcSceneEducationMode	The education scenario. This mode prioritizes audio continuity and stability.
  AliRtcSceneMediaMode	The media scenario. This mode ensures high-fidelity voice and music quality. It is recommended for interactive live channels.
  AliRtcSceneMusicMode	The music scenario. This mode provides high-fidelity music quality. It is recommended for scenarios with high requirements for music quality, such as musical instrument tutoring.
  AliRtcSceneChatroomMode	The chat scenario. This mode is suitable for chat scenarios where users frequently enable and disable their microphones. The volume bar always indicates the voice call volume.

• AliRtcMuteLocalAudioMode: The modes for muting local audio.

  Enumeration name	Description
  AliRtcMuteAudioModeDefault	The default mode. All audio, including microphone and external audio input, is muted.
  AliRtcMuteAllAudioMode	Mute all audio, including microphone and external audio input.
  AliRtcMuteOnlyMicAudioMode	Mute only the microphone.
  AliRtcMuteLocalAudioMax	A placeholder.

• AliRtcRecordAudioConfig: Parameter settings for recording audio files.

  Enumeration	Description
  AliRtcAudioSampleRate	The sample rate of the recorded audio file.
  AliRtcAudioQuality	The quality of the recorded audio file.

• AliRtcRecordVideoConfig: Parameter settings for recording video files.

  Enumeration name	Description
  AliRtcVideoQuality	The quality of the recorded video file.

• AliRtcBeautyConfig: Settings for basic retouching.

  Parameter	Type	Description
  whiteningLevel	float	The whitening level. Valid values: [0, 1]. The larger the value, the stronger the whitening effect.
  smoothnessLevel	float	The skin smoothing level. Valid values: [0, 1]. The larger the value, the stronger the smoothing effect.

• AliRtcOnByeType: Enumerations for OnBye types.

  Enumeration	Description
  AliRtcByeTypeKickOff	Kicked out.
  AliRtcByeTypeDelChannel	The channel is deleted.
  AliRtcByeTypeRestoreSession	The session needs to be restored after the user is passively removed.

• AliRtcAudioEffectVoiceChangerMode: The modes for voice changer effects.

  Enumeration name	Description
  AliRtcSdk_AudioEffect_Voice_Changer_OFF	Off.
  AliRtcSdk_AudioEffect_Voice_Changer_Oldman	Old man.
  AliRtcSdk_AudioEffect_Voice_Changer_Babyboy	Baby boy.
  AliRtcSdk_AudioEffect_Voice_Changer_Babygirl	Baby girl.
  AliRtcSdk_AudioEffect_Voice_Changer_Robot	Robot.
  AliRtcSdk_AudioEffect_Voice_Changer_Daimo	Devil.
  AliRtcSdk_AudioEffect_Voice_Changer_Ktv	KTV.
  AliRtcSdk_AudioEffect_Voice_Changer_Echo	Echo.
  AliRtcSdk_AudioEffect_Voice_Changer_MAX	A placeholder with no specific meaning.

• AliRtcAudioEffectReverbMode: The modes for reverb effects.

  Enumeration name	Description
  AliRtcAudioEffectReverb_Off	Off.
  AliRtcAudioEffectReverb_Vocal_I	Vocal I.
  AliRtcAudioEffectReverb_Vocal_II	Vocal II.
  AliRtcAudioEffectReverb_Bathroom	Public bathhouse
  AliRtcAudioEffectReverb_Small_Room_Bright	Bright small room.
  AliRtcAudioEffectReverb_Small_Room_Dark	Dark small room.
  AliRtcAudioEffectReverb_Medium_Room	Medium room.
  AliRtcAudioEffectReverb_Large_Room	Large room.
  AliRtcAudioEffectReverb_Church_Hall	Church hall.
  AliRtcAudioEffectReverb_Cathedral	Cathedral.
  AliRtcAudioEffectReverb_Mode_Max	A placeholder with no specific meaning.

• AliRtcAudioEffectReverbParamType: Parameters for reverb effects.

  Enumeration	Description
  AliRtcAudioEffectReverb_Room_Size	The room size. Valid values: [0, 100].
  AliRtcAudioEffectReverb_Pre_Delay	The pre-delay. Unit: milliseconds. Valid values: [0, 200].
  AliRtcAudioEffectReverb_Revetberance	The reverberance. Valid values: [0, 100].
  AliRtcAudioEffectReverb_Hf_Damping	The damping. Valid values: [0, 100].
  AliRtcAudioEffectReverb_Tone_Low	The low tone. Valid values: [0, 100].
  AliRtcAudioEffectReverb_Tone_High	The high tone. Valid values: [0, 100].
  AliRtcAudioEffectReverb_Dry_Gain	The dry gain. Valid values: [-20, 10].
  AliRtcAudioEffectReverb_Wet_Gain	The wet gain. Valid values: [-20, 10].
  AliRtcAudioEffectReverb_Type_Max	A placeholder with no specific meaning.

• AliRtcAudioRouteType: Audio routing.

  Enumeration Name	Description
  AliRtcAudioRouteType_Default	The default audio route.
  AliRtcAudioRouteType_Headset	Headset.
  AliRtcAudioRouteType_Earpiece	Earpiece.
  AliRtcAudioRouteType_HeadsetNoMic	Headset without a microphone.
  AliRtcAudioRouteType_Speakerphone	Phone speaker.
  AliRtcAudioRouteType_LoudSpeaker	External speaker.
  AliRtcAudioRouteType_BlueTooth	Bluetooth headset.

• AliRtcRemoteTextureInfo: Texture information for a remote user.

  Parameter	Type	Description
  AliRtcVideoCanvas	AliRtcVideoCanvas	The rendering canvas.
  userId	String	The ID of the remote user.
  videoTrack	int	The video stream type.

• AliRtcVideoCanvas: The canvas for rendering.

  Parameter	Type	Description
  textureId	int	The texture ID of the video data.
  textureWidth	int	The texture width.
  textureHeight	int	High texture quality
  sharedContext	long	The thread-related context variable of OpenGL.
  enableBeauty	boolean	Indicates whether to enable retouching. Valid values: true: enabled. false: disabled. The default value is false.
  view	View	The video display window. This must be a SurfaceView rendering view created using the createRenderSurfaceView interface, or a TextureView rendering view created using the createRenderTextureView interface.
  renderMode	AliRtcRenderMode	The view rendering mode. The default value is AliRtcRenderModeAuto.
  mirrorMode	AliRtcRenderMirrorMode	The view image mode. The default value is AliRtcRenderMirrorModeOnlyFront.
  rotationMode	AliRtcRotationMode	The view rotation angle. The default value is AliRtcRotationMode_0.
  backgroundColor	int	The background color of the view.

• AliRtcAudioRouteType: The states of a bypass stream ingest task.

  Enumeration	Description
  AliRtcMpuStateStart	The bypass task has started.
  AliRtcMpuStateUpdate	The bypass task is being updated.
  AliRtcMpuStateStop	The bypass task has stopped.
  AliRtcMpuStateEnd	The bypass task has ended.
  AliRtcMpuStateConnect	Connecting to the bypass task.
  AliRtcMpuStateRunning	The bypass task is running.
  AliRtcMpuStateRecovering	Resumes a bypass task.
  AliRtcMpuStateFailed	The bypass task failed.
  AliRtcMpuStateUnknow	The bypass task is in an unknown state.

• AliRtcRectPosition: The position and size of the watermark image.

  Parameter	Type	Description
  x	float	The horizontal offset from the top-left corner.
  y	float	The vertical offset from the top-left corner.
  width	float	The width of the watermark image.
  height	float	The height of the watermark image.

• AliRtcWatermarkConfig: Settings for the watermark image.

  Parameter	Type	Description
  visibleInPreview	boolean	Indicates whether the watermark is visible in the local preview.
  positionInLandscapeMode	AliRtcRectPosition	The coordinates of the watermark in landscape mode.
  positionInPortraitMode	AliRtcRectPosition	The coordinates of the watermark in portrait mode.
  alpha	float	The transparency.
  normalized	boolean	Normalization.

• AliRtcTextureInfo: Texture information.

  Parameter	Type	Description
  textureId	int	The texture ID.
  mirrorMode	AliRtcRenderMirrorMode	The image mode.

• AliEngineCameraCapturerConfiguration: Properties for camera capture preferences.

  Parameter	Type	Description
  preference	AliRtcCaptureOutputPreference	The capture preference.
  cameraDirection	AliRtcCameraDirection	The camera direction. This parameter is supported only on Android and iOS.

• AliRtcCaptureOutputPreference: Preferences for camera capture.

  Enumeration Name	Description
  CAPTURER_OUTPUT_PREFERENCE_AUTO	Automatically adjust capture parameters.
  CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE	Prioritize device performance. The camera output parameters that are closest to the parameters set by setVideoProfile are selected.
  CAPTURER_OUTPUT_PREFERENCE_PREVIEW	Prioritize video preview quality. Higher camera output parameters are selected.

• AliRtcCameraDirection: The directions of the camera.

  Enumeration	Description
  CAMERA_REAR	Use the rear camera.
  CAMERA_FRONT	Use the front camera.

• AliRtcVideoEncoderFrameRate: The frame rates for video encoding.

  Enumeration	Description
  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: The bitrates for video encoding.

  Enumeration	Description
  AliRtcVideoEncoderStandardBitrate	Standard bitrate mode.

• AliRtcVideoEncoderMirrorMode: The image modes for encoded video.

  Enumeration name	Description
  AliRtcVideoEncoderMirrorModeDisabled	The encoded video is mirrored.
  AliRtcVideoEncoderMirrorModeEnabled	The encoded video is not mirrored.

• AliRtcVideoEncoderOrientationMode: The rotation modes for encoded video.

  Enumeration	Description
  AliRtcVideoEncoderOrientationModeAdaptive	Adaptive. The rotation angle is the same as that of the captured video.
  AliRtcVideoEncoderOrientationModeFixedLandscape	Fixed landscape.
  AliRtcVideoEncoderOrientationModeFixedPortrait	Fixed portrait.

• AliRtcVideoDimensions: The resolutions of a video.

  Parameter	Type	Description
  width	int	The video width.
  height	int	The video height.

• AliRtcVideoEncoderConfiguration: Preferences for video encoding.

  Parameter	Type	Description
  dimensions	AliRtcVideoDimensions	The video resolution.
  frameRate	int	The video encoding frame rate.
  bitrate	int	The video encoding bitrate.
  mirrorMode	AliRtcVideoEncoderMirrorMode	The encoded video image mode.
  orientationMode	AliRtcVideoEncoderOrientationMode	The encoded video rotation mode.
  rotation	AliRtcRotationMode	The video rotation angle.

• AliRtcScreenShareEncoderConfiguration: Preferences for screen encoding.

  Parameter	Type	Description
  dimensions	AliRtcVideoDimensions	The video resolution.
  frameRate	int	The video encoding frame rate.
  bitrate	int	The video encoding bitrate.
  rotationMode	AliRtcRotationMode	The stream ingest rotation angle.

• AliRtcAuthInfo: Authentication information.

  Parameter	Type	Description
  channelId	String	The channel ID.
  userId	String	The user ID.
  appId	String	The application ID.
  nonce	String	A random string.
  role	String	The role type. The default value is empty, which indicates that this feature is not used. Valid values: pub: streamer. sub: viewer. relay: cross-channel stream forwarding. To perform role-based authentication, see How do I perform role-based authentication?.
  timestamp	long	The timestamp.
  session	String	The session.
  token	String	The token.
  gslb	String[]	The GSLB address.
  agent	String[]	The address of the agent server.

• AliRtcTranscodingUser: User information for live transcoding.

  Parameter	Type	Description
  userId	String	The user ID.

• AliRtcTranscodingUserPane: User pane information for live transcoding.

  Parameter	Type	Description
  paneId	int	The pane ID.
  userId	String	The user ID.
  sourceType	String	The stream type. Valid values: camera: camera. shareScreen: screen sharing.

• AliRtcTranscodingPane: Custom user pane information for live transcoding.

  Parameter Name	Type	Description
  paneId	int	The pane ID.
  userId	String	The user ID.
  majorPane	Integer	Specifies the main pane. Valid values: 0: secondary pane. 1: main pane. Each layout can have only one main pane.
  x	float	The horizontal coordinate relative to the top-left corner, as a normalized percentage.
  y	float	The vertical coordinate relative to the top-left corner, as a normalized percentage.
  width	float	The pane width.
  height	float	The pane height.
  zorder	int	The stacking order. A value of 0 indicates the bottom layer. A value of 1 indicates the layer above layer 0, and so on.
  sourceType	String	The stream type. Valid values: camera: The camera. shareScreen: screen sharing.
  segmentType	int	The portrait segmentation type. Valid values: 0: Portrait segmentation is disabled. 1: Portrait segmentation. Portrait segmentation is valid only in virtual background mode.

• AliRtcTranscodingLayout: Custom layout information for live transcoding.

  Parameter Name	Type	Description
  audioMixCount	int	The maximum number of mixed audio streams.
  panes	List<AliRtcTranscodingPane>	The custom layout pane parameters.

• AliRtcLiveTranscoding: Configurations for live transcoding.

  Parameter	Type	Description
  mixMode	int	The stream mixing mode. Valid values: 0: single-stream forwarding. In this mode, the original single stream is forwarded without being mixed or transcoded. You do not need to configure stream mixing and transcoding parameters. 1: Stream mixing and transcoding, supporting mixed and transcoded outputs.
  layoutIds	List<String>	An array of layout IDs.
  subSpecUsers	List<AliRtcTranscodingUser>	A list of specified users for stream mixing.
  userPanes	List<AliRtcTranscodingUserPane>	A list of user panes.
  layouts	List<AliRtcTranscodingLayout>	A list of custom user layouts.
  taskProfile	String	The task billing configuration.
  backgroundColor	int	The background color in RGB format. The default value is 0, which indicates black. The value is calculated using the following formula: R + G × 256 + B × 65536. The valid values for R (red), G (green), and B (blue) are 0 to 255.
  mediaEncode	int	The encoding option.
  cropMode	int	The video clipping mode. Valid values: 1: crop while maintaining the aspect ratio. 2: add black bars while maintaining the aspect ratio. The default value is 2.
  streamType	int	The audio stream to forward in single-stream forwarding mode. Valid values: 0: Forwards the original stream. 1: Forward only the audio stream. 2: Forward only the video stream.
  sourceType	String	The user video input stream in single-stream forwarding mode. Valid values: camera: camera. shareScreen: screen sharing.
  externalParam	String	An extended field.

• AliRtcRemoteUserInfo: Information about a remote user.

  Parameter	Type	Description
  userID	String	The ID of the remote user.
  sessionID	String	The session ID of the remote user.
  displayName	String	The name of the remote user.
  muteAudioPlaying	boolean	Indicates whether the local client has muted this remote user.
  isOnline	boolean	Indicates whether the remote user is online.
  cameraCanvas	AliRtcVideoCanvas	The camera stream canvas.
  screenCanvas	AliRtcVideoCanvas	The screen stream canvas.
  hasAudio	boolean	Indicates whether the remote user has published an audio stream.
  hasCameraMaster	boolean	Indicates whether the remoteuser has published the high-definition camera stream.
  hasCameraSlave	boolean	Indicates whether the remote user has published the low-definition camera stream.
  hasScreenSharing	boolean	Indicates whether the remote user has published a screen stream.
  subScribedAudio	boolean	Indicates whether the local client has pulled the audio stream of this remote user.
  subScribedCamearSlave	boolean	Indicates whether the local client has pulled the low-definition camera stream of this remote user.
  subScribedCameraMaster	boolean	Indicates whether the local client has pulled the high-definition camera stream of this remote user.
  subScribedScreenSharing	boolean	Indicates whether the local client has pulled the screen stream of this remote user.
  requestAudio	boolean	Indicates whether the local client has subscribed to the audio stream of this remote user.
  requestCameraSlave	boolean	Indicates whether the local client has subscribed to the low-definition camera stream of this remote user.
  requestCameraMaster	boolean	Indicates whether the local client has subscribed to the high-definition camera stream of this remote user.
  requestScreenSharing	boolean	Indicates whether the local client has subscribed to the screen stream of this remote user.
  preferCameraMaster	boolean	Indicates whether the remote user has prioritized the high-definition stream.
  hasCameraView	boolean	Indicates whether the local client has set the view for the camera stream of this remote user.
  hasScreenView	boolean	Indicates whether the local client has set the view for the screen stream of this remote user.

• AliRtcVideoReason: The reason that triggers a change in the video stream state.

  Enumeration	Description
  AliRTCVideoChangedByClient	Client.
  AliRTCVideoChangedByServer	Server.

• AliRtcVideoState: Changes in the state of the video stream.

  Enumeration	Description
  AliRtcVideoVideoClose	Close the video stream.
  AliRtcVideoVideoOpen	Resume the video stream.

• AliRtcTranscodingPublishTaskStatus: The states of a live transcoding stream ingest task.

  Enumeration Name	Description
  AliRtcTrascodingPublishTaskStatusStart	The live transcoding stream ingest task has started.
  AliRtcTrascodingPublishTaskStatusUpdate	The live transcoding stream ingest task is being updated.
  AliRtcTrascodingPublishTaskStatusStop	The live transcoding stream ingest task has stopped.

• AliEngineLiveTranscodingErrorCode: Error codes for live transcoding stream ingest.

  Enumeration	Description
  AliEngineLiveTranscodingErrorPublishOk	Preparation for bypass live streaming is complete.
  AliEngineLiveTranscodingErrorStreamNotFound	The bypass live stream ingest URL was not found.

• AliRtcLiveTranscodingState: The states of live transcoding.

  Enumeration Name	Description
  AliRtcLiveTranscodingState_IDLE	Stream ingest is idle.
  AliRtcLiveTranscodingState_CONNNECT	Connecting to the stream ingest server.
  AliRtcLiveTranscodingState_RUNNING	Stream ingest is in progress.
  AliRtcLiveTranscodingState_RECOVERING	Resuming stream ingest.
  AliRtcLiveTranscodingState_FAILURE	Stream ingest failed.
  AliRtcLiveTranscodingState_END	Stream ingest has ended.

• AliRtcLiveTranscodingMediaProcessMode: The media processing modes for live transcoding.

  Enumeration	Description
  AliRtcLiveTranscodingNormal	Normal mode.
  AliRtcLiveTranscodingVirtualBackground	Virtual background mode.

• AliRtcLiveTranscodingCropMode: The clipping modes for live transcoding.

  Enumeration	Description
  AliRtcLiveTranscodingCrop	Crop while maintaining the aspect ratio.
  AliRtcLiveTranscodingFill	Add black bars while maintaining the aspect ratio (default).

• AliRtcLiveTranscodingFontType: The fonts for live transcoding.

  Enumeration	Description
  NOTO_SERIF_CJKSC_REGULAR	NotoSerifCJKsc-REGULAR.
  ALIBABA_PUHUITI_REGULAR	Alibaba-PuHuiTi-Regular.
  ALIBABA_PUHUITI_BOLD	Alibaba-PuHuiTi-Bold.
  ALIBABA_PUHUITI_Heavy	Alibaba-PuHuiTi-Heavy.
  ALIBABA_PUHUITI_LIGHT	Alibaba-PuHuiTi-Light.
  ALIBABA_PUHUITI_MEDIUM	Alibaba-PuHuiTi-Medium.

• AliRtcLiveTranscodingSegmentType: The input types for live transcoding.

  Enumeration Name	Description
  AliRtcLiveTranscodingNoBody	No portrait segmentation.
  AliRtcLiveTranscodingBody	Portrait segmentation.

• AliRtcLiveTranscodingAudioSampleRate: The audio sample rates for live transcoding.

  Enumeration Name	Description
  AliRtcLiveTranscoding_HZ_48000	Sample rate of 48,000 Hz.
  AliRtcLiveTranscoding_HZ_44100	Sample rate of 44,100 Hz.
  AliRtcLiveTranscoding_HZ_32000	Sample rate of 32,000 Hz.
  AliRtcLiveTranscoding_HZ_16000	Sample rate of 16,000 Hz.
  AliRtcLiveTranscoding_HZ_8000	Sample rate of 8,000 Hz.

• AliRtcLiveTranscodingTaskProfile: The billing specifications for live transcoding.

  Enumeration name	Description
  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	Audio-only.

• AliRtcLiveTranscodingSourceType: The video stream types for live transcoding.

  Enumeration	Description
  AliRtcLiveTranscodingCamera	Camera.
  AliRtcLiveTranscodingShareScreen	Screen sharing.

• AliRtcLiveTranscodingStreamType: The stream types for live transcoding.

  Enumeration name	Description
  AliRtcLiveTranscodingOrigin	Forward the original stream.
  AliRtcLiveTranscodingAudio	Forward only the audio stream.
  AliRtcLiveTranscodingVideo	Forward only the video stream.

• AliRtcLiveTranscodingMixMode: The modes for live transcoding.

  Enumeration name	Description
  AliRtcLiveTranscodingSINGLE	Single-stream forwarding. In this mode, the original single stream is forwarded without being mixed or transcoded. You do not need to configure stream mixing and transcoding parameters.
  AliRtcLiveTranscodingMIX	Stream mixing and transcoding (default). This mode supports mixed and transcoded output.

• AliRtcVideoObserAlignment: The types of data alignment for raw data callbacks.

  Enumeration Name	Description
  AliRtcAlignmentDefault	No processing. The raw data is directly called back.
  AliRtcAlignmentEven	The width is processed to be an even number.
  AliRtcAlignment4	The width is processed to be a multiple of 4.
  AliRtcAlignment8	The width is processed to be a multiple of 8.
  AliRtcAlignment16	The width is processed to be a multiple of 16.

• AliRtcLiveTranscodingEncodeParam: Encoding parameters for live transcoding.

  Parameter	Type	Description
  videoWidth	int	Width.
  videoHeight	int	Height.
  videoFramerate	int	Frame rate.
  videoBitrate	int	Bitrate.
  videoGop	int	GOP.
  audioSamplerate	AliRtcLiveTranscodingAudioSampleRate	Bypasses the audio sampling rate of the live stream.
  audioBitrate	int	Audio bitrate.
  audioChannels	int	The number of audio channels.

• AliRtcLiveTranscodingMixParam: Stream mixing parameters for live transcoding.

  Parameter	Type	Description
  taskProfile	AliRtcLiveTranscodingTaskProfile	Billing specifications for bypass live streaming.
  encodeParam	AliRtcLiveTranscodingEncodeParam	Bypasses the encoding parameters for live streaming.
  users	List<TranscodingUser>	A list of users in the bypass live stream.
  backgroundColor	int	Background color.
  backgrounds	List<TranscodingImage>	A list of background images.
  watermarks	List<TranscodingImage>	A list of watermark images.
  clockWidgets	List<TranscodingClockWidget>	A list of clock widgets.
  cropMode	AliRtcLiveTranscodingCropMode	Bypass mode for live stream clipping.
  mediaProcessMode	AliRtcLiveTranscodingMediaProcessMode	Bypass mode for live streams.

• AliRtcLiveTranscodingParam: Parameters for live transcoding.

  Parameter	Type	Description
  mixMode	AliRtcLiveTranscodingMixMode	Live streaming bypass mode.
  singleParam	AliRtcLiveTranscodingSingleParam	Parameters for a single stream in Bypass Live Streaming.
  mixParam	AliRtcLiveTranscodingMixParam	Parameters for bypassing live stream mixing.

• AliRtcLiveTranscodingSingleParam: Parameters for a single stream in live transcoding.

  Parameter	Type	Description
  userId	String	User ID.
  streamType	AliRtcLiveTranscodingStreamType	Bypass live stream relay
  sourceType	AliRtcLiveTranscodingSourceType	The bypass live video stream type.

• TranscodingClockWidget: The clock widget for live transcoding.

  Parameter	Type	Description
  mX	int	X-coordinate (in pixels).
  mY	int	Y-coordinate (in pixels).
  mFontSize	int	Specifies the font size for bypass live streaming.
  mZorder	int	The stacking order. A value of 0 indicates the bottom layer. A value of 1 indicates the layer above layer 0, and so on.
  mFontColor	int	Font color for bypass live streaming.
  mFontType	AliRtcLiveTranscodingFontType	Bypass font for live streaming.

• TranscodingUser: User information for live transcoding.

  Parameter	Type	Description
  mUserId	String	User ID.
  x	int	X-coordinate (in pixels).
  y	int	Y-coordinate (in pixels).
  width	int	Pane width.
  height	int	Pane height.
  zOrder	int	The stacking order. A value of 0 indicates the bottom layer. A value of 1 indicates the layer above layer 0, and so on.
  sourceType	AliRtcLiveTranscodingSourceType	Bypassed live video stream type.
  segmentType	AliRtcLiveTranscodingSegmentType	Live stream bypass input type.
  images	List<TranscodingImage>	A list of images.
  texts	List<TranscodingText>	A list of texts.

• TranscodingText: Text information for live transcoding.

  Parameter	Type	Description
  mText	String	Text information.
  mX	int	X-coordinate (in pixels).
  mY	int	Y-coordinate (in pixels).
  mFontSize	int	Font size.
  mZorder	int	The stacking order. A value of 0 indicates the bottom layer. A value of 1 indicates the layer above layer 0, and so on.
  mFontColor	int	Font color.
  mFontType	AliRtcLiveTranscodingFontType	Bypass the font for live streaming.

• TranscodingImage: Image information for live transcoding.

  Parameter	Type	Description
  mUrl	String	Image URL.
  mAlpha	float	Transparency. A value of 0.0 indicates fully transparent, and 1.0 indicates fully opaque.
  mDisplay	DisplayType	Image display.
  mX	int	X-coordinate (in pixels).
  mY	int	Y-coordinate (in pixels).
  mWidth	int	Pane width.
  mHeight	int	Pane height.
  mZorder	int	The stacking order. A value of 0 indicates the bottom layer. A value of 1 indicates the layer above layer 0, and so on.

• DisplayType: The display modes for an image.

  Enumeration	Description
  NOT_DISPLAY	Not displayed.
  ALWAYS	Always displayed.
  WHEN_NO_VIDEO	Displayed when there is no video.