全部產品
Search
文件中心

ApsaraVideo Live:資料結構

更新時間:Dec 17, 2025

本文介紹即時音視頻iOS SDK和Mac SDK涉及的資料類型。

目錄

資料類型

描述

AliRtcAudioPlayingErrorCode

音樂伴奏播放錯誤碼(僅iOS)。

AliRtcAudioPlayingStateCode

音樂伴奏播放狀態(僅iOS)。

AliRtcUserVolumeInfo

使用者音量資訊。

AliRtcAudioDataSample

音頻樣本。

AliRtcVideoDataSample

視頻樣本。

AliRtcChannelProfile

頻道模式。

AliRtcClientRole

使用者角色。

AliRtcStats

會話資料統計資訊。

AliRtcLocalVideoStats

本地視頻統計資訊。

AliRtcRemoteVideoStats

遠端視頻統計資訊。

AliRtcLocalAudioStats

本地音頻統計資訊。

AliRtcRemoteAudioStats

遠端音頻統計資訊。

AliRtcVideoObserPosition

視頻資料輸出位置。

AliRtcVideoFormat

視頻資料格式。

AliRtcExternalDeviceType

外接裝置類型(僅Mac)。

AliRtcExternalDeviceState

外接裝置狀態(僅Mac)。

AliRtcConnectionStatus

網路連接狀態。

AliRtcConnectionStatusChangeReason

網路連接狀態變更原因。

AliRtcVideoTrack

視頻流類型。

AliRtcPublishState

推流狀態。

AliRtcSubscribeState

訂閱狀態。

AliRtcUserOfflineReason

使用者離線原因。

AliRtcVideoStreamType

相機流類型。

AliRtcAudioTrack

音頻流類型。

AliRtcNetworkQuality

網路品質。

AliRtcOrientationMode

橫豎屏類型(僅iOS)。

AliRtcAudioSessionOperationRestriction

SDK對Audio Session的控制許可權(僅iOS)。

AliRtcRenderMode

渲染模式。

AliRtcRenderMirrorMode

鏡像模式。

AliRtcRotationMode

旋轉角度。

AliRtcLogLevel

記錄層級。

AliRtcAudioNumChannel

音頻聲道數。

AliRtcAudioSampleRate

錄製音頻採樣率。

AliRtcRecordType

錄製類型。

AliRtcRecordFormat

錄製格式

AliRtcAudioQuality

錄製音頻檔案的音頻品質。

AliRtcVideoQuality

錄製視頻檔案的視頻品質。

AliRtcVideoCodecType

視頻轉碼器類型。

AliRtcVideoDecoderConfiguration

視頻解碼器設定。

AliRtcVideoEncodeCodecType

視頻編碼類別型。

AliRtcTranportAudioQuality

音頻品質。

AliRtcAudioProfile

音頻品質模式。

AliRtcAudioScenario

音頻情境模式參數。

AliRtcMuteLocalAudioMode

本地靜音。

AliRtcRecordAudioConfig

錄製音頻設定。

AliRtcRecordVideoConfig

錄製視頻設定。

AliRtcRecordVideoCanvasConfig

錄製視頻設定的畫布大小(僅Mac)。

AliRtcRecordVideoLayout

錄製視頻的布局資訊(僅Mac)。

AliRtcRecordVideoLayoutMode

錄製視頻的配置模式(僅Mac)。

AliRtcRecordVideoBgColor

錄製視頻的背景顏色(僅Mac)。

AliRtcRecordVideoRegion

錄製布局的使用者畫面配置資訊(僅Mac)。

AliRtcRecordVideoRectangle

使用者畫面的位置資訊(僅Mac)。

AliRtcRecordVideoRational

混流錄製座標(僅Mac)。

AliRtcRecordTemplate

錄製模板(僅Mac)。

AliRtcDeviceInfo

裝置資訊(僅Mac)。

AliRtcBeautyConfig

基礎美顏設定。

AliRtcOnByeType

OnBye類型枚舉。

AliRtcAudioEffectVoiceChangerMode

變聲音效模式。

AliRtcAudioEffectReverbMode

音效混響模式。

AliRtcAudioEffectReverbParamType

音效混響參數。

AliRtcAudioRouteType

語音路由(僅iOS)。

AliVideoCanvas

渲染畫布。

AliRtcTrascodingLiveStreamErrorCode

旁路推流錯誤碼。

AliRtcWatermarkConfig

浮水印圖片的設定。

AliRtcCameraCapturerConfiguration

相機採集偏好屬性。

AliRtcCameraDirection

網路攝影機方向。

AliRtcCameraCaptureProfile

指定網路攝影機採集解析度。

AliRtcCaptureOutputPreference

網路攝影機採集偏好。

AliRtcVideoEncoderFrameRate

視頻編碼幀率。

AliRtcVideoEncoderBitrate

視頻編碼碼率。

AliRtcVideoEncoderMirrorMode

編碼視頻鏡像模式。

AliRtcVideoEncoderOrientationMode

編碼視頻旋轉模式。

AliRtcVideoEncoderConfiguration

視頻編碼偏好。

AliRtcScreenShareEncoderConfiguration

螢幕分享編碼偏好。

AliRtcScreenShareConfig

螢幕分享配置(僅Mac)。

AliRtcScreenShareRegion

螢幕分享地區(僅Mac)。

AliRtcScreenSourceInfo

螢幕分享源資訊(僅Mac)。

AliRtcScreenShareInfo

螢幕分享配置資訊(僅Mac)。

AliRtcScreenShareType

螢幕分享類型(僅Mac)。

AliRtcAuthInfo

鑒權資訊。

AliRtcDeviceVolumeType

裝置音量類型(僅iOS)。

AliRtcVideoSource

視頻裸資料來源類型。

AliRtcAudioSource

音頻裸資料來源類型。

AliRtcBufferType

視頻資料類型。

AliRtcErrorCode

錯誤碼。

AliRtcVideoObserAlignment

視頻輸出寬度對齊。

AliRtcShowDebugViewType

顯示儀錶盤類型。

AliRtcTrascodingLiveTaskStatus

旁路推流LiveStream狀態。

AliRtcLiveTranscodingDisplayType

旁路直播圖片顯示類型。

AliRtcLiveTranscodingFontType

旁路直播文字類型。

AliRtcLiveTranscodingSegmentType

旁路直播分割類型。

AliRtcLiveTranscodingSourceType

旁路直播輸入類型。

AliRtcVideoState

視頻流狀態變化。

AliRtcVideoReason

觸發視頻流狀態變化的原因。

AliRtcLiveTranscodingCropMode

旁路直播裁剪模式。

AliRtcLiveTranscodingMediaProcessMode

旁路直播ApsaraVideo for Media Processing模式。

AliRtcLiveTranscodingStreamType

旁路直播轉推流類型。

AliRtcLiveTranscodingMixMode

旁路直播模式。

AliRtcLiveTranscodingState

旁路直播狀態。

AliRtcLiveTranscodingText

旁路直播文本資訊。

AliRtcLiveTranscodingImage

旁路直播圖片資訊。

AliRtcLiveTranscodingUser

旁路直播使用者自訂流資訊。

AliRtcLiveTranscodingParam

旁路直播配置。

AliRtcLiveTranscodingMixParam

旁路模式混流參數。

AliRtcLiveTranscodingSingleParam

旁路模式單路參數。

AliRtcLiveTranscodingTaskProfile

旁路直播計費規格。

AliRtcLiveTranscodingEncodeParam

旁路直播編碼參數。

AliRtcLiveTranscodingAudioSampleRate

旁路直播音頻採樣率。

AliRtcLiveTranscodingClockWidget

旁路直播時鐘小工具。

AliRtcBokehScaleModel

背景替換縮放模式(僅Mac)。

AliRtcAudioPlayingStateCode

音樂伴奏播放狀態(僅Mac)。

AliRtcAudioPlayingErrorCode

音樂伴奏播放錯誤碼(僅Mac)。

AliRtcScreenShareMode。

螢幕畫面分享類型。

AliRtcCapabilityProfile

功能彙總的profile。

AliRtcChannelParam

入會參數。

AliRtcNetworkQualityProbeConfig

網路探測的參數配置。

AliRtcNetworkQualityProbeResult

網路探測的結果。

AliRtcAudioFrame

音訊框架結構體。

AliRtcVideoPipelineMirrorMode

視頻鏈路鏡像類型。

AliRtcCapturePipelineScaleMode

採集鏈路縮放類型。

AliRtcAudioAccompanyConfig

音頻伴奏播放配置。

AliRtcAudioFileInfo

音頻檔案資訊。

AliRtcDataChannelMsg

data訊息定義。

AliRtcDataMsgType

data訊息類型。

AliRtcLocalDeviceType

本地裝置類型。

AliRtcLocalDeviceExceptionType

當前裝置異常類型。

AliRtcLocalAudioStateType

本地音頻採集狀態回調。

AliRtcLocalVideoStateType

本地視頻採集狀態回調。

AliRtcAudioAccompanyStateCode

音樂伴奏播放狀態。

AliRtcAudioAccompanyErrorCode

音樂伴奏播放錯誤碼。

AliRtcLiveTranscodingVideoCodec

旁路直播視頻編碼器。

AliRtcAudioEffectBeautifyMode

美聲模式類型枚舉。

AliRtcAudioEffectEqualizationBandFrequency

混響參數類型枚舉。

詳情

  • AliRtcAudioPlayingErrorCode:音樂伴奏播放錯誤碼(僅iOS)。

    枚舉名

    描述

    AliRtcAudioPlayingNoError

    正常狀態。

    AliRtcAudioPlayingOpenFailed

    開啟檔案失敗。

    AliRtcAudioPlayingDecodeFailed

    編碼失敗。

  • AliRtcAudioPlayingStateCode:音樂伴奏播放狀態(僅iOS)。

    枚舉名

    描述

    AliRtcAudioPlayingStarted

    現正播放。

    AliRtcAudioPlayingStopped

    停止播放。

    AliRtcAudioPlayingPaused

    暫停播放。

    AliRtcAudioPlayingResumed

    恢複播放。

    AliRtcAudioPlayingEnded

    播放結束。

    AliRtcAudioPlayingBuffering

    正在緩衝。

    AliRtcAudioPlayingBufferingEnd

    緩衝結束。

    AliRtcAudioPlayingFailed

    播放失敗。

  • AliRtcUserVolumeInfo:使用者音量資訊。

    參數

    類型

    描述

    uid

    NSString * _Nonnull

    目前使用者的UID,取值:

    • 0:表示本地。

    • 1:表示遠端混音。

    • 其他:表示遠端使用者。

    volume

    int

    當前回調的音量。

    speech_state

    BOOL

    • true:表示正在說話。

    • false:表示沒有說話。

  • AliRtcAudioDataSample:音頻樣本。

    參數

    類型

    描述

    dataPtr

    long

    音頻資料指標。

    numOfSamples

    int

    每個聲道的採樣點數。

    bytesPerSample

    int

    每個採樣點的位元組數:對於PCM來說,一般使用16 bit,即兩個位元組。

    numOfChannels

    int

    聲道數量,取值:

    • 1:單聲道。

    • 2:雙聲道。

    samplesPerSec

    int

    每聲道每秒的採樣點數,即採樣率。

  • AliRtcVideoDataSample:視頻樣本。

    參數

    類型

    描述

    format

    AliRtcVideoFormat

    視頻資料格式。

    type

    AliRtcBufferType

    視頻資料類型。

    pixelBuffer

    CVPixelBufferRef _Nullable

    pixelBuffer資料。

    dataPtr

    long

    yuv資料指標。

    dataYPtr

    long

    Y分量指標。

    dataUPtr

    long

    U分量指標。

    dataVPtr

    long

    V分量指標。

    dataLength

    long

    資料大小。

    strideY

    int

    YUV資料中的Y緩衝區的行跨度。

    strideU

    int

    YUV資料中的U緩衝區的行跨度。

    strideV

    int

    YUV資料中的V緩衝區的行跨度。

    stride

    int

    RGB類型的stride。

    height

    int

    視訊框架的高。

    width

    int

    視訊框架的寬。

    rotation

    int

    視訊框架的旋轉角度,僅支援設定0、90、180、270。

    timeStamp

    long long

    時間戳記。

  • AliRtcChannelProfile:頻道模式。

    枚舉名

    描述

    AliRtcCommunication

    通訊模式。

    AliRtcInteractivelive

    互動模式。

    AliRtcInteractiveWithLowLatencyLive

    低延遲即時音視頻模式。

  • AliRtcClientRole:使用者角色。

    枚舉名

    描述

    AliRtcClientRoleInteractive

    主播角色。

    AliRtcClientRolelive

    觀眾角色。

  • AliRtcStats:會話資料統計資訊。

    參數

    類型

    描述

    sent_kbitrate

    long long

    發送碼率。

    rcvd_kbitrate

    long long

    接收碼率。

    sent_bytes

    long long

    發送位元組數。

    rcvd_bytes

    long long

    接收位元組數。

    systemCpuUsage

    float

    系統CPU使用率。

    cpu_usage

    float

    RTC進程CPU使用率。

    video_rcvd_kbitrate

    long

    視頻接收碼率。

    video_sent_kbitrate

    long

    視頻發送碼率。

    call_duration

    long

    通話時間長度,單位:秒。

    sent_loss_rate

    long

    用戶端到伺服器的丟包率。

    sent_loss_pkts

    long long

    用戶端到伺服器的丟包數。

    sent_expected_pkts

    long long

    用戶端到伺服器的總包數。

    rcvd_loss_rate

    long long

    用戶端到伺服器的下行丟包率。

    rcvd_loss_pkts

    long long

    用戶端到伺服器的下行丟包數。

    rcvd_expected_pkts

    long long

    用戶端到伺服器的下行總包數。

    lastmile_delay

    int

    延時時間長度,單位:毫秒。

    available_sent_kbitrate

    long long

    可用頻寬(kb)。

  • AliRtcLocalVideoStats:本地視頻統計資訊。

    參數

    類型

    描述

    track

    AliRtcVideoTrack

    流類型。

    capture_width

    unsigned int

    採集寬度。

    capture_height

    unsigned int

    採集高度。

    encode_width

    unsigned int

    編碼寬度。

    encode_height

    unsigned int

    編碼高度。

    sent_bitrate

    unsigned int

    發布位元速率。

    sent_fps

    unsigned int

    發布幀率。

    encode_fps

    unsigned int

    編碼幀率。

    target_encode_bitrate

    unsigned int

    目標編碼碼率。

    actual_encode_bitrate

    unsigned int

    實際編碼碼率。

    capture_fps

    unsigned int

    採集幀率。

  • AliRtcRemoteVideoStats:遠端視頻統計資訊。

    參數

    類型

    描述

    userId

    NSString * _Nonnull

    使用者ID。

    track

    AliRtcVideoTrack

    視頻流類型。

    width

    unsigned int

    寬。

    height

    unsigned int

    高。

    decode_fps

    unsigned int

    編碼器輸出幀率。

    render_fps

    unsigned int

    渲染器輸出幀率。

    frozen_times

    iunsigned int

    卡頓次數。

    video_total_frozen_time

    unsigned int

    視頻播放的累計卡頓時間長度,單位ms。

    video_total_frozen_rate

    unsigned int

    視頻播放的累計卡頓率,單位% 計算方法視頻播放卡頓率=視頻播放的累計卡頓時間長度/視頻播放的總時間長度。

  • AliRtcLocalAudioStats:本地音頻統計資訊。

    參數

    類型

    描述

    track

    AliRtcVideoTrack

    音頻流類型。

    sent_bitrate

    int

    發送碼率,單位:Kbps。

    sent_samplerate

    int

    發送的採樣率。

    num_channel

    int

    聲道數。

    sendLoss

    int

    發送丟包率。

  • AliRtcRemoteAudioStats:遠端音頻統計資訊。

    參數

    類型

    描述

    userId

    NSString * _Nonnull

    遠端使用者UID。

    track

    AliRtcAudioTrack

    音頻流類型。

    sample_rate

    unsigned int

    採樣率。

    channels

    unsigned int

    聲道數。

    quality

    unsigned int

    音質,詳情請參見AliRtcTranportAudioQuality

    audio_loss_rate

    unsigned int

    回調周期內的音頻丟幀率。

    rcvd_bitrate

    unsigned int

    接收流的瞬時碼率,單位:Kbps。

    network_transport_delay

    unsigned int

    發送端到接收端的網路延時,單位:毫秒。

    jitter_buffer_delay

    unsigned int

    接受端到網路抖動緩衝的網路延時,單位:毫秒。

  • AliRtcVideoObserPosition:視頻資料輸出位置。

    枚舉名

    描述

    AliRtcPositionPostCapture

    採集視頻資料,對應輸出回調onCaptureVideoSample。

    AliRtcPositionPreRender

    渲染視頻資料,對應輸出回調onCaptureVideoSample。

    AliRtcPositionPreEncoder

    編碼前視頻資料,對應輸出回調onCaptureVideoSample。

  • AliRtcVideoFormat:視頻資料格式。

    枚舉名

    描述

    AliRtcVideoFormat_UNKNOW

    未知。

    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紋理。

    AliRtcVideoFormat_Texture2D

    Texture2D紋理。

    AliRtcVideoFormat_H264

    H264編碼流。

    AliRtcVideoFormat_H265

    H265編碼流。

    AliRtcVideoFormat_File

    檔案。

    AliRtcVideoFormat_cvPixelBuffer

    cvPixelBuffer。

  • AliRtcConnectionStatus:網路連接狀態。

    枚舉名

    描述

    AliRtcConnectionStatusInit

    初始化完成。

    AliRtcConnectionStatusDisconnected

    網路連接斷開。

    AliRtcConnectionStatusConnecting

    建立網路連接中。

    AliRtcConnectionStatusConnected

    網路已串連。

    AliRtcConnectionStatusReconnecting

    重建立立網路連接中。

    AliRtcConnectionStatusFailed

    網路連接失敗。

  • AliRtcConnectionStatusChangeReason:網路連接狀態變更原因。

    枚舉名

    描述

    AliRtcConnectionChangedDummyReason

    未知原因。

    AliRtcConnectionChangedMediaPathChanged

    媒體通道變更。

    AliRtcConnectionChangedSignalingHeartbeatTimeout

    心跳逾時。

    AliRtcConnectionChangedSignalingHeartbeatAlive

    心跳恢複。

    AliRtcConnectionChangedSignalingHttpdnsResolved

    DNS解析成功。

    AliRtcConnectionChangedSignalingHttpdnsFailure

    DNS解析失敗。

    AliRtcConnectionChangedSignalingGslbFailure

    GSLB請求失敗。

    AliRtcConnectionChangedSignalingGslbSucccess

    GSLB請求成功。

    AliRtcConnectionChangedSignalingJoinChannelFailure

    加入頻道失敗。

    AliRtcConnectionChangedSignalingJoinChannelSuccess

    加入頻道成功。

    AliRtcConnectionChangedSignalingLeaveRoom

    離開頻道。

    AliRtcConnectionChangedSignalingConnecting

    信令建立串連。

    AliRtcConnectionChangedNetworkInterrupted

    網路連接中斷 。

  • AliRtcVideoTrack:視頻流類型。

    枚舉名

    描述

    AliRtcVideoTrackNo

    無視頻流。

    AliRtcVideoTrackCamera

    網路攝影機流。

    AliRtcVideoTrackScreen

    螢幕畫面分享流。

    AliRtcVideoTrackBoth

    網路攝影機和螢幕畫面分享。

  • AliRtcPublishState:推流狀態。

    枚舉名

    描述

    AliRtcStatsPublishIdle

    初始狀態。

    AliRtcStatsNoPublish

    未推流。

    AliRtcStatsPublishing

    推流中。

    AliRtcStatsPublished

    已推流。

  • AliRtcSubscribeState:訂閱狀態。

    枚舉名

    描述

    AliRtcStatsSubscribeIdle

    初始狀態。

    AliRtcStatsNoSubscribe

    未訂閱。

    AliRtcStatsSubscribing

    訂閱中。

    AliRtcStatsSubscribed

    已訂閱。

  • AliRtcUserOfflineReason:使用者離線原因。

    枚舉名

    描述

    AliRtcUserOfflineQuit

    使用者主動離開。

    AliRtcUserOfflineDropped

    因過長時間收不到對方資料包,逾時掉線。

    AliRtcUserOfflineBecomeAudience

    使用者身份從主播切換為觀眾時觸發。

  • AliRtcVideoStreamType:相機流類型。

    枚舉名

    描述

    AliRtcVideoStreamTypeNone

    無視頻流。

    AliRtcVideoStreamTypeHigh

    大流。

    AliRtcVideoStreamTypeLow

    小流。

  • AliRtcAudioTrack:音頻流類型。

    枚舉名

    描述

    AliRtcAudioTrackNo

    無音頻流。

    AliRtcAudioTrackMic

    麥克風流。

    AliRtcAudioTrackDual

    第二條音頻流。

    AliRtcAudioTrackBoth

    麥克風流和第二條音頻流。

  • AliRtcNetworkQuality:網路品質。

    枚舉名

    描述

    AlivcRtcNetworkQualityExcellent

    網路極好,流暢度、清晰度品質好。

    AlivcRtcNetworkQualityGood

    網路好,流暢度、清晰度和極好差不多。

    AlivcRtcNetworkQualityPoor

    網路較差,音視頻流暢度、清晰度有瑕疵,不影響溝通。

    AlivcRtcNetworkQualityBad

    網路差,視訊卡頓嚴重,音頻能正常溝通。

    AlivcRtcNetworkQualityVeryBad

    網路極差,基本無法溝通。

    AlivcRtcNetworkQualityDisconnect

    網路斷開。

    AlivcRtcNetworkQualityUnknow

    未知原因。

  • AliRtcOrientationMode:橫豎屏類型(僅iOS)。

    枚舉名

    描述

    AliRtcOrientationModePortrait

    固定豎屏模式。

    AliRtcOrientationModeLandscapeLeft

    固定左橫屏模式。

    AliRtcOrientationModePortraitUpsideDown

    固定倒立模式。

    AliRtcOrientationModeLandscapeRight

    固定右橫屏模式。

    AliRtcOrientationModeAuto

    自適應橫豎屏模式。

  • AliRtcAudioSessionOperationRestriction:SDK對Audio Session的控制許可權(僅iOS)。

    枚舉名

    描述

    AliRtcAudioSessionOperationRestrictionNone

    沒有限制,SDK完全控制AVAudioSession。

    AliRtcAudioSessionOperationRestrictionSetCategory

    SDK不能修改AVAudioSession的Category。

    AliRtcAudioSessionOperationRestrictionConfigureSession

    SDK不能修改AVAudioSession的配置,包括Category、Mode、CategoryOptions。

    AliRtcAudioSessionOperationRestrictionDeactivateSession

    SDK不能關閉AVAudioSession的活動狀態,離開頻道時,AVAudioSession依然處於活動狀態。

    AliRtcAudioSessionOperationRestrictionAll

    SDK不修改AVAudioSession的配置,包含上述3個配置項。

  • AliRtcRenderMode:渲染模式。

    枚舉名

    描述

    AliRtcRenderModeAuto

    自動。

    AliRtcRenderModeStretch

    展開填充視圖,不保持視頻比例。

    AliRtcRenderModeFill

    在保持視頻寬高比的同時縮放,填充黑邊。

    AliRtcRenderModeClip

    在保持視頻寬高比的同時縮放,並裁剪以適合視圖。

  • AliRtcRenderMirrorMode:鏡像模式。

    枚舉名

    描述

    AliRtcRenderMirrorModeOnlyFrontCameraPreviewEnabled

    只有自拍預覽鏡像,其餘不鏡像。

    AliRtcRenderMirrorModeAllEnabled

    全部鏡像。

    AliRtcRenderMirrorModeAllDisable

    全部不鏡像。

  • AliRtcRotationMode:旋轉角度。

    枚舉名

    描述

    AliRtcRotationMode_0

    不旋轉。

    AliRtcRotationMode_90

    旋轉90度。

    AliRtcRotationMode_180

    旋轉180度。

    AliRtcRotationMode_270

    旋轉270度。

  • AliRtcLogLevel:記錄層級。

    枚舉名

    描述

    AliRtcLogLevelInfo

    普通。

    AliRtcLogLevelWarn

    警告。

    AliRtcLogLevelError

    錯誤。

    AliRtcLogLevelFatal

    嚴重。

    AliRtcLogLevelNone

    無。

  • AliRtcAudioNumChannel:音頻聲道數。

    枚舉名

    描述

    AliRtcMonoAudio

    單聲道。

    AliRtcStereoAudio

    雙聲道。

  • AliRtcAudioSampleRate:錄製音頻採樣率。

    枚舉名

    描述

    AliRtcAudioSampleRate_8000

    採樣率8000Hz。

    AliRtcAudioSampleRate_11025

    採樣率11025Hz。

    AliRtcAudioSampleRate_16000

    採樣率16000Hz。

    AliRtcAudioSampleRate_22050

    採樣率22050Hz。

    AliRtcAudioSampleRate_32000

    採樣率32000Hz。

    AliRtcAudioSampleRate_44100

    採樣率44100Hz。

    AliRtcAudioSampleRate_48000

    採樣率48000Hz。

    AliRtcAudioSampleRate_Unknown

    未知採樣率,某些場合使用。

  • AliRtcRecordType:錄製類型。

    枚舉名

    描述

    AliRtcRecordTypeAudio

    錄製純音頻檔案。

    AliRtcRecordTypeVideo

    錄製視頻檔案。

  • AliRtcRecordFormat:錄製格式。

    枚舉名

    描述

    AliRtcRecordFormatAAC

    AAC檔案。

    AliRtcRecordFormatWAV

    WAV檔案。

    AliRtcRecordFormatMP4

    MP4檔案。

  • AliRtcAudioQuality:錄製音頻品質。

    枚舉名

    描述

    AliRtcAudioQualityLow

    低。

    AliRtcAudioQualityMidium

    中。

    AliRtcAudioQualityHigh

    高。

  • AliRtcVideoQuality:錄製視頻品質。

    枚舉名

    描述

    AliRtcVideoQualityDefault

    預設和採集保持一致。

  • AliRtcVideoCodecType :視頻編解碼類型

    枚舉名

    描述

    AliRtcVideoCodecTypeDefault

    未設定,使用預設值(硬體編碼)

    AliRtcVideoCodecTypeSoftware

    軟體視頻編碼器

    AliRtcVideoCodecTypeHardware

    硬體視頻編碼器

  • AliRtcVideoDecoderConfiguration:視頻解碼器設定。

    參數

    類型

    描述

    codecType

    AliRtcVideoCodecType

    轉碼器類型

    預設值是AliRtcVideoCodecTypeDefault,使用系統預設設定,

    enableDecoderBframe

    NSInteger

    是否啟用解碼器B幀

    預設設定是-1,不啟用B幀為0,啟用B幀設定為1,

    backgroundHardwareToSoftware

    NSInteger

    是否在APP切到後台後硬體解碼降級到軟體編碼;

    預設設定是-1,不啟用設定為0,啟用降級邏輯設定為1;

  • AliRtcVideoEncodeCodecType:編碼器類型。

    枚舉名

    描述

    AliRtcVideoEncodeCodecTypeDefault

    未設定,使用預設值(目前為h264)

    AliRtcVideoEncodeCodecTypeH264

    h264編碼

    AliRtcVideoEncodeCodecTypeHevc

    hevc編碼

  • AliRtcTranportAudioQuality:音頻品質。

    枚舉名

    描述

    AliRtcAudioQulityUnknow

    品質未知。

    AliRtcAudioQulityExcellent

    品質極好。

    AliRtcAudioQulityGood

    使用者主觀感覺和極好差不多,但碼率可能略低於極好。

    AliRtcAudioQulityPoor

    使用者主觀感受有瑕疵,但不影響溝通。

    AliRtcAudioQulityBad

    勉強能溝通但不順暢。

    AliRtcAudioQulityVeryBad

    網路品質非常差,基本不能溝通。

    AliRtcAudioQulityNetworkDisconnected

    網路連接已斷開,完全無法溝通。

  • AliRtcAudioProfile:音頻品質模式。

    枚舉名

    描述

    AliRtcEngineLowQualityMode

    音頻低音質模式。

    AliRtcEngineBasicQualityMode

    標準音質模式。

    AliRtcEngineHighQualityMode

    高音質模式。

    AliRtcEngineStereoHighQualityMode

    立體聲高音質模式。

    AliRtcEngineSuperHighQualityMode

    超高音質模式。

    AliRtcEngineStereoSuperHighQualityMode

    立體聲超高音質模式。

  • AliRtcAudioScenario:音頻情境模式。

    枚舉名

    描述

    AliRtcSceneDefaultMode

    預設情境,一般的音視頻通訊情境推薦使用。

    AliRtcSceneEducationMode

    教育情境,優先保證音頻連續性與穩定性。

    AliRtcSceneMediaMode

    媒體情境,保真人聲與音樂音質,連麥直播間推薦使用。

    AliRtcSceneMusicMode

    音樂情境,高保真音樂音質,樂器教學等對音樂音質有要求的情境推薦使用。

    AliRtcSceneChatroomMode

    聊天室情境,適用於頻繁上下麥的聊天情境。

  • AliRtcMuteLocalAudioMode:本地靜音。

    枚舉名

    描述

    AliRtcMuteAudioModeDefault

    預設模式(靜音全部,包括麥克風及外部輸入音頻)。

    AliRtcMuteAllAudioMode

    靜音全部(包括麥克風及外部輸入音頻)。

    AliRtcMuteOnlyMicAudioMode

    只靜音麥克風。

    AliRtcMuteLocalAudioMax

    預留位置。

  • AliRtcRecordAudioConfig:錄製音頻設定。

    參數

    類型

    描述

    sampleRate

    AliRtcAudioSampleRate

    音頻採樣率。

    quality

    AliRtcAudioQuality

    音頻品質。

    enableRecordExternalRenderPCM

    bool

    是否允許錄製外部PCM輸入渲染資料。

  • AliRtcRecordVideoConfig:錄製視頻設定。

    參數

    類型

    描述

    quality

    AliRtcVideoQuality

    視頻品質。

  • AliRtcBeautyConfig:基礎美顏設定。

    參數

    類型

    描述

    whiteningLevel

    float

    美白,取值範圍:[0,1],數值越大美白效果越好。

    smoothnessLevel

    float

    磨皮,取值範圍:[0,1],數值越大磨皮效果越好。

  • AliRtcOnByeType:OnBye類型枚舉。

    枚舉名

    描述

    AliRtcOnByeBeKickedOut

    被踢出。

    AliRtcOnByeChannelTerminated

    頻道已結束,需要離開通話。

    AliRtcOnByeUserReplaced

    相同使用者ID在其他裝置加入頻道,當前裝置被下線。

  • AliRtcAudioEffectVoiceChangerMode:變聲音效模式。

    枚舉名

    描述

    AliRtcAudioEffectvVoiceChanger_OFF

    關閉。

    AliRtcAudioEffectvVoiceChanger_OLD_MAN

    老人。

    AliRtcAudioEffectvVoiceChanger_BABYBOY

    男孩。

    AliRtcAudioEffectvVoiceChanger_BABYGILR

    女孩。

    AliRtcAudioEffectvVoiceChanger_ROBOT

    機器人。

    AliRtcAudioEffectvVoiceChanger_DAIMO

    大魔王。

    AliRtcAudioEffectvVoiceChanger_KTV

    KTV。

    AliRtcAudioEffectvVoiceChangerR_ECHO

    回聲。

    AliRtcAudioEffectvVoiceChangerR_DIALECT

    方言。

    AliRtcAudioEffectvVoiceChangerR_HOWL

    怒吼。

    AliRtcAudioEffectvVoiceChangerR_ELECTRONIC

    電音。

    AliRtcAudioEffectvVoiceChangerR_PHONOGRAPH

    留聲機。

    AliRtcAudioEffectvVoiceChanger_MAX

    預留位置,無含義。

  • AliRtcAudioEffectReverbMode:音效混響模式。

    枚舉名

    描述

    AliRtcAudioEffectReverb_Off

    關閉。

    AliRtcAudioEffectReverb_Vocal_I

    人聲 I。

    AliRtcAudioEffectReverb_Vocal_II

    人聲 II。

    AliRtcAudioEffectReverb_Bathroom

    澡堂。

    AliRtcAudioEffectReverb_Small_Room_Bright

    明亮小房間。

    AliRtcAudioEffectReverb_Small_Room_Dark

    黑暗小房間。

    AliRtcAudioEffectReverb_Medium_Room

    中等房間。

    AliRtcAudioEffectReverb_Large_Room

    大房間。

    AliRtcAudioEffectReverb_Church_Hall

    教堂走廊。

    AliRtcAudioEffectReverb_Mode_Max

    預留位置,無含義。

  • AliRtcAudioEffectReverbParamType:音效混響參數。

    枚舉名

    描述

    AliRtcAudioEffectReverb_Room_Size

    房間大小,取值範圍:[0,100]。

    AliRtcAudioEffectReverb_Pre_Delay

    預延時,單位:ms,取值範圍:[0,200]。

    AliRtcAudioEffectReverb_Revetberance

    混響感,取值範圍:[0,100]。

    AliRtcAudioEffectReverb_Hf_Damping

    消聲,取值範圍:[0,100]。

    AliRtcAudioEffectReverb_Tone_Low

    低音調,取值範圍:[0,100]。

    AliRtcAudioEffectReverb_Tone_High

    高音調,取值範圍:[0,100]。

    AliRtcAudioEffectReverb_Dry_Gain

    幹增益,取值範圍:[-20,10]。

    AliRtcAudioEffectReverb_Wet_Gain

    濕增益,取值範圍:[-20,10]。

    AliRtcAudioEffectReverb_Type_Max

    預留位置,無含義。

  • AliRtcAudioRouteType:語音路由(僅iOS)。

    枚舉名

    描述

    AliRtcAudioRouteTypeDefault

    預設的語音路由。

    AliRtcAudioRouteTypeHeadset

    耳機。

    AliRtcAudioRouteTypeEarpiece

    耳機。

    AliRtcAudioRouteTypeHeadsetNoMic

    不帶麥的耳機。

    AliRtcAudioRouteTypeSpeakerphone

    手機擴音器。

    AliRtcAudioRouteTypeLoudSpeaker

    外接擴音器。

    AliRtcAudioRouteTypeBlueTooth

    藍芽耳機。

  • AliVideoCanvas:渲染畫布。

    參數

    類型

    描述

    view

    UIView * _Nonnull

    渲染view,不可為nil。

    renderMode

    AliRtcRenderMode

    渲染模式,預設AliRtcRenderModeAuto。

    mirrorMode

    AliRtcRenderMirrorMode

    鏡像模式。預設AliRtcRenderMirrorModeOnlyFront。

    backgroundColor

    int

    背景顏色,格式為RGB的Hex。

    rotationMode

    AliRtcRotationMode

    視頻旋轉角度,預設不旋轉。

  • AliRtcTrascodingLiveStreamErrorCode:旁路推流錯誤碼。

    枚舉名

    描述

    AliRtcTrascodingLiveStreamErrorPublishOk

    推流成功。

    AliRtcTrascodingLiveStreamErrorStreamNotFound

    錯誤:找不到流。

    AliRtcTrascodingLiveStreamErrorStreamAlreadyExist

    錯誤:目標流已存在。

    AliRtcTrascodingLiveStreamErrorInvalidParam

    錯誤:非法的參數。

    AliRtcTrascodingLiveStreamErrorInternalError

    錯誤:內部錯誤。

    AliRtcTrascodingLiveStreamErrorRtmpServerError

    錯誤:RTMP服務異常。

    AliRtcTrascodingLiveStreamErrorRtmpStreamUrlError

    錯誤:URL異常。

    AliRtcTrascodingLiveStreamErrorPublishTimeout

    錯誤:任務逾時。

    AliRtcTrascodingLiveStreamErrorNotAuthorized

    錯誤:操作未授權。

  • AliRtcWatermarkConfig:浮水印圖片的設定。

    參數

    類型

    描述

    visibleInPreview

    BOOL

    是否將浮水印設定為預覽時本地可見。

    positionInLandscapeMode

    CGRect

    橫屏時的浮水印座標。

    positionInPortraitMode

    CGRect

    豎屏時的浮水印座標。

    alpha

    float

    透明度。

    normalized

    BOOL

    是否歸一化。

  • AliRtcCameraCapturerConfiguration:相機採集偏好屬性。

    參數

    類型

    描述

    preference

    AliRtcCaptureOutputPreference

    採集偏好。

    cameraDirection

    AliRtcCameraDirection

    相機方向。

    fps

    int

    指定網路攝影機的採集預覽幀率,通過設定此參數,可以實現預覽幀率和編碼幀率不同,編碼幀率設定參見:AliRtcVideoEncoderConfiguration中的frameRate

    cameraCaptureProfile

    AliRtcCameraCaptureProfile

    指定視頻採集的特定解析度。

    disableVideoCaptureReverse

    int

    不根據縱橫比設定翻轉採集視訊框架設定

    enableCameraMacroFocus

    int

    支援微距調整焦距

    captureObserverOriginal

    int

    是否回調原始的videoframe資料

    nativeBufferObserver

    int

    回調textureid

    captureCallbackCvpixelbufferToRaw

    int

    視頻採集callback使用cvPixelBuffer回調

  • AliRtcCameraDirection:網路攝影機方向。

    枚舉名

    描述

    AliRtcCameraDirectionInvalid

    未知。

    AliRtcCameraDirectionBack

    後置網路攝影機。

    AliRtcCameraDirectionFront

    自拍。

  • AliRtcCameraCaptureProfile:指定網路攝影機採集解析度。

    枚舉名

    描述

    AliRtcCameraCaptureProfileDefault

    預設。

    AliRtcCameraCaptureProfile1080P

    視頻1080P使用,開啟後網路攝影機使用1080P解析度採集。

  • AliRtcCaptureOutputPreference:網路攝影機採集偏好。

    枚舉名

    描述

    AliRtcCaptureOutputPreferenceAuto

    自動調整採集參數。

    AliRtcCaptureOutputPreferencePerformance

    優先保證裝置效能,根據setVideoProfile設定參數選擇最接近的網路攝影機輸出參數。

    AliRtcCaptureOutputPreferencePreview

    優先保證視頻預覽品質,選擇較高的網路攝影機輸出參數。

  • AliRtcVideoEncoderFrameRate:視頻編碼幀率。

    枚舉名

    描述

    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:視頻編碼碼率。

    枚舉名

    描述

    AliRtcVideoEncoderStandardBitrate

    標準碼率模式。

  • AliRtcVideoEncoderMirrorMode:編碼視頻鏡像模式。

    枚舉名

    描述

    AliRtcVideoEncoderMirrorModeDisabled

    編碼視頻鏡像。

    AliRtcVideoEncoderMirrorModeEnabled

    編碼視頻不鏡像。

  • AliRtcVideoEncoderOrientationMode:編碼視頻旋轉模式。

    枚舉名

    描述

    AliRtcVideoEncoderOrientationModeAdaptive

    自適應,和採集視頻保持一致。

    AliRtcVideoEncoderOrientationModeFixedLandscape

    固定橫屏。

    AliRtcVideoEncoderOrientationModeFixedPortrait

    固定豎屏。

  • AliRtcVideoEncoderConfiguration:視頻編碼偏好。

    參數

    類型

    描述

    dimensions

    CGSize

    視頻解析度。

    frameRate

    NSInteger

    視頻編碼幀率。

    bitrate

    NSInteger

    視頻編碼碼率。

    min_bitrate

    NSInteger

    最小視頻編碼碼率(Kbps),預設值為0。

    keyFrameInterval

    NSInteger

    主要畫面格間隔,單位毫秒。預設值0,表示SDK內部控制主要畫面格間隔。

    forceStrictKeyFrameInterval

    bool

    是否強制編碼器嚴格按照設定的主要畫面格間隔產生主要畫面格。預設值false。

    • false:表示編碼器會響應他人入會等主要畫面格請求,主要畫面格間隔和設定的值不嚴格匹配。

    • true:表示編碼器不響應其他主要畫面格請求,嚴格按照設定的值產生主要畫面格。可能會造成訂閱者首幀變慢。

    mirrorMode

    AliRtcVideoEncoderMirrorMode

    編碼視頻鏡像模式。

    orientationMode

    AliRtcVideoEncoderOrientationMode

    編碼視頻旋轉模式。

    rotationMode

    AliRtcRotationMode

    視頻旋轉角度。

    codecType

    AliRtcVideoCodecType

    轉碼器類型。

    encoderType

    AliRtcVideoEncodeCodecType

    視頻編碼類別型。

    seiForceFrontIFrame

    NSInteger

    SEI發送前強制I幀。

    -1表示使用預設值,0表示不強制,1表示強制(預設值)。

    enableDynamicEncode

    NSInteger

    啟用動態編碼。

    同時建立硬體編碼和軟體編碼,在硬體編碼器出問題之後降級到軟體編碼,-1表示使用預設值,0表示不同時建立兩種編碼,1表示建立兩種編碼。

    disableDipenseResolutionChange

    NSInteger

    關閉QoS降低解析度能力。

    在QoS探測到即時頻寬下降不足以當前方解析度進行編碼,降低視頻編碼解析度。

    -1表示使用預設值,0表示允許降低,1表示不允許QoS降低解析度。

    enableDowngrade

    NSInteger

    允許QoS根據實際探測頻寬降低視頻編碼碼流。

    -1表示使用預設值,0表示不允許降低編碼碼流大小,1允許降低編碼碼流大小。

    enableH264BFrame

    NSInteger

    是否開啟h264 B幀支援。

    -1表示使用預設值,0表示不開啟B幀支援,1表示開啟B幀支援。

    重要

    開啟該項之後,必須解碼端同步開啟B幀支援。

    enableHevcBFrame

    NSInteger

    是否開啟hevc B幀支援。

    -1表示使用預設值,0表示不開啟B幀支援,1表示開啟B幀支援。

    重要

    開啟該項之後,必須解碼端同步開啟B幀支援。

    backgroundHardwareToSoftware

    NSInteger

    是否允許APP切到後台,因iOS裝置APP切到後台,硬體編碼無法編碼,硬體編碼降級到軟體編碼。

    -1表示使用預設值,0表示不允許降級到軟體編碼,1表示允許降級到軟體編碼。

  • AliRtcScreenShareEncoderConfiguration:螢幕分享編碼偏好。

    參數

    類型

    描述

    dimensions

    CGSize

    視頻解析度。

    frameRate

    NSInteger

    視頻編碼幀率。

    bitrate

    NSInteger

    視頻編碼碼率。

    rotationMode

    AliRtcRotationMode

    旋轉螢幕角度。

    keyFrameInterval

    NSInteger

    主要畫面格間隔,單位毫秒。預設值0,表示SDK內部控制主要畫面格間隔。

    forceStrictKeyFrameInterval

    bool

    是否強制編碼器嚴格按照設定的主要畫面格間隔產生主要畫面格。預設值false。

    false表示編碼器會響應他人入會等主要畫面格請求,主要畫面格間隔和設定的值不嚴格匹配。

    true表示編碼器不響應其他主要畫面格請求,嚴格按照設定的值產生主要畫面格。可能會造成訂閱者首幀變慢。

  • AliRtcAuthInfo:鑒權資訊。

    參數

    類型

    描述

    channelId

    NSString * _Nonnull

    頻道ID。

    userId

    NSString * _Nonnull

    使用者ID。

    appId

    NSString * _Nonnull

    應用ID。

    nonce

    NSString * _Nonnull

    隨機串。

    token

    NSString * _Nonnull

    令牌。

    timestamp

    long long

    時間戳記。

  • AliRtcDeviceVolumeType:裝置音量類型(僅iOS)。

    枚舉名

    描述

    AliRtcDeviceVolumeTypeAuto

    SDK自動化佈建音量類型(預設值)。SDK內部會自動選擇合適的音量類型,如無特殊需求,不推薦自行設定。

    AliRtcDeviceVolumeTypeMedia

    設定為媒體音量,適合媒體播放情境,音量可以調節到零。

    AliRtcDeviceVolumeTypeVOIP

    設定為通話音量,適合通話情境,音量無法調節到零。

  • AliRtcVideoSource:視頻裸資料來源類型。

    枚舉名

    描述

    AliRtcVideosourceCameraType

    視頻流。

    AliRtcVideosourceScreenShareType

    螢幕畫面分享流。

    AliRtcVideosourceTypeMax

    預留位置。

  • AliRtcAudioSource:音頻裸資料來源類型。

    枚舉名

    描述

    AliRtcAudioSourceCaptured

    採集的音頻資料。

    AliRtcAudioSourceProcessCaptured

    3A後的音頻資料。

    AliRtcAudiosourcePub

    推流音頻資料。

    AliRtcAudioSourcePlayback

    播放的音頻資料。

    AliRtcAudioSourceRemoteUser

    拉流的遠端音頻資料 。

  • AliRtcBufferType:視頻資料類型。

    枚舉名

    描述

    AliRtcBufferType_Raw_Data

    YUV裸資料。

    AliRtcBufferType_CVPixelBuffer

    CVPixelBuffer資料。

    AliRtcBufferType_Texture

    紋理。

    AliRtcBufferType_File

    檔案路徑。

  • AliRtcErrorCode:錯誤碼。

    枚舉名

    描述

    AliRtcErrNone

    無。

    AliRtcErrJoinBadAppId

    App ID不存在。

    AliRtcErrJoinInvalidAppId

    App ID已失效。

    AliRtcErrJoinBadChannel

    頻道不存在。

    AliRtcErrJoinInvalidChannel

    頻道已失效。

    AliRtcErrJoinBadToken

    token不存在。

    AliRtcErrJoinTimeout

    加入頻道逾時。

    AliRtcErrJoinBadParam

    參數錯誤。

    AliRtcErrMicOpenFail

    採集裝置初始化失敗。

    AliRtcErrSpeakerOpenFail

    播放裝置初始化失敗。

    AliRtcErrMicInterrupt

    採集過程中出現異常。

    AliRtcErrSpeakerInterrupt

    播放過程中出現異常。

    AliRtcErrMicAuthFail

    麥克風裝置未授權。

    AliRtcErrMicNotAvailable

    無可用的音頻採集裝置。

    AliRtcErrSpeakerNotAvailable

    無可用的音頻播放裝置。

    AliRtcErrCameraOpenFail

    採集裝置初始化失敗。

    AliRtcErrCameraInterrupt

    採集過程中出現異常。

    AliRtcErrDisplayOpenFail

    染裝置初始化失敗。

    AliRtcErrDisplayInterrupt

    渲染過程中出現異常。

    AliRtcErrIceConnectionConnectFail

    媒體通道建立失敗。

    AliRtcErrIceConnectionReconnectFail

    媒體通道重連失敗。

    AliRtcErrIceConnectionHeartbeatTimeout

    信令心跳逾時。

    AliRtcErrPublishInvaild

    推流無效。

    AliRtcErrPublishNotJoinChannel

    未進入頻道推流失敗。

    AliRtcErrPublishAudioStreamFailed

    推送音頻流失敗。

    AliRtcErrPublishVideoStreamFailed

    推送視頻流失敗。

    AliRtcErrPublishDualStreamFailed

    推送雙流失敗。

    AliRtcErrPublishScreenShareFailed

    推送螢幕畫面分享失敗。

    AliRtcErrPublishScreenShareConfigError

    螢幕畫面分享配置錯誤。

    AliRtcErrSubscribeInvaild

    訂閱無效。

    AliRtcErrSubscribeNotJoinChannel

    未進入頻道訂閱錯誤。

    AliRtcErrSubscribeAudioStreamFailed

    訂閱音頻流失敗。

    AliRtcErrSubscribeVideoStreamFailed

    訂閱視頻流失敗。

    AliRtcErrSubscribeDualStreamFailed

    訂閱雙流失敗。

    AliRtcErrSubscribeScreenShareFailed

    訂閱螢幕畫面分享失敗。

    AliRtcErrCdnLiveCommunicationFailed

    低延時即時音視頻信令失敗。

    AliRtcErrCdnLiveMeidaSettingFailed

    低延時即時音視頻媒體設定錯誤。

    AliRtcErrCdnLiveNoneBroadcaster

    低延時即時音視頻當前房間沒有主播推流。

    AliRtcErrCdnLiveNeedRestart

    低延時即時音視頻錯誤,應用程式層需要重新建立新的SDK執行個體。

    AliRtcErrCdnLiveNeedRestartAgainLater

    低延時即時音視頻錯誤,應用程式層需要稍等一定時間(自訂間隔)重新建立新的SDK執行個體。

    AliRtcErrCdnLiveServiceUnavailable

    低延時即時音視頻服務不可用或者服務降級。

    AliRtcErrCdnLiveMediaConnectionInterruption

    低延時即時音視頻網路中斷錯誤。

    AliRtcErrSdkInvalidState

    SDK狀態錯誤。

    AliRtcErrSessionRemoved

    Session已經被移除。

    AliRtcErrInvalidArguments

    參數不匹配。

    AliRtcErrAudioBufferFull

    buffer隊列飽和,用於外部輸送裸資料功能。

    AliRtcErrVideoBufferFull

    buffer隊列飽和,用於外部輸送裸資料功能。

    AliRtcErrUpdateRoleChannel

    互動模式下設定角色錯誤。

    AliRtcErrInner

    其他錯誤。

  • AliRtcExternalDeviceType:外接裝置類型(僅Mac)。

    枚舉名

    描述

    AliRtcExternalTypeUnknown

    未知類型。

    AliRtcExternalTypeAudioCapture

    音頻採集裝置。

    AliRtcExternalTypeAudioPlayout

    音頻播放裝置。

    AliRtcExternalTypeVideoCapture

    視頻採集裝置。

  • AliRtcExternalDeviceState:外接裝置狀態(僅Mac)。

    枚舉名

    描述

    AliRtcExternalDeviceAdd

    新增外接裝置。

    AliRtcExternalDeviceRemove

    移除外接裝置。

  • AliRtcRecordVideoCanvasConfig:錄製視頻設定的畫布大小(僅Mac)。

    參數

    類型

    描述

    canvasWidth

    int

    畫布的寬。

    canvasHeight

    int

    畫布的高。

  • AliRtcRecordVideoLayout:錄製視頻的布局資訊(僅Mac)。

    參數

    類型

    描述

    mode

    AliRtcRecordVideoLayoutMode

    配置模式。

    backColor

    AliRtcRecordVideoBgColor

    背景顏色。

    shapes

    NSMutableArray<AliRtcRecordVideoRegion *> * _Nullable

    各使用者的畫面位置資訊。

  • AliRtcRecordVideoLayoutMode:錄製視頻的配置模式(僅Mac)。

    枚舉名

    描述

    AliRtcRecordVideoLayoutMode_GRID

    窗格布局。

    AliRtcRecordVideoLayoutMode_SPEAKER

    演講布局。

    AliRtcRecordVideoLayoutMode_UNIQUE

    單路布局。

    AliRtcRecordVideoLayoutMode_CUSTOM

    自義布局。

  • AliRtcRecordVideoBgColor:錄製視頻的背景顏色(僅Mac)。

    參數

    類型

    描述

    r

    uint8_t

    顏色配比中紅色的值。

    g

    uint8_t

    顏色配比中綠色的值。

    b

    uint8_t

    顏色配比中藍色的值。

  • AliRtcRecordVideoRegion:錄製布局的使用者畫面配置資訊(僅Mac)。

    參數

    類型

    描述

    userId

    NSString * _Nonnull

    使用者ID。

    sourceType

    AliRtcVideoSource

    視頻裸資料來源類型。

    area

    AliRtcRecordVideoRectangle

    使用者畫面的位置資訊。

  • AliRtcRecordVideoRectangle:使用者畫面的位置資訊(僅Mac)。

    參數

    類型

    描述

    left

    AliRtcRecordVideoRational

    左邊距。

    top

    AliRtcRecordVideoRational

    上邊距。

    width

    AliRtcRecordVideoRational

    寬度。

    height

    AliRtcRecordVideoRational

    高度。

  • AliRtcRecordVideoRational:混流錄製座標(僅Mac)。

    參數

    類型

    描述

    numerator

    uint32_t

    分子(整數)。

    denominator

    uint32_t

    分母(整數)。

  • AliRtcRecordTemplate:錄製模板(僅Mac)。

    參數

    類型

    描述

    recordType

    AliRtcRecordType

    錄製類型。

    recordFormat

    AliRtcRecordFormat

    錄製格式。

    sampleRate

    AliRtcAudioSampleRate

    錄製音頻採樣率。

    audioQuality

    AliRtcAudioQuality

    錄製音頻品質。

    enableRecordExternalCapturePCM

    bool

    是否混音錄製外部輸入音頻。

    enableRecordExternalRenderPCM

    bool

    是否混音錄製外部輸入渲染後的音頻。

    canvas

    AliRtcRecordVideoCanvasConfig

    錄製視頻的畫布大小。

    fps

    int

    幀率。

    bitrate

    int

    碼率。

    isFragment

    bool

    是否錄製分段MP4,預設true。

  • AliRtcDeviceInfo:裝置資訊(僅Mac)。

    參數

    類型

    描述

    deviceName

    NSString * _Nullable

    裝置名稱。

    deviceID

    NSString * _Nullable

    裝置ID。

  • AliRtcScreenShareConfig:螢幕分享配置(僅Mac)。

    參數

    類型

    描述

    isShareByRegion

    bool

    是否是地區分享。

    shareRegion

    AliRtcScreenShareRegion* _Nonnull

    地區分享的布局資訊。

  • AliRtcScreenShareRegion:螢幕分享地區(僅Mac)。

    參數

    類型

    描述

    originX

    float

    x座標。

    originY

    float

    y座標。

    width

    float

    寬度。

    heigh

    foat

    高度。

  • AliRtcScreenSourceInfo:螢幕分享源資訊(僅Mac)。

    參數

    類型

    描述

    sourceId

    NSString * _Nonnull

    分享源ID。

    sourceName

    NSString * _Nonnull

    分享源名稱。

  • AliRtcScreenShareInfo:螢幕分享配置資訊(僅Mac)。

    參數

    類型

    描述

    sourceType

    AliRtcScreenShareType

    分享類型。

    sourceId

    NSString * _Nonnull

    分享源ID。

    config

    AliRtcScreenShareConfig * _Nonnull

    螢幕分享配置。

  • AliRtcScreenShareType:螢幕分享類型(僅Mac)。

    枚舉名

    描述

    AliRtcScreenShareDesktop

    案頭分享。

    AliRtcScreenShareWindow

    視窗分享。

  • AliRtcVideoObserAlignment:視頻輸出寬度對齊。

    枚舉名

    描述

    AliRtcAlignmentDefault

    保持原有視頻寬度(預設值)。

    AliRtcAlignmentEven

    寬度偶數對齊。

    AliRtcAlignment4

    寬度是4的倍數。

    AliRtcAlignment8

    寬度是8的倍數。

    AliRtcAlignment16

    寬度是16的倍數。

  • AliRtcShowDebugViewType:顯示儀錶盤類型。

    枚舉名

    描述

    AliRtcShowTypeNone

    不顯示。

    AliRtcShowTypeAudio

    音頻。

    AliRtcShowTypeVideo

    視頻。

    AliRtcShowTypeNetwork

    網路。

    AliRtcShowTypeAll

    全部。

  • AliRtcTrascodingLiveTaskStatus:旁路推流LiveStream狀態。

    枚舉名

    描述

    AliRtcTrascodingLiveTaskStatusStart

    任務開始。

    AliRtcTrascodingLiveTaskStatusUpdate

    任務更新。

    AliRtcTrascodingLiveTaskStatusStop

    任務已停止。

  • AliRtcLiveTranscodingDisplayType:旁路直播圖片顯示類型。

    枚舉名

    描述

    NOT_DISPLAY

    不顯示。

    ALWAYS

    一直顯示。

    WHEN_NO_VIDEO

    當沒有視頻時候顯示。

  • AliRtcLiveTranscodingFontType:旁路直播文字類型。

    枚舉名

    描述

    NOTO_SERIF_CJKSC_REGULAR

    思源宋體NotoSerifCJKsc-REGULAR。

    ALIBABA_PUHUITI_REGULAR

    阿里巴巴-普惠體-REGULAR。

    ALIBABA_PUHUITI_BOLD

    阿里巴巴-普惠體-BOLD。

    ALIBABA_PUHUITI_Heavy

    阿里巴巴-普惠體-Heavy。

    ALIBABA_PUHUITI_LIGHT

    阿里巴巴-普惠體-LIGHT。

    ALIBABA_PUHUITI_MEDIUM

    阿里巴巴-普惠體-MEDIUM。

  • AliRtcLiveTranscodingSegmentType:旁路直播分割類型。

    枚舉名

    描述

    AliRtcLiveTranscodingNoBody

    無人像分割。

    AliRtcLiveTranscodingBody

    人像分割。

  • AliRtcLiveTranscodingSourceType:旁路直播輸入類型。

    枚舉名

    描述

    AliRtcLiveTranscodingCamera

    相機。

    AliRtcLiveTranscodingShareScreen

    共用螢幕。

  • AliRtcVideoState:視頻流狀態變化。

    枚舉名

    描述

    AliRtcVideoVideoClose

    關閉視頻流。

    AliRtcVideoVideoOpen

    恢複視頻流。

  • AliRtcVideoReason:觸發視頻流狀態變化的原因。

    枚舉名

    描述

    AliRTCVideoChangedByClient

    用戶端。

    AliRTCVideoChangedByServer

    伺服器。

  • AliRtcLiveTranscodingCropMode:旁路直播裁剪模式。

    枚舉名

    描述

    AliRtcLiveTranscodingCrop

    保持比例裁剪。

    AliRtcLiveTranscodingFill

    保持比例留邊(預設值)。

  • AliRtcLiveTranscodingMediaProcessMode:旁路直播ApsaraVideo for Media Processing模式。

    枚舉名

    描述

    AliRtcLiveTranscodingNormal

    通用模式。

    AliRtcLiveTranscodingVirtualBackground

    虛擬背景模式。

  • AliRtcLiveTranscodingStreamType:旁路直播轉推流類型。

    枚舉名

    描述

    AliRtcLiveTranscodingOrigin

    轉推原始流。

    AliRtcLiveTranscodingAudio

    僅轉推音頻流。

    AliRtcLiveTranscodingVideo

    僅轉推視頻流。

  • AliRtcLiveTranscodingMixMode:旁路直播模式。

    枚舉名

    描述

    AliRtcLiveTranscodingSINGLE

    單路轉推,不混流轉碼,僅轉推原始單路流,無需配置混流轉碼參數。

    AliRtcLiveTranscodingMIX

    混流轉碼(預設值),支援混流轉碼輸出。

  • AliRtcLiveTranscodingState:旁路直播狀態。

    枚舉名

    描述

    AliRtcLiveTranscodingState_IDLE

    推流空閑。

    AliRtcLiveTranscodingState_CONNNECT

    正在串連推流伺服器。

    AliRtcLiveTranscodingState_RUNNING

    推流進行中。

    AliRtcLiveTranscodingState_RECOVERING

    正在恢複推流。

    AliRtcLiveTranscodingState_FAILURE

    推流失敗。

    AliRtcLiveTranscodingState_END

    推流結束。

  • AliRtcLiveTranscodingText:旁路直播文本資訊。

    參數

    類型

    描述

    text

    NSString

    文本資訊。

    x

    int

    座標X(像素)。

    y

    int

    座標Y(像素)。

    fontType

    AliRtcLiveTranscodingFontType

    旁路直播字型。

    fontSize

    int

    字型大小。

    zOrder

    int

    疊放順序,0為最底層,1層在0層之上,以此類推。

    fontColor

    int

    字型顏色。

  • AliRtcLiveTranscodingImage:旁路直播圖片資訊。

    參數

    類型

    描述

    url

    NSString

    圖片URL。

    alpha

    float

    透明度。0.0表示透明,1.0表示完全不透明。

    display

    AliRtcLiveTranscodingDisplayType

    圖片顯示。

    x

    int

    座標X(像素)。

    y

    int

    座標Y(像素)。

    width

    int

    圖片寬。

    height

    int

    圖片高。

    zOrder

    it

    疊放順序,0為最底層,1層0層之上,以此類推。

  • AliRtcLiveTranscodingUser:旁路直播使用者自訂流資訊。

    參數

    類型

    描述

    x

    int

    座標X(像素)。

    y

    int

    座標Y(像素)。

    width

    int

    窗格寬。

    height

    int

    窗格高。

    zOrder

    int

    疊放順序,0為最底層,1層在0層之上,以此類推。

    userId

    NSString *

    使用者ID。

    streamType

    AliRtcLiveTranscodingStreamType

    旁路直播轉推流模式。

    sourceType

    AliRtcLiveTranscodingSourceType

    流類型。

    segmentType

    AliRtcLiveTranscodingSegmentType

    旁路直播輸入類型。

    images

    NSArray<AliRtcLiveTranscodingImage *> *

    旁路直播圖片資訊。

    texts

    NSArray<AliRtcLiveTranscodingText *> *

    旁路直播文本資訊。

  • AliRtcLiveTranscodingParam:旁路直播配置。

    參數

    類型

    描述

    mixMode

    AliRtcLiveTranscodingMixMode

    旁路直播模式。

    singleParam

    AliRtcLiveTranscodingSingleParam

    旁路直播單流參數。

    mixParam

    AliRtcLiveTranscodingMixParam

    旁路直播混流參數。

  • AliRtcLiveTranscodingMixParam:旁路模式混流參數。

    參數

    類型

    描述

    taskProfile

    AliRtcLiveTranscodingTaskProfile

    旁路直播計費規格。

    encodeParam

    AliRtcLiveTranscodingEncodeParam

    旁路直播編碼參數。

    users

    NSArray<AliRtcLiveTranscodingUser *> *

    旁路直播使用者列表。

    backgroundColor

    int

    背景色。

    backgrounds

    NSArray<AliRtcLiveTranscodingImage *> *

    背景圖片列表。

    watermarks

    NSArray<AliRtcLiveTranscodingImage *> *

    浮水印圖片列表。

    clockWidgets

    NSArray<AliRtcLiveTranscodingClockWidget *> *

    時鐘小組件列表。

    cropMode

    AliRtcLiveTranscodingCropMode

    旁路直播裁剪模式。

    mediaProcessMode

    AliRtcLiveTranscodingMediaProcessMode

    旁路直播ApsaraVideo for Media Processing模式。

  • AliRtcLiveTranscodingSingleParam:旁路模式單路參數。

    參數

    類型

    描述

    userId

    NSString *

    使用者ID。

    streamType

    AliRtcLiveTranscodingStreamType

    旁路直播轉推流類型。

    sourceType

    AliRtcLiveTranscodingSourceType

    旁路直播視頻流類型。

  • AliRtcLiveTranscodingTaskProfile:旁路直播計費規格。

    枚舉名

    描述

    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

    純音頻。

  • AliRtcLiveTranscodingEncodeParam:旁路直播編碼參數。

    參數

    類型

    描述

    videoWidth

    int

    寬。

    videoHeight

    int

    高。

    videoFramerate

    int

    幀率。

    videoBitrate

    int

    碼率。

    videoGop

    int

    GOP。

    videoCodec

    AliRtcLiveTranscodingVideoCodec

    旁路直播視頻編碼器。

    audioSamplerate

    AliRtcLiveTranscodingAudioSampleRate

    旁路直播音頻採樣率。

    audioBitrate

    int

    音頻碼率。

    audioChannels

    int

    音頻聲道數。

  • AliRtcLiveTranscodingAudioSampleRate:旁路直播音頻採樣率。

    枚舉名

    描述

    AliRtcLiveTranscoding_HZ_48000

    採樣率48000Hz。

    AliRtcLiveTranscoding_HZ_44100

    採樣率44100Hz。

    AliRtcLiveTranscoding_HZ_32000

    採樣率32000Hz。

    AliRtcLiveTranscoding_HZ_16000

    採樣率16000Hz。

    AliRtcLiveTranscoding_HZ_8000

    採樣率8000Hz。

  • AliRtcLiveTranscodingClockWidget:旁路直播時鐘小工具。

    參數

    類型

    描述

    x

    int

    座標X(像素)。

    y

    int

    座標Y(像素)。

    fontSize

    int

    旁路直播字型大小。

    zOrder

    int

    疊放順序,0為最底層,1層在0層之上,以此類推。

    fontColor

    int

    旁路直播字型顏色。

    fontType

    AliRtcLiveTranscodingFontType

    旁路直播字型。

  • AliRtcBokehScaleModel:背景替換縮放模式(僅Mac)。

    枚舉名

    描述

    AliRtcBokehScaleModelCrop

    等比裁剪。

    AliRtcBokehScaleModelFill

    填充黑邊。

  • AliRtcAudioPlayingStateCode:音樂伴奏播放狀態(僅Mac)。

    枚舉名

    描述

    AliRtcAudioPlayingStarted

    開始播放。

    AliRtcAudioPlayingStopped

    停止播放。

    AliRtcAudioPlayingPaused

    播放暫停。

    AliRtcAudioPlayingResumed

    播放恢複。

    AliRtcAudioPlayingEnded

    播放完畢。

    AliRtcAudioPlayingBuffering

    正在緩衝。

    AliRtcAudioPlayingBufferingEnd

    緩衝結束。

    AliRtcAudioPlayingFailed

    播放失敗。

  • AliRtcAudioPlayingErrorCode:音樂伴奏播放錯誤碼(僅Mac)。

    枚舉名

    描述

    AliRtcAudioPlayingNoError

    沒有錯誤。

    AliRtcAudioPlayingOpenFailed

    開啟檔案錯誤。

    AliRtcAudioPlayingDecodeFailed

    解碼檔案錯誤。

  • AliRtcScreenShareMode。

    枚舉名

    描述

    AliRtcScreenShareNone

    不共用。

    AliRtcScreenShareVideo

    共用視頻流。

    AliRtcScreenShareAudioApp

    共用APP音頻流。

    AliRtcScreenShareAll

    共用所有音視頻流,不支援螢幕畫面分享Mic音頻流,請使用SDK內建的Mic音頻採集。

  • AliRtcCapabilityProfile:功能彙總的profile。

    枚舉名

    描述

    AliRtcCapabilityProfileDefault

    預設值,無特殊要求。

    AliRtcCapabilityProfileAiHuman

    AI agent通話情境下, 真實使用者的功能。

    AliRtcCapabilityProfileAiRobot

    AI agent通話情境下, 機器人的功能 。

  • AliRtcChannelParam:入會參數。

    參數

    類型

    描述

    channelId

    NSString*

    入會頻道,必須和產生token時一樣;可以不傳,此時會預設使用產生token的channelId

    userId

    NSString*

    入會的userid,必須和產生token時一樣;可以不傳,此時會預設使用產生token的userId

    userName

    NSString*

    任意用於顯示的使用者名稱稱,不是User ID;可以不傳,標識沒有userName

    capabilityProfile

    AliRtcCapabilityProfile

    功能profile,如在 AI agent通話情境下有其他功能需求,可以直接選擇porfile,不需要挨個開啟功能

  • AliRtcNetworkQualityProbeConfig:網路探測的參數配置。

    參數

    類型

    描述

    probeUplink

    BOOL

    是否探測上行,預設值:NO

    probeDownlink

    BOOL

    是否探測下行,預設值:NO 暫不支援

    upLinkBandWidth

    int

    探測上行頻寬峰值,單位kbps 預設值:1000

    DownLinkBandWidth

    int

    探測下行頻寬峰值,單位kbps 預設值:1000 暫不支援

  • AliRtcNetworkQualityProbeResult:網路探測的結果。

    參數

    類型

    描述

    rtt

    int

    鏈路的rtt,單位ms。

    upLinkLossRate

    int

    探測上行網路的丟包率,最大值100%。

    upLinkJitter

    int

    探測上行網路的jitter,單位ms。

    upLinkBandWidth

    int

    上行網路頻寬,單位kbps。

    downLinkLossRate

    int

    探測下行網路的丟包率,最大值100%,暫不支援。

    downLinkJitter

    int

    探測下行網路的jitter,單位ms,暫不支援。

    downLinkBandWidth

    int

    下行網路頻寬,單位kbps,暫不支援。

  • AliRtcAudioFrame:音頻裸資料。

    參數

    類型

    描述

    dataPtr

    void *

    音頻資料指標。

    numOfSamples

    int

    多少個採樣。

    bytesPerSample

    int

    每個採樣的位元組數。

    numOfChannels

    int

    多少個聲道。

    samplesPerSec

    int

    採樣率。

  • AliRtcVideoPipelineMirrorMode:視頻鏈路鏡像類型。

    枚舉名

    描述

    AliRtcVideoPipelineMirrorModeNoMirror

    預覽和編碼均關閉鏡像。

    AliRtcVideoPipelineMirrorModeBothMirror

    預覽和編碼均開啟鏡像。

    AliRtcVideoPipelineMirrorModeOnlyPreviewMirror

    僅預覽開啟鏡像。

    AliRtcVideoPipelineMirrorModeOnlyPublishMirror

    僅推流開啟鏡像。

  • AliRtcCapturePipelineScaleMode:採集鏈路縮放類型。

    枚舉名

    描述

    AliRtcCapturePipelineScaleModePre

    採集後立即進行縮放,預設。

    AliRtcCapturePipelineScaleModePost

    編碼時進行縮放。

  • AliRtcAudioAccompanyConfig:音頻伴奏播放配置。

    參數

    類型

    描述

    onlyLocalPlay

    BOOL

    是否只本地播放。

    replaceMic

    BOOL

    是否替換掉MIC。

    loopCycles

    int

    迴圈次數,可以設定-1(無限迴圈)或者>0的正整數次,其他值無效。

    startPosMs

    NSInteger

    起播位置,單位:ms。

    publishVolume

    int

    推流音量,取值範圍[0-100],預設值:50。

    playoutVolume

    int

    播放音量,取值範圍[0-100],預設值:50。

  • AliRtcAudioFileInfo:音頻檔案資訊。

    參數

    類型

    描述

    filePath

    NSString *

    音頻檔案路徑。

    durationMs

    NSInteger

    音頻檔案時間長度,單位:ms 。

  • AliRtcDataChannelMsg:data訊息定義。

    參數

    類型

    描述

    type

    AliRtcDataMsgType

    音頻資料指標。

    networkTime

    long long

    網路時間戳記。

    progress

    int

    進度。

    data

    NSData*

    資料。

  • AliRtcDataMsgType:data訊息類型。

    枚舉

    描述

    AliRtcDataMsgNone

    未定義訊息。

    AliRtcDataMsgMusicProgress

    音樂進度訊息。

    AliRtcDataMsgCustom

    使用者自訂訊息。

  • AliRtcLocalDeviceType:本地裝置類型。

    枚舉值

    描述

    AliRtcLocalDeviceTypeUnknown

    未知裝置類型。

    AliRtcLocalDeviceTypeMic

    麥克風裝置。

    AliRtcLocalDeviceTypeSpeaker

    擴音器裝置。

    AliRtcLocalDeviceTypeAudioDevice

    音訊裝置。

    AliRtcLocalDeviceTypeCamera

    網路攝影機裝置。

    AliRtcLocalDeviceTypeDisplay

    顯示裝置。

    AliRtcLocalDeviceTypeVideoDevice

    視頻裝置。

  • AliRtcLocalDeviceExceptionType:本地裝置異常類型。

    枚舉值

    描述

    AliRtcLocalDeviceExceptionTypeUnknown

    未知異常類型。

    AliRtcLocalDeviceExceptionTypeMicOpenFail

    麥克風開啟失敗。

    AliRtcLocalDeviceExceptionTypeMicInterrupt

    麥克風被打斷。

    AliRtcLocalDeviceExceptionTypeMicAuthFail

    麥克風無許可權 。

    AliRtcLocalDeviceExceptionTypeMicNotAvailable

    無可用麥克風 。

    AliRtcLocalDeviceExceptionTypeSpeakerOpenFail

    擴音器開啟失敗。

    AliRtcLocalDeviceExceptionTypeSpeakerInterrupt

    擴音器被打斷。

    AliRtcLocalDeviceExceptionTypeSpeakerNotAvailable

    無可用擴音器。

    AliRtcLocalDeviceExceptionTypeAudioDeviceException

    音訊裝置異常。

    AliRtcLocalDeviceExceptionTypeCameraOpenFail

    網路攝影機開啟失敗 。

    AliRtcLocalDeviceExceptionTypeCameraInterrupt

    網路攝影機被打斷。

    AliRtcLocalDeviceExceptionTypeCameraAuthFail

    網路攝影機無許可權 。

    AliRtcLocalDeviceExceptionTypeDisplayExecption

    顯示裝置異常。

    AliRtcLocalDeviceExceptionTypeVideoDeviceException

    視頻裝置異常。

  • AliRtcLocalAudioStateType:本地音頻採集狀態。

    枚舉值

    描述

    AliRtcLocalAudioStateTypeStarting

    啟動中。

    AliRtcLocalAudioStateTypeStarted

    啟動結束。

    AliRtcLocalAudioStateTypeStopping

    關閉中。

    AliRtcLocalAudioStateTypeStopped

    關閉完成。

  • AliRtcLocalVideoStateType:本地視頻裝置狀態。

    枚舉值

    描述

    AliRtcLocalVideoStateTypeStarting

    啟動中。

    AliRtcLocalVideoStateTypeStarted

    啟動完成。

    AliRtcLocalVideoStateTypeStopping

    關閉中。

    AliRtcLocalVideoStateTypeStopped

    關閉完成。

  • AliRtcAudioAccompanyStateCode:音樂伴奏播放狀態。

    枚舉值

    描述

    AliRtcAudioAccompanyStarted

    開始播放。

    AliRtcAudioAccompanyStopped

    停止播放。

    AliRtcAudioAccompanyPaused

    播放暫停。

    AliRtcAudioAccompanyResumed

    播放恢複。

    AliRtcAudioAccompanyEnded

    播放完畢。

    AliRtcAudioAccompanyBuffering

    正在緩衝 。

    AliRtcAudioAccompanyBufferingEnd

    緩衝結束。

    AliRtcAudioAccompanyFailed

    播放失敗。

  • AliRtcAudioAccompanyErrorCode:音樂伴奏播放錯誤碼。

    枚舉值

    描述

    AliRtcAudioAccompanyNoError

    沒有錯誤。

    AliRtcAudioAccompanyOpenFailed

    開啟檔案失敗 。

    AliRtcAudioAccompanyDecodeFailed

    解碼檔案失敗。

  • AliRtcLiveTranscodingVideoCodec:旁路直播視頻編碼器。

    枚舉名

    描述

    AliRtcLiveTranscodingVideoCodec_H264

    h264

    AliRtcLiveTranscodingVideoCodec_H265

    h265

  • AliRtcAudioEffectBeautifyMode:美聲模式類型枚舉。

    枚舉值

    描述

    AliRtcAudioEffectBeautify_Off

    關閉美聲音效。

    AliRtcAudioEffectBeautify_Vigorous

    混厚。

    AliRtcAudioEffectBeautify_Ringing

    嘹亮。

    AliRtcAudioEffectBeautify_Mode_Max

    預留位置,表示最大值,不可用於實際設定。

  • AliRtcAudioEffectEqualizationBandFrequency:混響參數類型枚舉。

    枚舉常量

    描述

    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