ApsaraVideo Live:Data structures

Parameter

Type

Description

uid

String

The UID of the current user. Valid values:

• 0: The local user.

• 1: The remote mixed stream.

• Other values: A remote user.

volume

int

The volume in the current callback.

speech_state

bool

• true: The user is speaking.

• false: The user is not speaking.

sumVolume

int

The accumulated volume within the callback period. This is used to identify the current speaker. The value ranges from 0 to 255.

Parameter

Type

Description

dataPtr

void*

Audio data.

numOfSamples

int

The number of samples (for a single channel).

bytesPerSample

int

The number of bytes per sample.

numOfChannels

int

The number of sound channels.

samplesPerSec

int

The number of samples per second.

Parameter

Type

Description

format

AliEngineVideoFormat

Video data type.

type

AliEngineBufferType

Video data type.

dataLength

int

Data size.

pixelBuffer

void*

Pixel buffer data.

dataPtr

void*

YUV data pointer.

dataYPtr

void*

Y-component pointer.

dataUPtr

void*

U-component pointer.

dataVPtr

void*

V-component pointer.

strideY

int

The row stride of the Y-buffer in the YUV data.

strideU

int

The row stride of the U-buffer in the YUV data.

strideV

int

The row 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. Only 0, 90, 180, and 270 are supported.

timeStamp

long long

Timestamp.

Enumeration

Description

AliEngineCommunication

Communication mode.

AliEngineInteractiveLive

Interactive mode.

Enumeration

Description

AliEngineClientRoleInteractive

Streamer role.

AliEngineClientRoleLive

Viewer role.

Parameter

Type

Description

sentKBitrate

long long

Send bitrate.

rcvdKBitrate

long long

Receive bitrate.

sentBytes

long long

Number of bytes sent.

rcvdBytes

long long

Number of bytes received.

systemCpu

unsigned int

System CPU utilization.

appCpu

unsigned int

RTC process CPU utilization.

videoRcvdKBitrate

long long

Video receive bitrate.

videoSentKBitrate

long long

Video send bitrate.

callDuration

unsigned long long

Call duration in seconds.

sentLossRate

long long

Packet loss rate from client to server.

sentLossPkts

long long

Number of lost packets from client to server.

sentExpectedPkts

long long

Total number of packets from client to server.

rcvdLossRate

long long

Downstream packet loss rate from client to server.

rcvdLossPkts

long long

Number of downstream lost packets from client to server.

rcvdExpectedPkts

long long

Total number of downstream packets from client to server.

lastmileDelay

long long

Latency in milliseconds.

availableSendBitrate

long long

Available send bitrate.

Parameter

Type

Description

track

AliEngineVideoTrack

Stream type.

sentBitrate

unsigned int

Publishing bitrate.

sentFps

unsigned int

Publishing 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 (Quantization Parameter) quality of encoding.

Parameter

Type

Description

userId

const char*

Remote user ID.

track

AliEngineVideoTrack

Video stream type.

width

unsigned int

The width of the video frame.

height

unsigned int

The height of the video frame.

decodeFps

unsigned int

Encoder output frame rate.

renderFps

unsigned int

Renderer output frame rate.

frozenTimes

unsigned int

Number of stutters.

Parameter

Type

Description

track

AliEngineAudioTrack

Audio stream type.

scene

AliEngineAudioScenario

Audio scenario.

sentBitrate

unsigned int

Send bitrate.

sentSamplerate

unsigned int

Send sample rate.

numChannel

unsigned int

The number of sound channels.

inputLevel

unsigned int

Input level.

Parameter

Type

Description

userId

const char*

User ID.

track

AliEngineAudioTrack

Audio stream type.

networkTransportDelay

int

Network latency from the audio sender to the receiver in milliseconds.

quality

int

Audio quality.

audioLossRate

int

Audio packet loss rate.

rcvdBitrate

int

Receive bitrate.

totalFrozenTimes

int

Number of stutters.

audioTotalFrozenTime

int

Total duration of audio playback stuttering in milliseconds.

audioTotalFrozenRate

int

Audio playback stuttering rate in percent.

Enumeration

Description

AliEnginePositionPostCapture

Captured data.

AliEnginePositionPreRender

Stream pulling data.

AliEnginePositionPreEncoder

Pre-encoding data.

Enumeration

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

H264.

Enumeration

Description

AliEngineExternalTypeUnknown

Unknown type.

AliEngineExternalTypeAudioCapture

An audio capture device.

AliEngineExternalTypeAudioPlayout

An audio playback device.

AliEngineExternalTypeVideoCapture

Video capture device.

Enumeration Name

Description

AliEngineExternalDeviceAdd

An external device is added.

AliEngineExternalDeviceRemove

An external device is removed.

Enumeration name

Description

AliEngineConnectionInit

Initialization completed.

AliEngineConnectionDisconnected

Network connectivity is lost.

AliEngineConnectionConnecting

Establishing a network connection.

AliEngineConnectionConnected

The network is connected.

AliEngineConnectionReconnecting

Re-establishing network connection.

AliEngineConnectionFailed

Network connectivity failed.

Enumeration name

Description

AliEngineConnectionChangedDummyReason

Unknown reason.

AliEngineConnectionMediaPathChanged

The media channel's path changed.

AliEngineConnectionSignalingHeartbeatTimeout

The heartbeat timeout.

AliEngineConnectionSignalingHeartbeatAlive

Heartbeat resumed.

AliEngineConnectionSignalingHttpdnsResolved

DNS resolution succeeded.

AliEngineConnectionSignalingHttpdnsFailure

DNS parsing failed.

AliEngineConnectionSignalingGslbFailure

The GSLB request failed.

AliEngineConnectionSignalingGslbSuccess

The GSLB request is successful.

AliEngineConnectionSignalingJoinChannelFailure

Failed to join the channel.

AliEngineConnectionSignalingJoinChannelSuccess

Joined the channel successfully.

AliEngineConnectionSignalingLeaveChannel

Leaves the channel.

AliEngineConnectionSignalingConnecting

Establishing a signaling connection.

AliRtcConnectionChangedNetworkInterrupted

The network connection is interrupted.

Enumeration

Description

AliEngineVideoTrackNo

No video stream.

AliEngineVideoTrackCamera

Camera stream.

AliEngineVideoTrackScreen

Screen sharing stream.

AliEngineVideoTrackBoth

Camera and screen sharing.

Enumeration name

Description

AliEngineStatsPublishIdle

Initial status.

AliEngineStatsNoPublish

No stream ingest.

AliEngineStatsPublishing

Stream ingest in progress.

AliEngineStatsPublished

Stream ingestion has started.

Enumeration name

Description

AliEngineStatsSubscribeIdle

Initial status.

AliEngineStatsNoSubscribe

Not subscribed.

AliEngineStatsSubscribing

Subscribing.

AliEngineStatsSubscribed

Subscribed.

Enumeration name

Description

AliEngineUserOfflineQuit

The user left voluntarily.

AliEngineUserOfflineDropped

The user is dropped due to a timeout because no data packets were received for an extended period.

AliEngineUserOfflineBecomeAudience

Triggered when the user switches from a streamer to a viewer.

Enumeration name

Description

AliEngineVideoStreamTypeNone

No video stream.

AliEngineVideoStreamTypeHigh

High-volume stream.

AliEngineVideoStreamTypeLow

Minor stream.

Enumeration

Description

AliEngineAudioTrackNo

No audio stream.

AliEngineAudioTrackMic

Microphone stream.

Enumeration name

Description

AliEngineNetworkQualityExcellent

The network is excellent. The flow and definition are good.

AliEngineNetworkQualityGood

The network is good. Smoothness and definition are comparable to the Excellent level.

AliEngineNetworkQualityPoor

The network is poor. Audio and video have minor quality issues, but communication is not affected.

AliEngineNetworkQualityBad

The network connection is poor. Video stuttering is critical, but audio communication is normal.

AliEngineNetworkQualityVeryBad

The network is extremely poor. Communication is nearly impossible.

AliEngineNetworkQualityDisconnect

The network is disconnected.

AliEngineNetworkQualityUnknown

Unknown reason.

Enumeration name

Description

AliEngineVideoEncoderOrientationModeAdaptive

0: Adaptive. The stream ingest direction matches the capture direction.

AliEngineVideoEncoderOrientationModeFixedLandscape

1: Portrait mode.

In this mode, the SDK ingests a portrait stream. The SDK sets the output video width to the smaller of the configured width and height, and sets the height to the larger.

AliEngineVideoEncoderOrientationModeFixedPortrait

2: Landscape mode.

In this mode, the SDK ingests a landscape stream. The SDK sets the output video width to the larger of the configured width and height, and sets the height to the smaller.

Enumeration name

Description

AliEngineRenderModeAuto

Auto.

AliEngineRenderModeStretch

Stretches the video to fill the view. The aspect ratio is not preserved.

AliEngineRenderModeFill

Scales the video while maintaining the aspect ratio and fills the remaining area with black bars.

AliEngineRenderModeCrop

Scales the video while maintaining the aspect ratio and crops it to fit the view.

AliEngineRenderModeNoChange

Retains the previous display mode.

Enumeration

Description

AliEngineRenderMirrorModeOnlyFrontMirror

Only the front camera preview is mirrored. All other views are not mirrored.

AliEngineRenderMirrorModeAllMirror

All views are mirrored.

AliEngineRenderMirrorModeAllNoMirror

No views are mirrored.

Enumeration name

Description

AliEngineRotationModeNoChange

The rotation angle does not change.

AliEngineRotationMode_0

No rotation.

AliEngineRotationMode_90

Rotate 90 degrees.

AliEngineRotationMode_180

Rotate 180 degrees.

AliEngineRotationMode_270

Rotate 270 degrees.

Enumeration name

Description

AliEngineLogLevelInfo

Normal.

AliEngineLogLevelWarn

Warning.

AliEngineLogLevelError

Error.

AliEngineLogLevelFatal

Critical.

AliEngineLogLevelNone

None.

Enumerator

Description

AliEngineMonoAudio

Mono channel.

AliEngineStereoAudio

Stereo channel.

Enumeration name

Description

AliEngineAudioSampleRate_8000

A sample rate of 8000.

AliEngineAudioSampleRate_11025

The sample rate is 11025.

AliEngineAudioSampleRate_16000

The sample rate is 16000.

AliEngineAudioSampleRate_22050

The sample rate is 22050.

AliEngineAudioSampleRate_32000

The sample rate is 32000.

AliEngineAudioSampleRate_44100

Sample rate 44,100.

AliEngineAudioSampleRate_48000

Sample rate: 48000.

Enumeration name

Description

AliEngineRecordTypeAudio

Audio-only recording.

AliEngineRecordTypeVideo

Record a single audio and video file

AliEngineRecordTypeBoth

Record audio-only and audio-video files

Enumeration name

Description

AliEngineRecordFormatAAC

AAC file.

AliEngineRecordFormatWAV

WAV file.

AliEngineRecordFormatMP4

MP4 file.

Enumeration name

Description

AliEngineAudioQualityLow

Low.

AliEngineAudioQualityMedium

Work in progress.

AliEngineAudioQualityHigh

High.

Enumerator

Description

AliEngineVideoQualityDefault

Matches the video capture quality. This is the default setting. (Video recording is not supported on mobile clients.)

Enumeration name

Description

AliEngineLowQualityMode

Audio low quality mode.

AliEngineBasicQualityMode

Standard sound quality mode.

AliEngineHighQualityMode

High-quality audio mode.

AliEngineStereoHighQualityMode

High-quality stereo mode.

AliEngineSuperHighQualityMode

Ultra-high audio quality mode.

AliEngineStereoSuperHighQualityMode

Ultra-high-quality stereo mode.

Enumeration name

Description

AliEngineSceneDefaultMode

The default scenario. Recommended for general Real-Time Communication scenarios.

AliEngineSceneEducationMode

The education scenario. This mode prioritizes audio continuity and stability.

AliEngineSeneMediaMode

Media scenario. Preserves the quality of human voices and music. Recommended for co-hosted live channels.

AliEngineSceneMusicMode

Recommended for scenarios that require high music quality, such as high-fidelity music playback and musical instrument instruction.

AliEngineSceneChatRoomMode

This scenario is for chat rooms where users frequently turn their microphones on and off. The volume bar always controls the voice call volume.

AliEngineSceneShowRoomMode

The Showroom scenario is for single-streamer broadcasts that require high-quality audio.

Enumeration name

Description

AliEngineMuteLocalAudioModeDefault

Default mode. Mutes all audio, including the microphone and external audio input.

AliEngineMuteLocalAudioModeMuteAll

Mutes all local audio, including the microphone and external audio input.

AliEngineMuteLocalAudioModeMuteOnlyMic

Mutes the microphone only.

Parameter

Type

Description

sampleRate

AliEngineAudioSampleRate

The audio sampling rate.

quality

AliEngineAudioQuality

The audio quality.

externalPcmCaptureRecording

bool

Specifies whether to record captured data from an external PCM input.

externalPcmRenderRecording

bool

Specifies whether to record rendering data from an external PCM input.

Parameter

Type

Description

quality

AliEngineVideoQuality

The video quality.

fps

int

The frame rate.

bitrate

int

The bitrate.

sourceType

AliEngineVideoRecordSource

The data source for recorded videos.

canvas

AliEngineVideoRecordCanvasConfig

Sets the video recording resolution.

Parameter

Type

Description

canvasWidth

int

The width of the recorded video.

canvasHeight

int

The height of the recorded video.

Enumeration name

Description

AliEngineRecordVideoLayoutModeGrid

Grid layout.

AliEngineRecordVideoLayoutModeSpeaker

Speaker layout.

AliEngineRecordVideoLayoutModeUnique

There is only one screen layout.

AliEngineRecordVideoLayoutModeCustom

Custom layout.

Parameter

Type

Description

r

unsigned char

The red component.

g

unsigned char

Green component.

b

unsigned char

Blue component.

Parameter

Type

Description

userId

char*

User information.

sourceType

AliEngineVideoSource

The type of the video source.

area

AliEngineRecordVideoRectangle

The recording area.

Parameter

Type

Description

left

AliEngineRecordVideoRational

The left coordinate.

top

AliEngineRecordVideoRational

The top coordinate.

width

AliEngineRecordVideoRational

The width.

height

AliEngineRecordVideoRational

Height.

Parameter

Type

Description

numerator

unsigned int

The numerator.

denominator

unsigned int

The denominator.

Parameter

Type

Description

recordType

AliEngineRecordType

The record type.

recordFormat

AliEngineRecordFormat

The recording format.

sampleRate

AliEngineAudioSampleRate

The audio sampling rate for recording.

audioQuality

AliEngineAudioQuality

The audio recording quality.

externalPcmCaptureRecording

bool

Specifies whether to mix and record the external audio input.

externalPcmRenderRecording

bool

Specifies whether to mix and record the rendered audio from an external input.

canvas

AliEngineVideoRecordCanvasConfig

The canvas size for video recording.

fps

int

Frame rate.

Bitrate

int

Bitrate.

isFragment

bool

Specifies whether to record segmented MP4 files. The default is true.

Parameter

Type

Description

deviceName

String

The name of the device.

deviceID

String

The ID of the device.

deviceTransportType

AliEngineDeviceTransportType

The transport type for the device.

Parameter

Type

Description

whiteningLevel

float

The whitening level. Valid values: [0, 1]. A larger value produces a stronger whitening effect.

smoothnessLevel

float

The skin smoothing level. Valid values: [0, 1]. A larger value produces a stronger smoothing effect.

Enumeration name

Description

AliEngineOnByeBeKickOut

Kicked out.

AliEngineOnByeChannelTerminated

The channel is terminated. You must leave the meeting.

AliEngineOnByeUserReplaced

The current device is taken offline because the same user ID joined the channel from another device.

Enumeration name

Description

AliEngineAudioEffectVoiceChangerOff

Off.

AliEngineAudioEffectVoiceChangerOldMan

Old man.

AliEngineAudioEffectVoiceChangerBabyBoy

Boy.

AliEngineAudioEffectVoiceChangerBabyGirl

Girl.

AliEngineAudioEffectVoiceChangerRobot

Robot.

AliEngineAudioEffectVoiceChangerDemon

Final Boss.

AliEngineAudioEffectVoiceChangerKTV

KTV.

AliEngineAudioEffectVoiceChangerEcho

Echo.

Enumeration name

Description

AliEngineAudioEffectReverbOff

Off.

AliEngineAudioEffectReverbVocal_I

Vocal I.

AliEngineAudioEffectReverbVocal_II

Vocal II.

AliEngineAudioEffectReverbBathroom

Bathhouse.

AliEngineAudioEffectReverbSmallRoomBright

Bright small channel.

AliEngineAudioEffectReverbSmallRoomDark

Small dark channel.

AliEngineAudioEffectReverbMediumRoom

Medium channel.

AliEngineAudioEffectReverbLargeRoom

Large channel.

AliEngineAudioEffectReverbChurchHall

Church aisle.

Enumeration name

Description

AliEngineAudioEffectReverbRoomSize

The room size. The value ranges from 0 to 100.

AliEngineAudioEffectReverbPreDelay

The pre-delay in ms. The value range is [0, 200].

AliEngineAudioEffectReverbPreDelay

Reverberation: The valid range is 0 to 100.

AliEngineAudioEffectReverbHfDamping

High-frequency damping. The value range is [0, 100].

AliEngineAudioEffectReverbToneLow

The low tone. The value range is [0, 100].

AliEngineAudioEffectReverbToneHigh

Pitch. The value range is [0, 100].

AliEngineAudioEffectReverbDryGain

Dry gain. The value range is [-20, 10].

AliEngineAudioEffectReverbWetGain

Wet gain. The value range is from -20 to 10.

Parameter

Type

Description

displayView

void *

The rendering view. Cannot be nil.

renderMode

AliEngineRenderMode

The rendering mode. The default is AliEngineRenderModeAuto.

mirrorMode

AliEngineRenderMirrorMode

The mirroring mode. The default is AliEngineRenderMirrorModeOnlyFrontMirror.

backgroundColor

int

The background color. The value is an integer in 0xRRGGBB format.

rotationMode

AliEngineRotationMode

The angle to rotate the video. By default, the video is not rotated.

renderId

int

The ID.

width

int

The width.

height

int

Height.

scaleMode

AliEngineVideoScale

The default value for the video aspect ratio is AliEngineVideoScale_16_9.

Enumeration name

Description

AliEngineLiveTranscodingErrorPublishOk

Stream ingest successful.

AliEngineLiveTranscodingErrorStreamNotFound

Error: Stream not found.

AliEngineLiveTranscodingErrorStreamAlreadyExist

Error: The destination stream already exists.

AliEngineLiveTranscodingErrorInvalidParam

Error: Invalid parameter.

AliEngineLiveTranscodingErrorInternalError

Error: Internal error.

AliEngineLiveTranscodingErrorRtmpServerError

Error: RTMP service error.

AliEngineLiveTranscodingErrorRtmpStreamUrlError

Error: URL error.

AliEngineLiveTranscodingErrorPublishTimeout

Error: Task timeout.

AliEngineLiveTranscodingErrorNotAuthorized

Error: Operation not authorized.

Parameter

Type

Description

visibleInPreview

bool

Specifies whether the watermark is locally visible during preview.

positionInLandscapeMode

AliEngineWaterMarkPosition

The coordinates of the watermark in landscape mode.

positionInPortraitMode

AliEngineWaterMarkPosition

The watermark coordinates in portrait mode.

alpha

float

Transparency.

normalized

bool

Indicates whether the data is normalized.

Parameter

Type

Description

preference

AliEngineCaptureOutputPreference

The capture preference.

fps

int

The capture frame rate. The default value is -1, which indicates that the default configurations of the internal SDK encoder are used.

cameraCaptureProfile

AliEngineCameraCaptureProfile

Specifies a specific resolution for video capture.

disableVideoCaptureReverse

int

Specifies whether to disable the automatic flipping of captured video frames based on the aspect ratio. -1: Default. 0: Disabled. 1: Enabled.

captureObserverOriginal

int

Specifies whether to trigger a callback for the original video frame data. -1: Default. 0: Disabled. 1: Enabled.

renderMode

AliEngineDisplayMode

The rendering mode to use if the camera dimensions do not match the set dimensions.

Enumeration name

Description

AliEngineCameraCaptureProfileDefault

Default. The capture resolution follows the encoding configuration.

AliEngineCameraCaptureProfile1080P

The camera captures video at 1080p resolution.

Enumeration name

Description

AliEngineDisplayMode_Auto

Auto (default). If the aspect ratio of the video source does not match the stream ingest configuration, the video is scaled proportionally to fit the configured dimensions. This maintains the original aspect ratio. Note: The final stream resolution may differ from the configured resolution to preserve the video's content and aspect ratio.

AliEngineDisplayMode_FullOf

Stretch to fill. If the aspect ratio of the video source does not match the stream ingest configuration, the video is stretched to fit the configured aspect ratio. This distorts the video.

AliEngineDisplayMode_FillBlack

Fill with black bars. If the aspect ratio of the video source does not match the stream ingest configuration, black bars are added to the video. This allows the video to fit the configured dimensions while maintaining its original aspect ratio.

AliEngineDisplayMode_Scale

Crop. If the aspect ratio of the video source does not match the stream ingest configuration, the video is cropped on its width or height to fit. This causes some video content to be lost.

Enumeration name

Description

AliEngineCaptureOutputPreferenceAuto

Automatically adjusts the capture parameters.

AliEngineCaptureOutputPreferencePerformance

Prioritizes device performance. Selects the camera output parameters that most closely match the parameters set by setVideoProfile.

AliEngineCaptureOutputPreferencePreview

Prioritizes video preview quality and selects higher camera output parameters.

Enumeration

Description

AliEngineFrameRateFps5

5 FPS.

AliEngineFrameRateFps10

10 FPS.

AliEngineFrameRateFps15

15 FPS.

AliEngineFrameRateFps20

20 FPS.

AliEngineFrameRateFps30

30 FPS.

Enumeration

Description

AliEngineVideoStandardBitrate

Standard bitrate mode.

Enumeration name

Description

AliEngineVideoMirrorModeDisabled

Mirrors the encoded video.

AliEngineVideoMirrorModeEnable

Does not mirror the encoded video.

Parameter

Type

Description

dimensions

AliEngineVideoDimensions

The video resolution.

frameRate

AliEngineFrameRate

The video encoding frame rate.

bitrate

int

The bitrate for video encoding.

keyFrameInterval

int

The keyframe interval in milliseconds. The default value is 0. A value of 0 indicates that the SDK internally controls the keyframe interval.

forceStrictKeyFrameInterval

bool

Specifies whether to force the encoder to generate keyframes at a strict, fixed interval. The default value is false.

• false: The encoder responds to keyframe requests, such as when another user joins a session. This means the actual keyframe interval may differ from the set value.

• true: The encoder ignores other keyframe requests and generates keyframes strictly at the set interval. This may delay the first frame for subscribers.

mirrorMode

AliEngineVideoMirrorMode

The mirror mode for the encoded video.

orientationMode

AliEngineVideoEncoderOrientationMode

The rotation mode for video encoding.

rotationMode

AliEngineRotationMode

The video rotation angle.

codecType

AliEngineVideoCodecType

Sets the encoding mode.

encodeCodecType

AliEngineVideoEncodeCodecType

The encoding type.

seiForceFrontIFrame

int

Specifies whether to force an I-frame before sending a Supplemental Enhancement Information (SEI) message.

A value of -1 uses the default setting. A value of 0 does not force an I-frame. A value of 1 forces an I-frame. The default value is 1.

enableDynamicEncode

int

Enables dynamic encoding.

disableDipenseResolutionChange

int

Whether scaling before encoding is supported.

enableDowngrade

int

Specifies whether to allow resolution or bitrate downgrade.

enableH264BFrame

int

Whether to enable H.264 B-frames.

enableHevcBFrame

int

Specifies whether to enable HEVC B-frames.

Parameter

Type

Description

codecType

AliEngineVideoCodecType

Sets the decoding type, such as software or hardware decoding. The default value is AliEngineVideoCodecTypeDefault, which uses the system's default settings.

enableHardwareDecoderBframe

int

Specifies whether to enable B-frame decoding. If the sender uses B-frames, enable this option. Otherwise, decoding fails.

The default value is -1. Set this parameter to 0 to disable B-frames, or 1 to enable B-frames.

Enumerator

Description

AliEngineVideoCodecTypeDefault

Not set. The system default is used.

AliEngineVideoCodecTypeSoftware

Software video codec.

AliEngineVideoCodecTypeHardware

Hardware video codec.

AliEngineVideoCodecTypeHardwareTexture

Hardware texture codec.

Parameter

Type

Description

dimensions

AliEngineVideoDimensions

Video resolution.

frameRate

AliEngineFrameRate

Video encoding frame rate.

bitrate

int

The video encoding bitrate.

rotationMode

AliEngineRotationMode

The rotation angle of the screen.

keyFrameInterval

int

The keyframe interval in milliseconds. The default value is 0. A value of 0 means the SDK controls the keyframe interval.

forceStrictKeyFrameInterval

bool

Specifies whether to force the encoder to strictly follow the set keyframe interval. The default value is false.

• false: The encoder responds to keyframe requests, such as when a new subscriber joins. The keyframe interval may not strictly match the set value.

• true: The encoder ignores other keyframe requests and generates keyframes strictly based on the set value. This may cause a delay in displaying the first frame for subscribers.

Parameter

Type

Description

isShareByRegion

bool

Specifies whether the resource is shared by region.

shareRegion

AliEngineScreenShareRegion

Layout information for region sharing.

isPushStream

bool

Specifies whether to push the video stream during the preview.

Parameter

Type

Description

originX

float

The x-coordinate.

originY

float

The y-coordinate.

width

float

The width.

height

float

The height.

Parameter

Type

Description

sourceId

String

The ID of the sharing source.

sourceName

String

The name of the sharing source.

sourceIsSelf

bool

Indicates whether the source is the SDK caller.

Parameter

Type

Description

shareType

AliEngineScreenShareType

The sharing type.

shareSourceId

unsigned int

The sharing source ID.

shareConfig

AliEngineScreenShareConfig

The screen sharing configuration.

Enumerator

Description

AliEngineScreenShareDesktop

Desktop sharing.

AliEngineScreenShareWindow

Window sharing.

Parameter

Type

Description

channelId

char*

The channel ID.

userId

char*

The user ID.

appId

char*

The application ID.

nonce

char*

A random string.

token

char*

The token.

gslb

char**

An array of pointers to GSLB addresses.

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 addresses.

agent

char**

An array of pointers to agent addresses.

agentCount

int

The number of agent addresses.

tokenType

char*

The token type. This parameter is optional.

Enumeration name

Description

AliEngineVideoSourceCamera

Video stream.

AliEngineVideoSourceScreenShare

Screen sharing stream.

Enumeration Name

Description

AliEngineAudioSourceCaptured

Captured audio data.

AliEngineAudioSourceProcessCaptured

Audio data after 3A processing.

AliEngineAudioSourcePub

Audio data for stream ingest.

AliEngineAudioSourcePlayback

Audio data for playback.

AliEngineAudioSourceRemoteUser

Remote audio data from stream pulling.

AliEngineAudioSourceMixedAll

Mixed audio data from stream ingest and playback.

Enumerator

Description

AliEngineBufferTypeRawData

YUV raw data.

AliEngineBufferTypeTexture

CVPixelBuffer data.

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 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 video rendering.

AliEngineErrorIceConnectionConnectFail

Failed to establish the media channel.

AliEngineErrorIceConnectionReconnectFail

Failed to reconnect to the media channel.

AliEngineErrorIceConnectionHeartbeatTimeout

The signaling heartbeat timed out.

AliEngineErrorPublishInvaild

Invalid publish operation.

AliEngineErrorPublishNotJoinChannel

Publish failed. 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

Incorrect screen sharing configuration.

AliEngineErrorSubscribeInvaild

Invalid subscription.

AliEngineErrorSubscribeNotJoinChannel

Subscription failed. 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

Failed to establish low-latency signaling for ApsaraVideo Real-time Communication.

AliEngineErrorLowLatencyLiveMediaSettingFail

Incorrect media settings for low-latency ApsaraVideo Real-time Communication.

AliEngineErrorLowLatencyLiveNoneBroadcaster

In low-latency ApsaraVideo Real-time Communication mode, no streamer is publishing a stream in the current channel.

AliEngineErrorLowLatencyLiveNeedRestart

A low-latency ApsaraVideo Real-time Communication error occurred. The application layer must create a new software development kit (SDK) instance.

AliEngineErrorLowLatencyLiveNeedRestartAgainLater

A low-latency ApsaraVideo Real-time Communication error occurred. The application layer must wait for a custom interval and then create a new SDK instance.

AliEngineErrorLowLatencyLiveServiceUnavailable

The low-latency ApsaraVideo Real-time Communication service is unavailable or has been degraded.

AliEngineErrorLowLatencyLiveMediaConnectionInterrruption

A network interruption occurred in low-latency ApsaraVideo Real-time Communication.

AliEngineErrorInvaildState

Incorrect SDK status.

AliEngineErrorSessionRemoved

The session has been removed.

AliEngineErrorInvaildArgument

Invalid argument.

AliEngineErrorAudioBufferFull

The audio buffer queue is full. This error is for the external raw data input feature.

AliEngineErrorVideoBufferFull

The video buffer queue is full. This error is for the external raw data input feature.

AliEngineErrorUpdateRoleChannel

Failed to set the user role in interactive mode.

AliEngineErrorInner

Other errors.

Enumeration name

Description

AliEngineAlignmentDefault

Maintains the original video width (default).

AliEngineAlignmentEven

Aligns the width 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.

Enumeration name

Description

AliEngineShowTypeNone

Do not display.

AliEngineShowTypeAudio

Audio.

AliEngineShowTypeVideo

Video.

AliEngineShowTypeNetwork

Network.

AliEngineShowTypeAll

All.

Enumeration name

Description

AliEngineTrascodingPublishTaskStatusStart

The task has started.

AliEngineTrascodingPublishTaskStatusUpdate

The task is updating.

AliEngineTrascodingPublishTaskStatusStop

The task has stopped.

Enumeration Name

Description

NOT_DISPLAY

Not visible.

ALWAYS

Always displayed.

WHEN_NO_VIDEO

The image is displayed when no video is available.

Enumeration member

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.

Enumerator

Description

AliEngineLiveTranscodingNoBody

No portrait segmentation.

AliEngineLiveTranscodingBody

Portrait segmentation.

Enumeration

Description

AliEngineLiveTranscodingCamera

Camera.

AliEngineLiveTranscodingShareScreen

Screen sharing.

Enumeration name

Description

AliEngineVideoClose

The video stream is closed.

AliEngineVideoOpen

The video stream is resumed.

Enumeration

Description

AliEngineVideoChangeByClient

The client.

AliEngineVideoChangeByServer

The server.

Enumeration Name

Description

AliEngineLiveTranscodingCrop

Crops the video while preserving the aspect ratio.

AliEngineLiveTranscodingFill

Pads the video with black bars to preserve the aspect ratio. (Default)

Enumerator

Description

AliEngineLiveTranscodingNormal

Normal mode.

AliEngineLiveTranscodingVirtualBackground

Virtual background mode.

Enumerator

Description

AliEngineLiveTranscodingOrigin

Ingest the original stream.

AliEngineLiveTranscodingAudio

Ingest the audio stream only.

AliEngineLiveTranscodingVideo

Ingest the video stream only.

Enumeration name

Description

AliEngineLiveTranscodingSINGLE

Pushes a single stream without stream mixing or transcoding. Only the original stream is pushed. No configuration of stream mixing or transcoding parameters is required.

AliEngineLiveTranscodingMIX

Stream mixing and transcoding (default). Supports output from stream mixing and transcoding.

Enumerator

Description

AliEngineLiveTranscodingState_IDLE

The stream ingest is idle.

AliEngineLiveTranscodingState_CONNECT

Connecting to the stream ingest server.

AliEngineLiveTranscodingState_RUNNING

The stream ingest is in progress.

AliEngineLiveTranscodingState_RECOVERING

The stream ingest is recovering.

AliEngineLiveTranscodingState_FAILURE

The stream ingest failed.

AliEngineLiveTranscodingState_END

The stream ingest ended.

Parameter

Type

Description

text

String

The text content.

x

int

The x-coordinate, in pixels.

y

int

The y-coordinate, in pixels.

fontType

AliEngineLiveTranscodingFontType

The font for bypass live streaming.

fontSize

int

The font size.

zOrder

int

The layer order. A value of 0 indicates the bottom layer. A larger value indicates a higher layer.

fontColor

int

The font color.

Parameter

Type

Description

url

String

The image URL.

alpha

float

The transparency. A value of 0.0 is transparent. A value of 1.0 is fully opaque.

display

DisplayType

Image display.

x

int

The x-coordinate in pixels.

y

int

The y-coordinate in pixels.

width

int

The width of the image.

height

int

Image height.

zOrder

int

The stacking order. A value of 0 is the bottom-most layer. A value of 1 is the layer above 0, and so on.

Parameter

Type

Description

x

int

The X coordinate in pixels.

y

int

The y-coordinate in pixels.

width

int

The width of the pane.

height

int

The height of the pane.

zOrder

int

The stacking order. A value of 0 represents the bottom layer. Layer 1 is on top of layer 0, and so on.

userId

String

The user ID.

sourceType

AliEngineLiveTranscodingSourceType

The stream type.

segmentType

AliEngineLiveTranscodingSegmentType

The segmentation type for bypass live streaming.

images

AliEngineLiveTranscodingImageArray

The image information for bypass live streaming.

texts

AliEngineLiveTranscodingTextArray

Text information for the bypass live stream.

Parameter

Type

Description

mixMode

AliEngineLiveTranscodingMixMode

Bypass live streaming mode.

singleParam

AliEngineLiveTranscodingSingleParam

Single-stream parameters for bypass live streaming.

mixParam

AliEngineLiveTranscodingMixParam

Stream mixing parameters for bypass live streaming.

Parameter

Type

Description

taskProfile

AliEngineLiveTranscodingTaskProfile

The billing specifications for bypass live streaming.

encodeParam

AliEngineLiveTranscodingEncodeParam

The encoding parameters for bypass live streaming.

users

AliEngineLiveTranscodingUserArray

The user list 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

AliEngineLiveTranscodingCropMode

The crop mode for bypass live streaming.

mediaProcessMode

AliEngineLiveTranscodingMediaProcessMode

The media processing mode for bypass live streaming.

Parameter

Type

Description

userId

String

The user ID.

streamType

AliEngineLiveTranscodingStreamType

The type of stream ingest for bypass live streaming.

sourceType

AliEngineLiveTranscodingSourceType

The type of the bypass live video stream.

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.

Parameters

Type

Description

videoWidth

int

The width.

videoHeight

int

Height.

videoFramerate

int

The frame rate.

videoBitrate

int

The bitrate.

videoGop

int

Group of Pictures (GOP).

audioSamplerate

AliEngineLiveTranscodingAudioSampleRate

The audio sampling rate for bypass live streaming.

audioBitrate

int

Audio bitrate.

audioChannels

int

The number of sound channels.

Enumeration name

Description

AliEngineLiveTranscoding_HZ_48000

The sample rate is 48000 Hz.

AliEngineLiveTranscoding_HZ_44100

Sample rate 44100 Hz.

AliEngineLiveTranscoding_HZ_32000

The sample rate is 32000 Hz.

AliEngineLiveTranscoding_HZ_16000

The sample rate is 16,000 Hz.

AliEngineLiveTranscoding_HZ_8000

The sample rate is 8000 Hz.

Parameter

Type

Description

x

int

The x-coordinate in pixels.

y

int

Y coordinate (pixel).

fontSize

int

Font size for bypass live streaming.

zOrder

int

The stacking order. A value of 0 indicates the bottom layer. A value of 1 is on top of 0, and so on.

fontColor

int

Font color for bypass live streaming.

fontType

AliEngineLiveTranscodingFontType

Bypass live streaming font.

Enumeration name

Description

AliEngineBokehScaleModelCrop

Proportional crop.

AliEngineBokehScaleModelFill

Fills with black bars.

Enumeration name

Description

AliEngineAudioAccompanyStarted

Playback starts.

AliEngineAudioAccompanyStopped

Playback stopped.

AliEngineAudioAccompanyPaused

Playback is paused.

AliEngineAudioAccompanyResumed

Playback resumes.

AliEngineAudioAccompanyEnded

Playback finished.

AliEngineAudioAccompanyBuffering

Buffering.

AliEngineAudioAccompanyBufferingEnd

Buffering complete.

AliEngineAudioAccompanyFailed

Playback failed.

Enumeration name

Description

AliEngineAudioAccompanyNoError

No error.

AliEngineAudioAccompanyOpenFailed

Failed to open the file.

AliEngineAudioAccompanyDecodeFailed

Failed to decode the file.

Parameter

Type

Description

GetCount

unsigned int

Gets the number of screen sharing sources.

GetSourceInfo

AliEngineScreenSourcInfo

Retrieves the source description by index.

Release

None

Release API.

Enumeration

Description

AliEngineInterfaceAudioDeviceManager

The IAliEngineAudioDeviceManager class, which provides features for audio devices.

AliEngineInterfaceVideoDeviceManager

The IAliEngineVideoDeviceManager class, which provides features for video devices.

AliEngineInterfaceMediaEngine

The IAliEngineMediaEngine class, which provides features for audio and video media data.

Enumeration name

Description

AliEngineVideoEncoderType

Encoder.

AliEngineVideoDecoderType

Decoder.

Enumeration name

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

DVI device.

AliEngineDeviceTransportTypeAirPlay

AirPlay device.

AliEngineDeviceTransportTypeAVB

AVB device.

AliEngineDeviceTransportTypeThunderbolt

Thunderbolt device.

Parameter

Type

Description

sampleRate

AliEngineAudioSampleRate

The callback audio sampling rate.

channels

AliEngineAudioNumChannelType

The number of sound channels for the callback audio.

mode

AliEngineAudioFrameObserverOperationMode

The callback mode.

userDefinedInfo

int

A user-defined parameter. For valid values, see AliEngineAudioFrameObserverUserDefinedInfoBitMask.

Method name

Return value type

Description

GetCount

int

Resolution count

GetDeviceInfo

AliEngineDeviceInfo

Gets information about a specified device.

Release

void

Releases the object.

Method name

Return value type

Description

GetCount

int

The number of resolutions.

GetResolutionInfo

AliEngineVideoResolution

Gets the resolution at a specified index.

Release

void

Releases the object.

Enumeration name

Description

AliEngineVideoRecordSourceCamera

Record the video from the camera stream.

AliEngineVideoRecordSourceScreenShare

Record the video from the screen sharing stream.

AliEngineVideoRecordSourceBoth

Record the video from both the camera and screen sharing streams.

Enumeration name

Description

AliEngineAudioFrameObserverOperationModeReadOnly

Read-only mode.

AliEngineAudioFrameObserverOperationModeWriteOnly

Write-only mode.

AliEngineAudioFrameObserverOperationModeReadWrite

Read-write mode.

Parameter

Type

Description

width

int

The width.

height

int

The height.

Enumeration name

Description

AliEngineVideoScale_16_9

16:9

AliEngineVideoScale_4_3

4:3

Parameter

Type

Description

x

float

The x-coordinate of the top-left corner.

y

float

The y-coordinate of the top-left corner.

w

float

The width of the watermark.

h

float

The height of the watermark.

Parameter

Type

Description

width

int

The width of the video.

height

int

The height of the video.

Enumeration

Description

AliEngineVideoEncodeCodecTypeDefault

Uses the default encoding format. The current default is H.264.

AliEngineVideoEncodeCodecTypeH264

Uses H.264 encoding.

AliEngineVideoEncodeCodecTypeHevc

Uses H.265 encoding.

Parameter

Type

Description

userName

string

The username to be displayed.

capabilityProfile

AliCapabilityProfile

A user property that requires special configuration for AI agent call scenarios. For all other scenarios, the default value is used.

Enumeration name

Description

AliCapabilityProfileDefault

Non-AI agent call scenario.

AliCapabilityProfileHuman

User property.

AliCapabilityProfileRobot

Robot property.

Parameter

Type

Description

onlyLocalPlay

bool

Specifies whether to play the audio locally only. The default value is false.

replaceMic

bool

Specifies whether to replace the microphone input. The default value is false.

loopCycles

int

The number of playback loops. Set this parameter to -1 for an infinite loop or a positive integer greater than 0. Other values are invalid. The default value is -1.

startPosMs

long

The start position for playback. The unit is milliseconds (ms). The default value is 0.

publishVolume

int

The volume for stream ingest. The value ranges from 0 to 100. The default value is 50.

playoutVolume

int

The playback volume. The value ranges from 0 to 100. The default value is 50.

Enumeration

Description

AliEngineVideoPipelineMirrorModeNoMirror

Mirroring is disabled for both preview and encoding.

AliEngineVideoPipelineMirrorModeBothMirror

Mirroring is enabled for both preview and encoding.

AliEngineVideoPipelineMirrorModeOnlyPreviewMirror

Mirroring is enabled for preview only.

AliEngineVideoPipelineMirrorModeOnlyPublishMirror

Mirroring is enabled for publishing only.

Enumerator

Description

AliEngineCapturePipelineScaleModePre

Scales the video immediately after capture. This is the default.

AliEngineCapturePipelineScaleModePost

Scales the video during encoding.

Parameter

Type

Description

type

AliEngineDataMsgType

The message type.

networkTime

long long

The timestamp.

progress

int

The current progress in milliseconds. This parameter is used only for AliEngineDataMsgMusicProgress messages in KTV scenarios. Do not set this parameter for other scenarios.

data

void*

The message content. The content can be any data, such as text and images.

dataLen

int

The length of the message.

Enumeration name

Description

AliEngineDataChannelNone

No message.

AliEngineDataChannelProgress

Used in KTV scenarios.

AliEngineDataChannelCustom

A normal message. For other scenarios, set the message type to this value.

Parameter

Type

Description

filePath

const char*

The path of the audio file.

durationMs

long

The duration of the audio file in milliseconds.

Enumeration name

Description

AliEngineLocalAudioStateTypeStarting

The local audio capture is starting.

AliEngineLocalAudioStateTypeStarted

The local audio capture has started.

AliEngineLocalAudioStateTypeStopping

The local audio capture is stopping.

AliEngineLocalAudioStateTypeStopped

The local audio capture has stopped.

Enumeration

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.