This topic describes the data types used in the ApsaraVideo Real-time Communication iOS and Mac SDKs.
Contents
Data Type | Description |
Music accompaniment playback error code (iOS only). | |
Music accompaniment playback state (iOS only). | |
User volume information. | |
Audio sample. | |
Video sample. | |
Channel mode. | |
User role. | |
Session statistics. | |
Local video statistics. | |
Remote video statistics. | |
Local audio statistics. | |
Remote audio statistics. | |
Video data output position. | |
Video data format. | |
External device type (Mac only). | |
External device state (Mac only). | |
Network connectivity status. | |
Reason for network connectivity status change. | |
Video stream type. | |
Stream ingest state. | |
Subscription state. | |
Reason for user going offline. | |
Camera stream type. | |
Audio stream type. | |
Network quality. | |
Portrait or landscape mode (iOS only). | |
SDK control permissions for Audio Session (iOS only). | |
Rendering mode. | |
Mirror mode. | |
Rotation angle. | |
Log level. | |
Number of audio sound channels. | |
Recording audio sampling rate. | |
Recording type. | |
Recording format | |
Audio quality of recorded audio files. | |
Video quality of recorded video files. | |
Video codec type. | |
Video decoder settings. | |
Video encoding type. | |
Audio quality. | |
Audio quality mode. | |
Audio scenario mode parameter. | |
Local mute mode. | |
Recording audio settings. | |
Recording video settings. | |
Canvas size for recording video settings (Mac only). | |
Layout information for recording video (Mac only). | |
Layout mode for recording video (Mac only). | |
Background color for recording video (Mac only). | |
User frame configuration information for recording layout (Mac only). | |
User frame position information (Mac only). | |
Mixed-stream recording coordinates (Mac only). | |
Recording template (Mac only). | |
Device information (Mac only). | |
Basic retouching settings. | |
OnBye type enumeration. | |
Voice changer effect mode. | |
Audio reverb effect mode. | |
Audio reverb parameters. | |
Voice routing (iOS only). | |
Rendering canvas. | |
Bypass stream ingest error code. | |
Watermark image settings. | |
Camera capture preference properties. | |
Camera direction. | |
Specify camera capture resolution. | |
Camera capture preference. | |
Video encoding frame rate. | |
Video encoding bitrate. | |
Encoded video mirror mode. | |
Encoded video rotation mode. | |
Video encoding preferences. | |
Screen sharing encoding preferences. | |
Screen sharing configuration (Mac only). | |
Screen sharing region (Mac only). | |
Screen sharing source information (Mac only). | |
Screen sharing configuration information (Mac only). | |
Screen sharing type (Mac only). | |
Authentication information. | |
Device volume type (iOS only). | |
Raw video data source type. | |
Raw audio data source type. | |
Video data type. | |
Error code. | |
Video output width alignment mode. | |
Dashboard display type. | |
Bypass stream ingest LiveStream status. | |
Bypass live streaming image display type. | |
Bypass live streaming text type. | |
Bypass live streaming segmentation type. | |
Bypass live streaming input type. | |
Video stream state change. | |
Reason for triggering video stream state change. | |
Bypass live streaming cropping mode. | |
Bypass live streaming media processing mode. | |
Bypass live streaming relay stream type. | |
Bypass live streaming mode. | |
Bypass live streaming status. | |
Bypass live streaming text information. | |
Bypass live streaming image information. | |
Bypass live streaming custom user stream information. | |
Bypass live streaming configuration. | |
Bypass mode mixed-stream parameters. | |
Bypass mode single-stream parameters. | |
Bypass live streaming billing specification. | |
Bypass live streaming encoding parameters. | |
Bypass live streaming audio sampling rate. | |
Bypass live streaming clock widget. | |
Background replacement scaling mode (Mac only). | |
Music accompaniment playback state (Mac only). | |
Music accompaniment playback error code (Mac only). | |
Screen sharing type. | |
Feature aggregation profile. | |
Channel join parameters. | |
Network probing parameter settings. | |
Network probing result. | |
Audio frame struct. | |
Video pipeline mirror type. | |
Capture pipeline scaling type. | |
Audio accompaniment playback configuration. | |
Audio file information. | |
Data message definition. | |
Data message type. | |
Local device type. | |
Current device exception type. | |
Local audio capture state callback. | |
Local video capture state callback. | |
Music accompaniment playback state. | |
Music accompaniment playback error code. | |
Bypass live streaming video encoder. | |
Voice beautification mode enumeration. | |
Reverb parameter type enumeration. |
Details
AliRtcAudioPlayingErrorCode: Audio accompaniment playback error code (iOS only).
Enumeration Name
Description
AliRtcAudioPlayingNoError
Normal state.
AliRtcAudioPlayingOpenFailed
Failed to open file.
AliRtcAudioPlayingDecodeFailed
Encoding failed.
AliRtcAudioPlayingStateCode: Audio accompaniment playback state (iOS only).
Enumeration Name
Description
AliRtcAudioPlayingStarted
Playing.
AliRtcAudioPlayingStopped
Stopped playing.
AliRtcAudioPlayingPaused
Paused.
AliRtcAudioPlayingResumed
Resumed playing.
AliRtcAudioPlayingEnded
Playback finished.
AliRtcAudioPlayingBuffering
Buffering.
AliRtcAudioPlayingBufferingEnd
Buffering ended.
AliRtcAudioPlayingFailed
Playback failed.
AliRtcUserVolumeInfo: User volume information.
Parameter
Type
Description
uid
NSString * _Nonnull
UID of the current user. Values:
0: Local user.
1: Mixed remote audio.
Other: Remote user.
volume
int
Current callback volume.
speech_state
BOOL
true: Speaking.
false: Not speaking.
AliRtcAudioDataSample: Audio sample.
Parameter
Type
Description
dataPtr
long
Audio data pointer.
numOfSamples
int
Number of samples per channel.
bytesPerSample
int
Bytes per sample: For PCM, typically 16 bits (2 bytes).
numOfChannels
int
Number of sound channels. Values:
1: Mono.
2: Stereo.
samplesPerSec
int
Samples per second per channel (sampling rate).
AliRtcVideoDataSample: Video sample.
Parameter
Type
Description
format
Video data format.
type
Video data type.
pixelBuffer
CVPixelBufferRef _Nullable
PixelBuffer data.
dataPtr
long
YUV data pointer.
dataYPtr
long
Y component pointer.
dataUPtr
long
U component pointer.
dataVPtr
long
V component pointer.
dataLength
long
Data size.
strideY
int
Row stride of Y buffer in YUV data.
strideU
int
Row stride of U buffer in YUV data.
strideV
int
Row stride of V buffer in YUV data.
stride
int
Stride for RGB type.
height
int
Video frame height.
width
int
Video frame width.
rotation
int
Video frame rotation angle. Only 0, 90, 180, or 270 is supported.
timeStamp
long long
Timestamp.
AliRtcChannelProfile: Channel mode.
Enumeration Name
Description
AliRtcCommunication
Communication mode.
AliRtcInteractivelive
Interactive mode.
AliRtcInteractiveWithLowLatencyLive
Low-latency real-time communication mode.
AliRtcClientRole: User role.
Enumeration Name
Description
AliRtcClientRoleInteractive
Streamer role.
AliRtcClientRolelive
Viewer role.
AliRtcStats: Session statistics.
Parameter
Type
Description
sent_kbitrate
long long
Send bitrate.
rcvd_kbitrate
long long
Receive bitrate.
sent_bytes
long long
Sent bytes.
rcvd_bytes
long long
Received bytes.
systemCpuUsage
float
System CPU usage.
cpu_usage
float
RTC process CPU usage.
video_rcvd_kbitrate
long
Video receive bitrate.
video_sent_kbitrate
long
Video send bitrate.
call_duration
long
Call duration in seconds.
sent_loss_rate
long
Packet loss rate from client to server.
sent_loss_pkts
long long
Lost packets from client to server.
sent_expected_pkts
long long
Total packets from client to server.
rcvd_loss_rate
long long
Downstream packet loss rate from client to server.
rcvd_loss_pkts
long long
Downstream lost packets from client to server.
rcvd_expected_pkts
long long
Downstream total packets from client to server.
lastmile_delay
int
Delay in milliseconds.
available_sent_kbitrate
long long
Available bandwidth (kb).
AliRtcLocalVideoStats: Local video statistics.
Parameter
Type
Description
track
Stream type.
capture_width
unsigned int
Capture width.
capture_height
unsigned int
Capture height.
encode_width
unsigned int
Encode width.
encode_height
unsigned int
Encode height.
sent_bitrate
unsigned int
Publish bitrate.
sent_fps
unsigned int
Publish frame rate.
encode_fps
unsigned int
Encode frame rate.
target_encode_bitrate
unsigned int
Target encode bitrate.
actual_encode_bitrate
unsigned int
Actual encode bitrate.
capture_fps
unsigned int
Capture frame rate.
AliRtcRemoteVideoStats: Remote video statistics.
Parameter
Type
Description
userId
NSString * _Nonnull
User ID.
track
Video stream type.
width
unsigned int
Width.
height
unsigned int
Height.
decode_fps
unsigned int
Encoder output frame rate.
render_fps
unsigned int
Renderer output frame rate.
frozen_times
iunsigned int
Stuttering count.
video_total_frozen_time
unsigned int
Total accumulated stuttering duration during video playback, in ms.
video_total_frozen_rate
unsigned int
Accumulated stuttering rate during video playback, in %. Calculated as: Total stuttering duration / Total playback duration.
AliRtcLocalAudioStats: Local audio statistics.
Parameter
Type
Description
track
Audio stream type.
sent_bitrate
int
Send bitrate in Kbps.
sent_samplerate
int
Send sampling rate.
num_channel
int
Number of sound channels.
sendLoss
int
Send packet loss rate.
AliRtcRemoteAudioStats: Remote audio statistics.
Parameter
Type
Description
userId
NSString * _Nonnull
Remote user UID.
track
Audio stream type.
sample_rate
unsigned int
Sampling rate.
channels
unsigned int
Number of sound channels.
quality
unsigned int
Audio quality. For details, see AliRtcTranportAudioQuality.
.
audio_loss_rate
unsigned int
Audio frame loss rate during the callback period.
rcvd_bitrate
unsigned int
Instantaneous bitrate of the received stream in Kbps.
network_transport_delay
unsigned int
Network delay from sender to receiver in milliseconds.
jitter_buffer_delay
unsigned int
Network delay from receiver to jitter buffer in milliseconds.
AliRtcVideoObserPosition: Video data output position.
Enumeration Name
Description
AliRtcPositionPostCapture
Captured video data. Corresponds to the onCaptureVideoSample callback.
AliRtcPositionPreRender
Rendered video data. Corresponds to the onCaptureVideoSample callback.
AliRtcPositionPreEncoder
Pre-encoding video data. Corresponds to the onCaptureVideoSample callback.
AliRtcVideoFormat: Video data format.
Enumeration Name
Description
AliRtcVideoFormat_UNKNOW
Unknown.
AliRtcVideoFormat_BGRA
BGRA.
AliRtcVideoFormat_I420
I420.
AliRtcVideoFormat_NV21
NV21.
AliRtcVideoFormat_NV12
NV12.
AliRtcVideoFormat_RGBA
RGBA.
AliRtcVideoFormat_I422
I422.
AliRtcVideoFormat_ARGB
ARGB.
AliRtcVideoFormat_ABGR
ABGR.
AliRtcVideoFormat_RGB24
RGB24.
AliRtcVideoFormat_BGR24
BGR24.
AliRtcVideoFormat_RGB565
RGB565.
AliRtcVideoFormat_TextureOES
OES texture.
AliRtcVideoFormat_Texture2D
Texture2D texture.
AliRtcVideoFormat_H264
H264 encoded stream.
AliRtcVideoFormat_H265
H265 encoded stream.
AliRtcVideoFormat_File
File.
AliRtcVideoFormat_cvPixelBuffer
cvPixelBuffer.
AliRtcConnectionStatus: Network connectivity status.
Enumeration Name
Description
AliRtcConnectionStatusInit
Initialization complete.
AliRtcConnectionStatusDisconnected
Network connection disconnected.
AliRtcConnectionStatusConnecting
Establishing network connection.
AliRtcConnectionStatusConnected
Network connected.
AliRtcConnectionStatusReconnecting
Re-establishing network connection.
AliRtcConnectionStatusFailed
Network connection failed.
AliRtcConnectionStatusChangeReason: Reason for a change in the network connectivity status.
Enumeration Name
Description
AliRtcConnectionChangedDummyReason
Unknown reason.
AliRtcConnectionChangedMediaPathChanged
Media path changed.
AliRtcConnectionChangedSignalingHeartbeatTimeout
Heartbeat timeout.
AliRtcConnectionChangedSignalingHeartbeatAlive
Heartbeat restored.
AliRtcConnectionChangedSignalingHttpdnsResolved
DNS resolution succeeded.
AliRtcConnectionChangedSignalingHttpdnsFailure
DNS resolution failed.
AliRtcConnectionChangedSignalingGslbFailure
GSLB request failed.
AliRtcConnectionChangedSignalingGslbSucccess
GSLB request succeeded.
AliRtcConnectionChangedSignalingJoinChannelFailure
Failed to join channel.
AliRtcConnectionChangedSignalingJoinChannelSuccess
Joined channel successfully.
AliRtcConnectionChangedSignalingLeaveRoom
You can leave the channel.
AliRtcConnectionChangedSignalingConnecting
Signaling connection established.
AliRtcConnectionChangedNetworkInterrupted
Network connection interrupted.
AliRtcVideoTrack: Video stream type.
Enumeration Name
Description
AliRtcVideoTrackNo
No video stream.
AliRtcVideoTrackCamera
Camera stream.
AliRtcVideoTrackScreen
Screen sharing stream.
AliRtcVideoTrackBoth
Camera and screen sharing.
AliRtcPublishState: Stream ingest state.
Enumeration Name
Description
AliRtcStatsPublishIdle
Initial state.
AliRtcStatsNoPublish
Not ingesting stream.
AliRtcStatsPublishing
Ingesting stream.
AliRtcStatsPublished
Stream ingested.
AliRtcSubscribeState: Subscription state.
Enumeration Name
Description
AliRtcStatsSubscribeIdle
Initial state.
AliRtcStatsNoSubscribe
Not subscribed.
AliRtcStatsSubscribing
Subscribing.
AliRtcStatsSubscribed
Subscribed.
AliRtcUserOfflineReason: Reason for a user going offline.
Enumeration Name
Description
AliRtcUserOfflineQuit
User left voluntarily.
AliRtcUserOfflineDropped
Timed out due to prolonged lack of data packets from the other side.
AliRtcUserOfflineBecomeAudience
Triggered when user switches from streamer to viewer.
AliRtcVideoStreamType: Camera stream type.
Enumeration Name
Description
AliRtcVideoStreamTypeNone
No video stream.
AliRtcVideoStreamTypeHigh
High-volume stream.
AliRtcVideoStreamTypeLow
Small stream
AliRtcAudioTrack: Audio stream type.
Enumeration Name
Description
AliRtcAudioTrackNo
No audio stream.
AliRtcAudioTrackMic
Microphone stream.
AliRtcAudioTrackDual
Second audio stream.
AliRtcAudioTrackBoth
Microphone stream and second audio stream.
AliRtcNetworkQuality: Network quality.
Enumeration Name
Description
AlivcRtcNetworkQualityExcellent
Excellent network. Smooth and clear.
AlivcRtcNetworkQualityGood
Good network. Similar to excellent.
AlivcRtcNetworkQualityPoor
Fair network. Minor issues but communication unaffected.
AlivcRtcNetworkQualityBad
Poor network. Severe video stuttering but audio works.
AlivcRtcNetworkQualityVeryBad
Very poor network. Communication nearly impossible.
AlivcRtcNetworkQualityDisconnect
Network disconnected.
AlivcRtcNetworkQualityUnknow
Unknown reason.
AliRtcOrientationMode: Portrait or landscape mode (iOS only).
Enumeration Name
Description
AliRtcOrientationModePortrait
Fixed portrait mode.
AliRtcOrientationModeLandscapeLeft
Fixed left landscape mode.
AliRtcOrientationModePortraitUpsideDown
Fixed upside-down mode.
AliRtcOrientationModeLandscapeRight
Fixed right landscape mode.
AliRtcOrientationModeAuto
Auto portrait/landscape mode.
AliRtcAudioSessionOperationRestriction: SDK control permissions for the Audio Session (iOS only).
Enumeration Name
Description
AliRtcAudioSessionOperationRestrictionNone
No restrictions. SDK fully controls AVAudioSession.
AliRtcAudioSessionOperationRestrictionSetCategory
SDK cannot modify AVAudioSession category.
AliRtcAudioSessionOperationRestrictionConfigureSession
SDK cannot modify AVAudioSession configuration, including Category, Mode, and CategoryOptions.
AliRtcAudioSessionOperationRestrictionDeactivateSession
SDK cannot deactivate AVAudioSession. AVAudioSession remains active after leaving the channel.
AliRtcAudioSessionOperationRestrictionAll
SDK does not modify AVAudioSession configuration, including the three settings above.
AliRtcRenderMode: Rendering mode.
Enumeration Name
Description
AliRtcRenderModeAuto
Automatic.
AliRtcRenderModeStretch
Stretch to fill view without maintaining aspect ratio.
AliRtcRenderModeFill
Scale while maintaining aspect ratio and add black bars.
AliRtcRenderModeClip
Scale while maintaining aspect ratio and crop to fit view.
AliRtcRenderMirrorMode: Mirror mode.
Enumeration Name
Description
AliRtcRenderMirrorModeOnlyFrontCameraPreviewEnabled
Only mirror front camera preview; others are not mirrored.
AliRtcRenderMirrorModeAllEnabled
Mirror all.
AliRtcRenderMirrorModeAllDisable
Do not mirror any.
AliRtcRotationMode: Rotation angle.
Enumeration Name
Description
AliRtcRotationMode_0
No rotation.
AliRtcRotationMode_90
Rotate 90 degrees.
AliRtcRotationMode_180
Rotate 180 degrees.
AliRtcRotationMode_270
Rotate 270 degrees.
AliRtcLogLevel: Log level.
Enumeration Name
Description
AliRtcLogLevelInfo
Normal.
AliRtcLogLevelWarn
Warning.
AliRtcLogLevelError
Error.
AliRtcLogLevelFatal
Critical.
AliRtcLogLevelNone
None.
AliRtcAudioNumChannel: Number of audio channels.
Enumeration Name
Description
AliRtcMonoAudio
Mono.
AliRtcStereoAudio
Stereo.
AliRtcAudioSampleRate: Audio recording sampling rate.
Enumeration Name
Description
AliRtcAudioSampleRate_8000
8000 Hz sampling rate.
AliRtcAudioSampleRate_11025
11025 Hz sampling rate.
AliRtcAudioSampleRate_16000
16000 Hz sampling rate.
AliRtcAudioSampleRate_22050
22050 Hz sampling rate.
AliRtcAudioSampleRate_32000
32000 Hz sampling rate.
AliRtcAudioSampleRate_44100
44100 Hz sampling rate.
AliRtcAudioSampleRate_48000
48000 Hz sampling rate.
AliRtcAudioSampleRate_Unknown
Unknown sampling rate, used in specific scenarios.
AliRtcRecordType: Recording type.
Enumeration Name
Description
AliRtcRecordTypeAudio
Record audio-only file.
AliRtcRecordTypeVideo
Record video file.
AliRtcRecordFormat: Recording format.
Enumeration Name
Description
AliRtcRecordFormatAAC
AAC file.
AliRtcRecordFormatWAV
WAV file.
AliRtcRecordFormatMP4
MP4 file.
AliRtcAudioQuality: Recording audio quality.
Enumeration Name
Description
AliRtcAudioQualityLow
Low.
AliRtcAudioQualityMidium
Medium.
AliRtcAudioQualityHigh
High.
AliRtcVideoQuality: Recording video quality.
Enumeration Name
Description
AliRtcVideoQualityDefault
Default, same as capture.
AliRtcVideoCodecType: Video codec type.
Enumeration Name
Description
AliRtcVideoCodecTypeDefault
Not set, use default (hardware encoding)
AliRtcVideoCodecTypeSoftware
Software video encoder
AliRtcVideoCodecTypeHardware
Hardware video encoder
AliRtcVideoDecoderConfiguration: Video decoder settings.
Parameter
Type
Description
codecType
Codec type
Default is AliRtcVideoCodecTypeDefault, using system default settings,
enableDecoderBframe
NSInteger
Enable decoder B-frame
Default is -1, disable B-frame is 0, enable B-frame is 1,
backgroundHardwareToSoftware
NSInteger
Whether to degrade hardware decoding to software encoding when the app goes to the background;
Default is -1, disable degradation is 0, enable degradation logic is 1;
AliRtcVideoEncodeCodecType: Encoder type.
Enumeration Name
Description
AliRtcVideoEncodeCodecTypeDefault
Not set, use default value (currently h264)
AliRtcVideoEncodeCodecTypeH264
h264 encoding
AliRtcVideoEncodeCodecTypeHevc
hevc encoding
AliRtcTranportAudioQuality: Audio quality.
Enumeration name
Description
AliRtcAudioQulityUnknow
The quality is unknown.
AliRtcAudioQulityExcellent
The quality is excellent.
AliRtcAudioQulityGood
The user experience is similar to Excellent, but the bitrate may be slightly lower.
AliRtcAudioQulityPoor
The user experience is flawed, but communication is not affected.
AliRtcAudioQulityBad
Communication is difficult and not smooth.
AliRtcAudioQulityVeryBad
The network quality is very poor. Communication is nearly impossible.
AliRtcAudioQulityNetworkDisconnected
The network connectivity is lost. Communication is impossible.
AliRtcAudioProfile: Audio quality mode.
Enumeration Name
Description
AliRtcEngineLowQualityMode
Low audio quality mode.
AliRtcEngineBasicQualityMode
Standard audio quality mode.
AliRtcEngineHighQualityMode
High audio quality mode.
AliRtcEngineStereoHighQualityMode
Stereo high audio quality mode.
AliRtcEngineSuperHighQualityMode
Ultra-high audio quality mode.
AliRtcEngineStereoSuperHighQualityMode
Stereo ultra-high audio quality mode.
AliRtcAudioScenario: Audio scenario mode.
Enumeration Name
Description
AliRtcSceneDefaultMode
Default scenario. Recommended for general audio and video communication.
AliRtcSceneEducationMode
Education scenario. Prioritizes audio continuity and stability.
AliRtcSceneMediaMode
Media scenario. Preserves natural voice and music quality. Recommended for co-streaming live rooms.
AliRtcSceneMusicMode
Music scenario. High-fidelity music quality. Recommended for instrument teaching and scenarios requiring high music quality.
AliRtcSceneChatroomMode
Chat room scenario. Suitable for chat scenarios with frequent mic on/off.
AliRtcMuteLocalAudioMode: Local audio mute mode.
Enumeration Name
Description
AliRtcMuteAudioModeDefault
Default mode (mute all, including microphone and external audio input).
AliRtcMuteAllAudioMode
Mute all (including microphone and external audio input).
AliRtcMuteOnlyMicAudioMode
Mute only microphone.
AliRtcMuteLocalAudioMax
Placeholder.
AliRtcRecordAudioConfig: Audio recording settings.
Parameter
Type
Description
sampleRate
Audio sampling rate.
quality
Audio quality.
enableRecordExternalRenderPCM
bool
Allow recording external PCM input render data.
AliRtcRecordVideoConfig: Video recording settings.
Parameter
Type
Description
quality
Video quality.
AliRtcBeautyConfig: Basic retouching settings.
Parameter
Type
Description
whiteningLevel
float
Whitening. Range: [0,1]. Higher values produce stronger whitening.
smoothnessLevel
float
Skin smoothing. Range: [0,1]. Higher values produce stronger smoothing.
AliRtcOnByeType: OnBye type enumeration.
Enumeration Name
Description
AliRtcOnByeBeKickedOut
Kicked out.
AliRtcOnByeChannelTerminated
Channel terminated. Leave meeting.
AliRtcOnByeUserReplaced
Same user ID joined from another device. Current device goes offline.
AliRtcAudioEffectVoiceChangerMode: Voice changer effect mode.
Enumeration Name
Description
AliRtcAudioEffectvVoiceChanger_OFF
Off.
AliRtcAudioEffectvVoiceChanger_OLD_MAN
Old man.
AliRtcAudioEffectvVoiceChanger_BABYBOY
Boy.
AliRtcAudioEffectvVoiceChanger_BABYGILR
Girl.
AliRtcAudioEffectvVoiceChanger_ROBOT
Robot.
AliRtcAudioEffectvVoiceChanger_DAIMO
Big demon king.
AliRtcAudioEffectvVoiceChanger_KTV
KTV.
AliRtcAudioEffectvVoiceChangerR_ECHO
Echo.
AliRtcAudioEffectvVoiceChangerR_DIALECT
Dialect.
AliRtcAudioEffectvVoiceChangerR_HOWL
Roar.
AliRtcAudioEffectvVoiceChangerR_ELECTRONIC
Electronic.
AliRtcAudioEffectvVoiceChangerR_PHONOGRAPH
Phonograph.
AliRtcAudioEffectvVoiceChanger_MAX
Placeholder, no meaning.
AliRtcAudioEffectReverbMode: Audio reverb effect mode.
Enumeration Name
Description
AliRtcAudioEffectReverb_Off
Off.
AliRtcAudioEffectReverb_Vocal_I
Vocal I.
AliRtcAudioEffectReverb_Vocal_II
Vocal II.
AliRtcAudioEffectReverb_Bathroom
Bathhouse.
AliRtcAudioEffectReverb_Small_Room_Bright
Bright small room.
AliRtcAudioEffectReverb_Small_Room_Dark
Dark small room.
AliRtcAudioEffectReverb_Medium_Room
Medium room.
AliRtcAudioEffectReverb_Large_Room
Large room.
AliRtcAudioEffectReverb_Church_Hall
Church hall.
AliRtcAudioEffectReverb_Mode_Max
Placeholder, no meaning.
AliRtcAudioEffectReverbParamType: Audio reverb parameters.
Enumeration Name
Description
AliRtcAudioEffectReverb_Room_Size
Room size. Range: [0,100].
AliRtcAudioEffectReverb_Pre_Delay
Pre-delay in ms. Range: [0,200].
AliRtcAudioEffectReverb_Revetberance
Reverberance. Range: [0,100].
AliRtcAudioEffectReverb_Hf_Damping
Damping. Range: [0,100].
AliRtcAudioEffectReverb_Tone_Low
Low tone. Range: [0,100].
AliRtcAudioEffectReverb_Tone_High
High tone. Range: [0,100].
AliRtcAudioEffectReverb_Dry_Gain
Dry gain. Range: [-20,10].
AliRtcAudioEffectReverb_Wet_Gain
Wet gain. Range: [-20,10].
AliRtcAudioEffectReverb_Type_Max
Placeholder, no meaning.
AliRtcAudioRouteType: Audio routing (iOS only).
Enumeration Name
Description
AliRtcAudioRouteTypeDefault
Default voice routing.
AliRtcAudioRouteTypeHeadset
Headset.
AliRtcAudioRouteTypeEarpiece
Earpiece.
AliRtcAudioRouteTypeHeadsetNoMic
Headset without mic.
AliRtcAudioRouteTypeSpeakerphone
Phone speaker.
AliRtcAudioRouteTypeLoudSpeaker
External speaker.
AliRtcAudioRouteTypeBlueTooth
Bluetooth headset.
AliVideoCanvas: Rendering canvas.
Parameter
Type
Description
view
UIView * _Nonnull
Rendering view. Cannot be nil.
renderMode
Rendering mode. Default: AliRtcRenderModeAuto.
mirrorMode
Mirror mode. Default: AliRtcRenderMirrorModeOnlyFront.
backgroundColor
int
Background color in RGB hex format.
rotationMode
Video rotation angle. Default: no rotation.
AliRtcTrascodingLiveStreamErrorCode: Bypass live streaming error code.
Enumeration Name
Description
AliRtcTrascodingLiveStreamErrorPublishOk
Stream ingest succeeded.
AliRtcTrascodingLiveStreamErrorStreamNotFound
Error: Stream not found.
AliRtcTrascodingLiveStreamErrorStreamAlreadyExist
Error: Target stream already exists.
AliRtcTrascodingLiveStreamErrorInvalidParam
Error: Invalid parameter.
AliRtcTrascodingLiveStreamErrorInternalError
Error: Internal error.
AliRtcTrascodingLiveStreamErrorRtmpServerError
Error: RTMP service exception.
AliRtcTrascodingLiveStreamErrorRtmpStreamUrlError
Error: URL exception.
AliRtcTrascodingLiveStreamErrorPublishTimeout
Error: Task timeout.
AliRtcTrascodingLiveStreamErrorNotAuthorized
Error: Operation not authorized.
AliRtcWatermarkConfig: Watermark image settings.
Parameter
Type
Description
visibleInPreview
BOOL
Make watermark visible locally during preview.
positionInLandscapeMode
CGRect
Watermark coordinates in landscape mode.
positionInPortraitMode
CGRect
Watermark coordinates in portrait mode.
alpha
float
Transparency.
normalized
BOOL
Normalization
AliRtcCameraCapturerConfiguration: Camera capture preferences.
Parameter
Type
Description
preference
Capture preference.
cameraDirection
Camera direction.
fps
int
Specify camera preview frame rate. This setting allows different preview and encoding frame rates. For encoding frame rate, see frameRate in AliRtcVideoEncoderConfiguration.
cameraCaptureProfile
Specify a specific resolution for video capture.
disableVideoCaptureReverse
int
Do not flip captured video frames based on aspect ratio.
enableCameraMacroFocus
int
Support macro focus adjustment.
captureObserverOriginal
int
Callback original videoframe data.
nativeBufferObserver
int
Callback textureid.
captureCallbackCvpixelbufferToRaw
int
Use cvPixelBuffer for video capture callback.
AliRtcCameraDirection: Camera direction.
Enumeration Name
Description
AliRtcCameraDirectionInvalid
Unknown.
AliRtcCameraDirectionBack
Rear camera.
AliRtcCameraDirectionFront
Front camera.
AliRtcCameraCaptureProfile: Camera capture resolution.
Enumeration Name
Description
AliRtcCameraCaptureProfileDefault
Default.
AliRtcCameraCaptureProfile1080P
For 1080P video. Enables 1080P resolution capture.
AliRtcCaptureOutputPreference: Camera capture preference.
Enumeration Name
Description
AliRtcCaptureOutputPreferenceAuto
Automatically adjust capture parameters.
AliRtcCaptureOutputPreferencePerformance
Prioritize device performance. Select closest camera output parameters based on setVideoProfile.
AliRtcCaptureOutputPreferencePreview
Prioritize video preview quality. Select higher camera output parameters.
AliRtcVideoEncoderFrameRate: Video encoding frame rate.
Enumeration Name
Description
AliRtcVideoEncoderFrameRate_FPS_5
5 FPS.
AliRtcVideoEncoderFrameRate_FPS_10
10 FPS.
AliRtcVideoEncoderFrameRate_FPS_15
15 FPS.
AliRtcVideoEncoderFrameRate_FPS_20
20 FPS.
AliRtcVideoEncoderFrameRate_FPS_30
30 FPS.
AliRtcVideoEncoderBitrate: Video encoding bitrate.
Enumeration Name
Description
AliRtcVideoEncoderStandardBitrate
Standard bitrate mode.
AliRtcVideoEncoderMirrorMode: Encoded video mirror mode.
Enumeration Name
Description
AliRtcVideoEncoderMirrorModeDisabled
Mirror encoded video.
AliRtcVideoEncoderMirrorModeEnabled
Do not mirror encoded video.
AliRtcVideoEncoderOrientationMode: Encoded video rotation mode.
Enumeration Name
Description
AliRtcVideoEncoderOrientationModeAdaptive
Adaptive. Same as captured video.
AliRtcVideoEncoderOrientationModeFixedLandscape
Fixed landscape.
AliRtcVideoEncoderOrientationModeFixedPortrait
Fixed portrait.
AliRtcVideoEncoderConfiguration: Video encoding preferences.
Parameter
Type
Description
dimensions
CGSize
Video resolution.
frameRate
NSInteger
Video encoding frame rate.
bitrate
NSInteger
Video encoding bitrate.
min_bitrate
NSInteger
Minimum video encoding bitrate (Kbps). Default: 0.
keyFrameInterval
NSInteger
Keyframe interval in milliseconds. Default: 0 (SDK controls keyframe interval).
forceStrictKeyFrameInterval
bool
Force encoder to strictly follow set keyframe interval. Default: false.
false: Encoder responds to keyframe requests (e.g., when others join), so keyframe interval may not strictly match the set value.
true: Encoder ignores other keyframe requests and strictly follows the set value. May cause slower first-frame display for subscribers.
mirrorMode
Encoded video mirror mode.
orientationMode
Encoded video rotation mode.
rotationMode
Video rotation angle.
codecType
Codec type.
encoderType
Video encoding type.
seiForceFrontIFrame
NSInteger
Force I-frame before SEI sending.
-1: Use default value. 0: Do not force. 1: Force (default).
enableDynamicEncode
NSInteger
Enable dynamic encoding.
Create both hardware and software encoders. If hardware encoder fails, degrade to software encoder. -1: Use default. 0: Do not create both. 1: Create both.
disableDipenseResolutionChange
NSInteger
Disable QoS resolution reduction.
When QoS detects insufficient bandwidth for current resolution, it reduces video encoding resolution.
-1: Use default. 0: Allow reduction. 1: Disallow QoS resolution reduction.
enableDowngrade
NSInteger
Allow QoS to reduce video encoding bitrate based on actual bandwidth.
-1: Use default. 0: Disallow bitrate reduction. 1: Allow bitrate reduction.
enableH264BFrame
NSInteger
Enable h264 B-frame support.
-1: Use default. 0: Disable B-frame. 1: Enable B-frame.
ImportantDecoder must also enable B-frame support.
enableHevcBFrame
NSInteger
Enable hevc B-frame support.
-1: Use default. 0: Disable B-frame. 1: Enable B-frame.
ImportantDecoder must also enable B-frame support.
backgroundHardwareToSoftware
NSInteger
On iOS, hardware encoding stops when app is in background.
-1: Use default. 0: Disallow degradation. 1: Allow degradation.
AliRtcScreenShareEncoderConfiguration: Screen sharing encoding preferences.
Parameter
Type
Description
dimensions
CGSize
Video resolution.
frameRate
NSInteger
Video encoding frame rate.
bitrate
NSInteger
Video encoding bitrate.
rotationMode
Screen rotation angle.
keyFrameInterval
NSInteger
Keyframe interval in milliseconds. Default: 0 (SDK controls keyframe interval).
forceStrictKeyFrameInterval
bool
Force encoder to strictly follow set keyframe interval. Default: false.
false: Encoder responds to keyframe requests (e.g., when others join), so keyframe interval may not strictly match the set value.
true: Encoder ignores other keyframe requests and strictly follows the set value. May cause slower first-frame display for subscribers.
AliRtcAuthInfo: Authentication information.
Parameter
Type
Description
channelId
NSString * _Nonnull
Channel ID.
userId
NSString * _Nonnull
User ID.
appId
NSString * _Nonnull
Application ID.
nonce
NSString * _Nonnull
Random string.
token
NSString * _Nonnull
Token.
timestamp
long long
Timestamp.
AliRtcDeviceVolumeType: Device volume type (iOS only).
Enumeration Name
Description
AliRtcDeviceVolumeTypeAuto
SDK automatically sets volume type (default). SDK selects appropriate volume type internally. Do not set manually unless necessary.
AliRtcDeviceVolumeTypeMedia
Set to media volume. Suitable for media playback. Volume can be set to zero.
AliRtcDeviceVolumeTypeVOIP
Set to VOIP volume. Suitable for calls. Volume cannot be set to zero.
AliRtcVideoSource: Raw video data source type.
Enumeration Name
Description
AliRtcVideosourceCameraType
Video stream.
AliRtcVideosourceScreenShareType
Screen sharing stream.
AliRtcVideosourceTypeMax
Placeholder.
AliRtcAudioSource: Raw audio data source type.
Enumeration Name
Description
AliRtcAudioSourceCaptured
Captured audio data.
AliRtcAudioSourceProcessCaptured
3A processed audio data.
AliRtcAudiosourcePub
Stream ingest audio data.
AliRtcAudioSourcePlayback
Playback audio data.
AliRtcAudioSourceRemoteUser
Pulled remote user audio data.
AliRtcBufferType: Video data type.
Enumeration Name
Description
AliRtcBufferType_Raw_Data
Raw YUV data.
AliRtcBufferType_CVPixelBuffer
CVPixelBuffer data.
AliRtcBufferType_Texture
Texture.
AliRtcBufferType_File
File path.
AliRtcErrorCode: Error code.
Enumeration Name
Description
AliRtcErrNone
None.
AliRtcErrJoinBadAppId
App ID does not exist.
AliRtcErrJoinInvalidAppId
App ID expired.
AliRtcErrJoinBadChannel
Channel does not exist.
AliRtcErrJoinInvalidChannel
Channel expired.
AliRtcErrJoinBadToken
Token does not exist.
AliRtcErrJoinTimeout
Join channel timeout.
AliRtcErrJoinBadParam
Parameter error.
AliRtcErrMicOpenFail
Audio capture device initialization failed.
AliRtcErrSpeakerOpenFail
Audio playback device initialization failed.
AliRtcErrMicInterrupt
Exception during audio capture.
AliRtcErrSpeakerInterrupt
Exception during audio playback.
AliRtcErrMicAuthFail
Microphone not authorized.
AliRtcErrMicNotAvailable
No available audio capture device.
AliRtcErrSpeakerNotAvailable
No available audio playback device.
AliRtcErrCameraOpenFail
Video capture device initialization failed.
AliRtcErrCameraInterrupt
Exception during video capture.
AliRtcErrDisplayOpenFail
Rendering device initialization failed.
AliRtcErrDisplayInterrupt
Exception during rendering.
AliRtcErrIceConnectionConnectFail
Media channel establishment failed.
AliRtcErrIceConnectionReconnectFail
Media channel reconnection failed.
AliRtcErrIceConnectionHeartbeatTimeout
Signaling heartbeat timeout.
AliRtcErrPublishInvaild
Invalid stream ingest.
AliRtcErrPublishNotJoinChannel
Failed to ingest stream without joining channel.
AliRtcErrPublishAudioStreamFailed
Failed to push audio stream.
AliRtcErrPublishVideoStreamFailed
Failed to push video stream.
AliRtcErrPublishDualStreamFailed
Failed to push dual stream.
AliRtcErrPublishScreenShareFailed
Failed to push screen share.
AliRtcErrPublishScreenShareConfigError
Screen share configuration error.
AliRtcErrSubscribeInvaild
Invalid subscription.
AliRtcErrSubscribeNotJoinChannel
Subscription error without joining channel.
AliRtcErrSubscribeAudioStreamFailed
Failed to subscribe to audio stream.
AliRtcErrSubscribeVideoStreamFailed
Failed to subscribe to video stream.
AliRtcErrSubscribeDualStreamFailed
Failed to subscribe to dual stream.
AliRtcErrSubscribeScreenShareFailed
Failed to subscribe to screen share.
AliRtcErrCdnLiveCommunicationFailed
Low-latency real-time communication signaling failed.
AliRtcErrCdnLiveMeidaSettingFailed
Low-latency real-time communication media setting error.
AliRtcErrCdnLiveNoneBroadcaster
No streamer ingesting stream in low-latency real-time communication room.
AliRtcErrCdnLiveNeedRestart
Low-latency real-time communication error. Application layer must create new SDK instance.
AliRtcErrCdnLiveNeedRestartAgainLater
Low-latency real-time communication error. Application layer must wait and create new SDK instance later.
AliRtcErrCdnLiveServiceUnavailable
Low-latency real-time communication service unavailable or degraded.
AliRtcErrCdnLiveMediaConnectionInterruption
Low-latency real-time communication network interruption error.
AliRtcErrSdkInvalidState
SDK state error.
AliRtcErrSessionRemoved
Session removed.
AliRtcErrInvalidArguments
Parameter mismatch.
AliRtcErrAudioBufferFull
Buffer queue full. Used for external raw data input.
AliRtcErrVideoBufferFull
Buffer queue full. Used for external raw data input.
AliRtcErrUpdateRoleChannel
Role setting error in interactive mode.
AliRtcErrInner
Other errors.
AliRtcExternalDeviceType: External device type (Mac only).
Enumeration Name
Description
AliRtcExternalTypeUnknown
Unknown type.
AliRtcExternalTypeAudioCapture
Audio capture device.
AliRtcExternalTypeAudioPlayout
Audio playback device.
AliRtcExternalTypeVideoCapture
Video capture device.
AliRtcExternalDeviceState: External device state (Mac only).
Enumeration Name
Description
AliRtcExternalDeviceAdd
Add external device.
AliRtcExternalDeviceRemove
Remove external device.
AliRtcRecordVideoCanvasConfig: Canvas size for video recording settings (Mac only).
Parameter
Type
Description
canvasWidth
int
Canvas width.
canvasHeight
int
Canvas height.
AliRtcRecordVideoLayout: Layout information for video recording (Mac only).
Parameter
Type
Description
mode
Layout mode.
backColor
Background color.
shapes
NSMutableArray<AliRtcRecordVideoRegion *> * _Nullable
User frame position information.
AliRtcRecordVideoLayoutMode: Layout mode for video recording (Mac only).
Enumeration Name
Description
AliRtcRecordVideoLayoutMode_GRID
Grid layout.
AliRtcRecordVideoLayoutMode_SPEAKER
Speaker layout.
AliRtcRecordVideoLayoutMode_UNIQUE
Single stream layout.
AliRtcRecordVideoLayoutMode_CUSTOM
Custom layout.
AliRtcRecordVideoBgColor: Background color for video recording (Mac only).
Parameter
Type
Description
r
uint8_t
Red value in color ratio.
g
uint8_t
Green value in color ratio.
b
uint8_t
Blue value in color ratio.
AliRtcRecordVideoRegion: User frame configuration for the recording layout (Mac only).
Parameter
Type
Description
userId
NSString * _Nonnull
User ID.
sourceType
Raw video data source type.
area
User frame position information.
AliRtcRecordVideoRectangle: User frame position information (Mac only).
Parameter
Type
Description
left
Left margin.
top
Top margin.
width
Width.
height
Height.
AliRtcRecordVideoRational: Mixed-stream recording coordinates (Mac only).
Parameter
Type
Description
numerator
uint32_t
Numerator (integer).
denominator
uint32_t
Denominator (integer).
AliRtcRecordTemplate: Recording template (Mac only).
Parameter
Type
Description
recordType
Recording type.
recordFormat
Recording format.
sampleRate
Recording audio sampling rate.
audioQuality
Recording audio quality.
enableRecordExternalCapturePCM
bool
Mix and record external input audio.
enableRecordExternalRenderPCM
bool
Mix and record external input rendered audio.
canvas
Canvas size for recording video.
fps
int
Frame rate.
bitrate
int
Bitrate.
isFragment
bool
Record segmented MP4. Default: true.
AliRtcDeviceInfo: Device information (Mac only).
Parameter
Type
Description
deviceName
NSString * _Nullable
Device name.
deviceID
NSString * _Nullable
Device ID.
AliRtcScreenShareConfig: Screen sharing configuration (Mac only).
Parameter
Type
Description
isShareByRegion
bool
Whether to share by region.
shareRegion
AliRtcScreenShareRegion* _Nonnull
Layout information for region sharing.
AliRtcScreenShareRegion: Screen sharing region (Mac only).
Parameter
Type
Description
originX
float
X coordinate.
originY
float
Y coordinate.
width
float
Width.
heigh
foat
Height.
AliRtcScreenSourceInfo: Screen sharing source information (Mac only).
Parameter
Type
Description
sourceId
NSString * _Nonnull
Sharing source ID.
sourceName
NSString * _Nonnull
Sharing source name.
AliRtcScreenShareInfo: Screen sharing configuration information (Mac only).
Parameter
Type
Description
sourceType
Sharing type.
sourceId
NSString * _Nonnull
Sharing source ID.
config
AliRtcScreenShareConfig * _Nonnull
Screen sharing configuration.
AliRtcScreenShareType: Screen sharing type (Mac only).
Enumeration Name
Description
AliRtcScreenShareDesktop
Desktop sharing.
AliRtcScreenShareWindow
Window sharing.
AliRtcVideoObserAlignment: Video output width alignment mode.
Enumeration Name
Description
AliRtcAlignmentDefault
Keep original video width (default).
AliRtcAlignmentEven
Even number alignment.
AliRtcAlignment4
Width is multiple of 4.
AliRtcAlignment8
Width is multiple of 8.
AliRtcAlignment16
Width is multiple of 16.
AliRtcShowDebugViewType: Dashboard display type.
Enumeration Name
Description
AliRtcShowTypeNone
Do not display.
AliRtcShowTypeAudio
Audio.
AliRtcShowTypeVideo
Video.
AliRtcShowTypeNetwork
Network.
AliRtcShowTypeAll
All.
AliRtcTrascodingLiveTaskStatus: Bypass live streaming task status.
Enumeration Name
Description
AliRtcTrascodingLiveTaskStatusStart
Task started.
AliRtcTrascodingLiveTaskStatusUpdate
Task updated.
AliRtcTrascodingLiveTaskStatusStop
Task stopped.
AliRtcLiveTranscodingDisplayType: Bypass live streaming image display type.
Enumeration Name
Description
NOT_DISPLAY
Do not display.
ALWAYS
Always display.
WHEN_NO_VIDEO
Display when no video.
AliRtcLiveTranscodingFontType: Bypass live streaming text type.
Enumeration Name
Description
NOTO_SERIF_CJKSC_REGULAR
Noto Serif CJK SC Regular.
ALIBABA_PUHUITI_REGULAR
Alibaba PuHuiTi Regular.
ALIBABA_PUHUITI_BOLD
Alibaba PuHuiTi Bold.
ALIBABA_PUHUITI_Heavy
Alibaba PuHuiTi Heavy.
ALIBABA_PUHUITI_LIGHT
Alibaba PuHuiTi Light.
ALIBABA_PUHUITI_MEDIUM
Alibaba PuHuiTi Medium.
AliRtcLiveTranscodingSegmentType: Bypass live streaming segmentation type.
Enumeration Name
Description
AliRtcLiveTranscodingNoBody
No human segmentation.
AliRtcLiveTranscodingBody
Human segmentation.
AliRtcLiveTranscodingSourceType: Bypass live streaming input type.
Enumeration Name
Description
AliRtcLiveTranscodingCamera
Camera.
AliRtcLiveTranscodingShareScreen
Screen share.
AliRtcVideoState: Video stream state change.
Enumeration Name
Description
AliRtcVideoVideoClose
Close video stream.
AliRtcVideoVideoOpen
Resume video stream.
AliRtcVideoReason: Reason for a video stream state change.
Enumeration Name
Description
AliRTCVideoChangedByClient
Client.
AliRTCVideoChangedByServer
Server.
AliRtcLiveTranscodingCropMode: Bypass live streaming cropping mode.
Enumeration Name
Description
AliRtcLiveTranscodingCrop
Proportional cropping.
AliRtcLiveTranscodingFill
Proportional with black bars (default).
AliRtcLiveTranscodingMediaProcessMode: Bypass live streaming media processing mode.
Enumeration Name
Description
AliRtcLiveTranscodingNormal
General mode.
AliRtcLiveTranscodingVirtualBackground
Virtual background mode.
AliRtcLiveTranscodingStreamType: Bypass live streaming relay stream type.
Enumeration Name
Description
AliRtcLiveTranscodingOrigin
Relay original stream.
AliRtcLiveTranscodingAudio
Relay audio stream only.
AliRtcLiveTranscodingVideo
Relay video stream only.
AliRtcLiveTranscodingMixMode: Bypass live streaming mode.
Enumeration Name
Description
AliRtcLiveTranscodingSINGLE
Single stream relay. No mixing or transcoding. Relay original single stream only. No mixing/transcoding parameters needed.
AliRtcLiveTranscodingMIX
Mixed-stream transcoding (default). Supports mixed-stream transcoding output.
AliRtcLiveTranscodingState: Bypass live streaming status.
Enumeration Name
Description
AliRtcLiveTranscodingState_IDLE
Stream idle.
AliRtcLiveTranscodingState_CONNNECT
Connecting to stream server.
AliRtcLiveTranscodingState_RUNNING
Streaming in progress.
AliRtcLiveTranscodingState_RECOVERING
Recovering stream.
AliRtcLiveTranscodingState_FAILURE
Stream failed.
AliRtcLiveTranscodingState_END
Stream ended.
AliRtcLiveTranscodingText: Bypass live streaming text information.
Parameter
Type
Description
text
NSString
Text information.
x
int
X coordinate in pixels.
y
int
Y coordinate in pixels.
fontType
Bypass live streaming font.
fontSize
int
Font size.
zOrder
int
Stacking order. 0 is bottom layer, 1 is above 0, and so on.
fontColor
int
Font color.
AliRtcLiveTranscodingImage: Bypass live streaming image information.
Parameter
Type
Description
url
NSString
Image URL.
alpha
float
Transparency. 0.0 is transparent, 1.0 is fully opaque.
display
Image display.
x
int
X coordinate in pixels.
y
int
Y coordinate in pixels.
width
int
Image width.
height
int
Image height.
zOrder
it
Stacking order. 0 is bottom layer, 1 is above 0, and so on.
AliRtcLiveTranscodingUser: Bypass live streaming custom user stream information.
Parameter
Type
Description
x
int
X coordinate in pixels.
y
int
Y coordinate in pixels.
width
int
Pane width.
height
int
Pane height.
zOrder
int
Stacking order. 0 is bottom layer, 1 is above 0, and so on.
userId
NSString *
User ID.
streamType
Bypass live streaming relay stream mode.
sourceType
Stream type.
segmentType
Bypass live streaming input type.
images
NSArray<AliRtcLiveTranscodingImage *> *
Bypass live streaming image information.
texts
NSArray<AliRtcLiveTranscodingText *> *
Bypass live streaming text information.
AliRtcLiveTranscodingParam: Bypass live streaming configuration.
Parameter
Type
Description
mixMode
Bypass live streaming mode.
singleParam
Bypass live streaming single stream parameters.
mixParam
Bypass live streaming mixed-stream parameters.
AliRtcLiveTranscodingMixParam: Mixed-stream parameters for bypass mode.
Parameter
Type
Description
taskProfile
Bypass live streaming billing specification.
encodeParam
Bypass live streaming encoding parameters.
users
NSArray<AliRtcLiveTranscodingUser *> *
Bypass live streaming user list.
backgroundColor
int
Background color.
backgrounds
NSArray<AliRtcLiveTranscodingImage *> *
Background image list.
watermarks
NSArray<AliRtcLiveTranscodingImage *> *
Watermark image list.
clockWidgets
NSArray<AliRtcLiveTranscodingClockWidget *> *
Clock widget list.
cropMode
Bypass live streaming cropping mode.
mediaProcessMode
Bypass live streaming media processing mode.
AliRtcLiveTranscodingSingleParam: Single-stream parameters for bypass mode.
Parameter
Type
Description
userId
NSString *
User ID.
streamType
Bypass live streaming relay stream type.
sourceType
Bypass live streaming video stream type.
AliRtcLiveTranscodingTaskProfile: Bypass live streaming billing specification.
Enumeration Name
Description
AliRtcLiveTranscoding_Profile_1IN_1080P
1IN_1080P.
AliRtcLiveTranscoding_Profile_1IN_720P
1IN_720P.
AliRtcLiveTranscoding_Profile_1IN_360P
1IN_360P.
AliRtcLiveTranscoding_Profile_2IN_1080P
2IN_1080P.
AliRtcLiveTranscoding_Profile_2IN_720P
2IN_720P.
AliRtcLiveTranscoding_Profile_2IN_360P
2IN_360P.
AliRtcLiveTranscoding_Profile_4IN_1080P
4IN_1080P.
AliRtcLiveTranscoding_Profile_4IN_720P
4IN_720P.
AliRtcLiveTranscoding_Profile_4IN_360P
4IN_360P.
AliRtcLiveTranscoding_Profile_9IN_1080P
9IN_1080P.
AliRtcLiveTranscoding_Profile_9IN_720P
9IN_720P.
AliRtcLiveTranscoding_Profile_9IN_360P
9IN_360P.
AliRtcLiveTranscoding_Profile_12IN_1080P
12IN_1080P.
AliRtcLiveTranscoding_Profile_12IN_720P
12IN_720P.
AliRtcLiveTranscoding_Profile_12IN_360P
12IN_360P.
AliRtcLiveTranscoding_Profile_16IN_1080P
16IN_1080P.
AliRtcLiveTranscoding_Profile_16IN_720P
16IN_720P.
AliRtcLiveTranscoding_Profile_16IN_360P
16IN_360P.
AliRtcLiveTranscoding_Profile_Mixed
Audio-only.
AliRtcLiveTranscodingEncodeParam: Bypass live streaming encoding parameters.
Parameter
Type
Description
videoWidth
int
Width.
videoHeight
int
Height.
videoFramerate
int
Frame rate.
videoBitrate
int
Bitrate.
videoGop
int
GOP.
videoCodec
Bypass live streaming video encoder.
audioSamplerate
Bypass live streaming audio sampling rate.
audioBitrate
int
Audio bitrate.
audioChannels
int
Number of audio sound channels.
AliRtcLiveTranscodingAudioSampleRate: Bypass live streaming audio sampling rate.
Enumeration Name
Description
AliRtcLiveTranscoding_HZ_48000
48000 Hz sampling rate.
AliRtcLiveTranscoding_HZ_44100
44100 Hz sampling rate.
AliRtcLiveTranscoding_HZ_32000
32000 Hz sampling rate.
AliRtcLiveTranscoding_HZ_16000
16000 Hz sampling rate.
AliRtcLiveTranscoding_HZ_8000
8000 Hz sampling rate.
AliRtcLiveTranscodingClockWidget: Bypass live streaming clock widget.
Parameter
Type
Description
x
int
X coordinate in pixels.
y
int
Y coordinate in pixels.
fontSize
int
Bypass live streaming font size.
zOrder
int
Stacking order. 0 is bottom layer, 1 is above 0, and so on.
fontColor
int
Bypass live streaming font color.
fontType
Bypass live streaming font.
AliRtcBokehScaleModel: Background replacement scaling mode (Mac only).
Enumeration Name
Description
AliRtcBokehScaleModelCrop
Proportional cropping.
AliRtcBokehScaleModelFill
Add black bars.
AliRtcAudioPlayingStateCode: Audio accompaniment playback state (Mac only).
Enumeration Name
Description
AliRtcAudioPlayingStarted
Started playing.
AliRtcAudioPlayingStopped
Stopped playing.
AliRtcAudioPlayingPaused
Playback paused.
AliRtcAudioPlayingResumed
Playback resumed.
AliRtcAudioPlayingEnded
Playback finished.
AliRtcAudioPlayingBuffering
Buffering.
AliRtcAudioPlayingBufferingEnd
Buffering ended.
AliRtcAudioPlayingFailed
Playback failed.
AliRtcAudioPlayingErrorCode: Audio accompaniment playback error code (Mac only).
Enumeration Name
Description
AliRtcAudioPlayingNoError
No error.
AliRtcAudioPlayingOpenFailed
Failed to open file.
AliRtcAudioPlayingDecodeFailed
Failed to decode file.
AliRtcScreenShareMode
Enumeration Name
Description
AliRtcScreenShareNone
Do not share.
AliRtcScreenShareVideo
Share video stream.
AliRtcScreenShareAudioApp
Share app audio stream.
AliRtcScreenShareAll
Share all audio and video streams. Does not support sharing mic audio stream. Use SDK's built-in mic audio capture instead.
AliRtcCapabilityProfile: Feature aggregation profile.
Enumeration Name
Description
AliRtcCapabilityProfileDefault
Default value, no special requirements.
AliRtcCapabilityProfileAiHuman
For AI agent call scenarios, real user features.
AliRtcCapabilityProfileAiRobot
For AI agent call scenarios, robot features.
AliRtcChannelParam: Channel join parameters.
Parameter
Type
Description
channelId
NSString*
Channel to join. Must match the channel used when generating the token. Can be omitted to use the token's channelId by default.
userId
NSString*
User ID to join. Must match the ID used when generating the token. Can be omitted to use the token's userId by default.
userName
NSString*
Any display name for the user (not User ID). Can be omitted to indicate no userName.
capabilityProfile
Feature profile. For AI agent call scenarios with additional feature requirements, select a profile instead of enabling features individually.
AliRtcNetworkQualityProbeConfig: Network quality probing parameters.
Parameter
Type
Description
probeUplink
BOOL
Probe uplink. Default: NO
probeDownlink
BOOL
Probe downlink. Default: NO (Not supported yet)
upLinkBandWidth
int
Peak uplink bandwidth for probing, in kbps. Default: 1000
DownLinkBandWidth
int
Peak downlink bandwidth for probing, in kbps. Default: 1000 (Not supported yet)
AliRtcNetworkQualityProbeResult: Network quality probing result.
Parameter
Type
Description
rtt
int
Round-trip time (RTT) in ms.
upLinkLossRate
int
Uplink packet loss rate, max 100%.
upLinkJitter
int
Uplink jitter in ms.
upLinkBandWidth
int
Uplink bandwidth in kbps.
downLinkLossRate
int
Downlink packet loss rate, max 100%. Not supported yet.
downLinkJitter
int
Downlink jitter in ms. Not supported yet.
downLinkBandWidth
int
Downlink bandwidth in kbps. Not supported yet.
AliRtcAudioFrame: Raw audio data.
Parameter
Type
Description
dataPtr
void *
Audio data pointer.
numOfSamples
int
Number of samples.
bytesPerSample
int
Bytes per sample.
numOfChannels
int
Number of sound channels.
samplesPerSec
int
Sampling rate.
AliRtcVideoPipelineMirrorMode: Video pipeline mirror type.
Enumeration Name
Description
AliRtcVideoPipelineMirrorModeNoMirror
Disable mirroring for both preview and encoding.
AliRtcVideoPipelineMirrorModeBothMirror
Enable mirroring for both preview and encoding.
AliRtcVideoPipelineMirrorModeOnlyPreviewMirror
Enable mirroring for preview only.
AliRtcVideoPipelineMirrorModeOnlyPublishMirror
Enable mirroring for stream ingest only.
AliRtcCapturePipelineScaleMode: Capture pipeline scaling type.
Enumeration Name
Description
AliRtcCapturePipelineScaleModePre
Scale immediately after capture (default).
AliRtcCapturePipelineScaleModePost
Scale during encoding.
AliRtcAudioAccompanyConfig: Audio accompaniment playback configuration.
Parameter
Type
Description
onlyLocalPlay
BOOL
Play locally only.
replaceMic
BOOL
Specifies whether the MIC will be replaced.
loopCycles
int
Loop count. Set to -1 for infinite loop or a positive integer for specific loops. Other values are invalid.
startPosMs
NSInteger
Start position in ms.
publishVolume
int
Stream ingest volume. Range: [0-100]. Default: 50.
playoutVolume
int
Playback volume. Range: [0-100]. Default: 50.
AliRtcAudioFileInfo: Audio file information.
Parameter
Type
Description
filePath
NSString *
Audio file path.
durationMs
NSInteger
Audio file duration in ms.
AliRtcDataChannelMsg: Data message definition.
Parameter
Type
Description
type
Audio data pointer.
networkTime
long long
Network timestamp.
progress
int
Progress.
data
NSData*
Data.
AliRtcDataMsgType: Data message type.
Enumeration
Description
AliRtcDataMsgNone
Undefined message.
AliRtcDataMsgMusicProgress
Music progress message.
AliRtcDataMsgCustom
Custom user message.
AliRtcLocalDeviceType: Local device type.
Enumeration Value
Description
AliRtcLocalDeviceTypeUnknown
Unknown device type.
AliRtcLocalDeviceTypeMic
Microphone device.
AliRtcLocalDeviceTypeSpeaker
Speaker device.
AliRtcLocalDeviceTypeAudioDevice
Audio device.
AliRtcLocalDeviceTypeCamera
Camera device.
AliRtcLocalDeviceTypeDisplay
Display device.
AliRtcLocalDeviceTypeVideoDevice
Video device.
AliRtcLocalDeviceExceptionType: Local device exception type.
Enumeration Value
Description
AliRtcLocalDeviceExceptionTypeUnknown
Unknown exception type.
AliRtcLocalDeviceExceptionTypeMicOpenFail
Microphone open failed.
AliRtcLocalDeviceExceptionTypeMicInterrupt
Microphone interrupted.
AliRtcLocalDeviceExceptionTypeMicAuthFail
Microphone unauthorized.
AliRtcLocalDeviceExceptionTypeMicNotAvailable
No available microphone.
AliRtcLocalDeviceExceptionTypeSpeakerOpenFail
Speaker open failed.
AliRtcLocalDeviceExceptionTypeSpeakerInterrupt
Speaker interrupted.
AliRtcLocalDeviceExceptionTypeSpeakerNotAvailable
No available speaker.
AliRtcLocalDeviceExceptionTypeAudioDeviceException
Audio device exception.
AliRtcLocalDeviceExceptionTypeCameraOpenFail
Camera open failed.
AliRtcLocalDeviceExceptionTypeCameraInterrupt
Camera interrupted.
AliRtcLocalDeviceExceptionTypeCameraAuthFail
Camera unauthorized.
AliRtcLocalDeviceExceptionTypeDisplayExecption
Display device exception.
AliRtcLocalDeviceExceptionTypeVideoDeviceException
Video device exception.
AliRtcLocalAudioStateType: Local audio capture state.
Enumeration Value
Description
AliRtcLocalAudioStateTypeStarting
Starting.
AliRtcLocalAudioStateTypeStarted
Startup is complete.
AliRtcLocalAudioStateTypeStopping
Stopping.
AliRtcLocalAudioStateTypeStopped
Stopped.
AliRtcLocalVideoStateType: Local video device state.
Enumeration Value
Description
AliRtcLocalVideoStateTypeStarting
Starting.
AliRtcLocalVideoStateTypeStarted
Started.
AliRtcLocalVideoStateTypeStopping
Stopping.
AliRtcLocalVideoStateTypeStopped
Stopped.
AliRtcAudioAccompanyStateCode: Audio accompaniment playback state.
Enumeration Value
Description
AliRtcAudioAccompanyStarted
Started playing.
AliRtcAudioAccompanyStopped
Stopped playing.
AliRtcAudioAccompanyPaused
Playback paused.
AliRtcAudioAccompanyResumed
Playback resumed.
AliRtcAudioAccompanyEnded
Playback finished.
AliRtcAudioAccompanyBuffering
Buffering.
AliRtcAudioAccompanyBufferingEnd
Buffering ended.
AliRtcAudioAccompanyFailed
Playback failed.
AliRtcAudioAccompanyErrorCode: Audio accompaniment playback error code.
Enumeration Value
Description
AliRtcAudioAccompanyNoError
No error.
AliRtcAudioAccompanyOpenFailed
Failed to open file.
AliRtcAudioAccompanyDecodeFailed
Failed to decode file.
AliRtcLiveTranscodingVideoCodec: Bypass live streaming video encoder.
Enumeration Name
Description
AliRtcLiveTranscodingVideoCodec_H264
h264
AliRtcLiveTranscodingVideoCodec_H265
h265
AliRtcAudioEffectBeautifyMode: Voice beautification mode enumeration.
Enumeration Value
Description
AliRtcAudioEffectBeautify_Off
Disable voice beautification effect.
AliRtcAudioEffectBeautify_Vigorous
Mellow.
AliRtcAudioEffectBeautify_Ringing
Clear.
AliRtcAudioEffectBeautify_Mode_Max
Placeholder indicating maximum value. Do not use for actual settings.
AliRtcAudioEffectEqualizationBandFrequency: Equalization band frequency enumeration.
Enumeration Constant
Description
AliRtcSdk_AudioEffect_EqualizationBand31
31 Hz
AliRtcSdk_AudioEffect_EqualizationBand62
62 Hz
AliRtcSdk_AudioEffect_EqualizationBand125
125 Hz
AliRtcSdk_AudioEffect_EqualizationBand250
250 Hz
AliRtcSdk_AudioEffect_EqualizationBand500
500 Hz
AliRtcSdk_AudioEffect_EqualizationBand1K
1 kHz
AliRtcSdk_AudioEffect_EqualizationBand2K
2 kHz
AliRtcSdk_AudioEffect_EqualizationBand4K
4 kHz
AliRtcSdk_AudioEffect_EqualizationBand8K
8 kHz
AliRtcSdk_AudioEffect_EqualizationBand16K
16 kHz