Data structures
Data types and enumerations used in the Real-Time Communication (RTC) Windows SDK.
Contents
|
Type |
Description |
|
User volume information. |
|
|
A sample of raw audio data. |
|
|
A sample of raw video data. |
|
|
The channel profile. |
|
|
The role of a user in a channel, such as a host or an audience member. |
|
|
Statistics for the current session. |
|
|
Statistics for the local video stream. |
|
|
Statistics for a remote video stream. |
|
|
Statistics for the local audio stream. |
|
|
Statistics for a remote audio stream. |
|
|
Video data output position. |
|
|
Video format properties. |
|
|
External device type. |
|
|
External device state. |
|
|
Network connection status. |
|
|
The reason for a network connection status change. |
|
|
Video stream type. |
|
|
Stream publishing state. |
|
|
Stream subscription state. |
|
|
The reason a user went offline. |
|
|
Camera stream type. |
|
|
Audio stream type. |
|
|
The quality of the network connection. |
|
|
Orientation mode. |
|
|
Video rendering mode. |
|
|
Video mirror mode. |
|
|
Video rotation mode. |
|
|
Logging level. |
|
|
Audio channel count. |
|
|
Audio recording sample rate. |
|
|
Recording type. |
|
|
Recording format. |
|
|
Audio quality for recorded files. |
|
|
Video quality for recorded files. |
|
|
Audio profile. |
|
|
Audio scenario parameters. |
|
|
Local audio mute mode. |
|
|
Audio recording configuration. |
|
|
Video recording configuration. |
|
|
Canvas size for video recording. |
|
|
Layout information for video recording. |
|
|
Background color for video recording. |
|
|
User view configuration for the recording layout. |
|
|
The rectangular area for a user's view. |
|
|
Coordinates for mixed-stream recording. |
|
|
Recording template. |
|
|
Device information. |
|
|
Basic beauty filter settings. |
|
|
OnBye type. |
|
|
Voice changer effect mode. |
|
|
Reverb effect mode. |
|
|
Reverb effect parameters. |
|
|
Video rendering canvas. |
|
|
Live transcoding error code. |
|
|
Watermark settings. |
|
|
Camera capture preferences. |
|
|
Camera capture resolution. |
|
|
Video display mode. |
|
|
Camera capture preference. |
|
|
Video encoding frame rate. |
|
|
Video encoding bitrate. |
|
|
Encoded video mirror mode. |
|
|
Video encoding preferences. |
|
|
Video decoder properties. |
|
|
Video codec type. |
|
|
Screen sharing encoding preferences. |
|
|
Screen sharing configuration. |
|
|
Screen sharing region. |
|
|
Screen source information. |
|
|
Screen sharing configuration. |
|
|
Screen sharing type. |
|
|
Authentication information. |
|
|
Raw video data source type. |
|
|
Raw audio data source type. |
|
|
Buffer type. |
|
|
Error code. |
|
|
Video output width alignment. |
|
|
Dashboard display type. |
|
|
Publishing status of a live transcoding task. |
|
|
Image display type for live transcoding. |
|
|
Text font type for live transcoding. |
|
|
Segmentation type for live transcoding. |
|
|
Input type for live transcoding. |
|
|
Video stream state. |
|
|
Reason for a video stream state change. |
|
|
Cropping mode for live transcoding. |
|
|
Media processing mode for live transcoding. |
|
|
Stream type for live transcoding. |
|
|
Live transcoding mode. |
|
|
Live transcoding state. |
|
|
Text information for live transcoding. |
|
|
Image information for live transcoding. |
|
|
Custom user pane information for live transcoding. |
|
|
Parameters for a live transcoding task. |
|
|
Parameters for mixed-stream live transcoding. |
|
|
Parameters for single-stream live transcoding. |
|
|
Billing specifications for live transcoding. |
|
|
Encoding parameters for live transcoding. |
|
|
Audio sample rate for live transcoding. |
|
|
Clock widget for live transcoding. |
|
|
Scaling mode for background replacement. |
|
|
Music accompaniment playback state. |
|
|
Error code for music accompaniment playback. |
|
|
List of screen sharing sources. |
|
|
API interface type. |
|
|
Video codec type. |
|
|
Device connection type. |
|
|
Audio frame callback configuration. |
|
|
List of video devices. |
|
|
List of resolutions for a video capture device. |
|
|
Video data source for recording. |
|
|
Audio data callback operation mode. |
|
|
Video resolution. |
|
|
Video aspect ratio. |
|
|
Watermark coordinate system. |
|
|
The width and height of a video in pixels. |
|
|
Video encoding format. |
|
|
User attributes, such as nickname and user type. |
|
|
User attributes for AI agent call scenarios. |
|
|
Music accompaniment playback configuration. |
|
|
Video pipeline mirror mode. |
|
|
The timing for video scaling in the capture pipeline. |
|
|
Data channel message. |
|
|
Data channel message type. |
|
|
Audio file information. |
|
|
Local audio capture state. |
|
|
Local video capture state. |
|
|
Audio beautification modes. |
|
|
Equalizer band frequencies. |
API
AliEngineUserVolumeInfo
User volume information.
|
Parameter |
Type |
Description |
|
uid |
String |
The user ID. Valid values:
|
|
volume |
int |
The audio volume reported in the callback. |
|
speech_state |
bool |
|
|
sumVolume |
int |
The total volume accumulated during the callback period, used to identify the current speaker. The value ranges from 0 to 255. |
AliEngineAudioRawData
A raw audio sample.
|
Parameter |
Type |
Description |
|
dataPtr |
void* |
Pointer to the audio data buffer. |
|
numOfSamples |
int |
Number of samples per channel. |
|
bytesPerSample |
int |
Number of bytes per audio sample. |
|
numOfChannels |
int |
Number of audio channels. |
|
samplesPerSec |
int |
Sample rate in Hz. |
AliEngineVideoRawData
Represents raw video data.
|
Parameter |
Type |
Description |
|
format |
The pixel format of the video data. |
|
|
type |
The buffer type of the video data. |
|
|
dataLength |
int |
The data length, in bytes. |
|
pixelBuffer |
void* |
Pointer to the pixel buffer. |
|
dataPtr |
void* |
Pointer to the YUV data. |
|
dataYPtr |
void* |
Pointer to the Y component. |
|
dataUPtr |
void* |
Pointer to the U component. |
|
dataVPtr |
void* |
Pointer to the V component. |
|
strideY |
int |
The stride of the Y plane, in bytes. |
|
strideU |
int |
The stride of the U plane, in bytes. |
|
strideV |
int |
The stride of the V plane, in bytes. |
|
height |
int |
The height of the video frame, in pixels. |
|
width |
int |
The width of the video frame, in pixels. |
|
rotation |
int |
The rotation angle of the video frame, in degrees. Valid values are 0, 90, 180, and 270. |
|
timeStamp |
long long |
The timestamp, in milliseconds. |
AliEngineChannelProfile
Specifies the channel mode.
|
Enum name |
Description |
|
AliEngineCommunication |
Communication mode |
|
AliEngineInteractiveLive |
Interactive live streaming mode |
AliEngineClientRole
The user role.
|
Value |
Description |
|
AliEngineClientRoleInteractive |
The broadcaster role. A user in this role can publish and subscribe to media streams. |
|
AliEngineClientRoleLive |
The audience role. A user in this role can only subscribe to media streams. |
AliEngineStats
Session statistics.
|
Parameter |
Type |
Description |
|
sentKBitrate |
long long |
Send bitrate in kilobits per second (Kbps). |
|
rcvdKBitrate |
long long |
Receive bitrate in kilobits per second (Kbps). |
|
sentBytes |
long long |
Total bytes sent. |
|
rcvdBytes |
long long |
Total bytes received. |
|
systemCpu |
unsigned int |
System CPU usage (%). |
|
appCpu |
unsigned int |
RTC process CPU usage (%). |
|
videoRcvdKBitrate |
long long |
Video receive bitrate in kilobits per second (Kbps). |
|
videoSentKBitrate |
long long |
Video send bitrate in kilobits per second (Kbps). |
|
callDuration |
unsigned long long |
Call duration in seconds. |
|
sentLossRate |
long long |
Uplink packet loss rate (%). |
|
sentLossPkts |
long long |
Total uplink packets lost. |
|
sentExpectedPkts |
long long |
Total uplink packets. |
|
rcvdLossRate |
long long |
Downlink packet loss rate (%). |
|
rcvdLossPkts |
long long |
Total downlink packets lost. |
|
rcvdExpectedPkts |
long long |
Total downlink packets. |
|
lastmileDelay |
long long |
Last-mile network delay in milliseconds. |
|
availableSendBitrate |
long long |
Available send bitrate in kilobits per second (Kbps). |
AliEngineLocalVideoStats
Local video statistics.
|
Parameter |
Type |
Description |
|
track |
Stream type. |
|
|
sentBitrate |
unsigned int |
Sent bitrate. |
|
sentFps |
unsigned int |
Sent frame rate. |
|
encodeFps |
unsigned int |
Encoding frame rate. |
|
targetEncodeBitrate |
unsigned int |
Target encoding bitrate. |
|
actualEncodeBitrate |
unsigned int |
Actual encoding bitrate. |
|
captureFps |
unsigned int |
Capture frame rate. |
|
avgQpPerSec |
unsigned int |
Average QP. |
AliEngineRemoteVideoStats
Remote video statistics.
|
Parameter |
Type |
Description |
|
userId |
const char* |
The remote user ID. |
|
track |
The video stream type. |
|
|
width |
unsigned int |
Video frame width in pixels. |
|
height |
unsigned int |
Video frame height in pixels. |
|
decodeFps |
unsigned int |
Decode frame rate in frames per second (fps). |
|
renderFps |
unsigned int |
Renderer output frame rate in frames per second (fps). |
|
frozenTimes |
unsigned int |
Total number of video freezes. |
AliEngineLocalAudioStats
Local audio statistics.
|
Parameter |
Type |
Description |
|
track |
Audio track type. |
|
|
scene |
Audio scene. |
|
|
sentBitrate |
unsigned int |
Sent bitrate. |
|
sentSamplerate |
unsigned int |
Sent sample rate. |
|
numChannel |
unsigned int |
Number of channels. |
|
inputLevel |
unsigned int |
Input level. |
AliEngineRemoteAudioStats
Remote audio statistics.
|
Parameter |
Type |
Description |
|
userId |
const char* |
The user ID. |
|
track |
The audio track type. |
|
|
networkTransportDelay |
int |
The network latency from the audio sender to the receiver, in milliseconds (ms). |
|
quality |
int |
The audio quality. |
|
audioLossRate |
int |
The audio packet loss rate. |
|
rcvdBitrate |
int |
The received bitrate, in bits per second (bps). |
|
totalFrozenTimes |
int |
The total number of freezes. |
|
audioTotalFrozenTime |
int |
The total freeze duration of audio playback, in milliseconds (ms). |
|
audioTotalFrozenRate |
int |
The audio freeze rate, as a percentage (%). |
AliEngineVideoObserPosition
Specifies the point in the video pipeline from which to observe video data.
|
Enum name |
Description |
|
AliEnginePositionPostCapture |
Observes the captured data from the local device. |
|
AliEnginePositionPreRender |
Observes the pre-render data from a remote user. |
|
AliEnginePositionPreEncoder |
Observes the pre-encoding data. |
AliEngineVideoFormat
Defines the video data output format.
|
Enum member |
Description |
|
AliEngineVideoFormatBGRA |
BGRA format. |
|
AliEngineVideoFormatUnknown |
Unknown format. |
|
AliEngineVideoFormatI420 |
I420 format. |
|
AliEngineVideoFormatNV21 |
NV21 format. |
|
AliEngineVideoFormatNV12 |
NV12 format. |
|
AliEngineVideoFormatRGBA |
RGBA format. |
|
AliEngineVideoFormatI422 |
I422 format. |
|
AliEngineVideoFormatARGB |
ARGB format. |
|
AliEngineVideoFormatABGR |
ABGR format. |
|
AliEngineVideoFormatRGB24 |
RGB24 format. |
|
AliEngineVideoFormatBGR24 |
BGR24 format. |
|
AliEngineVideoFormatRGB565 |
RGB565 format. |
|
AliEngineVideoFormatTextureOES |
TextureOES format. |
|
AliEngineVideoFormatTexture2D |
Texture2D format. |
|
AliEngineVideoFormatH264 |
H.264 format. |
AliEngineExternalDeviceType
Specifies the external device type.
|
Enum name |
Description |
|
AliEngineExternalTypeUnknown |
An unknown device type. |
|
AliEngineExternalTypeAudioCapture |
An audio capture device. |
|
AliEngineExternalTypeAudioPlayout |
An audio playout device. |
|
AliEngineExternalTypeVideoCapture |
A video capture device. |
AliEngineExternalDeviceState
Represents the state of an external device.
|
Parameter |
Description |
|
AliEngineExternalDeviceAdd |
An external device has been added. |
|
AliEngineExternalDeviceRemove |
An external device has been removed. |
AliEngineConnectionStatus
Indicates the network connection status.
|
Parameter |
Description |
|
AliEngineConnectionInit |
Initialization is complete. |
|
AliEngineConnectionDisconnected |
Disconnected from the network. |
|
AliEngineConnectionConnecting |
Connecting to the network. |
|
AliEngineConnectionConnected |
Connected to the network. |
|
AliEngineConnectionReconnecting |
Reconnecting to the network. |
|
AliEngineConnectionFailed |
Failed to connect to the network. |
AliEngineConnectionStatusChangeReason
The reason for the network connection status change.
|
Parameter |
Description |
|
AliEngineConnectionChangedDummyReason |
Unknown reason. |
|
AliEngineConnectionMediaPathChanged |
Media path change. |
|
AliEngineConnectionSignalingHeartbeatTimeout |
Signaling heartbeat timeout. |
|
AliEngineConnectionSignalingHeartbeatAlive |
Signaling heartbeat restored. |
|
AliEngineConnectionSignalingHttpdnsResolved |
Successful DNS resolution. |
|
AliEngineConnectionSignalingHttpdnsFailure |
DNS resolution failure. |
|
AliEngineConnectionSignalingGslbFailure |
GSLB request failure. |
|
AliEngineConnectionSignalingGslbSuccess |
Successful GSLB request. |
|
AliEngineConnectionSignalingJoinChannelFailure |
Failed to join the channel. |
|
AliEngineConnectionSignalingJoinChannelSuccess |
Successfully joined the channel. |
|
AliEngineConnectionSignalingLeaveChannel |
Left the channel. |
|
AliEngineConnectionSignalingConnecting |
Establishing a signaling connection. |
|
AliRtcConnectionChangedNetworkInterrupted |
Network connection interrupted. |
AliEngineVideoTrack
Specifies the video stream type.
|
Enumerator |
Description |
|
AliEngineVideoTrackNo |
No video stream. |
|
AliEngineVideoTrackCamera |
The video stream from the camera. |
|
AliEngineVideoTrackScreen |
The video stream from screen sharing. |
|
AliEngineVideoTrackBoth |
Video streams from both the camera and screen sharing. |
AliEnginePublishState
The publishing state of a stream.
|
Parameter |
Description |
|
AliEngineStatsPublishIdle |
The initial state. |
|
AliEngineStatsNoPublish |
Publishing is inactive. |
|
AliEngineStatsPublishing |
Publishing is in progress. |
|
AliEngineStatsPublished |
Publishing is complete. |
AliEngineSubscribeState
The subscription state.
|
Value |
Description |
|
AliEngineStatsSubscribeIdle |
Initial state |
|
AliEngineStatsNoSubscribe |
Not subscribed |
|
AliEngineStatsSubscribing |
Subscribing |
|
AliEngineStatsSubscribed |
Subscribed |
AliEngineUserOfflineReason
The reason a user goes offline.
|
Value |
Description |
|
AliEngineUserOfflineQuit |
The user leaves voluntarily. |
|
AliEngineUserOfflineDropped |
The user is dropped due to a timeout caused by not receiving any packets from the peer for an extended period. |
|
AliEngineUserOfflineBecomeAudience |
The user changes their user role from host to audience. |
AliEngineVideoStreamType
Defines the camera video stream type.
|
Enumerator |
Description |
|
AliEngineVideoStreamTypeNone |
No video stream. |
|
AliEngineVideoStreamTypeHigh |
High stream. |
|
AliEngineVideoStreamTypeLow |
Low stream. |
AliEngineAudioTrack
The audio stream type.
|
Enumerator |
Description |
|
AliEngineAudioTrackNo |
No audio stream. |
|
AliEngineAudioTrackMic |
The microphone audio stream. |
AliEngineNetworkQuality
Defines the network quality.
|
Value |
Description |
|
AliEngineNetworkQualityExcellent |
Smoothness and clarity are optimal. |
|
AliEngineNetworkQualityGood |
Smoothness and clarity are nearly optimal. |
|
AliEngineNetworkQualityPoor |
Audio and video smoothness and clarity are slightly impaired, but communication is unaffected. |
|
AliEngineNetworkQualityBad |
Significant video stuttering occurs, but audio communication is still possible. |
|
AliEngineNetworkQualityVeryBad |
Audio and video are severely impaired, making communication nearly impossible. |
|
AliEngineNetworkQualityDisconnect |
The network is interrupted. |
|
AliEngineNetworkQualityUnknown |
The network quality is unknown. |
AliEngineVideoEncoderOrientationMode
Specifies the video output orientation.
|
Parameter |
Description |
|
AliEngineVideoEncoderOrientationModeAdaptive |
0: Adaptive mode. The output orientation matches the capture orientation. |
|
AliEngineVideoEncoderOrientationModeFixedLandscape |
1: Portrait mode. The SDK publishes a portrait stream. The output width is set to the lesser of the configured resolution's width and height, and the output height is set to the greater. |
|
AliEngineVideoEncoderOrientationModeFixedPortrait |
2: Landscape mode. The SDK publishes a landscape stream. The output width is set to the greater of the configured resolution's width and height, and the output height is set to the lesser. |
AliEngineRenderMode
Specifies the render mode.
|
Parameter |
Description |
|
AliEngineRenderModeAuto |
The SDK automatically selects a render mode. |
|
AliEngineRenderModeStretch |
Stretches the video to fill the view. The video aspect ratio is not preserved. |
|
AliEngineRenderModeFill |
Scales the video to fit the view while preserving its aspect ratio. Black bars may be added to fill any empty space. |
|
AliEngineRenderModeCrop |
Scales the video to fill the view while preserving the video aspect ratio. Any overflow is cropped. |
|
AliEngineRenderModeNoChange |
Maintains the previous display mode. |
AliEngineRenderMirrorMode
Specifies the mirror mode.
|
Value |
Description |
|
AliEngineRenderMirrorModeOnlyFrontMirror |
Mirrors the local preview from the front camera. Other video views remain unmirrored. |
|
AliEngineRenderMirrorModeAllMirror |
Mirrors all video views. |
|
AliEngineRenderMirrorModeAllNoMirror |
Does not mirror any video views. |
AliEngineRotationMode
Specifies the rotation angle.
|
Value |
Description |
|
AliEngineRotationModeNoChange |
Keeps the previous rotation angle. |
|
AliEngineRotationMode_0 |
Applies no rotation. |
|
AliEngineRotationMode_90 |
Rotates by 90 degrees. |
|
AliEngineRotationMode_180 |
Rotates by 180 degrees. |
|
AliEngineRotationMode_270 |
Rotates by 270 degrees. |
AliEngineLogLevel
Specifies the log level.
|
Enumerator |
Description |
|
AliEngineLogLevelInfo |
Logs informational messages about the application's general flow. |
|
AliEngineLogLevelWarn |
Logs warnings about potentially harmful situations or non-critical errors. |
|
AliEngineLogLevelError |
Logs errors that allow the application to continue running. |
|
AliEngineLogLevelFatal |
Logs severe errors that are likely to cause the application to terminate. |
|
AliEngineLogLevelNone |
Disables all log output. |
AliEngineAudioNumChannelType
The audio channel type.
|
Enumerator |
Description |
|
AliEngineMonoAudio |
Mono audio. |
|
AliEngineStereoAudio |
Stereo audio. |
AliEngineAudioSampleRate
Specifies the audio sample rate.
|
Value |
Description |
|
AliEngineAudioSampleRate_8000 |
An 8,000 Hz sample rate. |
|
AliEngineAudioSampleRate_11025 |
An 11,025 Hz sample rate. |
|
AliEngineAudioSampleRate_16000 |
A 16,000 Hz sample rate. |
|
AliEngineAudioSampleRate_22050 |
A 22,050 Hz sample rate. |
|
AliEngineAudioSampleRate_32000 |
A 32,000 Hz sample rate. |
|
AliEngineAudioSampleRate_44100 |
A 44,100 Hz sample rate. |
|
AliEngineAudioSampleRate_48000 |
A 48,000 Hz sample rate. |
AliEngineRecordType
Specifies the recording type.
|
Value |
Description |
|
AliEngineRecordTypeAudio |
An audio-only recording. |
|
AliEngineRecordTypeVideo |
A single audio/video recording. |
|
AliEngineRecordTypeBoth |
Audio-only and audio/video recordings. |
AliEngineRecordFormat
Specifies the recording format.
|
Value |
Description |
|
AliEngineRecordFormatAAC |
An AAC file. |
|
AliEngineRecordFormatWAV |
A WAV file. |
|
AliEngineRecordFormatMP4 |
An MP4 file. |
AliEngineAudioQuality
Specifies the audio quality of recorded audio files.
|
Value |
Description |
|
AliEngineAudioQualityLow |
Low audio quality. |
|
AliEngineAudioQualityMedium |
Medium audio quality. |
|
AliEngineAudioQualityHigh |
High audio quality. |
AliEngineVideoQuality
Specifies the video quality of recorded video files.
|
Enum name |
Description |
|
AliEngineVideoQualityDefault |
Default. The recorded video quality matches the video capture quality. (Mobile clients do not support video recording.) |
AliEngineAudioProfile
An enumeration of audio quality modes.
|
Parameter |
Description |
|
AliEngineLowQualityMode |
Low-quality audio. |
|
AliEngineBasicQualityMode |
Standard-quality audio. |
|
AliEngineHighQualityMode |
High-quality audio. |
|
AliEngineStereoHighQualityMode |
High-quality stereo audio. |
|
AliEngineSuperHighQualityMode |
Super-high-quality audio. |
|
AliEngineStereoSuperHighQualityMode |
Super-high-quality stereo audio. |
AliEngineAudioScenario
Specifies the audio scenario.
|
Value |
Description |
|
AliEngineSceneDefaultMode |
The default scenario for general-purpose audio and video communication. |
|
AliEngineSceneEducationMode |
The education scenario. This mode prioritizes audio continuity and stability. |
|
AliEngineSceneMediaMode |
The media scenario. This mode preserves the natural quality of human voices and music. Ideal for interactive live streaming. |
|
AliEngineSceneMusicMode |
The music scenario. This mode delivers high-fidelity audio, making it ideal for applications with strict music quality requirements, such as online instrument lessons. |
|
AliEngineSceneChatRoomMode |
The chat room scenario, suitable for chat applications where users frequently go on and off mic. The volume control always adjusts the in-call volume. |
|
AliEngineSceneShowRoomMode |
The showroom scenario. Suitable for single-host live streaming that requires high-quality audio. |
AliEngineMuteLocalAudioMode
Modes for muting local audio.
|
Parameter |
Description |
|
AliEngineMuteLocalAudioModeDefault |
The default mode. Equivalent to |
|
AliEngineMuteLocalAudioModeMuteAll |
Mutes all local audio, including the microphone and external audio input. |
|
AliEngineMuteLocalAudioModeMuteOnlyMic |
Mutes only the microphone; external audio input is not affected. |
AliEngineRecordAudioConfig
Configures audio file recording.
|
Parameter |
Type |
Description |
|
sampleRate |
Specifies the audio sample rate. |
|
|
quality |
Specifies the audio quality. |
|
|
externalPcmCaptureRecording |
bool |
Indicates whether to record audio data from an external PCM capture source. |
|
externalPcmRenderRecording |
bool |
Indicates whether to record audio data from an external PCM render source. |
AliEngineRecordVideoConfig
Video recording settings.
|
Parameter |
Type |
Description |
|
quality |
Video quality. |
|
|
fps |
int |
Frame rate. |
|
bitrate |
int |
Bitrate. |
|
sourceType |
Video recording source. |
|
|
canvas |
Video recording resolution settings. |
AliEngineVideoRecordCanvasConfig
Specifies the recording video resolution.
|
Parameter |
Type |
Description |
|
canvasWidth |
int |
The width of the recording video, in pixels. |
|
canvasHeight |
int |
The height of the recording video, in pixels. |
AliEngineRecordVideoLayoutMode
Defines the video recording layout.
|
Enum name |
Description |
|
AliEngineRecordVideoLayoutModeGrid |
Grid layout. |
|
AliEngineRecordVideoLayoutModeSpeaker |
Speaker layout. |
|
AliEngineRecordVideoLayoutModeUnique |
Single-frame layout. |
|
AliEngineRecordVideoLayoutModeCustom |
Custom layout. |
AliEngineRecordVideoBgColor
The background color of the video recording.
|
Parameter |
Type |
Description |
|
r |
unsigned char |
Red component |
|
g |
unsigned char |
Green component |
|
b |
unsigned char |
Blue component |
AliEngineRecordVideoRegion
Configures a user's video region in a recording layout.
|
Parameter |
Type |
Description |
|
userId |
char* |
The user ID. |
|
sourceType |
The video source type. |
|
|
area |
The rectangular area on the canvas for the user's video. |
AliEngineRecordVideoRectangle
Specifies the coordinates and dimensions of the video recording rectangle.
|
Parameter |
Type |
Description |
|
left |
The x-coordinate of the top-left corner of the rectangle, expressed as a fraction of the total video width. |
|
|
top |
The y-coordinate of the top-left corner of the rectangle, expressed as a fraction of the total video height. |
|
|
width |
The width of the rectangle, expressed as a fraction of the total video width. |
|
|
height |
The height of the rectangle, expressed as a fraction of the total video height. |
AliEngineRecordVideoRational
A rational number representing video recording coordinates.
|
Parameter |
Type |
Description |
|
numerator |
unsigned int |
The numerator of the rational number. |
|
denominator |
unsigned int |
The denominator of the rational number. |
AliEngineRecordTemplate
Defines the settings for a recording template.
|
Parameter |
Type |
Description |
|
recordType |
The recording type. |
|
|
recordFormat |
The recording format. |
|
|
sampleRate |
The audio sample rate. |
|
|
audioQuality |
The audio quality. |
|
|
externalPcmCaptureRecording |
bool |
Indicates whether to mix and record audio from an external PCM capture source. |
|
externalPcmRenderRecording |
bool |
Indicates whether to mix and record rendered audio from an external PCM input. |
|
canvas |
The settings for the video recording canvas. |
|
|
fps |
int |
The frame rate. |
|
bitrate |
int |
The bitrate. |
|
isFragment |
bool |
Whether to record as fragmented MP4 files. Defaults to |
AliEngineDeviceInfo
Contains device information.
|
Parameter |
Type |
Description |
|
deviceName |
String |
The device name. |
|
deviceID |
String |
The device ID. |
|
deviceTransportType |
The device transport type. |
AliEngineBeautyConfig
Configures basic beauty effects.
|
Parameter |
Type |
Description |
|
whiteningLevel |
float |
Specifies the whitening level. The valid range is [0.0, 1.0]. The higher the value, the stronger the effect. |
|
smoothnessLevel |
float |
Specifies the smoothing level. The valid range is [0.0, 1.0]. The higher the value, the stronger the effect. |
AliEngineOnByeType
Specifies why a user leaves or is removed from a channel.
|
Member |
Description |
|
AliEngineOnByeBeKickOut |
The user was kicked out. |
|
AliEngineOnByeChannelTerminated |
The user had to leave because the channel was terminated. |
|
AliEngineOnByeUserReplaced |
The user's session on this device was terminated because the same user ID joined the channel from another device. |
AliEngineAudioEffectVoiceChangerMode
Specifies the voice changer mode.
|
Value |
Description |
|
AliEngineAudioEffectVoiceChangerOff |
Disables the voice changer effect. |
|
AliEngineAudioEffectVoiceChangerOldMan |
An old man voice. |
|
AliEngineAudioEffectVoiceChangerBabyBoy |
A baby boy voice. |
|
AliEngineAudioEffectVoiceChangerBabGirl |
A baby girl voice. |
|
AliEngineAudioEffectVoiceChangerRobot |
A robot voice. |
|
AliEngineAudioEffectVoiceChangerDaimo |
A demon voice. |
|
AliEngineAudioEffectVoiceChangerKTV |
A KTV (karaoke) reverberation. |
|
AliEngineAudioEffectVoiceChangerEcho |
An echo effect. |
AliEngineAudioEffectReverbMode
Specifies the audio effect reverb mode.
|
Enumerator |
Description |
|
AliEngineAudioEffectReverbOff |
Off |
|
AliEngineAudioEffectReverbVocal_I |
Vocal I |
|
AliEngineAudioEffectReverbVocal_II |
Vocal II |
|
AliEngineAudioEffectReverbBathroom |
Bathroom |
|
AliEngineAudioEffectReverbSmallRoomBright |
Small Room Bright |
|
AliEngineAudioEffectReverbSmallRoomDark |
Small Room Dark |
|
AliEngineAudioEffectReverbMediumRoom |
Medium Room |
|
AliEngineAudioEffectReverbLargeRoom |
Large Room |
|
AliEngineAudioEffectReverbChurchHall |
Church Hall |
AliEngineAudioEffectReverbParamType
The available reverb parameter types.
|
Parameter |
Description |
|
AliEngineAudioEffectReverbRoomSize |
Specifies the room size. Range: [0, 100]. |
|
AliEngineAudioEffectReverbPreDelay |
Specifies the pre-delay, in milliseconds (ms). Range: [0, 200]. |
|
AliEngineAudioEffectReverbReverberance |
Specifies the reverberance. Range: [0, 100]. |
|
AliEngineAudioEffectReverbHfDamping |
Specifies the high-frequency damping. Range: [0, 100]. |
|
AliEngineAudioEffectReverbToneLow |
Specifies the low tone. Range: [0, 100]. |
|
AliEngineAudioEffectReverbToneHigh |
Specifies the high tone. Range: [0, 100]. |
|
AliEngineAudioEffectReverbDryGain |
Specifies the dry gain. Range: [-20, 10]. |
|
AliEngineAudioEffectReverbWetGain |
Specifies the wet gain. Range: [-20, 10]. |
AliEngineVideoCanvas
The render canvas.
|
Parameter |
Type |
Description |
|
displayView |
void * |
The render view. Cannot be |
|
renderMode |
The render mode. Defaults to |
|
|
mirrorMode |
The mirror mode. Defaults to |
|
|
backgroundColor |
int |
The background color in |
|
rotationMode |
The rotation mode. Defaults to no rotation. |
|
|
renderId |
int |
The render ID. |
|
width |
int |
The width of the video. |
|
height |
int |
The height of the video. |
|
scaleMode |
The scale mode. Defaults to |
AliEngineLiveTranscodingErrorCode
Error codes for side-stream publishing.
|
Parameter |
Description |
|
AliEngineLiveTranscodingErrorPublishOk |
Publishing successful. |
|
AliEngineLiveTranscodingErrorStreamNotFound |
Error: Stream not found. |
|
AliEngineLiveTranscodingErrorStreamAlreadyExist |
Error: The destination stream already exists. |
|
AliEngineLiveTranscodingErrorInvalidParam |
Error: Invalid parameter. |
|
AliEngineLiveTranscodingErrorInternalError |
Error: Internal error. |
|
AliEngineLiveTranscodingErrorRtmpServerError |
Error: RTMP server error. |
|
AliEngineLiveTranscodingErrorRtmpStreamUrlError |
Error: Stream URL error. |
|
AliEngineLiveTranscodingErrorPublishTimeout |
Error: Publish timeout. |
|
AliEngineLiveTranscodingErrorNotAuthorized |
Error: Operation not authorized. |
AliEngineWaterMarkConfig
Configures the image watermark.
|
Parameter |
Type |
Description |
|
visibleInPreview |
bool |
Specifies whether the watermark is visible in the local preview. |
|
positionInLandscapeMode |
Specifies the watermark coordinates in landscape mode. |
|
|
positionInPortraitMode |
Specifies the watermark coordinates in portrait mode. |
|
|
alpha |
float |
Specifies the transparency of the watermark. |
|
normalized |
bool |
Specifies whether the watermark coordinates are normalized. |
AliEngineCameraCapturerConfiguration
Defines the preferences for camera capture.
|
Parameter |
Type |
Description |
|
preference |
The capture preference. |
|
|
fps |
int |
The capture frame rate. A default value of -1 means the SDK uses the default configuration of its internal encoder. |
|
cameraCaptureProfile |
Specifies the resolution for video capture. |
|
|
disableVideoCaptureReverse |
int |
Controls whether captured video frames are automatically flipped based on the aspect ratio. -1: Default. 0: Enables automatic flipping. 1: Disables automatic flipping. |
|
captureObserverOriginal |
int |
Controls whether callbacks return the original video frame data. -1: Default. 0: Off. 1: On. |
|
renderMode |
The render mode to use if the camera output resolution does not match the configured resolution. |
AliEngineCameraCaptureProfile
Defines the camera capture resolution.
|
Enumerator |
Description |
|
AliEngineCameraCaptureProfileDefault |
The default profile. The SDK automatically selects a capture resolution that matches the encoding configuration. |
|
AliEngineCameraCaptureProfile1080P |
Captures video at a 1080p resolution. |
AliEngineDisplayMode
An enumeration of display modes for handling an aspect ratio mismatch between the video source and the push stream configuration.
|
Enum name |
Description |
|
AliEngineDisplayMode_Auto |
Auto (Default). Preserves the video's original aspect ratio by using proportional scaling to fit it within the configured streaming dimensions. Note: To preserve the original aspect ratio and content integrity, the actual push streaming resolution may differ from the configured resolution. |
|
AliEngineDisplayMode_FullOf |
Stretch mode. Stretches the video to fill the configured streaming dimensions. This distorts the video. |
|
AliEngineDisplayMode_FillBlack |
Letterbox mode. Preserves the original aspect ratio and scales the video proportionally to fit, then fills the empty space with black bars. |
|
AliEngineDisplayMode_Scale |
Crop mode. Scales the video proportionally to fill the streaming dimensions and crops any excess, resulting in content loss from the edges. |
AliEngineCaptureOutputPreference
Specifies the camera capture preference.
|
Enumerator |
Description |
|
AliEngineCaptureOutputPreferenceAuto |
Automatically adjusts the camera output parameters. |
|
AliEngineCaptureOutputPreferencePerformance |
Prioritizes device performance. The SDK selects camera output parameters that most closely match the settings specified in |
|
AliEngineCaptureOutputPreferencePreview |
Prioritizes video preview quality by selecting higher camera output parameters. |
AliEngineFrameRate
Specifies the video encoding frame rate.
|
Parameter |
Description |
|
AliEngineFrameRateFps5 |
5 FPS |
|
AliEngineFrameRateFps10 |
10 FPS |
|
AliEngineFrameRateFps15 |
15 FPS |
|
AliEngineFrameRateFps20 |
20 FPS |
|
AliEngineFrameRateFps30 |
30 FPS |
AliEngineVideoEncoderBitrate
Video encoding bitrate.
|
Enum name |
Description |
|
AliEngineVideoStandardBitrate |
Standard bitrate mode. |
AliEngineVideoMirrorMode
The encoded video mirror mode.
|
Parameter |
Description |
|
AliEngineVideoMirrorModeDisabled |
Disables encoded video mirroring. |
|
AliEngineVideoMirrorModeEnable |
Enables encoded video mirroring. |
AliEngineVideoEncoderConfiguration
Video encoding preferences.
|
Parameter |
Type |
Description |
|
dimensions |
The video resolution. |
|
|
frameRate |
The frame rate. |
|
|
bitrate |
int |
The bitrate. |
|
keyFrameInterval |
int |
The keyframe interval, in milliseconds. A value of 0 means the SDK controls the keyframe interval. |
|
forceStrictKeyFrameInterval |
bool |
Whether to force the encoder to generate keyframes strictly at the configured keyframe interval. The default value is
|
|
mirrorMode |
The mirror mode for the encoded video. |
|
|
orientationMode |
The orientation mode for the encoded video. |
|
|
rotationMode |
The rotation angle of the video. |
|
|
codecType |
The codec type. |
|
|
encodeCodecType |
AliEngineVideoEncodeCodecType |
The codec type. |
|
seiForceFrontIFrame |
int |
Whether to force an I-frame before sending an SEI message. The default value is |
|
enableDynamicEncode |
int |
Whether to enable dynamic encoding. |
|
disableDipenseResolutionChange |
int |
Whether to disable pre-encoding scaling. |
|
enableDowngrade |
int |
Whether to enable resolution or bitrate downgrade. |
|
enableH264BFrame |
int |
Whether to enable B-frames for H.264 encoding. |
|
enableHevcBFrame |
int |
Whether to enable B-frames for HEVC encoding. |
AliEngineVideoDecoderConfiguration
Contains the settings for video decoding.
|
Parameter |
Type |
Description |
|
codecType |
Specifies the codec type, such as software decoding and hardware decoding. Defaults to |
|
|
enableHardwareDecoderBframe |
int |
Enables or disables B-frame support for the hardware decoder. If the sender's stream contains B-frames, you must enable this option; otherwise, decoding will fail. The default is -1. Set to |
AliEngineVideoCodecType
Specifies the video codec type.
|
Value |
Description |
|
AliEngineVideoCodecTypeDefault |
Not set. Uses the system default. |
|
AliEngineVideoCodecTypeSoftware |
Software video codec. |
|
AliEngineVideoCodecTypeHardware |
Hardware video codec. |
|
AliEngineVideoCodecTypeHardwareTexture |
Hardware texture codec. |
AliEngineScreenShareEncoderConfiguration
The encoding configuration for screen sharing.
|
Parameter |
Type |
Description |
|
dimensions |
The video resolution. |
|
|
frameRate |
The frame rate. |
|
|
bitrate |
int |
The bitrate. |
|
rotationMode |
The rotation mode. |
|
|
keyFrameInterval |
int |
The keyframe interval, in milliseconds. The default value is 0, which lets the SDK control the keyframe interval. |
|
forceStrictKeyFrameInterval |
bool |
Specifies whether to force the encoder to generate keyframes strictly at the configured keyframe interval. The default value is
|
AliEngineScreenShareConfig
Configuration for screen sharing.
|
Parameter |
Type |
Description |
|
isShareByRegion |
bool |
Whether to share a specific region of the screen. |
|
shareRegion |
Layout information for the shared region. This parameter is valid only when |
|
|
isPushStream |
bool |
Whether to push the video stream while previewing. |
AliEngineScreenShareRegion
The screen sharing region.
|
Parameter |
Type |
Description |
|
originX |
float |
X-coordinate of the top-left corner of the shared region. |
|
originY |
float |
Y-coordinate of the top-left corner of the shared region. |
|
width |
float |
Width of the shared region. |
|
height |
float |
Height of the shared region. |
AliEngineScreenSourceInfo
Represents a screen sharing source.
|
Parameter |
Type |
Description |
|
sourceId |
String |
The unique identifier of the sharing source. |
|
sourceName |
String |
The name of the sharing source. |
|
sourceIsSelf |
bool |
Specifies whether the sharing source is the SDK caller. |
AliEngineScreenShareInfo
Screen share configuration.
|
Parameter |
Type |
Description |
|
shareType |
Specifies the share type. |
|
|
shareSourceId |
unsigned int |
Specifies the ID of the share source. |
|
shareConfig |
Specifies the screen share configuration. |
AliEngineScreenShareType
The type of screen sharing source.
|
Parameter |
Description |
|
AliEngineScreenShareDesktop |
The entire desktop. |
|
AliEngineScreenShareWindow |
A specific application window. |
AliEngineAuthInfo
Authentication information.
|
Parameter |
Type |
Description |
|
channelId |
char* |
The channel ID. |
|
userId |
char* |
The user ID. |
|
appId |
char* |
The app ID. |
|
nonce |
char* |
The nonce. |
|
token |
char* |
The token. |
|
gslb |
char** |
An array of GSLB addresses. |
|
session |
char* |
The session ID (optional). |
|
role |
char* |
The role (optional). |
|
timestamp |
long long |
The timestamp. |
|
gslbCount |
int |
The number of elements in the gslb array. |
|
agent |
char** |
An array of agent addresses. |
|
agentCount |
int |
The number of elements in the agent array. |
|
tokenType |
char* |
The token type (optional). |
AliEngineVideoSource
The raw video data source type.
|
Parameter |
Description |
|
AliEngineVideoSourceCamera |
Video stream |
|
AliEngineVideoSourceScreenShare |
Screen share stream |
AliEngineAudioSource
Specifies the source of the raw audio data.
|
Value |
Description |
|
AliEngineAudioSourceCaptured |
Raw audio data captured from the local device. |
|
AliEngineAudioSourceProcessCaptured |
Audio data after 3A processing. |
|
AliEngineAudioSourcePub |
Audio data for stream publishing. |
|
AliEngineAudioSourcePlayback |
Audio data for playback. |
|
AliEngineAudioSourceRemoteUser |
Remote audio data from a stream subscription. |
|
AliEngineAudioSourceMixedAll |
Mixed audio data from publishing and playback streams. |
AliEngineBufferType
Specifies the video data type.
|
Parameter |
Description |
|
AliEngineBufferTypeRawData |
YUV raw data. |
|
AliEngineBufferTypeTexture |
CVPixelBuffer data. |
AliEngineErrorCode
Error codes.
|
Enum 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 parameter. |
|
AliEngineErrorMicOpenFail |
Failed to initialize the audio capture device. |
|
AliEngineErrorSpeakerOpenFail |
Failed to initialize the audio playback device. |
|
AliEngineErrorMicInterrupt |
An exception occurred during audio capture. |
|
AliEngineErrorSpeakerInterrupt |
An exception occurred during audio playback. |
|
AliEngineErrorMicAuthFail |
The microphone is not authorized. |
|
AliEngineErrorMicNotAvailable |
No audio capture device is available. |
|
AliEngineErrorSpeakerNotAvailable |
No audio playback device is available. |
|
AliEngineErrorCameraOpenFail |
Failed to initialize the video capture device. |
|
AliEngineErrorCameraInterrupt |
An exception occurred during video capture. |
|
AliEngineErrorVideoDisplayOpenFail |
Failed to initialize the rendering device. |
|
AliEngineErrorVideoDisplayInterrupt |
An exception occurred during rendering. |
|
AliEngineErrorIceConnectionConnectFail |
Failed to establish a media channel. |
|
AliEngineErrorIceConnectionReconnectFail |
Failed to reconnect the media channel. |
|
AliEngineErrorIceConnectionHeartbeatTimeout |
Signaling heartbeat timeout. |
|
AliEngineErrorPublishInvaild |
Invalid publishing operation. |
|
AliEngineErrorPublishNotJoinChannel |
Publishing failed because the user is not in a channel. |
|
AliEngineErrorPublishAudioStreamFailed |
Failed to publish the audio stream. |
|
AliEngineErrorPublishVideoStreamFailed |
Failed to publish the video stream. |
|
AliEngineErrorPublishDualStreamFailed |
Failed to publish the dual stream. |
|
AliEngineErrorPublishScreenShareFailed |
Failed to publish the screen sharing stream. |
|
AliEngineErrorPublishScreenShareConfigError |
Invalid screen sharing configuration. |
|
AliEngineErrorSubscribeInvaild |
The subscription is invalid. |
|
AliEngineErrorSubscribeNotJoinChannel |
Subscription failed because the user is not in a channel. |
|
AliEngineErrorSubscribeAudioStreamFailed |
Failed to subscribe to the audio stream. |
|
AliEngineErrorSubscribeVideoStreamFailed |
Failed to subscribe to the video stream. |
|
AliEngineErrorSubscribeDualStreamFailed |
Failed to subscribe to the dual stream. |
|
AliEngineErrorSubscribeScreenShareFailed |
Failed to subscribe to the screen sharing stream. |
|
AliEngineErrorLowLatencyLiveCommunicationFail |
Signaling failed for low-latency real-time communication. |
|
AliEngineErrorLowLatencyLiveMediaSettingFail |
Invalid media settings for low-latency real-time communication. |
|
AliEngineErrorLowLatencyLiveNoneBroadcaster |
No broadcaster is publishing a stream in low-latency real-time communication mode. |
|
AliEngineErrorLowLatencyLiveNeedRestart |
An error occurred in low-latency real-time communication. The application must create a new SDK instance. |
|
AliEngineErrorLowLatencyLiveNeedRestartAgainLater |
An error occurred in low-latency real-time communication. The application must wait for a custom interval before creating a new SDK instance. |
|
AliEngineErrorLowLatencyLiveServiceUnavailable |
The low-latency real-time communication service is unavailable or has been downgraded. |
|
AliEngineErrorLowLatencyLiveMediaConnectionInterrruption |
A network interruption occurred during low-latency real-time communication. |
|
AliEngineErrorInvaildState |
Invalid SDK state. |
|
AliEngineErrorSessionRemoved |
The session has been removed. |
|
AliEngineErrorInvaildArgument |
Invalid argument. |
|
AliEngineErrorAudioBufferFull |
The audio buffer queue is full. This error occurs when providing external raw data. |
|
AliEngineErrorVideoBufferFull |
The video buffer queue is full. This error occurs when providing external raw data. |
|
AliEngineErrorUpdateRoleChannel |
Failed to set the role in interactive mode. |
|
AliEngineErrorInner |
An internal error occurred. |
AliEngineVideoObserAlignment
Specifies the video output width alignment.
|
Enum name |
Description |
|
AliEngineAlignmentDefault |
Maintains the original video width (default). |
|
AliEngineAlignmentEven |
Ensures the width is an even number. |
|
AliEngineAlignment4 |
Ensures the width is a multiple of 4. |
|
AliEngineAlignment8 |
Ensures the width is a multiple of 8. |
|
AliEngineAlignment16 |
Ensures the width is a multiple of 16. |
AliEngineShowDebugViewType
Specifies which dashboard to display.
|
Enumerator |
Description |
|
AliEngineShowTypeNone |
Does not display a dashboard. |
|
AliEngineShowTypeAudio |
Displays the audio dashboard. |
|
AliEngineShowTypeVideo |
Displays the video dashboard. |
|
AliEngineShowTypeNetwork |
Displays the network dashboard. |
|
AliEngineShowTypeAll |
Displays all available dashboards. |
AliEngineTrascodingPublishTaskStatus
The status of a sideload streaming task.
|
Value |
Description |
|
AliEngineTrascodingPublishTaskStatusStart |
The task has started. |
|
AliEngineTrascodingPublishTaskStatusUpdate |
The task is updating. |
|
AliEngineTrascodingPublishTaskStatusStop |
The task has stopped. |
DisplayType
The image display type for sideload live streaming.
|
Parameter |
Description |
|
NOT_DISPLAY |
Not displayed. |
|
ALWAYS |
Always displayed. |
|
WHEN_NO_VIDEO |
Displayed only when video is unavailable. |
AliEngineLiveTranscodingFontType
Defines the font type for text in sideload live streaming.
|
Value |
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
Specifies the segmentation type for sideload live streaming.
|
Parameter |
Description |
|
AliEngineLiveTranscodingNoBody |
Disables portrait segmentation. |
|
AliEngineLiveTranscodingBody |
Enables portrait segmentation. |
AliEngineLiveTranscodingSourceType
The source for the live transcoding stream.
|
Value |
Description |
|
AliEngineLiveTranscodingCamera |
The camera feed. |
|
AliEngineLiveTranscodingShareScreen |
The shared screen feed. |
AliEngineVideoState
The state of the video stream.
|
Enum name |
Description |
|
AliEngineVideoClose |
The video stream is closed. |
|
AliEngineVideoOpen |
The video stream is open. |
AliEngineVideoReason
The reason for the video stream state change.
|
Enum name |
Description |
|
AliEngineVideoChangeByClient |
The client initiated the state change. |
|
AliEngineVideoChangeByServer |
The server initiated the state change. |
AliEngineLiveTranscodingCropMode
The crop mode for live stream transcoding.
|
Value |
Description |
|
AliEngineLiveTranscodingCrop |
Scales the video to fill the view while preserving its aspect ratio. Crops the video if its aspect ratio differs from the view's. |
|
AliEngineLiveTranscodingFill |
Scales the video to fit within the view while preserving its aspect ratio. Fills any empty space with black bars. This is the default value. |
AliEngineLiveTranscodingMediaProcessMode
Specifies the media processing mode for bypass live streaming.
|
Parameter |
Description |
|
AliEngineLiveTranscodingNormal |
Normal mode. |
|
AliEngineLiveTranscodingVirtualBackground |
Virtual background mode. |
AliEngineLiveTranscodingStreamType
Stream types for the server-side live streaming relay.
|
Parameter |
Description |
|
AliEngineLiveTranscodingOrigin |
Relays the original stream. |
|
AliEngineLiveTranscodingAudio |
Relays only the audio stream. |
|
AliEngineLiveTranscodingVideo |
Relays only the video stream. |
AliEngineLiveTranscodingMixMode
Defines the live transcoding mix mode.
|
Value |
Description |
|
AliEngineLiveTranscodingSINGLE |
Indicates the single-stream relay mode. The service relays the original single stream without stream mixing and transcoding. This mode does not require stream mixing and transcoding parameters. |
|
AliEngineLiveTranscodingMIX |
(Default) Indicates the stream mixing and transcoding mode. This mode supports stream mixing and transcoding output. |
AliEngineLiveTranscodingState
The state of live transcoding.
|
Value |
Description |
|
AliEngineLiveTranscodingState_IDLE |
Stream pushing is idle. |
|
AliEngineLiveTranscodingState_CONNECT |
Connecting to the stream-pushing server. |
|
AliEngineLiveTranscodingState_RUNNING |
Stream pushing is in progress. |
|
AliEngineLiveTranscodingState_RECOVERING |
Recovering the stream pushing connection. |
|
AliEngineLiveTranscodingState_FAILURE |
Stream pushing failed. |
|
AliEngineLiveTranscodingState_END |
Stream pushing ended. |
AliEngineLiveTranscodingText
Defines the text overlay for live transcoding.
|
Parameter |
Type |
Description |
|
text |
String |
The text content to display. |
|
x |
int |
The x-coordinate of the text overlay, in pixels. |
|
y |
int |
The y-coordinate of the text overlay, in pixels. |
|
fontType |
The font type for the text overlay. |
|
|
fontSize |
int |
The font size. |
|
zOrder |
int |
The z-order of the text overlay. |
|
fontColor |
int |
The font color. |
AliEngineLiveTranscodingImage
Configures an image overlay for a stream ingest task.
|
Parameter |
Type |
Description |
|
url |
String |
The image URL. |
|
alpha |
float |
The opacity of the image. The range is |
|
display |
Specifies the display mode for the image. |
|
|
x |
int |
The x-coordinate of the image's top-left corner, in pixels. |
|
y |
int |
The y-coordinate of the image's top-left corner, in pixels. |
|
width |
int |
The width of the image, in pixels. |
|
height |
int |
The height of the image, in pixels. |
|
zOrder |
int |
The stacking order (z-order) of the image. |
AliEngineLiveTranscodingUser
Defines the settings for a user's custom pane in a live transcoding task.
|
Parameter |
Type |
Description |
|
x |
int |
The x-coordinate of the top-left corner of the pane, in pixels. |
|
y |
int |
The y-coordinate of the top-left corner of the pane, in pixels. |
|
width |
int |
The width of the pane, in pixels. |
|
height |
int |
The height of the pane, in pixels. |
|
zOrder |
int |
The z-order of the pane. A higher value places the pane on top of panes with lower values. 0 is the bottom-most layer. |
|
userId |
String |
The ID of the user whose stream is displayed in the pane. |
|
sourceType |
The type of the source stream displayed in the pane. |
|
|
segmentType |
Specifies how the pane's content is segmented for live transcoding. |
|
|
images |
AliEngineLiveTranscodingImageArray |
An array of |
|
texts |
AliEngineLiveTranscodingTextArray |
An array of |
AliEngineLiveTranscodingParam
Configurations for bypass live streaming.
|
Parameter |
Type |
Description |
|
mixMode |
The bypass live streaming mode. |
|
|
singleParam |
Parameters for single-stream bypass live streaming. |
|
|
mixParam |
Stream mixing parameters for bypass live streaming. |
AliEngineLiveTranscodingMixParam
Stream mixing parameters for bypass live streaming.
|
Parameter |
Type |
Description |
|
taskProfile |
The billing profile. |
|
|
encodeParam |
The encoding parameters. |
|
|
users |
AliEngineLiveTranscodingUserArray |
A list of users whose streams are to be mixed. |
|
backgroundColor |
int |
The background color of the video canvas. |
|
backgrounds |
AliEngineLiveTranscodingImageArray |
The background images for the video canvas. |
|
watermarks |
AliEngineLiveTranscodingImageArray |
A list of watermarks to overlay on the video. |
|
clockWidgets |
AliEngineLiveTranscodingClockWidgetArray |
A list of clock widgets to display on the video. |
|
cropMode |
The video cropping mode. |
|
|
mediaProcessMode |
The media processing mode. |
AliEngineLiveTranscodingSingleParam
Parameters for a single stream in bypass mode.
|
Parameter |
Type |
Description |
|
userId |
String |
The user ID. |
|
streamType |
The type of the relay stream. |
|
|
sourceType |
The type of the source video stream. |
AliEngineLiveTranscodingTaskProfile
Billing profiles for CDN live streaming.
|
Value |
Description |
|
AliEngineLiveTranscoding_Profile_1IN_1080P |
One input stream, 1080p output. |
|
AliEngineLiveTranscoding_Profile_1IN_720P |
One input stream, 720p output. |
|
AliEngineLiveTranscoding_Profile_1IN_360P |
One input stream, 360p output. |
|
AliEngineLiveTranscoding_Profile_2IN_1080P |
Two input streams, 1080p output. |
|
AliEngineLiveTranscoding_Profile_2IN_720P |
Two input streams, 720p output. |
|
AliEngineLiveTranscoding_Profile_2IN_360P |
Two input streams, 360p output. |
|
AliEngineLiveTranscoding_Profile_4IN_1080P |
Four input streams, 1080p output. |
|
AliEngineLiveTranscoding_Profile_4IN_720P |
Four input streams, 720p output. |
|
AliEngineLiveTranscoding_Profile_4IN_360P |
Four input streams, 360p output. |
|
AliEngineLiveTranscoding_Profile_9IN_1080P |
Nine input streams, 1080p output. |
|
AliEngineLiveTranscoding_Profile_9IN_720P |
Nine input streams, 720p output. |
|
AliEngineLiveTranscoding_Profile_9IN_360P |
Nine input streams, 360p output. |
|
AliEngineLiveTranscoding_Profile_12IN_1080P |
Twelve input streams, 1080p output. |
|
AliEngineLiveTranscoding_Profile_12IN_720P |
Twelve input streams, 720p output. |
|
AliEngineLiveTranscoding_Profile_12IN_360P |
Twelve input streams, 360p output. |
|
AliEngineLiveTranscoding_Profile_16IN_1080P |
Sixteen input streams, 1080p output. |
|
AliEngineLiveTranscoding_Profile_16IN_720P |
Sixteen input streams, 720p output. |
|
AliEngineLiveTranscoding_Profile_16IN_360P |
Sixteen input streams, 360p output. |
|
AliEngineLiveTranscoding_Profile_Mixed |
Audio only. |
AliEngineLiveTranscodingEncodeParam
Encoding parameters for sideload live streaming.
|
Parameter |
Type |
Description |
|
videoWidth |
int |
The width of the output video, in pixels. |
|
videoHeight |
int |
The height of the output video, in pixels. |
|
videoFramerate |
int |
The frame rate of the output video, in frames per second (fps). |
|
videoBitrate |
int |
The bitrate of the output video, in kilobits per second (Kbps). |
|
videoGop |
int |
The GOP size of the output video. |
|
audioSamplerate |
The audio sample rate. |
|
|
audioBitrate |
int |
The audio bitrate. |
|
audioChannels |
int |
The number of audio channels. |
AliEngineLiveTranscodingAudioSampleRate
Specifies the audio sample rate for CDN live streaming.
|
Value |
Description |
|
AliEngineLiveTranscoding_HZ_48000 |
A sample rate of 48,000 Hz |
|
AliEngineLiveTranscoding_HZ_44100 |
A sample rate of 44,100 Hz |
|
AliEngineLiveTranscoding_HZ_32000 |
A sample rate of 32,000 Hz |
|
AliEngineLiveTranscoding_HZ_16000 |
A sample rate of 16,000 Hz |
|
AliEngineLiveTranscoding_HZ_8000 |
A sample rate of 8,000 Hz |
AliEngineLiveTranscodingClockWidget
The clock widget for live transcoding.
|
Parameter |
Type |
Description |
|
x |
int |
The x-coordinate of the top-left corner, in pixels. |
|
y |
int |
The y-coordinate of the top-left corner, in pixels. |
|
fontSize |
int |
The font size. |
|
zOrder |
int |
The z-order. A value of 0 represents the bottom layer, and higher values are rendered on top. |
|
fontColor |
int |
The font color. |
|
fontType |
The font type. |
AliEngineBokehScaleModel
Specifies how the background is scaled in a background replacement effect.
|
Parameter |
Description |
|
AliEngineBokehScaleModelCrop |
Scales the background to fill the view while preserving its aspect ratio. The background is cropped if its aspect ratio differs from that of the view. |
|
AliEngineBokehScaleModelFill |
Scales the background to fit within the view while preserving its aspect ratio, adding black bars to fill any empty space. |
AliEngineAudioAccompanyStateCode
Indicates the playback state of the audio accompaniment.
|
Parameter |
Description |
|
AliEngineAudioAccompanyStarted |
Playback started. |
|
AliEngineAudioAccompanyStopped |
Playback stopped. |
|
AliEngineAudioAccompanyPaused |
Playback paused. |
|
AliEngineAudioAccompanyResumed |
Playback resumed. |
|
AliEngineAudioAccompanyEnded |
Playback ended. |
|
AliEngineAudioAccompanyBuffering |
Buffering. |
|
AliEngineAudioAccompanyBufferingEnd |
Buffering finished. |
|
AliEngineAudioAccompanyFailed |
Playback failed. |
AliEngineAudioAccompanyErrorCode
Lists the error codes for audio accompaniment playback.
|
Enum name |
Description |
|
AliEngineAudioAccompanyNoError |
No error. |
|
AliEngineAudioAccompanyOpenFailed |
Failed to open the file. |
|
AliEngineAudioAccompanyDecodeFailed |
Failed to decode the file. |
AliEngineScreenSourceList
A list of screen sharing sources.
|
Parameter |
Type |
Description |
|
GetCount |
unsigned int |
Gets the number of available screen sharing sources. |
|
GetSourceInfo |
Gets the screen sharing source information at the specified index. |
|
|
Release |
void |
Releases the interface and its associated resources. |
AliEngineInterfaceIdType
Specifies the interface type.
|
Parameter |
Description |
|
AliEngineInterfaceAudioDeviceManager |
Maps to the |
|
AliEngineInterfaceVideoDeviceManager |
Maps to the |
|
AliEngineInterfaceMediaEngine |
Maps to the |
AliEngineVideoCodecKindType
The video codec type.
|
Parameter |
Description |
|
AliEngineVideoEncoderType |
The video encoder. |
|
AliEngineVideoDecoderType |
The video decoder. |
AliEngineDeviceTransportType
Specifies the device connection type.
|
Enumerator |
Description |
|
AliEngineDeviceTransportTypeUnknown |
Unknown device type. |
|
AliEngineDeviceTransportTypeBuiltIn |
Built-in 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 |
DisplayPort device. |
|
AliEngineDeviceTransportTypeAirPlay |
AirPlay device. |
|
AliEngineDeviceTransportTypeAVB |
AVB device. |
|
AliEngineDeviceTransportTypeThunderbolt |
Thunderbolt device. |
AliEngineAudioFrameObserverConfig
Settings for the audio data callback.
|
Parameter |
Type |
Description |
|
sampleRate |
The sample rate for the audio callback. |
|
|
channels |
The number of audio channels for the callback. |
|
|
mode |
Callback mode. |
|
|
userDefinedInfo |
int |
User-defined parameter. For valid values, see |
AliEngineDeviceInfoList
A list of video devices.
|
Method |
Return type |
Description |
|
GetCount |
int |
Returns the number of devices in the list. |
|
GetDeviceInfo |
Returns information for a specified device. |
|
|
Release |
void |
Releases all resources used by the object. |
AliEngineVideoResolutionList
Represents a list of video resolutions.
|
Method |
Return type |
Description |
|
GetCount |
int |
Returns the number of resolutions. |
|
GetResolutionInfo |
Gets the resolution at the specified index. |
|
|
Release |
void |
Releases the object. |
AliEngineVideoRecordSource
The video source for recording.
|
Value |
Description |
|
AliEngineVideoRecordSourceCamera |
Records the camera stream. |
|
AliEngineVideoRecordSourceScreenShare |
Records the screen sharing stream. |
|
AliEngineVideoRecordSourceBoth |
Records the camera and screen sharing streams. |
AliEngineAudioFrameObserverOperationMode
Specifies the operation mode for the audio data callback.
|
Enumerator |
Description |
|
AliEngineAudioFrameObserverOperationModeReadOnly |
Read-only mode. |
|
AliEngineAudioFrameObserverOperationModeWriteOnly |
Write-only mode. |
|
AliEngineAudioFrameObserverOperationModeReadWrite |
Read-write mode. |
AliEngineVideoResolution
Specifies the video resolution.
|
Parameter |
Type |
Description |
|
width |
int |
The video width in pixels. |
|
height |
int |
The video height in pixels. |
AliEngineVideoScale
Specifies the video aspect ratio.
|
Enum name |
Description |
|
AliEngineVideoScale_16_9 |
16:9 |
|
AliEngineVideoScale_4_3 |
4:3 |
AliEngineWaterMarkPosition
Specifies the position and dimensions of the watermark. All coordinates and dimensions are normalized relative to the video frame, where the top-left corner is (0.0, 0.0).
|
Parameter |
Type |
Description |
|
x |
float |
The x-coordinate of the watermark's top-left corner. |
|
y |
float |
The y-coordinate of the watermark's top-left corner. |
|
w |
float |
The width of the watermark. |
|
h |
float |
The height of the watermark. |
AliEngineVideoDimensions
Defines the video resolution.
|
Parameter |
Type |
Description |
|
width |
int |
The video width, in pixels. |
|
height |
int |
The video height, in pixels. |
AliEngineVideoEncodeCodecType
Specifies the video encoding format.
|
Enumerator |
Description |
|
AliEngineVideoEncodeCodecTypeDefault |
The default value. Currently H264. |
|
AliEngineVideoEncodeCodecTypeH264 |
H264 encoding. |
|
AliEngineVideoEncodeCodecTypeHevc |
H265 encoding (HEVC). |
AliEngineChannelParam
Defines user attributes, such as username and type.
|
Parameter |
Type |
Description |
|
userName |
string |
The user's display name. |
|
capabilityProfile |
Specifies user attributes for AI agent call scenarios; the default value is used for all other scenarios. |
AliCapabilityProfile
Specifies the user attribute. This parameter should only be configured for AI agent call scenarios; otherwise, use the default value.
|
Value |
Description |
|
AliCapabilityProfileDefault |
For non-AI agent call scenarios. |
|
AliCapabilityProfileHuman |
The human attribute. |
|
AliCapabilityProfileRobot |
The robot attribute. |
AliEngineAudioAccompanyConfig
Configuration for audio accompaniment playback.
|
Parameter |
Type |
Description |
|
onlyLocalPlay |
bool |
Indicates whether the accompaniment plays only locally. The default value is |
|
replaceMic |
bool |
Indicates whether the accompaniment replaces the microphone audio stream. The default value is |
|
loopCycles |
int |
The loop count. Valid values are |
|
startPosMs |
long |
The start position for playback, in milliseconds (ms). The default value is |
|
publishVolume |
int |
The publish volume. The valid range is [0, 100]. The default value is |
|
playoutVolume |
int |
The playback volume. The valid range is [0, 100]. The default value is |
AliEngineVideoPipelineMirrorMode
Specifies the video mirror mode.
|
Parameter |
Description |
|
AliEngineVideoPipelineMirrorModeNoMirror |
Disables mirroring for the local preview and published stream. |
|
AliEngineVideoPipelineMirrorModeBothMirror |
Enables mirroring for the local preview and published stream. |
|
AliEngineVideoPipelineMirrorModeOnlyPreviewMirror |
Enables mirroring for the local preview only. |
|
AliEngineVideoPipelineMirrorModeOnlyPublishMirror |
Enables mirroring for the published stream only. |
AliEngineCapturePipelineScaleMode
Specifies when video scaling occurs.
|
Value |
Description |
|
AliEngineCapturePipelineScaleModePre |
Scales the video immediately after it is captured. (Default) |
|
AliEngineCapturePipelineScaleModePost |
Scales the video during the encoding process. |
AliEngineDataChannelMsg
A message sent through a data channel.
|
Parameter |
Type |
Description |
|
type |
AliEngineDataMsgType |
The message type. |
|
networkTime |
long long |
The timestamp. |
|
progress |
int |
Applies only to |
|
data |
void* |
A pointer to the message content, which can be any type of data such as text or images. |
|
dataLen |
int |
The length of the message, in bytes. |
AliEngineDataMsgType
Specifies the data channel message type.
|
Parameter |
Description |
|
AliEngineDataChannelNone |
No message. |
|
AliEngineDataChannelProgress |
For use in KTV scenarios. |
|
AliEngineDataChannelCustom |
A general-purpose message type. Recommended for all other scenarios. |
AliEngineAudioFileInfo
Provides information about an audio file.
|
Parameter |
Type |
Description |
|
filePath |
const char* |
The path to the audio file. |
|
durationMs |
long |
The duration of the audio file, in milliseconds. |
AliEngineLocalAudioStateType
Defines the state of local audio capture.
|
Enum |
Description |
|
AliEngineLocalAudioStateTypeStarting |
Local audio capture is starting. |
|
AliEngineLocalAudioStateTypeStarted |
Local audio capture has started. |
|
AliEngineLocalAudioStateTypeStopping |
Local audio capture is stopping. |
|
AliEngineLocalAudioStateTypeStopped |
Local audio capture is stopped. |
AliEngineLocalVideoStateType
State of the local video capture.
|
Value |
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. |
AliRtcAudioEffectBeautifyMode
Defines the available audio beautification modes.
|
Value |
Description |
|
AliRtcSdk_AudioEffect_Beautify_Off |
Disables the audio beautification effect. |
|
AliEngineAudioEffectVigorous |
Vigorous effect. |
|
AliEngineAudioEffectRinging |
Ringing effect. |
AliRtcAudioEffectEqualizationBandFrequency
Specifies the center frequencies for audio equalizer bands.
|
Enumeration constant |
Description |
|
|
AliRtcSdk_AudioEffect_EqualizationBand31 |
31 Hz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand62 |
62 Hz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand125 |
125 Hz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand250 |
250 Hz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand500 |
500 Hz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand1K |
1 kHz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand2K |
2 kHz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand4K |
4 kHz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand8K |
8 kHz |
|
|
AliRtcSdk_AudioEffect_EqualizationBand16K |
16 kHz |
|