This topic describes the data types of ApsaraVideo Real-time Communication (ARTC) SDK for HarmonyOS.
List of classes
Data type | Description |
The video frame data. | |
The audio frame data. | |
The statistics on the session. | |
The volume information of the user. | |
The information about the audio file. | |
The statistics on the local video. | |
The statistics on the remote video. | |
The statistics on the local audio. | |
The statistics on the remote audio. | |
The device information. | |
The parameter struct of the external encoder for quality of service (QoS) feedback. | |
The encoder usage information. | |
The decoder usage information. | |
The network quality inspection results. | |
The video resolution. | |
The video encoding settings for the camera track. | |
The display view settings. | |
The user information. | |
The playback settings of the accompaniment. | |
The camera settings. | |
The Data Channel message. | |
The audio data callback settings. | |
The settings of the external audio stream. | |
The sound effect settings. | |
The parameters for ingesting a single stream in relayed live streaming. | |
The encoding parameters of relayed live streaming. | |
The information about the clock widget that is used in relayed live streaming. | |
The information about the image that is displayed in relayed live streaming. | |
The information about the text that is displayed in relayed live streaming. | |
The information about the user in relayed live streaming. | |
The parameters for ingesting mixed streams in relayed live streaming. | |
The configurations of relayed live streaming. |
List of enumerations
Data type | Description |
The source of the video track. | |
The source of the audio track. | |
The channel mode. | |
The user role. | |
The type of the camera track. | |
The log level. | |
The rendering mode. | |
The rotation angle. | |
The mirroring mode. | |
The type of the camera. | |
The collection preferences of the camera. | |
The aspect ratio. | |
The mode of local mute. | |
The voice change mode. | |
The reverberation mode. | |
The voice beautification mode. | |
The parameters of the reverberation mode. | |
The equalization frequency for reverberation. | |
The status of relayed live streaming. | |
The type of relayed live streaming. | |
The mode of relayed live streaming. | |
The input source of relayed live streaming. | |
The billing specifications of relayed live streaming. | |
The audio sampling rate of relayed live streaming. | |
The video codec of relayed live streaming. | |
The video source. | |
The video format. | |
The width alignment of the output video. | |
The type of the video data. | |
The output position of the video data. | |
The reason why the user is disconnected from the channel. | |
The scenario in which a user is forced to leave a channel. | |
The playback status code of the accompaniment. | |
The playback error code of the accompaniment. | |
The status of the network connection. | |
The reason why the network connection status changes. | |
The type of the peripheral device. | |
The status of the peripheral device. | |
The audio route. | |
The state of audio focus. | |
The stream ingest status. | |
The subscription status. | |
The error code of relayed live streaming. | |
The status of the publish task in relayed live streaming. | |
The mode of audio quality. | |
The mode for the audio scenario. | |
The cross-channel relaying event. | |
The status of cross-channel relaying. | |
The error code of cross-channel relaying. | |
The video frame rate. | |
The video bitrate. | |
The orientation mode of the video. | |
The mirroring mode of the video. | |
The type of the local device. | |
The exception that occurs on the local device. | |
The cropping mode in relayed live streaming. | |
The media processing mode in relayed live streaming. | |
The status of portrait segmentation in relayed live streaming. | |
The status of the video track. | |
The reason why the status of the video track changes. | |
The type of requested frames from the external encoder for QoS feedback. | |
The type of the plug-in. | |
The purpose of the plug-in. | |
The scaling mode for background replacement. | |
The decoding type. | |
The codec manufacturer. | |
The type of the Data Channel message. | |
The network quality. | |
The type of the audio track. | |
The device connection type. | |
The source of the audio data. | |
The audio sampling rate. | |
The sound channel settings. | |
The audio callback mode. | |
The video codec type. | |
The font of the text that is displayed in relayed live streaming. | |
The custom parameter for audio callbacks. | |
The display mode of the image in relayed live streaming. |
Class details
AliRtcVideoRawData
The video frame data.
Parameter | Type | Description |
format | AliRtcVideoFormat | The video format. |
type | AliRtcBufferType | The buffer type. |
dataLength | number | The data length. |
pixelBuffer | number | The buffer pointer. |
dataPtr | number | The data pointer. |
dataYPtr | number | The pointer for the luminance component Y. This parameter is available only if the YUV format is used. |
dataUPtr | number | The pointer for the chrominance component U. This parameter is available only if the YUV format is used. |
dataVPtr | number | The pointer for the chrominance component V. This parameter is available only if the YUV format is used. |
strideY | number | The number of bytes in a pixel per row for the luminance component Y. |
strideU | number | The number of bytes in a pixel per row for the chrominance component U. |
strideV | number | The number of bytes in a pixel per row for the chrominance component V. |
height | number | The height of a video frame. |
width | number | The width of a video frame. |
rotation | number | The rotation angle. |
stride | number | The number of bytes per row for a video frame. |
timeStamp | number | The video timestamp. |
textureId | number | The texture ID. |
encodeCostMs | number | The time consumed by encoding. |
shared_context | number | The ID of the shared context, which is used in multi-thread or multi-device scenarios. |
egl_change | boolean | Specifies whether the EGL context has changed. |
egl_context | number | The pointer to the EGL context, which is used in the rendering context of OpenGL for Embedded Systems (OpenGL ES). |
AliRtcAudioRawData
The audio frame data.
Parameter | Type | Description |
dataPtr | number | The native pointer of the audio data. |
numOfSamples | number | The number of sampling points. |
bytesPerSample | number | The number of bytes per sampling point. |
numOfChannels | number | The number of sound channels. |
samplesPerSec | number | The number of sampling points per second. |
AliRtcStats
The statistics on the session.
Parameter | Type | Description |
availableSendBitrate | number | The available bandwidth. Unit: Kbit/s. |
sentKBitrate | number | The total bitrate at which data is sent. Unit: Kbit/s. |
rcvdKBitrate | number | The total bitrate at which data is received. Unit: Kbit/s. |
sentBytes | number | The total amount of data sent. Unit: bytes. |
rcvdBytes | number | The total amount of data received. Unit: bytes. |
videoRcvdKBitrate | number | The bitrate at which the video is received. Unit: bit/s. |
videoSentKBitrate | number | The bitrate at which the video is sent. Unit: bit/s. |
systemCpu | number | The CPU utilization of the system. Unit: %. |
appCpu | number | The CPU utilization of the processes. Unit: %. |
callDuration | number | The duration of the call. |
sentLossRate | number | The packet loss rate in data transmission from the client to the server. Unit: %. |
sentLossPkts | number | The number of lost packets in data transmission from the client to the server. |
sentExpectedPkts | number | The total number of packets that are sent from the client to the server. |
rcvdLossRate | number | The packet loss rate in data transmission from the server to the client. Unit: %. |
rcvdLossPkts | number | The number of lost packets in data transmission from the server to the client. |
rcvdExpectedPkts | number | The total number of packets that are sent from the server to the client. |
lastmileDelay | number | The latency of data transmission from the client to the server. Unit: milliseconds. |
AliRtcStats
The statistics on the session.
Parameter | Type | Description |
availableSendBitrate | number | The available bandwidth. Unit: Kbit/s. |
sentKBitrate | number | The total bitrate at which data is sent. Unit: Kbit/s. |
rcvdKBitrate | number | The total bitrate at which data is received. Unit: Kbit/s. |
sentBytes | number | The total amount of data sent. Unit: bytes. |
rcvdBytes | number | The total amount of data received. Unit: bytes. |
AliRtcUserVolumeInfo
The volume information of the user.
Parameter | Type | Description |
uid | string | The user ID. |
speechState | boolean | The speech status. Valid values: 0 (the user is not speaking) and 1 (the user is speaking). |
volume | number | The volume. Valid values: 0 to 255. |
sumVolume | number | The accumulated volume within the callback period, which is used to identify the current speaker. Valid values: 0 to 255. |
AliRtcAudioFileInfo
The information about the audio file.
Parameter | Type | Description |
filePath | string | The path of the audio file. |
durationMs | number | The duration of the audio file. Unit: milliseconds. |
AliRtcLocalVideoStats
The statistics on the local video.
Parameter | Type | Description |
track | AliRtcVideoTrack | The source of the video track. |
targetEncodeBitrate | number | Target encoding bit rate |
actualEncodeBitrate | number | The actual encoding bitrate. |
sentBitrate | number | The bitrate at which the video is sent. |
sentFps | number | The frame rate of the video that is sent. |
encodeFps | number | The frame rate for encoding. |
captureFps | number | The frame rate for collection. |
avgQpPerSec | number | The average quantization parameter (QP) value per second. |
AliRtcRemoteVideoStats
The statistics on the remote video.
Parameter | Type | Description |
userId | string | The user ID. |
track | AliRtcVideoTrack | The source of the video track. |
width | number | The width of the video. |
height | number | The height of the video. |
decodeFps | number | The frame rate for decoding. |
renderFps | number | The frame rate for rendering. |
frozenTimes | number | The number of times stuttering occurs. |
videoTotalFrozenTime | number | The accumulated duration of stuttering during video playback. Unit: milliseconds. |
videoTotalFrozenRate | number | The stuttering rate during video playback. Unit: %. |
rtpCount | number | The number of frames per second. |
rtpLoss | number | The number of lost frames per second. |
AliRtcLocalAudioStats
The statistics on the local audio.
Parameter | Type | Description |
scene | AliRtcAudioScenario | The mode for the audio scenario. |
track | AliRtcAudioTrack | The source of the audio track. |
sentBitrate | number | The bitrate at which the audio is sent. Unit: Kbit/s. |
sentSamplerate | number | The sampling rate. |
numChannel | number | The number of sound channels. |
inputLevel | number | The input level. |
AliRtcRemoteAudioStats
The statistics on the remote audio.
Parameter | Type | Description |
userId | string | The ID of the remote user. |
track | AliRtcAudioTrack | The source of the audio track. |
quality | number | The quality of the audio track that is sent by the remote user. |
networkTransportDelay | number | The network latency from the publisher to the subscriber. Unit: milliseconds. |
jitterBufferDelay | number | The network latency from the subscriber to the cache due to network jitter. Unit: milliseconds. |
audioLossRate | number | The frame loss rate of the audio in the callback period. |
rcvdBitrate | number | The instantaneous bitrate of the received audio. Unit: Kbit/s. |
totalFrozenTimes | number | The accumulated duration of audio stuttering after the remote user joins the channel. Unit: milliseconds. |
audioTotalFrozenTime | number | The accumulated duration of stuttering during audio playback. Unit: milliseconds. |
audioTotalFrozenRate | number | The stuttering rate during audio playback. Unit: %. |
AliRtcDeviceInfo
The device information.
Parameter | Type | Description |
deviceID | string | The device ID. |
deviceTransportType | AliRtcDeviceTransportType | The device connection type. |
AliRtcVideoExternalEncoderParameter
The parameter struct of the external encoder for QoS feedback.
Parameter | Type | Description |
width | number | The width. |
height | number | The height. |
frame_rate | number | The frame rate. |
bitrate_bps | number | The bitrate. |
AliRtcEncoderNotifyInfo
The encoder usage information.
Parameter | Type | Description |
videoTrack | AliRtcVideoTrack | The source of the video track. |
encoderManufacturer | AliRtcVideoCodecManufacturer | The codec manufacturer. |
videoFormat | AliRtcVideoFormat | The video format. |
AliRtcDecoderNotifyInfo
The decoder usage information.
Parameter | Type | Description |
uid | string | The user ID. |
videoTrack | AliRtcVideoTrack | The source of the video track. |
decoderManufacturer | AliRtcVideoCodecManufacturer | The codec manufacturer. |
AliRtcNetworkProbeResult
The network quality inspection results.
Parameter | Type | Description |
rtt | number | The round-trip time (RTT) of the link. Unit: milliseconds. |
uplinkLoss | number | The upstream packet loss rate. Maximum value: 100. |
uplinkJitter | number | The upstream network jitter. Unit: milliseconds. |
uplinkBandWidth | number | The upstream bandwidth. Unit: Kbit/s. |
downlinkLoss | number | The downstream packet loss rate. Maximum value: 100. |
downlinkJitter | number | The downstream network jitter. Unit: milliseconds. |
downlinkBandWidth | number | The downstream bandwidth. Unit: Kbit/s. |
AliRtcVideoDimensions
The video resolution.
Parameter | Type | Description |
width | number | The width. |
height | number | The height. |
AliRtcVideoEncoderConfiguration
The video encoding settings for the camera track.
Parameter | Type | Description |
dimensions | AliRtcVideoDimensions | The video resolution. |
frameRate | AliRtcFrameRate | The video frame rate. |
bitrate | number | The bitrate for video encoding. Unit: Kbit/s. |
min_bitrate | number | The minimum bitrate for video encoding. Unit: Kbit/s. |
keyFrameInterval | number | The keyframe interval. Unit: milliseconds. |
forceStrictKeyFrameInterval | number | Specifies whether to force the encoder to generate keyframes exactly at the specified keyframe interval. |
orientationMode | AliRtcVideoEncoderOrientationMode | The orientation mode of the video. |
mirrorMode | AliRtcVideoMirrorMode | The mirroring mode for stream ingest. |
rotationMode | AliRtcRotationMode | The rotation angle for stream ingest. |
AliRtcStats
The statistics on the session.
Parameter | Type | Description |
availableSendBitrate | number | The available bandwidth. Unit: Kbit/s. |
sentKBitrate | number | The total bitrate at which data is sent. Unit: Kbit/s. |
rcvdKBitrate | number | The total bitrate at which data is received. Unit: Kbit/s. |
sentBytes | number | The total amount of data sent. Unit: bytes. |
rcvdBytes | number | The total amount of data received. Unit: bytes. |
AliRtcVideoCanvas
The display view settings.
Parameter | Type | Description |
surfaceId | string | surfaceId |
width | number | The texture width. |
height | number | The texture height. |
textureId | number | The texture ID. |
rotation | AliRtcRotationMode | The rotation angle. |
mirrorMode | AliRtcRenderMirrorMode | The mirroring mode. |
renderMode | AliRtcRenderMode | The rendering mode. |
backgroundColor | number | The background color. |
displayView | AliRtcSurfaceView | surfaceView |
AliRtcEngineAuthInfo
The user information.
Parameter | Type | Description |
channelId | string | The channel ID. |
userId | string | The user ID. |
appId | string | The application ID. |
nonce | string | The random string. |
token | string | The token. |
role | string | The user role. |
timestamp | number | The timestamp. |
AliRtcAudioAccompanyConfig
The playback settings of the accompaniment.
Parameter | Type | Description |
onlyLocalPlay | boolean | Specifies whether to play the accompaniment only locally. |
replaceMic | boolean | Specifies whether to replace the audio collected by microphone. |
loopCycles | number | The number of loops. |
startPosMs | number | The position of playback startup. Unit: milliseconds. |
publishVolume | number | The volume for stream ingest. |
playoutVolume | number | The volume for playback. |
AliRtcCameraCaptureConfiguration
The collection preferences of the camera.
Parameter | Type | Description |
preference | AliRtcCaptureOutputPreference | The collection preferences. |
cameraDirection | AliRtcCameraDirection | The type of the camera. |
AliRtcDataChannelMsg
The Data Channel message.
Parameter | Type | Description |
type | AliRtcDataMsgType | The type of the Data Channel message. |
networkTime | number | The network timestamp (NTP time) when the message was sent. |
progress | number | The current progress. Unit: milliseconds. |
data | ArrayBuffer | The custom data of the message. |
AliRtcAudioFrameObserverConfig
The audio data callback settings.
Parameter | Type | Description |
sampleRate | AliRtcAudioSampleRate | The audio sampling rate. |
channels | AliRtcAudioNumChannel | The number of sound channels. |
mode | AliRtcAudioFrameObserverOperationMode | The callback mode. |
userDefinedInfo | number | The custom parameter. |
AliRtcExternalAudioStreamConfig
The settings of the external audio stream.
Parameter | Type | Description |
channels | number | The number of sound channels. |
sampleRate | number | The sampling rate. |
playoutVolume | number | The volume for playback. |
publishVolume | number | The volume for stream ingest. |
publishStream | number | The mode in which the audio stream is ingested. A value of 1 specifies that the audio stream is ingested as a secondary audio track. A value of 0 specifies that the audio stream is ingested as a microphone track. |
AliRtcAudioEffectConfig
The sound effect settings.
Parameter | Type | Description |
needPublish | boolean | Specifies whether to ingest a stream for the sound effect. |
loopCycles | number | The number of loops. |
startPosMs | number | The position of playback startup. Unit: milliseconds. |
publishVolume | number | The volume for stream ingest. |
playoutVolume | number | The volume for playback. |
AliRtcLiveTranscodingSingleParam
The parameters for ingesting a single stream in relayed live streaming.
Parameter | Type | Description |
userId | string | The user ID. |
streamType | AliRtcLiveTranscodingStreamType | The stream ingest mode. |
sourceType | AliRtcLiveTranscodingSourceType | The input source of relayed live streaming. |
AliRtcLiveTranscodingEncodeParam
The encoding parameters of relayed live streaming.
Parameter | Type | Description |
videoWidth | number | The width. Valid values: (0,1920]. |
videoHeight | number | The height. Valid values: (0,1920]. |
videoFramerate | number | The frame rate. Valid values: [1,60]. |
videoBitrate | number | The bitrate. Valid values: [1,10000]. Unit: Kbit/s. |
videoGop | number | GOP [1,60] |
videoCodec | AliRtcLiveTranscodingVideoCodec | The video codec of relayed live streaming. |
audioSamplerate | AliRtcLiveTranscodingAudioSampleRate | The audio sampling rate of relayed live streaming. |
audioBitrate | number | The audio bitrate. Valid values: [8,500]. Unit: Kbit/s. |
audioChannels | number | The number of sound channels. Valid values: 1 and 2. |
AliRtcLiveTranscodingClockWidget
The information about the clock widget that is used in relayed live streaming.
Parameter | Type | Description |
x | number | The x-coordinate, in pixels. |
y | number | The y-coordinate, in pixels. |
fontType | AliRtcLiveTranscodingFontType | The font. |
fontSize | number | The font size. |
fontColor | number | The font color. |
zOrder | number | The layer in which the click widget resides. A value of 0 indicates the bottom layer. Each increment of the value by 1 indicates the next upper layer. |
AliRtcLiveTranscodingImage
The information about the image that is displayed in relayed live streaming.
Parameter | Type | Description |
url | string | The URL of the image. |
alpha | number | The transparency of the image. A value of 0.0 indicates that the image is transparent. A value of 1.0 indicates that the image is opaque. |
display | AliRtcLiveTranscodingImage_DisplayType | The display mode of the image. |
x | number | The x-coordinate, in pixels. |
y | number | The y-coordinate, in pixels. |
width | number | The width of the image. |
height | number | The height of the image. |
zOrder | number | The layer in which the image resides. A value of 0 indicates the bottom layer. Each increment of the value by 1 indicates the next upper layer. |
AliRtcLiveTranscodingText
The information about the text that is displayed in relayed live streaming.
Parameter | Type | Description |
text | string | The text. |
x | number | The x-coordinate, in pixels. |
y | number | The y-coordinate, in pixels. |
zOrder | number | The layer in which the text resides. A value of 0 indicates the bottom layer. Each increment of the value by 1 indicates the next upper layer. |
fontType | AliRtcLiveTranscodingFontType | The font. |
fontSize | number | The font size. |
fontColor | number | The font color. |
AliRtcLiveTranscodingUser
The information about the user in relayed live streaming.
Parameter | Type | Description |
userId | string | The user ID. |
x | number | The x-coordinate, in pixels. |
y | number | The y-coordinate, in pixels. |
width | number | The width of the pane. |
height | number | The height of the pane. |
zOrder | number | The layer in which the pane resides. A value of 0 indicates the bottom layer. Each increment of the value by 1 indicates the next upper layer. |
streamType | AliRtcLiveTranscodingStreamType | The type of relayed live streaming. |
sourceType | AliRtcLiveTranscodingSourceType | The input source of relayed live streaming. |
segmentType | AliRtcLiveTranscodingSegmentType | The status of portrait segmentation in relayed live streaming. |
images | Array<AliRtcLiveTranscodingImage> | The image list. |
texts | Array<AliRtcLiveTranscodingText> | The text list. |
AliRtcLiveTranscodingMixParam
The parameters for ingesting mixed streams in relayed live streaming.
Parameter | Type | Description |
taskProfile | AliRtcLiveTranscodingTaskProfile | The billing specifications of relayed live streaming. |
encodeParam | AliRtcLiveTranscodingEncodeParam | The custom encoding parameters of relayed live streaming. |
users | Array<AliRtcLiveTranscodingUser> | The list of users in relayed live streaming. |
backgroundColor | number | The background color. |
backgrounds | Array<AliRtcLiveTranscodingImage> | The list of background images. |
watermarks | Array<AliRtcLiveTranscodingImage> | The list of watermarks. |
clockWidgets | Array<AliRtcLiveTranscodingClockWidget> | The list of clock widgets. |
cropMode | AliRtcLiveTranscodingCropMode | The cropping mode. |
mediaProcessMode | AliRtcLiveTranscodingMediaProcessMode | The media processing mode. |
AliRtcLiveTranscodingParam
The configurations of relayed live streaming.
Parameter | Type | Description |
mixMode | AliRtcLiveTranscodingMixMode | The mode of relayed live streaming. |
singleParam | AliRtcLiveTranscodingSingleParam | The parameters for ingesting a single stream in relayed live streaming. |
mixParam | AliRtcLiveTranscodingMixParam | The parameters for ingesting mixed streams in relayed live streaming. |
Enumeration details
AliRtcVideoTrack
Enumerated value | Description |
AliEngineVideoTrackNo | No video track. |
AliEngineVideoTrackCamera | Camera. |
AliEngineVideoTrackScreen | Screen sharing. |
AliEngineVideoTrackBoth | Camera and screen sharing. |
AliRtcAudioTrack
Enumerated value | Description |
AliEngineAudioTrackNo | No audio track. |
AliEngineAudioTrackMic | Microphone. |
AliEngineAudioTrackDual | Secondary. |
AliEngineAudioTrackBoth | Microphone and secondary. |
AliRtcChannelProfile
Enumerated value | Description |
AliEngineCommunication | The communication mode. |
AliEngineInteractiveLive | The interactive mode. |
AliEngineInteractiveWithLowLatencyLive | The low-latency ARTC mode. |
AliRtcClientRole
Parameter | Description |
AliEngineClientRoleInteractive | The streamer role. |
AliEngineClientRoleLive | The viewer role. |
AliRtcVideoStreamType
Parameter | Description |
AliEngineVideoStreamTypeNone | No video track. |
AliEngineVideoStreamTypeHigh | The major stream. |
AliEngineVideoStreamTypeLow | The minor stream. |
AliRtcLogLevel
Parameter | Description |
AliEngineLogLevelInfo | Info. |
AliEngineLogLevelWarn | Warn. |
AliEngineLogLevelError | Error. |
AliEngineLogLevelFatal | Fatal. |
AliEngineLogLevelNone | None. |
AliRtcRenderMode
Parameter | Description |
AliEngineRenderModeAuto | The auto mode. |
AliEngineRenderModeStretch | The video is stretched to fill the view. The aspect ratio of the video is not maintained if it does not match the aspect ratio of the view. |
AliEngineRenderModeFill | The video is scaled at the original aspect ratio and black bars are added if required. |
AliEngineRenderModeCrop | The video is scaled at the original aspect ratio and cropped to fit the view. |
AliRtcRotationMode
Parameter | Description |
AliEngineRotationMode_0 | The video is not rotated. |
AliEngineRotationMode_90 | The rotation angle is 90°. |
AliEngineRotationMode_180 | The rotation angle is 180°. |
AliEngineRotationMode_270 | The rotation angle is 270°. |
AliRtcRenderMirrorMode
Parameter | Description |
AliEngineRenderMirrorModeOnlyFrontMirror | The mirroring mode is enabled only for previewing videos from the front camera. |
AliEngineRenderMirrorModeAllMirror | The mirroring mode is enabled for all videos. |
AliEngineRenderMirrorModeAllNoMirror | The mirroring mode is disabled for all videos. |
AliRtcCameraDirection
Parameter | Description |
AliEngineCameraDirectionBack | The rear camera. |
AliEngineCameraDirectionFront | The front camera. |
AliRtcCaptureOutputPreference
Parameter | Description |
AliEngineCaptureOutputPreferenceAuto | Collection parameters are automatically adjusted. |
AliEngineCaptureOutputPreferencePerformance | On condition that the camera performance takes precedence, the camera output settings that are closest to the setVideoProfile configuration are used. |
AliEngineCaptureOutputPreferencePreview | On condition that the quality of video preview takes precedence, the camera output settings are as high as possible. |
AliRtcVideoScale
Parameter | Description |
AliEngineVideoScale_16_9 | 16:9. |
AliEngineVideoScale_4_3 | 4:3. |
AliRtcMuteLocalAudioMode
Parameter | Description |
AliEngineMuteLocalAudioModeDefault | The default mode. In this mode, all audio, including the audio collected from the microphone and external audio sources, is muted. |
AliEngineMuteLocalAudioModeMuteAll | All audio, including the audio collected from the microphone and external audio sources, is muted. |
AliEngineMuteLocalAudioModeMuteOnlyMic | Only the audio collected from the microphone is muted. |
AliRtcAudioEffectVoiceChangerMode
Parameter | Description |
AliEngineAudioEffectVoiceChangerOff | Voice change is disabled. |
AliEngineAudioEffectVoiceChangerOldMan | Elder. |
AliEngineAudioEffectVoiceChangerBabyBoy | Boy. |
AliEngineAudioEffectVoiceChangerBabGirl | Girl. |
AliEngineAudioEffectVoiceChangerRobot | Robot. |
AliEngineAudioEffectVoiceChangerDaimo | Devil. |
AliEngineAudioEffectVoiceChangerKTV | KTV |
AliEngineAudioEffectVoiceChangerEcho | Echo. |
AliEngineAudioEffectVoiceChangerDialect | Dialect. |
AliEngineAudioEffectVoiceChangerHow | Roar. |
AliEngineAudioEffectVoiceChangerElectroinc | Electronic. |
AliEngineAudioEffectVoiceChangerPhonograph | Phonograph. |
AliRtcAudioEffectReverbMode
Parameter | Description |
AliEngineAudioEffectReverbOff | Reverberation is disabled. |
AliEngineAudioEffectReverbVocal_I | Vocal I. |
AliEngineAudioEffectReverbVocal_II | Vocal II. |
AliEngineAudioEffectReverbBathroom | Bathhouse. |
AliEngineAudioEffectReverbSmallRoomBright | Small bright room. |
AliEngineAudioEffectReverbSmallRoomDark | Small dark room. |
AliEngineAudioEffectReverbMediumRoom | Medium room. |
AliEngineAudioEffectReverbLargeRoom | Big room. |
AliEngineAudioEffectReverbChurchHall | Church hall. |
AliRtcAudioEffectBeautifyMode
Parameter | Description |
AliEngineAudioEffectBeautifyOff | Voice beatification is disabled. |
AliEngineAudioEffectVigorous | Deep voice. |
AliEngineAudioEffectRinging | Clear voice. |
AliRtcAudioEffectReverbParamType
Parameter | Description |
AliEngineAudioEffectReverbRoomSize | The size of the room. Valid values: 0 to 100. |
AliEngineAudioEffectReverbPreDelay | The pre-latency. Unit: milliseconds. Valid values: 1 to 200. |
AliEngineAudioEffectReverbReverberance | The level of reverberation. Valid values: 0 to 100. |
AliEngineAudioEffectReverbHfDamping | The damping. Valid values: 0 to 100. |
AliEngineAudioEffectReverbToneLow | The low tone. Valid values: 0 to 100. |
AliEngineAudioEffectReverbToneHigh | The high tone. Valid values: 0 to 100. |
AliEngineAudioEffectReverbDryGain | The dry gain. Valid values: -20 to 10. |
AliEngineAudioEffectReverbWetGain | The wet gain. Valid values: -20 to 10. |
AliRtcAudioEffectEqualizationBandFrequency
Parameter | Description |
AliRtcAudioEffectEqualizationBand31 | 31 Hz |
AliRtcAudioEffectEqualizationBand62 | 62 Hz |
AliRtcAudioEffectEqualizationBand125 | 125 Hz |
AliRtcAudioEffectEqualizationBand250 | 250 Hz |
AliRtcAudioEffectEqualizationBand500 | 500 Hz |
AliRtcAudioEffectEqualizationBand1K | 1 kHz |
AliRtcAudioEffectEqualizationBand2K | 2 kHz |
AliRtcAudioEffectEqualizationBand4K | 4 kHz |
AliRtcAudioEffectEqualizationBand8K | 8 kHz |
AliRtcAudioEffectEqualizationBand16K | 16 kHz |
AliRtcLiveTranscodingState
Parameter | Description |
AliEngineLiveTranscodingState_IDLE | No stream is being ingested. |
AliEngineLiveTranscodingState_CONNNECT | The server for relayed live streaming is being connected. |
AliEngineLiveTranscodingState_RUNNING | The stream ingest is in progress. |
AliEngineLiveTranscodingState_RECOVERING | The stream ingest is being resumed. |
AliEngineLiveTranscodingState_FAILURE | The stream ingest fails. |
AliEngineLiveTranscodingState_END | The stream ingest is complete. |
AliRtcLiveTranscodingStreamType
Parameter | Description |
AliEngineLiveTranscodingOrigin | Relays the original stream. |
AliEngineLiveTranscodingAudio | Relays only the audio track. |
AliEngineLiveTranscodingVideo | Relays only the video track. |
AliRtcLiveTranscodingMixMode
Parameter | Description |
AliEngineLiveTranscodingSINGLE | The single-stream relay mode. In this mode, mixed-stream transcoding is not required. |
AliEngineLiveTranscodingMIX | The mixed-stream transcoding mode. |
AliRtcLiveTranscodingSourceType
Parameter | Description |
AliEngineLiveTranscodingCamera | Camera. |
AliEngineLiveTranscodingShareScreen | Screen sharing. |
AliRtcLiveTranscodingTaskProfile
Parameter | Description |
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 | Audio-only |
AliRtcLiveTranscodingAudioSampleRate
Parameter | Description |
AliEngineLiveTranscoding_HZ_48000 | 48,000 Hz. |
AliEngineLiveTranscoding_HZ_44100 | 44,100 Hz. |
AliEngineLiveTranscoding_HZ_32000 | 32,000 Hz. |
AliEngineLiveTranscoding_HZ_16000 | 16,000 Hz. |
AliEngineLiveTranscoding_HZ_8000 | 8,000 Hz. |
AliRtcLiveTranscodingVideoCodec
Parameter | Description |
AliEngineLiveTranscodingVideoCodec_H264 | H.264 |
AliEngineLiveTranscodingVideoCodec_H265 | H.265 |
AliRtcVideoSource
Parameter | Description |
AliEngineVideoSourceCamera | Camera. |
AliEngineVideoSourceScreenShare | Screen sharing. |
AliRtcVideoFormat
Parameter | Description |
AliEngineVideoFormatUnknow | Unknown. |
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 |
AliEngineVideoFormatH264 | H.264 |
AliEngineVideoFormatFile | File |
AliRtcVideoObserAlignment
Parameter | Description |
AliEngineAlignmentDefault | The width of the original video is retained. This is the default value. |
AliEngineAlignmentEven | The width is aligned and is an even number. |
AliEngineAlignment4 | The width is aligned and is a multiple of four. |
AliEngineAlignment8 | The width is aligned and is a multiple of eight. |
AliEngineAlignment16 | The width is aligned and is a multiple of 16. |
AliRtcBufferType
Parameter | Description |
AliEngineBufferTypeRawData | Raw data in the YUV format. |
AliEngineBufferTypeTexture | Texture data. |
AliEngineBufferTypeFile | File path. |
AliRtcVideoObserPosition
Parameter | Description |
AliEnginePositionPostCapture | The video data that is collected. The data is returned in the onCaptureVideoSample callback. |
AliEnginePositionPreRender | The video data before rendering. The data is returned in the onCaptureVideoSample callback. |
AliEnginePositionPreEncoder | The video data before encoding. The data is returned in the onCaptureVideoSample callback. |
AliRtcUserOfflineReason
Parameter | Description |
AliEngineUserOfflineQuit | The user proactively leaves the channel. |
AliEngineUserOfflineDropped | The connection times out because no packet is received from the user for an excessively long period. |
AliEngineUserOfflineBecomeAudience | The user switches from the streamer role to the viewer role. |
AliRtcOnByeType
Parameter | Description |
AliEngineOnByeBeKickOut | The user is kicked out of the channel. |
AliEngineOnByeChannelTerminated | The channel is closed. |
AliEngineOnByeUserReplaced | The user ID is used in another device to join the channel, and the current device is disconnected. |
AliRtcAudioAccompanyStateCode
Parameter | Description |
AliEngineAudioAccompanyStarted | The playback starts. |
AliEngineAudioAccompanyStopped | The playback stops. |
AliEngineAudioAccompanyPaused | The playback is paused. |
AliEngineAudioAccompanyResumed | The playback is resumed. |
AliEngineAudioAccompanyEnded | The playback ends. |
AliEngineAudioAccompanyBuffering | The system is buffering data. |
AliEngineAudioAccompanyBufferingEnd | The buffering is complete. |
AliEngineAudioAccompanyFailed | The playback fails. |
AliRtcAudioAccompanyErrorCode
Parameter | Description |
AliEngineAudioAccompanyNoError | No errors. |
AliEngineAudioAccompanyOpenFailed | The file fails to be opened. |
AliEngineAudioAccompanyDecodeFailed | The file fails to be decoded. |
AliRtcConnectionStatus
Parameter | Description |
AliEngineConnectionInit | The initialization is complete. |
AliEngineConnectionDisconnected | The network is disconnected. |
AliEngineConnectionConnecting | The network connection is being established. |
AliEngineConnectionConnected | The network connection is established. |
AliEngineConnectionReconnecting | The network connection is being re-established. |
AliEngineConnectionFailed | The network connection fails. |
AliRtcConnectionStatusChangeReason
Parameter | Description |
AliEngineConnectionChangedDummyReason | The network connection status changes due to unknown reasons. |
AliEngineConnectionMediaPathChanged | The network connection status changes because the media channel is changed. |
AliEngineConnectionSignalingHeartbeatTimeout | The network connection status changes because the heartbeat times out. |
AliEngineConnectionSignalingHeartbeatAlive | The network connection status changes because the heartbeat is resumed. |
AliEngineConnectionSignalingHttpdnsResolved | The network connection status changes because the Domain Name System (DNS) resolution is successful. |
AliEngineConnectionSignalingHttpdnsFailure | The network connection status changes because the DNS resolution fails. |
AliEngineConnectionSignalingGslbFailure | The network connection status changes because the global server loading balancing (GSLB) feature fails to respond to the DNS request. |
AliEngineConnectionSignalingGslbSucccess | The network connection status changes because the GSLB feature returns a response to the DNS request. |
AliEngineConnectionSignalingJoinChannelFailure | The network connection status changes because the request to join the channel fails. |
AliEngineConnectionSignalingJoinChannelSuccess | The network connection status changes because the request to join the channel is successful. |
AliEngineConnectionSignalingLeaveChannel | The network connection status changes because the user leaves the channel. |
AliEngineConnectionSignalingConnecting | The network connection status changes because the signaling connection is established. |
AliRtcConnectionChangedNetworkInterrupted | The network connection status changes due to network disconnection. |
AliRtcExternalDeviceType
Parameter | Description |
AliEngineExternalTypeUnknown | Unknown type. |
AliEngineExternalTypeAudioCapture | Audio collection device. |
AliEngineExternalTypeAudioPlayout | Audio playback device. |
AliEngineExternalTypeVideoCapture | Video collection device. |
AliRtcExternalDeviceState
Parameter | Description |
AliEngineExternalDeviceAdd | The peripheral device is added. |
AliEngineExternalDeviceRemove | The peripheral device is removed. |
AliRtcAudioRouteType
Parameter | Description |
AliEngineAudioRouteTypeDefault | The default audio route. |
AliEngineAudioRouteTypeHeadset | An earphone. |
AliEngineAudioRouteTypeEarpiece | A headset. |
AliEngineAudioRouteTypeHeadsetNoMic | An earphone without a microphone. |
AliEngineAudioRouteTypeSpeakerphone | The speaker on the mobile phone. |
AliEngineAudioRouteTypeLoudSpeaker | An external speaker. |
AliEngineAudioRouteTypeBlueTooth | A Bluetooth earphone. |
AliEngineAudioRouteTypeUSB | A USB-connected earphone. |
AliRtcAudioFocusType
Parameter | Description |
AliEngineAudioFocusNone | The audio focus is not obtained, is lost, or is not requested. |
AliEngineAudioFocusGain | The audio focus is obtained or requested, which has an unknown duration. |
AliEngineAudioFocusGainTransient | The audio focus is temporarily obtained or requested, which is expected to have a short duration. |
AliEngineAudioFocusGainTransientMayDuck | The audio focus is temporarily requested, which is expected to have a short duration. In this state, it is acceptable that another application is playing audio at a reduced volume, which is called "evasion". |
AliEngineAudioFocusGainTransientExclusive | The audio focus is temporarily requested, which is expected to have a short duration. In this state, no other application or system component is allowed to be playing any content. |
AliEngineAudioFocusLoss | The audio focus is lost, which has an unknown duration. |
AliEngineAudioFocusLossTransient | The audio focus is temporarily lost. |
AliEngineAudioFocusLossCanDuck | The audio focus is temporarily lost. In this state, the one who loses the audio focus can continue to play at a reduced volume (which is called "evasion"), because the silence of others is not required for the new owner of the audio focus. |
AliRtcPublishState
Parameter | Description |
AliEngineStatsPublishIdle | The initial state. |
AliEngineStatsNoPublish | No stream is ingested. |
AliEngineStatsPublishing | A stream is being ingested. |
AliEngineStatsPublished | The stream ingest is complete. |
AliRtcSubscribeState
Parameter | Description |
AliEngineStatsSubscribeIdle | The initial state. |
AliEngineStatsNoSubscribe | No stream is subscribed to. |
AliEngineStatsSubscribing | A stream is being subscribed to. |
AliEngineStatsSubscribed | The subscription is complete. |
AliRtcLiveTranscodingErrorCode
Parameter | Description |
AliEngineLiveTranscodingErrorPublishOk | Relayed live streaming is ready. |
AliEngineLiveTranscodingErrorStreamNotFound | The ingest URL for relayed live streaming is not found. |
AliEngineLiveTranscodingErrorStreamAlreadyExist | The stream ingest task already exists. |
AliEngineLiveTranscodingErrorInvalidParam | The stream ingest parameters are invalid. |
AliEngineLiveTranscodingErrorInternalError | An internal error occurs during stream ingest. |
AliEngineLiveTranscodingErrorRtmpServerError | A server error occurs during stream ingest. |
AliEngineLiveTranscodingErrorRtmpStreamUrlError | The RtmpStreamUrl parameter specified for stream ingest is invalid. |
AliEngineLiveTranscodingErrorPublishTimeout | Stream ingest times out. |
AliEngineLiveTranscodingErrorNotAuthorized | Stream ingest is not authenticated. |
AliRtcTranscodingPublishTaskStatus
Parameter | Description |
AliEngineTrascodingPublishTaskStatusStart | The task is started. |
AliEngineTrascodingPublishTaskStatusUpdate | The task is updated. |
AliEngineTrascodingPublishTaskStatusStop | The task is stopped. |
AliRtcAudioProfile
Parameter | Description |
AliEngineLowQualityMode | Low audio quality mode: By default, the sampling rate is 8,000 Hz, a mono channel is supported, and the maximum bitrate is 12 Kbit/s. |
AliEngineBasicQualityMode | Standard audio quality mode: By default, the sampling rate is 16,000 Hz, a mono channel is supported, and the maximum bitrate is 24 Kbit/s. |
AliEngineHighQualityMode | High audio quality mode: By default, the sampling rate is 48,000 Hz, a mono channel is supported, and the maximum bitrate is 48 Kbit/s. |
AliEngineStereoHighQualityMode | High-quality stereo mode: By default, the sampling rate is 48,000 Hz, binaural channels are supported, and the maximum bitrate is 64 Kbit/s. |
AliEngineSuperHighQualityMode | Ultra-high audio quality mode: By default, the sampling rate is 48,000 Hz, a mono channel is supported, and the maximum bitrate is 96 Kbit/s. |
AliEngineStereoSuperHighQualityMode | Ultra-high-quality stereo mode: By default, the sampling rate is 48,000 Hz, binaural channels are supported, and the maximum bitrate is 128 Kbit/s. |
AliRtcAudioScenario
Parameter | Description |
AliEngineSceneDefaultMode | The default mode. We recommend that you select this mode if you have no special requirements. |
AliEngineSceneEducationMode | The education-related mode. The smoothness and stability of audio playback are prioritized in this mode. |
AliEngineSeneMediaMode | The media-related mode. The fidelity of the human voice and music is ensured in this mode. We recommend that you select this mode for co-streaming. |
AliEngineSceneMusicMode | The music-related mode. High fidelity is ensured for music in this mode. We recommend that you select this mode in scenarios that require high sound quality, such as instrument teaching. |
AliEngineSceneChatroomMode | The chatroom mode. This mode is suitable for scenarios in which users frequently turn on or off the mic to interact with each other. |
AliRtcChannelRelayEvent
Parameter | Description |
AliEngineChannelRelayEventStart | Stream relay across channels starts. |
AliEngineChannelRelayEventUpdate | Stream relay across channels is updated. |
AliEngineChannelRelayEventStop | Stream relay across channels stops. |
AliRtcChannelRelayState
Parameter | Description |
AliEngineChannelRelayStateInit | Stream relay across channels is initializing. |
AliEngineChannelRelayStateConnecting | Stream relay across channels is connecting. |
AliEngineChannelRelayStateRunning | Stream relay across channels is running. |
AliEngineChannelRelayStateFailure | Stream relay across channels fails. |
AliRtcChannelRelayErrorCode
Parameter | Description |
AliEngineChannelRelayErrorStateError | The local status is invalid because the user has not joined the channel, the user role is invalid, or the channel mode is invalid. |
AliEngineChannelRelayErrorSrcNotAllow | The server returns a 436 error because the source channel mode does not match. |
AliEngineChannelRelayErrorJoinDestFailed | The server returns a 437 error because the destination channel does not exist or match. |
AliEngineChannelRelayErrorTokenInvalid | The server returns a 438 error because the token is invalid. |
AliEngineChannelRelayErrorRoleError | The server returns a 651 error because the role is not streamer. |
AliEngineChannelRelayErrorInvalidParam | The server returns a 400 error because one or more parameters are invalid. |
AliEngineChannelRelayErrorToSelf | The server returns a 440 error because the stream cannot be relayed to the current channel. |
AliRtcFrameRate
Parameter | Description |
AliEngineFrameRateFps5 | 5 fps |
AliEngineFrameRateFps10 | 10 fps |
AliEngineFrameRateFps15 | 15 fps |
AliEngineFrameRateFps20 | 20 fps |
AliEngineFrameRateFps25 | 25 fps |
AliEngineFrameRateFps30 | 30 fps |
AliEngineFrameRateFps60 | 60 fps |
AliRtcVideoEncoderBitrate
Parameter | Description |
AliEngineVideoStandardBitrate | The standard bitrate for video encoding is used. |
AliRtcVideoEncoderOrientationMode
Parameter | Description |
AliEngineVideoEncoderOrientationModeAdaptive | Adaptive mode: the orientation for stream ingest is the same as that for collection. |
AliEngineVideoEncoderOrientationModeFixedLandscape | The landscape mode. |
AliEngineVideoEncoderOrientationModeFixedPortrait | The portrait mode. |
AliRtcVideoMirrorMode
Parameter | Description |
AliEngineVideoMirrorModeDisabled | Mirroring is disabled. |
AliEngineVideoMirrorModeEnable | Mirroring is enabled. |
AliRtcLocalDeviceType
Parameter | Description |
AliEngineLocalDeviceTypeUnknown | Unknown. |
AliEngineLocalDeviceTypeMic | Microphone. |
AliEngineLocalDeviceTypeSpeaker | Speaker. |
AliEngineLocalDeviceTypeAudioDevice | Audio device. |
AliEngineLocalDeviceTypeCamera | Camera. |
AliEngineLocalDeviceTypeDisplay | Display device. |
AliEngineLocalDeviceTypeVideoDevice | Video device. |
AliRtcLocalDeviceExceptionType
Parameter | Description |
AliEngineLocalDeviceExceptionTypeUnknown | Unknown exception. |
AliEngineLocalDeviceExceptionTypeMicOpenFail | The microphone fails to be opened. |
AliEngineLocalDeviceExceptionTypeMicInterrupt | The microphone is interrupted. |
AliEngineLocalDeviceExceptionTypeMicAuthFail | The microphone has no permissions. |
AliEngineLocalDeviceExceptionTypeMicNotAvailable | No microphone is available. |
AliEngineLocalDeviceExceptionTypeSpeakerOpenFail | The speaker fails to be opened. |
AliEngineLocalDeviceExceptionTypeSpeakerInterrupt | The speaker is interrupted. |
AliEngineLocalDeviceExceptionTypeSpeakerNotAvailable | No speaker is available. |
AliEngineLocalDeviceExceptionTypeAudioDeviceException | The audio device is abnormal. |
AliEngineLocalDeviceExceptionTypeCameraOpenFail | The camera fails to be opened. |
AliEngineLocalDeviceExceptionTypeCameraInterrupt | The camera is interrupted. |
AliEngineLocalDeviceExceptionTypeCameraAuthFail | The camera has no permissions. |
AliEngineLocalDeviceExceptionTypeDisplayExecption | The display device is abnormal. |
AliEngineLocalDeviceExceptionTypeVideoDeviceException | The video device is abnormal. |
AliRtcLiveTranscodingCropMode
Parameter | Description |
AliEngineLiveTranscodingCrop | Cropping. |
AliEngineLiveTranscodingFill | Padding. |
AliRtcLiveTranscodingMediaProcessMode
Parameter | Description |
AliEngineLiveTranscodingNormal | The general mode. |
AliEngineLiveTranscodingVirtualBackground | The virtual background mode. |
AliRtcLiveTranscodingSegmentType
Parameter | Description |
AliEngineLiveTranscodingNoBody | Portrait segmentation is disabled. |
AliEngineLiveTranscodingBody | Portrait segmentation is enabled. |
AliRtcVideoState
Parameter | Description |
AliEngineVideoClose | The video is closed. |
AliEngineVideoOpen | The video is opened. |
AliRtcVideoReason
Parameter | Description |
AliEngineVideoChangeByClient | The change is caused by the client. |
AliEngineVideoChangeByServer | The change is caused by the server. |
AliRtcVideoEncodedFrameType
Parameter | Description |
AliEngineVideoEncodedFrameNULL | None. This is the default value. |
AliEngineVideoEncodedFrameIDR | Instantaneous Decoder Refresh (IDR) frames. |
AliEngineVideoEncodedFrameLTR | Long-term Reference (LTR) frames. |
AliEngineVideoEncodedFrameB | B-frames. |
AliRtcPluginDataType
Parameter | Description |
AliEnginePluginDataTypeShared | Sharing type. |
AliEnginePluginDataTypeVideo | Video processing type. |
AliEnginePluginDataTypeAudio | Audio processing type. |
AliEnginePluginDataTypeEncryption | Encryption type. |
AliEnginePluginDataTypeMax | The placeholder, which has no meaning. |
AliRtcPluginOperationType
Parameter | Description |
AliEnginePluginShared | Sharing. |
AliEnginePluginPreOperation | Processing before stream ingest. |
AliEnginePluginPostOperation | Processing after stream pulling. |
AliEnginePluginEncodeOperation | Encoder. |
AliEnginePluginDecodeOperation | Decoder. |
AliEnginePluginRecord | Collection. |
AliEnginePluginRender | Rendering. |
AliRtcBokehScaleModel
Parameter | Description |
AliEngineBokehScaleModelCrop | The background is cropped at the original aspect ratio. |
AliEngineBokehScaleModelFill | The background is scaled at the original aspect ratio and black bars are added if required. |
AliRtcVideoDecoderImplType
Parameter | Description |
AliEngineVideoDecoderImplSoftware | Software decoding. |
AliEngineVideoDecoderImplHardware | Hardware decoding. |
AliRtcVideoCodecManufacturer
Parameter | Description |
AliEngineVideoCodecManufactureropenH264 | openH264 |
AliEngineVideoCodecManufacturerX264 | X264 |
AliEngineVideoCodecManufacturerX265 | X265 |
AliEngineVideoCodecManufacturerS265 | S265 |
AliEngineVideoCodecManufacturerFFMPEG | FFMPEG |
AliEngineVideoCodecManufacturerQsvIntel | QsvIntel |
AliEngineVideoCodecManufacturerNvidia | Nvidia |
AliEngineVideoCodecManufacturerAMD | AMD |
AliEngineVideoCodecManufacturerMicrosoft | Microsoft |
AliEngineVideoCodecManufacturerVideoToolbox | VideoToolbox |
AliEngineVideoCodecManufacturerMediaCodec | MediaCodec |
AliEngineVideoCodecManufacturerAVCodec | AVCodec |
AliEngineVideoCodecManufacturerUnknown | Unknown. |
AliRtcDataMsgType
Parameter | Description |
AliEngineDataChannelNone | None. |
AliEngineDataChannelProgress | Music playback progress. |
AliEngineDataChannelCustom | Custom. |
AliRtcNetworkQuality
Parameter | Description |
AliEngineNetworkQualityExcellent | The network quality is excellent. The audio and video are smooth and clear. |
AliEngineNetworkQualityGood | The network quality is good. The audio and video are as smooth and clear as those of the excellent quality. |
AliEngineNetworkQualityPoor | The network condition is slightly poor. The smoothness and clarity of the audio and video are defective, but communication is not affected. |
AliEngineNetworkQualityBad | The network condition is poor. Stuttering is severe in the video, but communication through audio is not affected. |
AliEngineNetworkQualityVeryBad | The network quality is unacceptable, and the communication among users is severely affected. |
AliEngineNetworkQualityDisconnect | The network is interrupted. |
AliEngineNetworkQualityUnknow | Unknown. |
AliEngineAudioTrack
Parameter | Description |
AliEngineAudioTrackNo | No microphone. |
AliEngineAudioTrackMic | Microphone. |
AliEngineAudioTrackDual | Secondary. |
AliEngineAudioTrackBoth | Microphone and secondary. |
AliEngineAudioTrackEnd | The placeholder. |
AliRtcDeviceTransportType
Parameter | Description |
AliEngineDeviceTransportTypeUnknown | Unknown. |
AliEngineDeviceTransportTypeBuiltIn | Built-in |
AliEngineDeviceTransportTypeBluetooth | Bluetooth |
AliEngineDeviceTransportTypeUSB | USB |
AliEngineDeviceTransportTypeAggregate | Aggregated |
AliEngineDeviceTransportTypeVirtual | Virtual |
AliEngineDeviceTransportTypePCI | PCI |
AliEngineDeviceTransportTypeFireWire | FireWire |
AliEngineDeviceTransportTypeBluetoothLE | BluetoothLE |
AliEngineDeviceTransportTypeHDMI | HDMI |
AliEngineDeviceTransportTypeDisplayPort | DisplayPort |
AliEngineDeviceTransportTypeAirPlay | AirPlay |
AliEngineDeviceTransportTypeAVB | AVB |
AliEngineDeviceTransportTypeThunderbolt | Thunderbolt |
AliRtcAudioSource
Parameter | Description |
AliEngineAudioSourceCaptured | Collected audio data. |
AliEngineAudioSourceProcessCaptured | Audio data after 3A processing. |
AliEngineAudioSourcePub | Ingested audio data. |
AliEngineAudioSourcePlayback | Played audio data. |
AliEngineAudioSourceMixedAll | Audio data that is mixed from ingested audio and played audio. |
AliEngineAudioSourceRemoteUser | Remote audio data that is pulled. |
AliRtcAudioSampleRate
Parameter | Description |
AliEngineAudioSampleRate_8000 | 8,000 Hz. |
AliEngineAudioSampleRate_11025 | 11,025 Hz. |
AliEngineAudioSampleRate_16000 | 16,000 Hz. |
AliEngineAudioSampleRate_22050 | 22,050 Hz. |
AliEngineAudioSampleRate_32000 | 32,000 Hz. |
AliEngineAudioSampleRate_44100 | 44,100 Hz. |
AliEngineAudioSampleRate_48000 | 48,000 Hz. |
AliRtcAudioNumChannel
Parameter | Description |
AliEngineMonoAudio | Mono. |
AliEngineStereoAudio | Binaural. |
AliRtcAudioFrameObserverOperationMode
Parameter | Description |
AliEngineAudioFrameObserverOperationModeReadOnly | Read-only mode. |
AliEngineAudioFrameObserverOperationModeWriteOnly | Write-only mode. |
AliEngineAudioFrameObserverOperationModeReadWrite | Read/write mode. |
AliRtcVideoCodecKindType
Parameter | Description |
AliEngineVideoEncoderType | Encoder. |
AliEngineVideoDecoderType | Decoder. |
AliRtcLiveTranscodingFontType
Parameter | 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. |
AliRtcAudioFrameObserverUserDefinedInfoBitMask
Parameter | Description |
AliEngineAudioFrameObserverUserDefinedInfoBitMaskMixExCapture | The onMixedAllAudioFrame callback is invoked if the audio is mixed from an externally ingested stream. |
AliEngineAudioFrameObserverUserDefinedInfoBitMaskMixExRender | The onMixedAllAudioFrame callback is invoked if the audio is mixed from an externally rendered stream. |
AliRtcLiveTranscodingImage_DisplayType
Parameter | Description |
NOT_DISPLAY | The image is not displayed. |
ALWAYS | The image is always displayed. |
WHEN_NO_VIDEO | The image is displayed when there is no video. |