Data structures

Data type

Description

ERROR_CODE

Defines error codes.

WARNNING_CODE

Defines warning codes.

ChannelProfile

The channel mode.

PublishMode

The stream ingest mode.

LogLevel

The log level.

AudioQualityMode

The audio quality mode.

AudioSceneMode

The audio scene mode.

VideoTrack

The video track.

AudioTrack

The audio track.

VideoProfile

The video resolution configuration.

AliEngineVideoDimensions

The video resolution.

AliEngineFrameRate

The video frame rate.

AliEngineVideoEncoderOrientationMode

The video output orientation.

AliEngineVideoMirrorMode

The video mirror mode.

AliEngineRotationMode

The video rotation angle.

AliEngineVideoEncoderConfiguration

The configuration for camera stream video encoding.

AliEngineScreenShareEncoderConfiguration

The configuration for screen sharing stream encoding.

VideoSource

The video source.

RenderMode

The rendering mode.

PublishAvsyncMode

The A/V sync mode for stream ingest.

VideoDataFormat

The video data format.

VideoBufferType

The video buffer type.

VideoDataSample

The video data sample.

SubscribeMode

Defines enumerations used only for subscriptions.

VideoTrackType

The video track type.

VideoFormat

The video format.

AudioFormat

The audio format.

VideoFrameType

The video frame type.

AudioFrameType

The audio frame type.

AudioPcmFrame

The audio PCM frame class.

AudioAacFrame

The audio AAC frame class.

AudioFrame

The audio frame class.

AudioTranscodingCodec

The audio transcoding codec type.

VideoTranscodingCodec

The video transcoding codec type.

VideoH264Frame

The H.264 video frame class.

VideoFrame

The video frame class.

AliEnginePublishState

The stream ingest state.

AliEngineSubscribeState

The subscription state.

AliEngineVideoStreamType

The video stream type.

AliEngineMuteLocalAudioMode

The mute mode.

AliEngineClientRole

The user role type.

JoinChannelConfig

Configuration class for joining a channel.

AuthInfo

The authentication information class.

AliEngineDataMsgType

The accompaniment control instruction mode.

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

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

ERR_LEAVE_UNUSUAL

(New) Left the channel unexpectedly. You may have been kicked out.

ERR_NO_PEOPLE

(Customized feature for review) No one is in the channel. The channel may not exist or the streamer may have stopped streaming.

ERR_AUDIO_DATA_ERROR

An error occurred in the audio data.

ERR_VIDEO_DATA_ERROR

An error occurred in the video data.

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-resolution 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

Failed to subscribe to the stream 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-resolution 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 external audio input frequency exceeds the supported range.

ERR_FATAL

A critical SDK error occurred.

Enumeration

Description

WARN_DEFAULT

Default warning.

Enumeration Name

Description

ChannelProfileCommunication

Communication mode.

ChannelProfileInteractiveLive

Live streaming mode

ChannelProfileInteractiveWithLowLatencyLive

Low-latency interactive live streaming mode.

Enumeration name

Description

PublishAutomatically

Automatic stream ingest.

PublishManually

Manual stream ingest.

Enumeration name

Description

LogLevelInfo

Outputs logs of LogLevelInfo and higher.

LogLevelWarn

Outputs logs of LogLevelWarn and higher.

LogLevelError

Outputs logs of LogLevelError and higher.

LogLevelFatal

Outputs logs of LogLevelFatal and higher.

LogLevelNone

Does not output any logs.

Enumeration Name

Description

LowQualityMode

Low quality mode. Default sample rate: 8000 Hz. Default sound channel: mono. Maximum bitrate: 12 kbps.

BasicQualityMode

(Default) Standard quality mode. Default sample rate: 16000 Hz. Default sound channel: mono. Maximum bitrate: 24 kbps.

HighQualityMode

High quality mode. Default sample rate: 48000 Hz. Default sound channel: mono. Maximum bitrate: 64 kbps.

StereoHighQualityMode

Stereo high quality mode. Default sample rate: 48000 Hz. Default sound channel: stereo. Maximum bitrate: 80 kbps.

SuperHighQualityMode

Super high quality mode. Default sample rate: 48000 Hz. Default sound channel: mono. Maximum bitrate: 96 kbps.

StereoSuperHighQualityMode

Stereo super high quality mode. Default sample rate: 48000 Hz. Default sound channel: stereo. Maximum bitrate: 128 kbps.

QualityMaxMode

The maximum value for the audio quality mode.

Enumeration

Description

DefaultMode

Default mode. Uses hardware 3A algorithms.

EducationMode

Education scenario. Uses hardware 3A algorithms.

MediaMode

Media scenario. Uses basic software 3A algorithms.

MusicMode

Music scenario. Uses music-optimized software 3A algorithms.

ChatroomMode

Chat scenario. Uses hardware 3A algorithms.

KtvMode

KTV mode. Uses music-optimized software 3A algorithms and AAudio.

SceneMaxMode

The maximum value for the scene mode.

Enumeration name

Description

VideoTrackNo

No video track.

VideoTrackCamera

Video from a source such as a camera or a file.

VideoTrackScreen

Video from screen sharing.

VideoTrackBoth

Includes both VideoTrackCamera and VideoTrackScreen.

VideoTrackEnd

A flag that indicates the end of the video track.

Enumeration name

Description

AudioTrackNo

No audio track.

AudioTrackMic

Audio from a source such as a microphone or a file.

AudioTrackEnd

A flag that indicates the end of 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: 1500 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: 1200 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 mode. The stream ingest orientation is the same as the capture orientation.

AliEngineVideoEncoderOrientationModeFixedLandscape

Landscape mode is for horizontal videos. In this mode, the SDK pushes a portrait stream because it always sets the output video width to the smaller of the set width and height, and the height to the larger value.

AliEngineVideoEncoderOrientationModeFixedPortrait

In portrait mode (vertical video), the SDK pushes a landscape stream by setting the output video's width to the larger of the two resolution dimensions and the height to the smaller dimension.

Enumeration Name

Description

AliEngineVideoMirrorModeDisabled

Disables mirroring.

AliEngineVideoMirrorModeEnable

Enables mirroring.

Enumeration name

Description

AliEngineRotationModeNoChange

Does not change the rotation angle.

AliEngineRotationMode_0

0 degrees.

AliEngineRotationMode_90

You can rotate the object by 90 degrees.

AliEngineRotationMode_180

180 degrees.

AliEngineRotationMode_270

Rotate 270 degrees.

Parameter

Type

Description

Dimensions

AliEngineVideoDimensions

The video resolution. Default: 640 × 480. Maximum: 1920 × 1080.

FrameRate

AliEngineFrameRate

The video frame rate. Default: 15. Maximum: 30.

Bitrate

int

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

KeyFrameInterval

int

The keyframe interval.

OrientationMode

AliEngineVideoEncoderOrientationMode

The video output orientation. Default: adaptive.

MirrorMode

AliEngineVideoMirrorMode

The mirror mode for stream ingest. Default: disabled.

RotationMode

AliEngineRotationMode

The rotation angle for stream ingest. Default: 0 degrees.

Parameter

Type

Description

Dimensions

AliEngineVideoDimensions

The video resolution. Default: 0 × 0. Maximum: 3840 × 2160. The default value indicates that the stream ingest resolution is the same as the screen capture resolution.

FrameRate

AliEngineFrameRate

The video frame rate. Default: 5. Maximum: 30.

Bitrate

int

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

RotationMode

AliEngineRotationMode

The rotation angle for stream ingest. Default: 0 degrees. For more information, see AliEngineRotationMode.

Enumeration Name

Description

VideoSourceCamera

Video source from the camera.

VideoSourceScreenShare

Video source from screen sharing.

VideosourceTypeMax

The maximum value for the video source type.

Enumeration Name

Description

RenderModeAuto

Auto mode.

RenderModeStretch

Stretch mode. If the aspect ratio of the external video input does not match the aspect ratio of the stream ingest, the video is stretched to fit, which may cause distortion.

RenderModeFill

Fill mode. If the aspect ratio of the external video input does not match the aspect ratio of the stream ingest, black bars are added to the top and bottom or to the left and right of the video.

RenderModeCrop

Crop mode. If the aspect ratio of the external video input does not match the aspect ratio of the stream ingest, the video is cropped by width or height, which may result in content loss.

Enumeration

Description

PublishAvsyncNoDelay

The SDK does not cache data internally. Data is sent to the network immediately after PushExternalVideoFrame or PushExternalAudioFrame is called. The caller must ensure A/V synchronization.

PublishAvysncWithPts

The SDK performs internal caching and uses the input Presentation Time Stamp (PTS) for audio-video synchronization and transmission pacing. The PublishAvysncWithPts method handles several use cases. For example, if you push only audio data from a file, such as a 2-second audio segment, you can input it into the SDK all at once. The SDK then uses the PTS to pace the data, progressively sending it to the network over the 2-second duration. If you input audio and video simultaneously but there is a delay between when they are obtained, the SDK internally aligns them based on their respective PTS values and sends them to the network sequentially. Within a single join-leave lifecycle, if you publish and unpublish multiple times, the PTS values of the different segments you send must be on the same timeline. For example, after you join a session, you publish for the first time with PTS values starting from 0. If you unpublish after 10 seconds and then publish again 10 seconds later, the PTS values for the second publish operation must start from 20 seconds. You cannot restart the PTS from 0, because this will cause stuttering.

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. Default: nullptr.

DataLen

int

The length of the video data.

StrideY

int

The stride of the Y plane. Default: 0.

StrideU

int

The stride of the U plane. Default: 0.

StrideV

int

The stride of the V plane. Default: 0.

Height

int

The video height. Default: 0.

Width

int

The video width. Default: 0.

Rotation

int

The video rotation angle. Default: 0.

TimeStamp

int

The timestamp.

Enumeration Name

Description

SubscribeAutomatically

Automatic subscription.

SubscribeManually

Manual subscription.

SubscribeAudioAutoAndOnly

Automatically subscribe to audio only.

SubscribeCameraAutoAndOnly

Automatically subscribe to video from the camera only.

Enumeration

Description

VideoTrackCameraLarge

The high-resolution video stream from the camera.

VideoTrackCameraSmall

The low-resolution video stream from the camera.

VideoTrackCameraSuper

The ultra-high-resolution video stream from the camera.

VideoTrackScreenshare

The screen sharing video stream.

Enumeration name

Description

VideoFormatNone

No video format.

VideoFormatH264

H.264 video format.

Enumeration

Description

AudioFormatNone

No audio format.

AudioFormatMixedPcm

Mixed PCM format.

AudioFormatPcmBeforMixing

Pre-mixed PCM format.

Enumeration

Description

VideoFrameH264

YUV I420. The decoded image.

VideoFrameH264Nalu

H.264 NALU. The pre-decoded image.

Enumeration name

Description

AudioFrameRawPcm

Raw PCM data.

AudioFrameAacAdts

AAC ADTS format data.

Parameter

Type

Description

FrameMs

int

The timestamp in milliseconds.

Channels

int

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

SampleBits

int

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

SampleRates

int

The audio sample rate, such as 8000 Hz (8 kHz), 16000 Hz (16 kHz), or 32000 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

FrameMs

int

The timestamp in milliseconds.

Channels

int

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

SampleRates

int

The audio sample rate. Valid values: 8000 Hz (8 kHz), 16000 Hz (16 kHz), and 32000 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

FrameType

AudioFrameType

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

Pcm

AudioPcmFrame

The audio PCM frame.

Aac

AudioAacFrame

The audio AAC frame.

Enumeration Name

Description

AudioTranscodingCodecPcm

Transcode to PCM format only.

AudioTranscodingCodecAac

Transcode to AAC format only.

AudioTranscodingCodecBothPcmAndAac

Transcode to both PCM and AAC formats.

AudioTranscodingCodecMax

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

Enumeration name

Description

VideoTranscodingCodecYuv

Transcode to YUV format only.

VideoTranscodingCodecH264

Transcode to H.264 format only.

VideoTranscodingCodecBothYuvAndH264

Transcode to both YUV and H.264 formats.

VideoTranscodingCodecMax

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

Parameter

Type

Description

FrameMs

int

The timestamp of the video frame in milliseconds.

FrameNum

int

The sequence 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.

FrameType

VideoFrameType

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

Frame

VideoH264Frame

The H.264 video frame.

Enum name

Description

AliEngineStatsPublishIdle

Initial state.

AliEngineStatsNoPublish

There is no stream ingest.

AliEngineStatsPublishing

Ingesting.

AliEngineStatsPublished

Stream ingestion has started.

Enumeration

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 subscribed to any stream.

AliEngineVideoStreamTypeHigh

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

AliEngineVideoStreamTypeLow

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

Enumeration name

Description

AliEngineMuteLocalAudioModeDefault

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

AliEngineMuteLocalAudioModeMuteOnlyMic

Mutes the microphone only.

AliEngineMuteLocalAudioModeMuteAll

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

Enumeration

Description

AliEngineClientRoleInteractive

Interactive role.

AliEngineClientRoleLive

Viewer role.

Parameter

Type

Description

ChannelProfile

ChannelProfile

The channel configuration mode.

IsAudioOnly

bool

Specifies whether to enable audio-only mode.

PublishAvsyncMode

PublishAvsyncMode

The A/V sync mode for stream ingest.

PublishMode

PublishMode

The stream ingest mode.

SubscribeMode

SubscribeMode

The subscription mode.

SubscribeVideoFormat

VideoFormat

The format of the subscribed video.

SubscribeAudioFormat

AudioFormat

The format of the subscribed audio.

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.