Data structures

Data type

Description

ERROR_CODE

Error code definitions.

WARNNING_CODE

Warning code definitions.

ChannelProfile

Channel modes.

PublishMode

Stream ingest modes.

LogLevel

Log levels.

AudioQualityMode

Audio quality modes.

AudioSceneMode

Audio scenario modes.

VideoTrack

Video tracks.

AudioTrack

Audio tracks.

VideoProfile

Video resolution configurations.

AliEngineVideoDimensions

Video resolution.

AliEngineFrameRate

Video frame rates.

AliEngineVideoEncoderOrientationMode

Video output orientation.

AliEngineVideoMirrorMode

Video mirror modes.

AliEngineRotationMode

Video rotation angles.

AliEngineVideoEncoderConfiguration

Property settings for camera stream video encoding.

AliEngineScreenShareEncoderConfiguration

Property settings for screen stream encoding.

VideoSource

Video sources.

RenderMode

Rendering modes.

PublishAvsyncMode

Audio and video synchronization modes for stream ingest.

VideoDataFormat

Video data formats.

VideoBufferType

Video buffer types.

VideoDataSample

Video data samples.

SubscribeMode

Enumerations used only for subscriptions.

VideoTrackType

Video track types.

VideoFormat

Video formats.

AudioFormat

Audio formats.

VideoFrameType

Video frame types.

AudioFrameType

Audio frame types.

AudioPcmFrame

The audio PCM frame class.

AudioAacFrame

The audio AAC frame class.

AudioFrame

The audio frame class.

AudioTranscodingCodec

Audio transcoding codec types.

VideoTranscodingCodec

Video transcoding codec types.

VideoH264Frame

The H.264 video frame class.

VideoFrame

The video frame class.

AliEnginePublishState

Stream ingest states.

AliEngineSubscribeState

Subscription states.

AliEngineVideoStreamType

Video stream types.

AliEngineMuteLocalAudioMode

Mute modes.

AliEngineClientRole

User role types.

JoinChannelConfig

The configuration class for joining a channel.

AuthInfo

The authentication information class.

AliEngineDataMsgType

Accompaniment control instruction modes.

AliEngineDataChannelMsg

The accompaniment control message class.

Enumeration name

Description

ERR_OK

Normal.

ERR_JOIN_BAD_APPID

The AppId does not exist.

ERR_JOIN_INVALID_APPID

The AppId is invalid.

ERR_JOIN_BAD_CHANNEL

The channel does not exist.

ERR_JOIN_INVALID_CHANNEL

The channel is invalid.

ERR_JOIN_BAD_TOKEN

The token does not exist.

ERR_JOIN_TIMEOUT

The request to join the channel timed out.

ERR_JOIN_BAD_PARAM

The parameters for joining the channel are invalid.

ERR_JOIN_FAILED

Failed to join the channel.

ERR_JOIN_CONFIG_INVALID

The parameters for joining the channel are invalid. For example, the token is empty.

ERR_LEAVE_UNUSUAL

Left the channel unexpectedly. You may have been removed from the channel.

ERR_NO_PEOPLE

No one is in the channel. The channel may not exist or the streamer has stopped streaming.

ERR_AUDIO_DATA_ERROR

An audio data error occurred.

ERR_VIDEO_DATA_ERROR

A video data error occurred.

ERR_NETWORK_CONNECT_FAIL

Failed to establish a media channel.

ERR_NETWORK_RECONNECT_FAIL

Failed to reconnect to the media channel.

ERR_NETWORK_DISCONNECT

The connection is disconnected.

ERR_NETWORK_TIMEOUT

The connection timed out.

ERR_PUBLISH_INVALID

The stream ingest is invalid.

ERR_Publish_NOT_JOIN_CHANNEL

Failed to ingest the stream because you have not joined a channel.

ERR_PUBLISH_AUDIO_STREAM_FAILED

Failed to push the audio stream.

ERR_PUBLISH_VIDEO_STREAM_FAILED

Failed to push the video stream.

ERR_PUBLISH_DUAL_STREAM_FAILED

Failed to push the low-bitrate stream.

ERR_PUBLISH_SCREEN_SHARE_FAILED

Failed to push the screen sharing stream.

ERR_PUBLISH_SCREEN_SHARE_CONFIG

The screen sharing configuration is invalid.

ERR_SUBSCRIBE_INVALID

The subscription is invalid.

ERR_SUBSCRIBE_NOT_JOIN_CHANNEL

A subscription error occurred because you have not joined a channel.

ERR_SUBSCRIBE_AUDIO_STREAM_FAILED

Failed to subscribe to the audio stream.

ERR_SUBSCRIBE_VIDEO_STREAM_FAILED

Failed to subscribe to the video stream.

ERR_SUBSCRIBE_DUAL_STREAM_FAILED

Failed to subscribe to the low-bitrate stream.

ERR_SUBSCRIBE_SCREEN_SHARE_FAILED

Failed to subscribe to the screen sharing stream.

ERR_SUBSCRIBE_DUAL_AUDIO_STREAM_FAILED

Failed to subscribe to the dual-channel audio.

ERR_SDK_INVALID_STATE

An internal SDK state error occurred.

ERR_SESSION_REMOVED

The session has been removed.

ERR_INNER

An internal SDK error occurred.

ERR_VIDEO_TRANSFER

A video data transmission error occurred.

ERR_AUDIO_TRANSFER

An audio data transmission error occurred.

ERR_AUDIO_BUFFER_FULL

The frequency of external audio input is too high.

ERR_FATAL

A critical SDK error occurred.

Enumeration name

Description

WARN_DEFAULT

The default warning.

Enumeration name

Description

ChannelProfileCommunication

Communication mode.

ChannelProfileInteractiveLive

Live streaming mode

ChannelProfileInteractiveWithLowLatencyLive

Interactive live streaming with low latency mode.

Enumeration name

Description

PublishAutomatically

Automatic stream ingest.

PublishManually

Manual stream ingest.

Enumeration name

Description

LogLevelInfo

Outputs logs of LogLevelInfo and higher levels.

LogLevelWarn

Outputs logs of LogLevelWarn and higher levels.

LogLevelError

Outputs logs of LogLevelError and higher levels.

LogLevelFatal

Outputs logs of LogLevelFatal and higher levels.

LogLevelNone

Does not output logs.

Enumeration name

Description

LowQualityMode

Low-quality audio mode. The default sample rate is 8,000 Hz, mono sound, and the maximum encoding bitrate is 12 kbps.

BasicQualityMode

(Default) Standard-quality audio mode. The default sample rate is 16,000 Hz, mono sound, and the maximum encoding bitrate is 24 kbps.

HighQualityMode

High-quality audio mode. The default sample rate is 48,000 Hz, mono sound, and the maximum encoding bitrate is 64 kbps.

StereoHighQualityMode

Stereo high-quality audio mode. The default sample rate is 48,000 Hz, stereo sound, and the maximum encoding bitrate is 80 kbps.

SuperHighQualityMode

Super-high-quality audio mode. The default sample rate is 48,000 Hz, mono sound, and the maximum encoding bitrate is 96 kbps.

StereoSuperHighQualityMode

Stereo super-high-quality audio mode. The default sample rate is 48,000 Hz, stereo sound, and the maximum encoding bitrate is 128 kbps.

QualityMaxMode

The maximum value for the audio quality mode.

Enumeration name

Description

DefaultMode

Default mode. Hardware 3A processing.

EducationMode

Education scenario. Hardware 3A processing.

MediaMode

Media scenario. Basic software 3A processing.

MusicMode

Music scenario. Music-optimized software 3A processing.

ChatroomMode

Chat room mode. Hardware 3A processing.

KtvMode

KTV mode. Music-optimized software 3A processing with Aaudio.

SceneMaxMode

The maximum value for the scenario mode.

Enumeration name

Description

VideoTrackNo

No video track.

VideoTrackCamera

Video from a camera, file, or other sources.

VideoTrackScreen

Video from screen sharing.

VideoTrackBoth

Includes both VideoTrackCamera and VideoTrackScreen.

VideoTrackEnd

The end marker for the video track.

Enumeration name

Description

AudioTrackNo

No audio track.

AudioTrackMic

Audio from a microphone, file, or other sources.

AudioTrackEnd

The end marker for the audio track.

Enumeration name

Description

VideoProfile_Default

Lets the SDK decide.

VideoProfile_180_240P_15

Resolution: 180 × 240. Frame rate: 15 fps.

VideoProfile_180_320P_15

Resolution: 180 × 320. Frame rate: 15 fps.

VideoProfile_180_320P_30

Resolution: 180 × 320. Frame rate: 30 fps.

VideoProfile_240_320P_15

Resolution: 240 × 320. Frame rate: 15 fps.

VideoProfile_360_480P_15

Resolution: 360 × 480. Frame rate: 15 fps.

VideoProfile_360_480P_30

Resolution: 360 × 480. Frame rate: 30 fps.

VideoProfile_360_640P_15

Resolution: 360 × 640. Frame rate: 15 fps.

VideoProfile_360_640P_30

Resolution: 360 × 640. Frame rate: 30 fps.

VideoProfile_480_640P_15

Resolution: 480 × 640. Frame rate: 15 fps.

VideoProfile_480_640P_30

Resolution: 480 × 640. Frame rate: 30 fps.

VideoProfile_720_960P_15

Resolution: 720 × 960. Frame rate: 15 fps.

VideoProfile_720_960P_30

Resolution: 720 × 960. Frame rate: 30 fps.

VideoProfile_720_1280P_15

Resolution: 720 × 1280. Frame rate: 15 fps.

VideoProfile_720_1280P_20

Resolution: 720 × 1280. Frame rate: 20 fps.

VideoProfile_720_1280P_30

Resolution: 720 × 1280. Frame rate: 30 fps.

VideoProfile_1080_1920P_15

Resolution: 1080 × 1920. Frame rate: 15 fps.

VideoProfile_1080_1920P_30

Resolution: 1080 × 1920. Frame rate: 30 fps.

VideoProfile_480_640P_15_1500Kb

Resolution: 480 × 640. Frame rate: 15 fps. Bitrate: 1,500 Kbps.

VideoProfile_900_1600P_20

Resolution: 900 × 1600. Frame rate: 20 fps.

VideoProfile_360_640P_15_800Kb

Resolution: 360 × 640. Frame rate: 15 fps. Bitrate: 800 Kbps.

VideoProfile_480_840P_15_500Kb

Resolution: 480 × 840. Frame rate: 15 fps. Bitrate: 500 Kbps.

VideoProfile_480_840P_15_800Kb

Resolution: 480 × 840. Frame rate: 15 fps. Bitrate: 800 Kbps.

VideoProfile_540_960P_15_800Kb

Resolution: 540 × 960. Frame rate: 15 fps. Bitrate: 800 Kbps.

VideoProfile_540_960P_15_1200Kb

Resolution: 540 × 960. Frame rate: 15 fps. Bitrate: 1,200 Kbps.

VideoProfile_540_960P_20

Resolution: 540 × 960. Frame rate: 20 fps.

VideoProfile_1080_1920P_20

Resolution: 1080 × 1920. Frame rate: 20 fps.

VideoProfile_240_320P_15_300kb

Resolution: 240 × 320. Frame rate: 15 fps. Bitrate: 300 Kbps.

VideoProfile_240_320P_15_500kb

Resolution: 240 × 320. Frame rate: 15 fps. Bitrate: 500 Kbps.

VideoProfile_90_160P_15

Resolution: 90 × 160. Frame rate: 15 fps.

AliRTCSDK_Video_Profile_Adaptive_Resolution

Adaptive resolution.

AliRTCSDK_Video_Profile_Max

The maximum value for the video resolution configuration.

Parameter

Type

Description

width

int

The video width.

height

int

The video height.

Enumeration name

Description

AliEngineFrameRateFps5

5 fps.

AliEngineFrameRateFps10

10 fps.

AliEngineFrameRateFps15

15 fps.

AliEngineFrameRateFps20

20 fps.

AliEngineFrameRateFps25

25 fps.

AliEngineFrameRateFps30

30 fps.

Enumeration name

Description

AliEngineVideoEncoderOrientationModeAdaptive

Adaptive. The stream ingest orientation is the same as the capture orientation.

AliEngineVideoEncoderOrientationModeFixedLandscape

Landscape mode: This mode is for horizontal videos. In this mode, the SDK pushes a vertical stream. The output video's width is set to the smaller value of the set resolution, and its height is set to the larger value.

AliEngineVideoEncoderOrientationModeFixedPortrait

Portrait mode. In this mode, when the SDK ingests a landscape stream, it always uses the larger of the specified width and height as the output video width and the smaller value as the output video height.

Enumeration name

Description

AliEngineVideoMirrorModeDisabled

Disables mirror mode.

AliEngineVideoMirrorModeEnable

Enables mirror mode.

Enumeration name

Description

AliEngineRotationModeNoChange

Uses the previous rotation angle.

AliEngineRotationMode_0

0-degree rotation.

AliEngineRotationMode_90

90-degree rotation.

AliEngineRotationMode_180

180-degree rotation.

AliEngineRotationMode_270

270-degree rotation.

Parameter

Type

Description

dimensions

AliEngineVideoDimensions

The video resolution. The default value is 640 × 480. The maximum value is 1920 × 1080.

frameRate

AliEngineFrameRate

The video frame rate. The default value is 15. The maximum value is 30.

bitrate

int

The video encoding bitrate in Kbps. The default value is 512. If you set this parameter to 0, the SDK calculates a suitable bitrate. The bitrate must be within a reasonable range based on the resolution and frame rate. If the specified value is outside this range, the SDK automatically adjusts the bitrate to a valid value.

orientationMode

AliEngineVideoEncoderOrientationMode

The video output orientation. The default value is adaptive.

mirrorMode

AliEngineVideoMirrorMode

The mirror mode for stream ingest. The default value is disabled.

rotationMode

AliEngineRotationMode

The rotation angle for stream ingest. The default value is 0 degrees.

Parameter

Type

Description

dimensions

AliEngineVideoDimensions

The video resolution. The default value is 0 × 0, which means the stream ingest resolution is the same as the screen capture resolution. The maximum value is 3840 × 2160.

frameRate

AliEngineFrameRate

The video frame rate. The default value is 5. The maximum value is 30.

bitrate

int

The video encoding bitrate in Kbps. The default value is 512. If you set this parameter to 0, the SDK calculates a suitable bitrate. The bitrate must be within a reasonable range based on the resolution and frame rate. If the specified value is outside this range, the SDK automatically adjusts the bitrate to a valid value.

rotationMode

AliEngineRotationMode

The rotation angle for stream ingest. The default value is 0 degrees. For more information, see AliEngineRotationMode.

Enumeration name

Description

VideoSourceCamera

The video source is a camera.

VideoSourceScreenShare

The video source is screen sharing.

VideosourceTypeMax

The maximum value for the video source type.

Enumeration name

Description

RenderModeAuto

Automatic mode.

RenderModeStretch

Stretch to fill mode. If the aspect ratio of the external input video is different from the aspect ratio set for stream ingest, the input video is stretched to match the ingest ratio. This may distort the image.

RenderModeFill

Fill with black bars mode. If the aspect ratio of the external input video is different from the aspect ratio set for stream ingest, black bars are added to the top and bottom or left and right of the input video.

RenderModeCrop

Clipping mode. If the aspect ratio of the external input video is different from the aspect ratio set for stream ingest, the width or height of the input video is clipped. This may cause loss of content.

Enumeration name

Description

PublishAvsyncNoDelay

The SDK does not cache data internally. After you call PushExternalVideoFrame or PushExternalAudioFrame, the data is immediately sent to the network. The caller must ensure audio and video synchronization.

PublishAvysncWithPts

The SDK caches data internally and uses the provided presentation timestamp (PTS) to align and synchronize audio and video. The following cases apply to PublishAvysncWithPts: - If you ingest only an audio stream from a file, such as a 2-second audio file, you can quickly input the data into the SDK. The SDK waits as needed based on the PTS and sends the data to the network over the 2-second duration. - If you ingest both audio and video streams and there is a time interval between when they are captured, the SDK uses their PTS values to align them before sending them to the network. - Within a join-leave lifecycle, if you publish and unpublish streams multiple times, the PTS values for different segments must be on the same timeline. For example, after you join a channel and publish a stream for the first time, the PTS starts from 0. If you unpublish the stream after 10 seconds and then publish it again 10 seconds later, the PTS for the second publication must start from 20 seconds, not 0. Otherwise, stuttering may occur.

Enumeration name

Description

VideoDataFormatUnknow

Unknown format.

VideoDataFormatBGRA

BGRA format.

VideoDataFormatI420

I420 format.

VideoDataFormatNV21

NV21 format.

VideoDataFormatNV12

NV12 format.

VideoDataFormatH264

H.264 format.

VideoDataFormatRGB24

RGB24 format.

VideoDataFormatBGR24

BGR24 format.

Enumeration name

Description

VideoBufferTypeRawData

Raw data.

VideoBufferTypeCVPixelBuffer

CVPixelBuffer type.

VideoBufferTypeTexture

Texture type.

Parameter

Type

Description

format

VideoDataFormat

The video data format.

bufferType

VideoBufferType

The video buffer type.

data

bytes

A pointer to the video data. The default value is nullptr.

dataLen

int

The length of the video data.

strideY

int

The stride of the Y plane. The default value is 0.

strideU

int

The stride of the U plane. The default value is 0.

strideV

int

The stride of the V plane. The default value is 0.

height

int

The video height. The default value is 0.

width

int

The video width. The default value is 0.

rotation

int

The video rotation angle. The default value is 0.

timeStamp

int

The timestamp.

Enumeration name

Description

SubscribeAutomatically

Automatic subscription.

SubscribeManually

Manual subscription.

SubscribeAudioAutoAndOnly

Automatically subscribes to audio only.

SubscribeCameraAutoAndOnly

Automatically subscribes to video from the camera only.

Enumeration name

Description

VideoTrackCameraLarge

High-resolution video stream from the camera.

VideoTrackCameraSmall

Low-resolution video stream from the camera.

VideoTrackCameraSuper

Ultra-high-resolution video stream from the camera.

VideoTrackScreenshare

Screen sharing video.

Enumeration name

Description

VideoFormatNone

No video format.

VideoFormatH264

H.264 video format.

Enumeration name

Description

AudioFormatNone

No audio format.

AudioFormatMixedPcm

Mixed PCM format.

AudioFormatPcmBeforMixing

PCM format before mixing.

Enumeration name

Description

VideoFrameH264

YUV I420. The decoded image.

VideoFrameH264Nalu

H.264 NALU. The image before decoding.

Enumeration name

Description

AudioFrameRawPcm

Raw PCM data.

AudioFrameAacAdts

AAC ADTS format data.

Parameter

Type

Description

frame_ms_

int

The timestamp in milliseconds.

channels_

int

The number of sound channels. For example, 1 indicates mono.

sample_bits_

int

The number of bits per sample. For example, 16-bit sampling depth.

sample_rates_

int

The audio sample rate, such as 8,000 Hz (8 kHz), 16,000 Hz (16 kHz), or 32,000 Hz (32 kHz).

samples_

int

The number of audio samples.

pcmBuf_

bytes

A pointer to the PCM data buffer.

pcmBufSize_

int

The size of the PCM data buffer in bytes.

Parameter

Type

Description

frame_ms_

int

The timestamp in milliseconds.

channels_

int

The number of sound channels. For example, 1 indicates mono.

sample_rates_

int

The audio sample rate. Valid values include 8,000 Hz (8 kHz), 16,000 Hz (16 kHz), and 32,000 Hz (32 kHz).

aacBuf_

bytes

A pointer to the AAC data buffer.

aacBufSize_

int

The size of the AAC data buffer in bytes.

Parameter

Type

Description

type

AudioFrameType

The type of the audio frame. This indicates whether raw PCM data or AAC data is stored.

pcm

AudioPcmFrame

The audio PCM frame.

aac

AudioAacFrame

The audio AAC frame.

Enumeration name

Description

AudioTranscodingCodecPcm

Transcodes to PCM format only.

AudioTranscodingCodecAac

Transcodes to AAC format only.

AudioTranscodingCodecBothPcmAndAac

Transcodes to both PCM and AAC formats.

AudioTranscodingCodecMax

The maximum enumeration value for the audio transcoding codec, used for range checks.

Enumeration name

Description

VideoTranscodingCodecYuv

Transcodes to YUV format only.

VideoTranscodingCodecH264

Transcodes to H.264 format only.

VideoTranscodingCodecBothYuvAndH264

Transcodes to both YUV and H.264 formats.

VideoTranscodingCodecMax

The maximum enumeration value for the video transcoding codec, used for range checks.

Parameter

Type

Description

frame_ms_

int

The timestamp of the video frame in milliseconds.

frame_num_

int

The ordinal number of the video frame.

buf_

bytes

A pointer to the video frame data.

bufSize_

int

The size of the video frame data in bytes.

width

int

The width of the video frame.

height

int

The height of the video frame.

Parameter

Type

Description

track

VideoTrackType

The track type corresponding to the video frame.

type

VideoFrameType

The type of the video frame, such as H.264 or H.264 NALU.

frame

VideoH264Frame

The H.264 video frame.

Enumeration name

Description

AliEngineStatsPublishIdle

Initial state.

AliEngineStatsNoPublish

Not ingesting a stream.

AliEngineStatsPublishing

Ingesting a stream.

AliEngineStatsPublished

Stream ingestion has started.

Enumeration name

Description

AliEngineStatsSubscribeIdle

Initial state.

AliEngineStatsNoSubscribe

Not subscribed.

AliEngineStatsSubscribing

Subscribing.

AliEngineStatsSubscribed

Subscribed.

Enumeration name

Description

AliEngineVideoStreamTypeNone

None. In the OnSubscribeStreamTypeChanged callback, this indicates that you are not currently subscribed.

AliEngineVideoStreamTypeHigh

High-bitrate, high-resolution stream (large stream).

AliEngineVideoStreamTypeLow

Low-bitrate, low-resolution stream (small stream).

Enumeration name

Description

AliEngineMuteLocalAudioModeDefault

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

AliEngineMuteLocalAudioModeMuteOnlyMic

Mutes the microphone only.

AliEngineMuteLocalAudioModeMuteAll

Mutes all audio, including microphone and external audio input.

Enumeration name

Description

AliEngineClientRoleInteractive

Interactive role.

AliEngineClientRoleLive

Viewer role.

Parameter

Type

Description

channelProfile

ChannelProfile

The channel configuration mode.

isAudioOnly

bool

Specifies whether to use audio-only mode.

publishAvsyncMode

PublishAvsyncMode

The audio and video synchronization mode for stream ingest.

publishMode

PublishMode

The stream ingest mode.

subscribeMode

SubscribeMode

The subscription mode.

subscribeVideoFormat

VideoFormat

The subscribed video format.

subscribeAudioFormat

AudioFormat

The subscribed audio format.

Parameter

Type

Description

channel

str

The channel name.

userid

str

The user ID.

username

str

The username.

appid

str

The application ID.

token

str

The authentication token.

timestamp

int

The timestamp.

Enumeration name

Description

AliEngineDataChannelNone

None.

AliEngineDataChannelProgress

Progress.

AliEngineDataChannelCustom

Custom.

Parameter

Type

Description

type

AliEngineDataMsgType

The message type.

networkTime

int

The network time.

progress

int

The progress.

data

bytes

The data.

dataLen

int

The data length.