This topic describes the data structures of the ApsaraVideo Real-time Communication software development kit (SDK) for Windows.
Contents
Data type | Description |
The volume information of the user. | |
The audio sample. | |
The video sample. | |
The channel mode. | |
The user role. | |
The statistics of the session. | |
The statistics of the local video. | |
The statistics of the remote video. | |
The statistics of the local audio. | |
The statistics of the remote audio. | |
The output position of the video data. | |
The format of the video data. | |
The type of the peripheral device. | |
The status of the peripheral device. | |
The status of the network connection. | |
The reason why the network connection status changes. | |
The type of the video stream. | |
The stream ingest status. | |
The subscription status. | |
The reason why the user is disconnected from the channel. | |
The type of the camera stream. | |
The type of the audio stream. | |
The network quality. | |
The orientation mode. | |
The rendering mode. | |
The mirror mode. | |
The rotation angle. | |
The log level. | |
The number of sound channels. | |
The audio sampling rate for recording. | |
The recording type. | |
The recording format. | |
The audio quality of the recorded audio file. | |
The video quality of the recorded video file. | |
The audio quality mode. | |
The audio scenario mode parameters. | |
The local mute mode. | |
The audio recording settings. | |
The video recording settings. | |
The canvas size for video recording. | |
The layout information for video recording. | |
The background color for video recording. | |
The user pane configuration for the recording layout. | |
The position of the user pane. | |
The coordinates for stream mixing and recording. | |
The recording template. | |
The device information. | |
The basic retouching settings. | |
The enumeration of OnBye types. | |
The voice changer mode. | |
The reverberation mode. | |
The reverberation parameters. | |
The rendering canvas. | |
The error code for bypass live streaming. | |
The watermark image settings. | |
The preferred properties for camera capture. | |
The camera capture preferences. | |
The video encoding frame rate. | |
The video encoding bitrate. | |
The mirror mode for encoded video. | |
The video encoding preferences. | |
The video decoding property settings. | |
The video codec type. | |
The screen sharing encoding preferences. | |
The screen sharing configuration. | |
The screen sharing region. | |
The screen sharing source information. | |
The screen sharing configuration information. | |
The screen sharing type. | |
The authentication information. | |
The raw video data source type. | |
The raw audio data source type. | |
The video data type. | |
The error code. | |
The width alignment of the output video. | |
The type of the displayed dashboard. | |
The status of the bypass live stream. | |
The display type of the image in bypass live streaming. | |
The font type for bypass live streaming. | |
The segmentation type for bypass live streaming. | |
The input type for bypass live streaming. | |
The change in the video stream state. | |
The reason that triggers the change in the video stream state. | |
The cropping mode for bypass live streaming. | |
The media processing mode for bypass live streaming. | |
The stream type for bypass live streaming. | |
The mode for bypass live streaming. | |
The status of bypass live streaming. | |
The text information for bypass live streaming. | |
The image information for bypass live streaming. | |
The custom pane information for a user in bypass live streaming. | |
The configuration for bypass live streaming. | |
The stream mixing parameters for bypass mode. | |
The single-stream parameters for bypass mode. | |
The billing specifications for bypass live streaming. | |
The encoding parameters for bypass live streaming. | |
The audio sampling rate for bypass live streaming. | |
The clock widget for bypass live streaming. | |
The scaling mode for background replacement. | |
The playback state of the music accompaniment. | |
The playback error code of the music accompaniment. | |
The list of screen sharing sources. | |
The function interface type. | |
The video codec type. | |
The device connection type. | |
The audio frame callback configuration. | |
The video device list. | |
The list of video capture device resolutions. | |
The video recording data source. | |
The audio data callback mode. | |
The video resolution. | |
The video resolution aspect ratio. | |
The watermark coordinate system. | |
The video resolution. | |
The video encoding format. | |
The user properties, such as the nickname and type. | |
The user properties. Special configuration is required for AI agent call scenarios. Use the default value for non-AI agent call scenarios. | |
The audio accompaniment playback configuration. | |
The video mirror mode. | |
The video scaling timing. | |
The data channel message. | |
The data channel message type. | |
The audio file information. | |
The local audio capture state. | |
The local video capture state. |
API details
AliEngineUserVolumeInfo
The user's volume information.
Parameter | Type | Description |
uid | String | The UID of the current user. Valid values:
|
volume | int | The volume in the current callback. |
speech_state | bool |
|
sumVolume | int | The accumulated volume within the callback period. This parameter is used to identify the current speaker. Valid values: 0 to 255. |
AliEngineAudioRawData
The audio sample.
Parameter | Type | Description |
dataPtr | void* | The audio data. |
numOfSamples | int | The number of sample points in a single sound channel. |
bytesPerSample | int | The number of bytes per sample point. |
numOfChannels | int | The number of sound channels. |
samplesPerSec | int | The number of sample points per second. |
AliEngineVideoRawData
The video sample.
Parameter | Type | Description |
format | The video data type. | |
type | The video data type. | |
dataLength | int | The data size. |
pixelBuffer | void* | The pixel buffer data. |
dataPtr | void* | The pointer to the YUV data. |
dataYPtr | void* | The pointer to the Y component. |
dataUPtr | void* | The pointer to the U component. |
dataVPtr | void* | The pointer to the V component. |
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. |
height | int | The height of the video frame. |
width | int | The width of the video frame. |
rotation | int | The rotation angle of the video frame. |
timeStamp | long long | The timestamp. |
AliEngineChannelProfile
The channel mode.
Enumeration Name | Description |
AliEngineCommunication | The communication mode. |
AliEngineInteractiveLive | The interactive mode. |
AliEngineClientRole
The user role.
Enumeration | Description |
AliEngineClientRoleInteractive | The streamer role. |
AliEngineClientRoleLive | The viewer role. |
AliEngineStats
The session statistics.
Parameter | Type | Description |
sentKBitrate | long long | The sending bitrate. |
rcvdKBitrate | long long | The receiving bitrate. |
sentBytes | long long | The number of bytes sent. |
rcvdBytes | long long | The number of bytes received. |
systemCpu | unsigned int | The CPU usage of the system. |
appCpu | unsigned int | The CPU usage of the RTC process. |
videoRcvdKBitrate | long long | The video receiving bitrate. |
videoSentKBitrate | long long | The video sending bitrate. |
callDuration | unsigned long long | The call duration in seconds. |
sentLossRate | long long | The packet loss rate from the client to the server. |
sentLossPkts | long long | The number of lost packets from the client to the server. |
sentExpectedPkts | long long | The total number of packets sent from the client to the server. |
rcvdLossRate | long long | The downstream packet loss rate from the client to the server. |
rcvdLossPkts | long long | The number of downstream lost packets from the client to the server. |
rcvdExpectedPkts | long long | The total number of downstream packets from the client to the server. |
lastmileDelay | long long | The latency in milliseconds. |
availableSendBitrate | long long | The available sending bitrate. |
AliEngineLocalVideoStats
The local video statistics.
Parameter | Type | Description |
track | The stream type. | |
sentBitrate | unsigned int | The publishing bitrate. |
sentFps | unsigned int | The publishing frame rate. |
encodeFps | unsigned int | The encoding frame rate. |
targetEncodeBitrate | unsigned int | The target encoding bitrate. |
actualEncodeBitrate | unsigned int | The actual encoding bitrate. |
captureFps | unsigned int | The capture frame rate. |
avgQpPerSec | unsigned int | The average QP for encoding. |
AliEngineRemoteVideoStats
The remote video statistics.
Parameter | Type | Description |
userId | const char* | The ID of the remote user. |
track | The type of the video stream. | |
width | unsigned int | The width of the video frame. |
height | unsigned int | The height of the video frame. |
decodeFps | unsigned int | The output frame rate of the encoder. |
renderFps | unsigned int | The output frame rate of the renderer. |
frozenTimes | unsigned int | The number of stutters. |
AliEngineLocalAudioStats
The local audio statistics.
Parameter | Type | Description |
track | The type of the audio stream. | |
scene | The audio scenario. | |
sentBitrate | unsigned int | The sending bitrate. |
sentSamplerate | unsigned int | The sending sample rate. |
numChannel | unsigned int | The number of sound channels. |
inputLevel | unsigned int | The input level. |
AliEngineRemoteAudioStats
The remote audio statistics.
Parameter | Type | Description |
userId | const char* | The user ID. |
track | The type of the audio stream. | |
networkTransportDelay | int | The network latency from the audio sender to the receiver in milliseconds. |
quality | int | The audio quality. |
audioLossRate | int | The audio packet loss rate. |
rcvdBitrate | int | The receiving bitrate. |
totalFrozenTimes | int | The number of stutters. |
audioTotalFrozenTime | int | The total duration of audio playback stutter in milliseconds. |
audioTotalFrozenRate | int | The audio playback stutter rate in percentage. |
AliEngineVideoObserPosition
The video data output position.
Enumeration Name | Description |
AliEnginePositionPostCapture | You can collect data. |
AliEnginePositionPreRender | The stream pulling data. |
AliEnginePositionPreEncoder | The data before encoding. |
AliEngineVideoFormat
The video data output format.
Enumeration Name | Description |
AliEngineVideoFormatBGRA | BGRA. |
AliEngineVideoFormatUnknow | Unknown. |
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. |
AliEngineExternalDeviceType
The peripheral device type.
Enumeration Name | Description |
AliEngineExternalTypeUnknown | Unknown type. |
AliEngineExternalTypeAudioCapture | Audio capture device. |
AliEngineExternalTypeAudioPlayout | Audio playback device. |
AliEngineExternalTypeVideoCapture | Video capture device. |
AliEngineExternalDeviceState
The peripheral device status.
Enumeration Name | Description |
AliEngineExternalDeviceAdd | A peripheral device is added. |
AliEngineExternalDeviceRemove | A peripheral device is removed. |
AliEngineConnectionStatus
The network connection status.
Enumeration name | Description |
AliEngineConnectionInit | The initialization is complete. |
AliEngineConnectionDisconnected | The network is disconnected. |
AliEngineConnectionConnecting | A network connection is being established. |
AliEngineConnectionConnected | The network is connected. |
AliEngineConnectionReconnecting | A network connection is being re-established. |
AliEngineConnectionFailed | The network connection failed. |
AliEngineConnectionStatusChangeReason
The reason for a change in the network connection status.
Enumeration | Description |
AliEngineConnectionChangedDummyReason | Unknown reason. |
AliEngineConnectionMediaPathChanged | The media channel changed. |
AliEngineConnectionSignalingHeartbeatTimeout | The heartbeat timed out. |
AliEngineConnectionSignalingHeartbeatAlive | The heartbeat recovered. |
AliEngineConnectionSignalingHttpdnsResolved | DNS resolution succeeded. |
AliEngineConnectionSignalingHttpdnsFailure | DNS resolution failed. |
AliEngineConnectionSignalingGslbFailure | The GSLB request failed. |
AliEngineConnectionSignalingGslbSucccess | The GSLB request succeeded. |
AliEngineConnectionSignalingJoinChannelFailure | Failed to join the channel. |
AliEngineConnectionSignalingJoinChannelSuccess | Joined the channel. |
AliEngineConnectionSignalingLeaveChannel | Left the channel. |
AliEngineConnectionSignalingConnecting | A signaling connection is being established. |
AliRtcConnectionChangedNetworkInterrupted | The network connection is interrupted. |
AliEngineVideoTrack
The video stream type.
Enumeration Name | Description |
AliEngineVideoTrackNo | No video stream. |
AliEngineVideoTrackCamera | The camera stream. |
AliEngineVideoTrackScreen | The screen sharing stream. |
AliEngineVideoTrackBoth | Both the camera and screen sharing streams. |
AliEnginePublishState
The stream ingest status.
Enumeration name | Description |
AliEngineStatsPublishIdle | The initial state. |
AliEngineStatsNoPublish | No stream is ingested. |
AliEngineStatsPublishing | A stream is being ingested. |
AliEngineStatsPublished | The stream ingest is complete. |
AliEngineSubscribeState
The subscription status.
Enumeration Name | Description |
AliEngineStatsSubscribeIdle | The initial state. |
AliEngineStatsNoSubscribe | No stream is subscribed to. |
AliEngineStatsSubscribing | A stream is being subscribed to. |
AliEngineStatsSubscribed | The subscription is complete. |
AliEngineUserOfflineReason
The reason why a user is disconnected from the channel.
Enumeration Name | Description |
AliEngineUserOfflineQuit | The user proactively leaves the channel. |
AliEngineUserOfflineDropped | The connection times out because no data packet is received from the user for an extended period. |
AliEngineUserOfflineBecomeAudience | The user switches from the streamer role to the viewer role. |
AliEngineVideoStreamType
The camera stream type.
Enumeration name | Description |
AliEngineVideoStreamTypeNone | No video stream. |
AliEngineVideoStreamTypeHigh | The high-quality stream. |
AliEngineVideoStreamTypeLow | Small Stream |
AliEngineAudioTrack
The audio stream type.
Enumeration Name | Description |
AliEngineAudioTrackNo | No audio stream. |
AliEngineAudioTrackMic | The microphone stream. |
AliEngineNetworkQuality
The network quality.
Enumeration Name | Description |
AliEngineNetworkQualityExcellent | The network is excellent. The audio and video are smooth and clear. |
AliEngineNetworkQualityGood | The network is good. The audio and video are almost as smooth and clear as when the network is excellent. |
AliEngineNetworkQualityPoor | The network is poor. The smoothness and clarity of the audio and video are slightly affected, but communication is not impacted. |
AliEngineNetworkQualityBad | The network is bad. The video experiences severe stuttering, but audio communication is normal. |
AliEngineNetworkQualityVeryBad | The network is very bad. Communication is almost impossible. |
AliEngineNetworkQualityDisconnect | The network is disconnected. |
AliEngineNetworkQualityUnknow | Unknown reason. |
AliEngineVideoEncoderOrientationMode
The video output orientation.
Enumeration Name | Description |
AliEngineVideoEncoderOrientationModeAdaptive | 0: Adaptive. The stream ingest orientation is the same as the capture orientation. |
AliEngineVideoEncoderOrientationModeFixedLandscape | 1: Portrait mode. In this mode, the SDK ingests a portrait stream. The smaller value of the specified width and height is always used as the width of the output video, and the larger value is used as the height. |
AliEngineVideoEncoderOrientationModeFixedPortrait | 2: Landscape mode. In this mode, the SDK ingests a landscape stream. The larger value of the specified width and height is always used as the width of the output video, and the smaller value is used as the height. |
AliEngineRenderMode
The rendering mode.
Enumeration Name | Description |
AliEngineRenderModeAuto | Automatic. |
AliEngineRenderModeStretch | Stretches the video to fill the view without maintaining the aspect ratio. |
AliEngineRenderModeFill | Scales the video while maintaining the aspect ratio and fills with black bars. |
AliEngineRenderModeCrop | Scales the video while maintaining the aspect ratio and crops it to fit the view. |
AliEngineRenderModeNoChange | Uses the previous display mode. |
AliEngineRenderMirrorMode
The mirror mode.
Enumeration Name | Description |
AliEngineRenderMirrorModeOnlyFrontMirror | Only the preview from the front camera is mirrored. Other views are not mirrored. |
AliEngineRenderMirrorModeAllMirror | All views are mirrored. |
AliEngineRenderMirrorModeAllNoMirror | Mirroring is disabled. |
AliEngineRotationMode
The rotation angle.
Enumeration Name | Description |
AliEngineRotationModeNoChange | Uses the previous rotation angle. |
AliEngineRotationMode_0 | No rotation. |
AliEngineRotationMode_90 | Rotates by 90 degrees. |
AliEngineRotationMode_180 | Rotates by 180 degrees. |
AliEngineRotationMode_270 | Rotates by 270 degrees. |
AliEngineLogLevel
The log level.
Enumeration Name | Description |
AliEngineLogLevelInfo | Normal. |
AliEngineLogLevelWarn | Warning. |
AliEngineLogLevelError | Error. |
AliEngineLogLevelFatal | Critical. |
AliEngineLogLevelNone | None. |
AliEngineAudioNumChannelType
The audio channel type.
Enumeration name | Description |
AliEngineMonoAudio | Mono. |
AliEngineStereoAudio | Stereo. |
AliEngineAudioSampleRate
The audio sample rate type.
Enumeration Name | Description |
AliEngineAudioSampleRate_8000 | Sample rate of 8000. |
AliEngineAudioSampleRate_11025 | Sample rate of 11025. |
AliEngineAudioSampleRate_16000 | Sample rate of 16000. |
AliEngineAudioSampleRate_22050 | Sample rate of 22050. |
AliEngineAudioSampleRate_32000 | Sample rate of 32000. |
AliEngineAudioSampleRate_44100 | Sample rate of 44100. |
AliEngineAudioSampleRate_48000 | Sample rate of 48000. |
AliEngineRecordType
The recording type.
Enumeration name | Description |
AliEngineRecordTypeAudio | Audio-only recording. |
AliEngineRecordTypeVideo | Records a single audio and video file. |
AliEngineRecordTypeBoth | Records both audio-only and audio and video files. |
AliEngineRecordFormat
The recording format.
Enumeration name | Description |
AliEngineRecordFormatAAC | AAC file. |
AliEngineRecordFormatWAV | WAV file. |
AliEngineRecordFormatMP4 | MP4 file. |
AliEngineAudioQuality
The audio quality of the recorded audio file.
Enumeration name | Description |
AliEngineAudioQualityLow | Low. |
AliEngineAudioQualityMidium | Medium. |
AliEngineAudioQualityHigh | High. |
AliEngineVideoQuality
The video quality of the recorded video file.
Enumeration Name | Description |
AliEngineVideoQualityDefault | The default quality, which is the same as the video capture quality. Video recording is not available on mobile devices. |
AliEngineAudioProfile
The audio quality mode.
Enumeration name | Description |
AliEngineLowQualityMode | Low audio quality mode. |
AliEngineBasicQualityMode | Standard audio quality mode. |
AliEngineHighQualityMode | High audio quality mode. |
AliEngineStereoHighQualityMode | High-quality stereo mode. |
AliEngineSuperHighQualityMode | Ultra-high audio quality mode. |
AliEngineStereoSuperHighQualityMode | Ultra-high-quality stereo mode. |
AliEngineAudioScenario
The audio scenario mode.
Enumeration name | Description |
AliEngineSceneDefaultMode | The default scenario. We recommend that you use this mode for general audio and video communication scenarios. |
AliEngineSceneEducationMode | The education scenario. This mode prioritizes audio continuity and stability. |
AliEngineSeneMediaMode | The media scenario. This mode ensures the quality of human voices and music. We recommend that you use this mode for co-streaming in live channels. |
AliEngineSceneMusicMode | The music scenario. This mode provides high-fidelity music quality. We recommend that you use this mode for scenarios that require high music quality, such as instrument teaching. |
AliEngineSceneChatRoomMode | The chat scenario. This mode is suitable for chat scenarios where users frequently turn their microphones on and off. The volume bar always indicates the voice call volume. |
AliEngineSceneShowRoomMode | The showroom scenario. This mode is suitable for single-streamer scenarios that require high audio quality. |
AliEngineMuteLocalAudioMode
The local mute mode.
Enumeration Name | Description |
AliEngineMuteLocalAudioModeDefault | The default mode. Mutes all audio, including microphone and external audio input. |
AliEngineMuteLocalAudioModeMuteAll | Mutes all audio, including microphone and external audio input. |
AliEngineMuteLocalAudioModeMuteOnlyMic | Mutes only the microphone. |
AliEngineRecordAudioConfig
The parameter settings for audio file recording.
Parameter | Type | Description |
sampleRate | The audio sample rate. | |
quality | The audio quality. | |
externalPcmCaptureRecording | bool | Specifies whether to allow recording of external PCM input rendering data. |
externalPcmRenderRecording | bool | Specifies whether to allow recording of external PCM input rendering data. |
AliEngineRecordVideoConfig
The video recording settings.
Parameter | Type | Description |
quality | The video quality. | |
fps | int | The frame rate. |
bitrate | int | The bitrate. |
sourceType | The video recording data source. | |
canvas | The video recording resolution settings. |
AliEngineVideoRecordCanvasConfig
The video recording resolution.
Parameter | Type | Description |
canvasWidth | int | The width of the recorded video. |
canvasHeight | int | The height of the recorded video. |
AliEngineRecordVideoLayoutMode
The video recording layout.
Enumeration name | Description |
AliEngineRecordVideoLayoutModeGrid | The grid layout. |
AliEngineRecordVideoLayoutModeSpeaker | The speaker layout. |
AliEngineRecordVideoLayoutModeUnique | The single-pane layout. |
AliEngineRecordVideoLayoutModeCustom | The custom layout. |
AliEngineRecordVideoBgColor
The background color for video recording.
Parameter | Type | Description |
r | unsigned char | The red component. |
g | unsigned char | The green component. |
b | unsigned char | The blue component. |
AliEngineRecordVideoRegion
The user layout for video recording.
Parameter | Type | Description |
userId | char* | The user information. |
sourceType | The video source type. | |
area | The recording area. |
AliEngineRecordVideoRectangle
The coordinates for video recording.
Parameter | Type | Description |
left | The left coordinate. | |
top | The top coordinate. | |
width | The width. | |
height | The height. |
AliEngineRecordVideoRational
The coordinate value for video recording.
Parameter | Type | Description |
numerator | unsigned int | The numerator. |
denominator | unsigned int | The denominator. |
AliEngineRecordTemplate
The recording template.
Parameter | Type | Description |
recordType | The recording type. | |
recordFormat | The recording format. | |
sampleRate | The audio sampling rate for recording. | |
audioQuality | The recorded audio quality. | |
externalPcmCaptureRecording | bool | Specifies whether to mix and record external audio input. |
externalPcmRenderRecording | bool | Specifies whether to mix and record rendered external audio input. |
canvas | The canvas size for video recording. | |
fps | int | The frame rate. |
bitrate | int | The bitrate. |
isFragment | bool | Specifies whether to record fragmented MP4 files. Default value: true. |
AliEngineDeviceInfo
The device information.
Parameter | Type | Description |
deviceName | String | The device name. |
deviceID | String | The device ID. |
deviceTransportType | The device transport type. |
AliEngineBeautyConfig
The basic retouching settings.
Parameter | Type | Description |
whiteningLevel | float | The skin whitening level. Valid values: 0 to 1. A larger value indicates a better skin whitening effect. |
smoothnessLevel | float | The skin smoothing level. Valid values: 0 to 1. A larger value indicates a better skin smoothing effect. |
AliEngineOnByeType
The OnBye type enumeration.
Enumeration Name | Description |
AliEngineOnByeBeKickOut | The user is kicked out. |
AliEngineOnByeChannelTerminated | The channel is closed. You must leave the meeting. |
AliEngineOnByeUserReplaced | The same user ID joins the channel on another device, and the current device is forced to go offline. |
AliEngineAudioEffectVoiceChangerMode
The voice changer mode.
Enumeration Name | Description |
AliEngineAudioEffectVoiceChangerOff | Disabled. |
AliEngineAudioEffectVoiceChangerOldMan | Old man. |
AliEngineAudioEffectVoiceChangerBabyBoy | Baby boy. |
AliEngineAudioEffectVoiceChangerBabGirl | Girl. |
AliEngineAudioEffectVoiceChangerRobot | Robot. |
AliEngineAudioEffectVoiceChangerDaimo | Daimo. |
AliEngineAudioEffectVoiceChangerKTV | KTV. |
AliEngineAudioEffectVoiceChangerEcho | Echo. |
AliEngineAudioEffectReverbMode
The reverberation mode.
Enumeration Name | Description |
AliEngineAudioEffectReverbOff | Shut down. |
AliEngineAudioEffectReverbVocal_I | Vocal I. |
AliEngineAudioEffectReverbVocal_II | Vocal II. |
AliEngineAudioEffectReverbBathroom | Bathhouse. |
AliEngineAudioEffectReverbSmallRoomBright | Small bright room. |
AliEngineAudioEffectReverbSmallRoomDark | Small dark room. |
AliEngineAudioEffectReverbMediumRoom | Medium room. |
AliEngineAudioEffectReverbLargeRoom | Large room. |
AliEngineAudioEffectReverbChurchHall | Church Aisle |
AliEngineAudioEffectReverbParamType
The reverberation parameter type enumeration.
Enumeration Name | Description |
AliEngineAudioEffectReverbRoomSize | The room size. Valid values: 0 to 100. |
AliEngineAudioEffectReverbPreDelay | The pre-delay in milliseconds. Valid values: 0 to 200. |
AliEngineAudioEffectReverbPreDelay | The reverberation level. 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. |
AliEngineVideoCanvas
The rendering canvas.
Parameter | Type | Description |
displayView | void * | The rendering view. The value cannot be nil. |
renderMode | The rendering mode. Default value: AliEngineRenderModeAuto. | |
mirrorMode | The mirror mode. Default value: AliEngineRenderMirrorModeOnlyFrontMirror. | |
backgroundColor | int | The background color. The value is an integer in the 0xRRGGBB format. |
rotationMode | The video rotation angle. By default, the video is not rotated. | |
renderId | int | The ID. |
width | int | The width. |
height | int | High |
scaleMode | The aspect ratio of the video. Default value: AliEngineVideoScale_16_9. |
AliEngineLiveTranscodingErrorCode
The error code for bypass live streaming.
Enumeration Name | Description |
AliEngineLiveTranscodingErrorPublishOk | Stream ingest is successful. |
AliEngineLiveTranscodingErrorStreamNotFound | Error: The stream is not found. |
AliEngineLiveTranscodingErrorStreamAlreadyExist | Error: The destination stream already exists. |
AliEngineLiveTranscodingErrorInvalidParam | Error: Invalid parameters. |
AliEngineLiveTranscodingErrorInternalError | Error: An internal error occurred. |
AliEngineLiveTranscodingErrorRtmpServerError | Error: An RTMP service exception occurred. |
AliEngineLiveTranscodingErrorRtmpStreamUrlError | Error: The URL is invalid. |
AliEngineLiveTranscodingErrorPublishTimeout | Error: The task timed out. |
AliEngineLiveTranscodingErrorNotAuthorized | Error: The operation is not authorized. |
AliEngineWaterMarkConfig
The watermark image settings.
Parameter | Type | Description |
visibleInPreview | bool | Specifies whether the watermark is visible in the local preview. |
positionInLandscapeMode | The watermark coordinates in landscape mode. | |
positionInPortraitMode | The watermark coordinates in portrait mode. | |
alpha | float | The transparency. |
normalized | bool | Specifies whether to normalize the value. |
AliEngineCameraCapturerConfiguration
The preferred properties for camera capture.
Parameter | Type | Description |
preference | The capture preferences. |
AliEngineCaptureOutputPreference
The camera capture preferences.
Enumeration Name | Description |
AliEngineCaptureOutputPreferenceAuto | Automatically adjusts the capture parameters. |
AliEngineCaptureOutputPreferencePerformance | Prioritizes device performance. Selects the camera output parameters that are closest to the setVideoProfile settings. |
AliEngineCaptureOutputPreferencePreview | Prioritizes video preview quality. Selects higher camera output parameters. |
AliEngineFrameRate
The video encoding frame rate.
Enumeration name | Description |
AliEngineFrameRateFps5 | 5 FPS. |
AliEngineFrameRateFps10 | 10 FPS. |
AliEngineFrameRateFps15 | 15 FPS. |
AliEngineFrameRateFps20 | 20 FPS. |
AliEngineFrameRateFps30 | 30 FPS. |
AliEngineVideoEncoderBitrate
The video encoding bitrate.
Enumeration Name | Description |
AliEngineVideoStandardBitrate | Standard bitrate mode. |
AliEngineVideoMirrorMode
The mirror mode for encoded video.
Enumeration Name | Description |
AliEngineVideoMirrorModeDisabled | The encoded video is mirrored. |
AliEngineVideoMirrorModeEnable | The encoded video is not mirrored. |
AliEngineVideoEncoderConfiguration
The video encoding preferences.
Parameter | Type | Description |
dimensions | The video resolution. | |
frameRate | The video encoding frame rate. | |
bitrate | int | The video encoding bitrate. |
keyFrameInterval | int | The keyframe interval in milliseconds. The default value is 0, which indicates that the SDK controls the keyframe interval. |
forceStrictKeyFrameInterval | bool | Specifies whether to force the encoder to generate keyframes at the specified keyframe interval. The default value is false.
|
mirrorMode | The mirror mode for encoded video. | |
orientationMode | The rotation mode for encoded video. | |
rotationMode | The video rotation angle. | |
codecType | Sets the encoding mode. | |
encodeCodecType | AliEngineVideoEncodeCodecType | The encoding type. |
seiForceFrontIFrame | int | Forces an I-frame before sending SEI. A value of -1 indicates the default value. A value of 0 indicates not to force. A value of 1 indicates to force. The default value is 1. |
enableDynamicEncode | int | Uses dynamic encoding. |
disableDipenseResolutionChange | int | Specifies whether to support pre-encoding scaling. |
enableDowngrade | int | Specifies whether to allow resolution or bitrate degradation. |
enableH264BFrame | int | Specifies whether to enable H.264 B-frames. |
enableHevcBFrame | int | Specifies whether to enable HEVC B-frames. |
AliEngineVideoDecoderConfiguration
The video decoding property settings.
Parameter | Type | Description |
codecType | The decoding type, such as software decoding or hardware decoding. The default value is AliEngineVideoCodecTypeDefault, which uses the system's default settings. | |
enableHardwareDecoderBframe | int | Specifies whether to enable B-frames for the decoder. If the sender enables B-frames, you must enable this option. Otherwise, the B-frames cannot be decoded. The default value is -1. You can set the value to 0 to disable or 1 to enable. |
AliEngineVideoCodecType
The video codec type.
Enumerated value | Description |
AliEngineVideoCodecTypeDefault | Not set. The system's default settings are used. |
AliEngineVideoCodecTypeSoftware | Software video codec. |
AliEngineVideoCodecTypeHardware | Hardware video codec. |
AliEngineVideoCodecTypeHardwareTexture | Hardware texture codec. |
AliEngineScreenShareEncoderConfiguration
The screen sharing encoding preferences.
Parameter | Type | Description |
dimensions | The video resolution. | |
frameRate | The video encoding frame rate. | |
bitrate | int | The video encoding bitrate. |
rotationMode | The screen rotation angle. | |
keyFrameInterval | int | The keyframe interval in milliseconds. The default value is 0, which indicates that the SDK controls the keyframe interval. |
forceStrictKeyFrameInterval | bool | Specifies whether to force the encoder to generate keyframes at the specified keyframe interval. The default value is false.
|
AliEngineScreenShareConfig
The screen sharing configuration.
Parameter | Type | Description |
isShareByRegion | bool | Specifies whether to share a region of the screen. |
shareRegion | The layout information for region sharing. |
AliEngineScreenShareRegion
The screen sharing region.
Parameter | Type | Description |
originX | float | The x-coordinate. |
originY | float | The y-coordinate. |
width | float | The width. |
heigh | float | The height. |
AliEngineScreenSourcInfo
The screen sharing source information.
Parameter | Type | Description |
sourceId | String | The sharing source ID. |
sourceName | String | The sharing source name. |
sourceIsSelf | bool | Specifies whether the source is the SDK caller. |
AliEngineScreenShareInfo
The screen sharing configuration information.
Parameter | Type | Description |
shareType | The sharing type. | |
shareSourceId | unsigned int | The sharing source ID. |
shareConfig | The screen sharing configuration. |
AliEngineScreenShareType
The screen sharing type.
Enumeration Name | Description |
AliEngineScreenShareDesktop | Desktop sharing. |
AliEngineScreenShareWindow | Window sharing. |
AliEngineAuthInfo
The authentication information.
Parameter | Type | Description |
channelId | char* | The channel ID. |
userId | char* | The user ID. |
appId | char* | The application ID. |
nonce | char* | The random string. |
token | char* | The token. |
gslb | char** | The array of GSLB address pointers. |
session | char* | The session ID. This parameter is optional. |
role | char* | The role. This parameter is optional. |
timestamp | long long | The timestamp. |
gslbCount | int | The number of GSLB address pointers. |
agent | char** | The array of agent address pointers. |
agentCount | int | The number of agent address pointers. |
tokenType | char* | The token type. This parameter is optional. |
AliEngineVideoSource
The raw video data source type.
Enumeration Name | Description |
AliEngineVideoSourceCamera | The video stream. |
AliEngineVideoSourceScreenShare | The screen sharing stream. |
AliEngineAudioSource
The raw audio data source type.
Enumeration Name | Description |
AliEngineAudioSourceCaptured | The captured audio data. |
AliEngineAudioSourceProcessCaptured | The audio data after 3A processing. |
AliEngineAudioSourcePub | The stream ingest audio data. |
AliEngineAudioSourcePlayback | The playback audio data. |
AliEngineAudioSourceRemoteUser | The remote audio data from stream pulling. |
AliEngineAudioSourceMixedAll | The mixed audio data from stream ingest and playback. |
AliEngineBufferType
The video data type.
Enumeration name | Description |
AliEngineBufferTypeRawData | Raw YUV data. |
AliEngineBufferTypeTexture | CVPixelBuffer data. |
AliEngineErrorCode
The error code.
Enumeration name | Description |
AliEngineErrorJoinBadAppId | The App ID does not exist. |
AliEngineErrorJoinInvaildAppId | The App ID is invalid. |
AliEngineErrorJoinBadChannel | The channel does not exist. |
AliEngineErrorJoinInvaildChannel | The channel is invalid. |
AliEngineErrorJoinBadToken | The token does not exist. |
AliEngineErrorJoinTimeout | The request to join the channel timed out. |
AliEngineErrorJoinBadParam | Invalid parameters. |
AliEngineErrorMicOpenFail | Failed to initialize the capture device. |
AliEngineErrorSpeakerOpenFail | Failed to initialize the playback device. |
AliEngineErrorMicInterrupt | An exception occurred during capture. |
AliEngineErrorSpeakerInterrupt | An exception occurred during playback. |
AliEngineErrorMicAuthFail | The microphone device is not authorized. |
AliEngineErrorMicNotAvailable | No audio capture device is available. |
AliEngineErrorSpeakerNotAvailable | No audio playback device is available. |
AliEngineErrorCameraOpenFail | Failed to initialize the capture device. |
AliEngineErrorCameraInterrupt | An exception occurred during capture. |
AliEngineErrorVideoDisplayOpenFail | Failed to initialize the rendering device. |
AliEngineErrorVideoDisplayInterrupt | An exception occurred during rendering. |
AliEngineErrorIceConnectionConnectFail | Failed to establish the media channel. |
AliEngineErrorIceConnectionReconnectFail | Failed to reconnect to the media channel. |
AliEngineErrorIceConnectionHeartbeatTimeout | The signaling heartbeat timed out. |
AliEngineErrorPublishInvaild | Invalid stream ingest. |
AliEngineErrorPublishNotJoinChannel | Failed to ingest the stream because the user has not joined the channel. |
AliEngineErrorPublishAudioStreamFailed | Failed to push the audio stream. |
AliEngineErrorPublishVideoStreamFailed | Failed to push the video stream. |
AliEngineErrorPublishDualStreamFailed | Failed to push the dual streams. |
AliEngineErrorPublishScreenShareFailed | Failed to push the screen sharing stream. |
AliEngineErrorPublishScreenShareConfigError | Screen sharing configuration error. |
AliEngineErrorSubscribeInvaild | Invalid subscription. |
AliEngineErrorSubscribeNotJoinChannel | Subscription error because the user has not joined the channel. |
AliEngineErrorSubscribeAudioStreamFailed | Failed to subscribe to the audio stream. |
AliEngineErrorSubscribeVideoStreamFailed | Failed to subscribe to the video stream. |
AliEngineErrorSubscribeDualStreamFailed | Failed to subscribe to the dual streams. |
AliEngineErrorSubscribeScreenShareFailed | Failed to subscribe to the screen sharing stream. |
AliEngineErrorLowLatencyLiveCommunicationFail | Low-latency live communication signaling failed. |
AliEngineErrorLowLatencyLiveMediaSettingFail | Low-latency live media setting error. |
AliEngineErrorLowLatencyLiveNoneBroadcaster | No streamer is ingesting a stream in the current low-latency live room. |
AliEngineErrorLowLatencyLiveNeedRestart | A low-latency live error occurred. The application layer needs to create a new SDK instance. |
AliEngineErrorLowLatencyLiveNeedRestartAgainLater | A low-latency live error occurred. The application layer needs to wait for a custom interval and then create a new SDK instance. |
AliEngineErrorLowLatencyLiveServiceUnavailable | The low-latency live service is unavailable or degraded. |
AliEngineErrorLowLatencyLiveMediaConnectionInterrruption | A low-latency live network interruption error occurred. |
AliEngineErrorInvaildState | SDK state error. |
AliEngineErrorSessionRemoved | The session has been removed. |
AliEngineErrorInvaildArgument | The parameters do not match. |
AliEngineErrorAudioBufferFull | The buffer queue is full. This is used for external raw data transmission. |
AliEngineErrorVideoBufferFull | The buffer queue is full. This is used for external raw data transmission. |
AliEngineErrorUpdateRoleChannel | Error setting the role in interactive mode. |
AliEngineErrorInner | Other errors. |
AliEngineVideoObserAlignment
The width alignment for the output video.
Enumeration name | Description |
AliEngineAlignmentDefault | Maintains the original video width. This is the default value. |
AliEngineAlignmentEven | The width is aligned to an even number. |
AliEngineAlignment4 | The width is a multiple of 4. |
AliEngineAlignment8 | The width is a multiple of 8. |
AliEngineAlignment16 | The width is a multiple of 16. |
AliEngineShowDebugViewType
The type of the dashboard.
Enumeration name | Description |
AliEngineShowTypeNone | Not displayed. |
AliEngineShowTypeAudio | Audio. |
AliEngineShowTypeVideo | Video. |
AliEngineShowTypeNetwork | Network. |
AliEngineShowTypeAll | All. |
AliEngineTrascodingPublishTaskStatus
The bypass live stream status.
Enumeration name | Description |
AliEngineTrascodingPublishTaskStatusStart | The task starts. |
AliEngineTrascodingPublishTaskStatusUpdate | The task is updated. |
AliEngineTrascodingPublishTaskStatusStop | The task has stopped. |
DisplayType
The image display type in bypass live streaming.
Enumeration Name | Description |
NOT_DISPLAY | Not displayed. |
ALWAYS | Always displayed. |
WHEN_NO_VIDEO | Displayed when there is no video. |
AliEngineLiveTranscodingFontType
The font type for bypass live streaming.
Enumeration name | Description |
NOTO_SERIF_CJKSC_REGULAR | Noto Serif CJK SC 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. |
AliEngineLiveTranscodingSegmentType
The segmentation type for bypass live streaming.
Enumeration Name | Description |
AliEngineLiveTranscodingNoBody | No portrait segmentation. |
AliEngineLiveTranscodingBody | Portrait segmentation. |
AliEngineLiveTranscodingSourceType
The input type for bypass live streaming.
Enumeration Name | Description |
AliEngineLiveTranscodingCamera | Camera. |
AliEngineLiveTranscodingShareScreen | Screen sharing. |
AliEngineVideoState
The video stream state change.
Enumeration name | Description |
AliEngineVideoClose | Closes the video stream. |
AliEngineVideoOpen | Resumes the video stream. |
AliEngineVideoReason
The reason for the video stream state change.
Enumeration name | Description |
AliEngineVideoChangeByClient | Client. |
AliEngineVideoChangeByServer | Server. |
AliEngineLiveTranscodingCropMode
The cropping mode for bypass live streaming.
Enumeration Name | Description |
AliEngineLiveTranscodingCrop | Crops while maintaining the aspect ratio. |
AliEngineLiveTranscodingFill | Fills with black bars while maintaining the aspect ratio. This is the default value. |
AliEngineLiveTranscodingMediaProcessMode
The media processing mode for bypass live streaming.
Enumeration Name | Description |
AliEngineLiveTranscodingNormal | General mode. |
AliEngineLiveTranscodingVirtualBackground | Virtual background mode. |
AliEngineLiveTranscodingStreamType
The stream type for bypass live streaming.
Enumeration Name | Description |
AliEngineLiveTranscodingOrigin | Push the original stream again. |
AliEngineLiveTranscodingAudio | Bypasses only the audio stream. |
AliEngineLiveTranscodingVideo | Bypasses only the video stream. |
AliEngineLiveTranscodingMixMode
The mode for bypass live streaming.
Enumeration Name | Description |
AliEngineLiveTranscodingSINGLE | Single-stream bypass. Does not mix and transcode streams. Bypasses only the original single stream. You do not need to configure stream mixing and transcoding parameters. |
AliEngineLiveTranscodingMIX | Stream mixing and transcoding. This is the default value. Supports stream mixing and transcoding output. |
AliEngineLiveTranscodingState
The bypass live streaming status.
Enumeration Name | Description |
AliEngineLiveTranscodingState_IDLE | Stream ingest is idle. |
AliEngineLiveTranscodingState_CONNNECT | Connecting to the stream ingest server. |
AliEngineLiveTranscodingState_RUNNING | Stream ingest is in progress. |
AliEngineLiveTranscodingState_RECOVERING | Resuming stream ingest. |
AliEngineLiveTranscodingState_FAILURE | Stream ingest failed. |
AliEngineLiveTranscodingState_END | Stream ingest is complete. |
AliEngineLiveTranscodingText
The text information for bypass live streaming.
Parameter | Type | Description |
text | String | The text information. |
x | int | The x-coordinate in pixels. |
y | int | The y-coordinate in pixels. |
fontType | The font for bypass live streaming. | |
fontSize | int | The font size. |
zOrder | int | The stacking order. A value of 0 indicates the bottom layer. Layer 1 is on top of layer 0, and so on. |
fontColor | int | The font color. |
AliEngineLiveTranscodingImage
The image information for bypass live streaming.
Parameter | Type | Description |
url | String | The image URL. |
alpha | float | The transparency. A value of 0.0 indicates transparent, and 1.0 indicates fully opaque. |
display | The image display. | |
x | int | The x-coordinate in pixels. |
y | int | The y-coordinate in pixels. |
width | int | The image width. |
height | int | The image height. |
zOrder | int | The stacking order. A value of 0 indicates the bottom layer. Layer 1 is on top of layer 0, and so on. |
AliEngineLiveTranscodingUser
The custom pane information for a user in bypass live streaming.
Parameter | Type | Description |
x | int | The x-coordinate in pixels. |
y | int | The y-coordinate in pixels. |
width | int | The pane width. |
height | int | The pane height. |
zOrder | int | The stacking order. A value of 0 indicates the bottom layer. Layer 1 is on top of layer 0, and so on. |
userId | String | The user ID. |
sourceType | The stream type. | |
segmentType | The segmentation type for bypass live streaming. | |
images | AliEngineLiveTranscodingImageArray | The image information for bypass live streaming. |
texts | AliEngineLiveTranscodingTextArray | The text information for bypass live streaming. |
AliEngineLiveTranscodingParam
The configuration for bypass live streaming.
Parameter | Type | Description |
mixMode | The mode for bypass live streaming. | |
singleParam | The single-stream parameters for bypass live streaming. | |
mixParam | The stream mixing parameters for bypass live streaming. |
AliEngineLiveTranscodingMixParam
The stream mixing parameters for bypass mode.
Parameter | Type | Description |
taskProfile | The billing specifications for bypass live streaming. | |
encodeParam | The encoding parameters for bypass live streaming. | |
users | AliEngineLiveTranscodingUserArray | The list of users for bypass live streaming. |
backgroundColor | int | The background color. |
backgrounds | AliEngineLiveTranscodingImageArray | The list of background images. |
watermarks | AliEngineLiveTranscodingImageArray | The list of watermark images. |
clockWidgets | AliEngineLiveTranscodingClockWidgetArray | The list of clock widgets. |
cropMode | The cropping mode for bypass live streaming. | |
mediaProcessMode | The media processing mode for bypass live streaming. |
AliEngineLiveTranscodingSingleParam
The single-stream parameters for bypass mode.
Parameter | Type | Description |
userId | String | The user ID. |
streamType | The stream type for bypass live streaming. | |
sourceType | The video stream type for bypass live streaming. |
AliEngineLiveTranscodingTaskProfile
The billing specifications for bypass live streaming.
Enumeration name | 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. |
AliEngineLiveTranscodingEncodeParam
The encoding parameters for bypass live streaming.
Parameter | Type | Description |
videoWidth | int | The width. |
videoHeight | int | The height. |
videoFramerate | int | The frame rate. |
videoBitrate | int | The bitrate. |
videoGop | int | The GOP. |
audioSamplerate | The audio sampling rate for bypass live streaming. | |
audioBitrate | int | The audio bitrate. |
audioChannels | int | The number of audio channels. |
AliEngineLiveTranscodingAudioSampleRate
The audio sampling rate for bypass live streaming.
Enumeration Name | Description |
AliEngineLiveTranscoding_HZ_48000 | Sample rate of 48000 Hz. |
AliEngineLiveTranscoding_HZ_44100 | Sample rate of 44100 Hz. |
AliEngineLiveTranscoding_HZ_32000 | Sample rate of 32000 Hz. |
AliEngineLiveTranscoding_HZ_16000 | Sample rate of 16000 Hz. |
AliEngineLiveTranscoding_HZ_8000 | Sample rate of 8000 Hz. |
AliEngineLiveTranscodingClockWidget
The clock widget for bypass live streaming.
Parameter | Type | Description |
x | int | The x-coordinate in pixels. |
y | int | The y-coordinate in pixels. |
fontSize | int | The font size for bypass live streaming. |
zOrder | int | The stacking order. A value of 0 indicates the bottom layer. Layer 1 is on top of layer 0, and so on. |
fontColor | int | The font color for bypass live streaming. |
fontType | The font for bypass live streaming. |
AliEngineBokehScaleModel
The scaling mode for background replacement.
Enumeration Name | Description |
AliEngineBokehScaleModelCrop | Crops while maintaining the aspect ratio. |
AliEngineBokehScaleModelFill | Fills with black bars. |
AliEngineAudioAccompanyStateCode
The music accompaniment playback state.
Enumeration name | Description |
AliEngineAudioAccompanyStarted | Playback starts. |
AliEngineAudioAccompanyStopped | Playback stops. |
AliEngineAudioAccompanyPaused | Playback is paused. |
AliEngineAudioAccompanyResumed | Playback is resumed. |
AliEngineAudioAccompanyEnded | Playback is complete. |
AliEngineAudioAccompanyBuffering | Buffering is in progress. |
AliEngineAudioAccompanyBufferingEnd | Buffering is complete. |
AliEngineAudioAccompanyFailed | Playback failed. |
AliEngineAudioAccompanyErrorCode
The music accompaniment playback error code.
Enumeration Name | Description |
AliEngineAudioAccompanyNoError | No error. |
AliEngineAudioAccompanyOpenFailed | Failed to open the file. |
AliEngineAudioAccompanyDecodeFailed | Failed to decode the file. |
AliEngineScreenSourceList
The screen sharing source list.
Parameter | Type | Description |
GetCount | unsigned int | Gets the number of screen sharing sources. |
GetSourceInfo | Gets the source description information by index. | |
Release | None | Releases the interface. |
AliEngineInterfaceIdType
The function interface type.
Enumeration Name | Description |
AliEngineInterfaceAudioDeviceManager | Corresponds to the IAliEngineAudioDeviceManager class, which implements audio device-related features. |
AliEngineInterfaceVideoDeviceManager | Corresponds to the IAliEngineVideoDeviceManager class, which implements video device-related features. |
AliEngineInterfaceMediaEngine | The IAliEngineMediaEngine class, which implements audio and video media data-related features. |
AliEngineVideoCodecKindType
The video codec type.
Enumeration name | Description |
AliEngineVideoEncoderType | Encoder. |
AliEngineVideoDecoderType | Decoder. |
AliEngineDeviceTransportType
The device connection type.
Enumeration Name | Description |
AliEngineDeviceTransportTypeUnknown | Unknown device type. |
AliEngineDeviceTransportTypeBuiltIn | Built-in computer device. |
AliEngineDeviceTransportTypeBluetooth | Bluetooth device. |
AliEngineDeviceTransportTypeUSB | USB device. |
AliEngineDeviceTransportTypeAggregate | Aggregate device. |
AliEngineDeviceTransportTypeVirtual | Virtual device. |
AliEngineDeviceTransportTypePCI | PCI device. |
AliEngineDeviceTransportTypeFireWire | FireWire device. |
AliEngineDeviceTransportTypeBluetoothLE | Bluetooth LE device. |
AliEngineDeviceTransportTypeHDMI | HDMI device. |
AliEngineDeviceTransportTypeDisplayPort | DVI device. |
AliEngineDeviceTransportTypeAirPlay | AirPlay device. |
AliEngineDeviceTransportTypeAVB | AVB device. |
AliEngineDeviceTransportTypeThunderbolt | Thunderbolt device. |
AliEngineAudioFrameObserverConfig
The audio data callback parameter settings.
Parameter | Type | Description |
sampleRate | The callback audio sample rate. | |
channels | The number of callback audio channels. | |
mode | The callback mode. | |
userDefinedInfo | int | Custom parameters. For more information, see AliEngineAudioFrameObserverUserDefinedInfoBitMask. |
AliEngineDeviceInfoList
The video device list.
Method | Return value type | Description |
GetCount | int | The number of resolutions. |
GetDeviceInfo | Gets information about the specified device. | |
Release | void | Releases the object. |
AliEngineVideoResolutionList
The video resolution list.
Method | Return value type | Description |
GetCount | int | The number of resolutions. |
GetResolutionInfo | Gets the resolution at the specified index. | |
Release | void | Releases the object. |
AliEngineVideoRecordSource
The video recording data source.
Enumeration Name | Description |
AliEngineVideoRecordSourceCamera | Records the camera stream video. |
AliEngineVideoRecordSourceScreenShare | Records the screen sharing stream video. |
AliEngineVideoRecordSourceBoth | Records both the camera and screen sharing stream videos. |
AliEngineAudioFrameObserverOperationMode
The audio data callback mode.
Enumeration Name | Description |
AliEngineAudioFrameObserverOperationModeReadOnly | Read-only mode. |
AliEngineAudioFrameObserverOperationModeWriteOnly | Write mode. |
AliEngineAudioFrameObserverOperationModeReadWrite | Read-write mode. |
AliEngineVideoResolution
The video resolution.
Parameter | Type | Description |
width | int | The width. |
height | int | The height. |
AliEngineVideoScale
The video resolution aspect ratio.
Enumeration Name | Description |
AliEngineVideoScale_16_9 | 16:9 |
AliEngineVideoScale_4_3 | 4:3 |
AliEngineWaterMarkPosition
The watermark coordinate system.
Parameter | Type | Description |
x | float | The x-coordinate, starting from the top-left corner. |
y | float | The y-coordinate, starting from the top-left corner. |
w | float | The watermark width. |
h | float | The watermark height. |
AliEngineVideoDimensions
The video resolution.
Parameter | Type | Description |
width | int | The video width. |
height | int | The video height. |
AliEngineVideoEncodeCodecType
The video encoding format.
Enumeration name | Description |
AliEngineVideoEncodeCodecTypeDefault | Not set. The default value, currently H.264, is used. |
AliEngineVideoEncodeCodecTypeH264 | Uses H.264 encoding. |
AliEngineVideoEncodeCodecTypeHevc | Uses H.265 encoding. |
AliEngineChannelParam
The user properties, such as nickname and type.
Parameter | Type | Description |
userName | string | The username to be displayed. |
capabilityProfile | The user properties. Special configuration is required for AI agent call scenarios. Use the default value for non-AI agent call scenarios. |
AliCapabilityProfile
The user properties. Special configuration is required for AI agent call scenarios. For all other scenarios, use the default value.
Enumeration name | Description |
AliCapabilityProfileDefault | Non-AI agent call scenario. |
AliCapabilityProfileHuman | User properties. |
AliCapabilityProfileRobot | Robot properties. |
AliEngineAudioAccompanyConfig
The audio accompaniment playback configuration.
Parameter | Type | Description |
onlyLocalPlay | bool | Specifies whether to play only locally. Default value: false. |
replaceMic | bool | Specifies whether to replace the microphone. Default value: false. |
loopCycles | int | The number of loops. You can set it to -1 for an infinite loop or a positive integer greater than 0. Other values are invalid. Default value: -1. |
startPosMs | long | The starting position in milliseconds. Default value: 0. |
publishVolume | int | The stream ingest volume. Valid values: 0 to 100. Default value: 50. |
playoutVolume | int | The playback volume. Valid values: 0 to 100. Default value: 50. |
AliEngineVideoPipelineMirrorMode
The video mirror mode.
Enumeration name | Description |
AliEngineVideoPipelineMirrorModeNoMirror | Mirroring is disabled for both preview and encoding. |
AliEngineVideoPipelineMirrorModeBothMirror | Mirroring is enabled for both preview and encoding. |
AliEngineVideoPipelineMirrorModeOnlyPreviewMirror | Opens a preview of the image. |
AliEngineVideoPipelineMirrorModeOnlyPublishMirror | Mirroring is enabled only for stream ingest. |
AliEngineCapturePipelineScaleMode
The video scaling timing.
Enumeration name | Description |
AliEngineCapturePipelineScaleModePre | Scales immediately after capture. This is the default. |
AliEngineCapturePipelineScaleModePost | Scales during encoding. |
AliEngineDataChannelMsg
The data channel message.
Parameter | Type | Description |
type | AliEngineDataMsgType | The message type. |
networkTime | long long | The timestamp. |
progress | int | The current progress in milliseconds. This is used only when `type` is `AliEngineDataMsgMusicProgress` and only in KTV scenarios. It does not need to be set for other scenarios. |
data | void* | The message content, which can be any data, such as text or images. |
dataLen | int | The message length. |
AliEngineDataMsgType
The data channel message type.
Enumeration name | Description |
AliEngineDataChannelNone | No message. |
AliEngineDataChannelProgress | Used in KTV scenarios. |
AliEngineDataChannelCustom | Normal message. We recommend that you set this type for other scenarios. |
AliEngineAudioFileInfo
The audio file information.
Parameter | Type | Description |
filePath | const char* | The audio file path. |
durationMs | long | The audio file duration in milliseconds. |
AliEngineLocalAudioStateType
The local audio capture state.
Enumeration name | Description |
AliEngineLocalAudioStateTypeStarting | Local audio capture is starting. |
AliEngineLocalAudioStateTypeStarted | Local audio capture has started. |
AliEngineLocalAudioStateTypeStopping | Local audio capture is stopping. |
AliEngineLocalAudioStateTypeStopped | Local audio capture has stopped. |
AliEngineLocalVideoStateType
The local video capture state.
Enumeration name | Description |
AliEngineLocalVideoStateTypeStarting | Local video capture is starting. |
AliEngineLocalVideoStateTypeStarted | Local video capture has started. |
AliEngineLocalVideoStateTypeStopping | Local video capture is stopping. |
AliEngineLocalVideoStateTypeStopped | Local video capture has stopped. |