Data type

更新时间:
复制 MD 格式

This topic describes the data types involved in the iOS SDK and the Mac SDK.

Data typeDescriptionSupported in the above version
AliRtcVideoTrackThe type of the video track. 1.1
AliRtcAudioTrackThe type of the audio track. 1.1
AliRtcNetworkQualityNetwork quality. 1.1
AliRtcRenderModeThe rendering mode. 1.1
AliRtcLogLevelThe level of the log entry. 1.1
AliRtcVideoProfileThe video quality parameters. 1.1
AliRtcErrorCodeThe type of the error that occurred. 1.9
AliRtcAuthInfoThe authentication information. 1.1
AliVideoCanvasRenders the canvas. 1.1
AliRtcRenderMirrorModeThe image mode. 1.11
AliRtcOnByeTypeThe OnBye type. 1.11
AliRtcAudioNumChannelAudio channel type (iOS only). 1.15
AudioSampleratesample rate (iOS only). 1.15
AliRtcChannelProfileThe type of the channel. 1.15
AliRtcAudioSessionOperationRestrictionSDK control permissions on Audio Sessions (iOS only). 1.15
AliRtcVideoFormatThe data format of the video.
  • iOS:1.15
  • Mac:1.16.2
AliRtcBufferTypeThe type of the video data.
  • iOS:1.15
  • Mac:1.16.2
AliRtcAudioSourceThe type of the bare audio data source. 1.15
AliRtcStatsCurrent channel call real-time data. 1.16
AliRtcRecordingQualityEnumeration of recording file quality. 1.16
AliRtcClientRoleThe type of the role. 1.16
AliRtcAudioPlayingStateCodeMusic accompaniment playback status (iOS only). 1.16.2
AliRtcVideoSourceThe type of the bare video data source. 1.16.2
AliRtcMuteLocalAudioModeLocal silent mode (Mac only). 1.16.2
AliRtcAudioEffectReverbModeReverberation sound mode. 1.17
AliRtcAudioEffectReverbParamTypeThe type of reverb sound effect. 1.17
AliRtcRecordTypeThe recording format. 1.17
AliRtcRecordFormatThe format of the recording. 1.17
AliRtcAudioQualityThe quality of the recording audio. 1.17
AliRtcVideoQualityThe quality of the recorded video. 1.17
AliRtcAudioSampleRateRecord audio sample rate. 1.17
AliRtcRecordAudioConfigRecord audio settings. 1.17
AliRtcRecordVideoConfigRecording video settings. 1.17
AliRtcLocalVideoStatsThe statistics on local videos. 1.17
AliRtcRemoteVideoStatsThe statistics on remote videos. 1.17
AliRtcBeautyConfigBeauty settings. 1.17.9
AliRtcUserVolumeInfoThe user volume information. 1.17.9
AliRtcFeedbackTypeThe type of the SDK feedback problem.
  • iOS:1.17.13
  • Mac:1.17.10
AliRtcCameraDirectionCamera direction. 1.17.20
AliRtcAudioDataSample The bare audio data. 1.17.20
AliRtcVideoDataSampleThe bare video data. 1.17
AliRtcOrientationModeThe type of the horizontal screen. 1.17
AliRtcAudioPlayingErrorCodeMusic accompaniment playback error code (iOS only). 1.17.30
AliRtcVideoEncoderMirrorModeThe image mode of the encoded video. 1.17.31
AliRtcVideoEncoderConfigurationvideo encoding preferences. 1.17.31
AliRtcVideoTextureTypeThe type of the texture. 1.17
AliRtcDeviceVolumeTypeThe device volume type (iOS only). 1.17.39
  • AliRtcVideoTrack: the type of the video track.

    Enumeration NameDescription
    AliRtcVideoTrackNoThere is no camera and screen sharing stream.
    AliRtcVideoTrackCameraThe camera stream.
    AliRtcVideoTrackScreenScreen sharing stream.
    AliRtcVideoTrackBothCamera stream and screen sharing stream.
  • AliRtcAudioTrack: the type of the audio track.

    Enumeration NameDescription
    AliRtcAudioTrackNoNo microphone stream.
    AliRtcAudioTrackMicMicrophone stream.
  • AliRtcNetworkQuality: network quality.

    Enumeration NameDescription
    AlivcRtcNetworkQualityExcellentThe network is excellent and the flow definition is good.
    AlivcRtcNetworkQualityGoodThe network is good, the fluency definition are about the same as excellent.
    AlivcRtcNetworkQualityPoorThe network is poor, and the definition of audio and video fluency is flawed, which does not affect communication.
    AlivcRtcNetworkQualityBadThe network is poor, the video is stuck seriously, and the audio can communicate normally.
    AlivcRtcNetworkQualityVeryBadThe network is extremely poor and basically unable to communicate.
    AlivcRtcNetworkQualityDisconnectNetwork interruption.
    AlivcRtcNetworkQualityUnknowUnknown.
  • AliRtcRenderMode: rendering mode.

    Enumeration NameDescription
    AliRtcRenderModeAutoAutomatic mode.
    AliRtcRenderModeStretchStretch the fill view without maintaining the video scale.
    AliRtcRenderModeFillScale and fill black edges while maintaining the aspect ratio of the video.
    AliRtcRenderModeCropZoom while maintaining the video aspect ratio and crop to fit the view.
  • AliRtcLogLevel: the log level.

    Enumeration NameDescription
    AliRtcLogLevelDumpFull.
    AliRtcLogLevelDebugDebug the job data.
    AliRtcLogLevelVerboseDetails.
    AliRtcLogLevelInfoOrdinary.
    AliRtcLogLevelWarnWarning.
    AliRtcLogLevelErrorThe error information.
    AliRtcLogLevelFatalSerious.
    AliRtcLogLevelNoneNone
  • AliRtcVideoProfile: the video quality parameters.

    The specification of the published video stream. The default value is AliRtcSDK_Video_Profile_Default. It can be set before or after the channel is added, but it must be set by using the setVideoProfile method before publishing.

    • iOS video quality parameters.
      Enumeration NameDescription
      AliRtcVideoProfile_DefaultBy default, the resolution is 480*640 and the frame rate is 15.
      AliRtcVideoProfile_180_240P_15Resolution 180*240, frame rate 15.
      AliRtcVideoProfile_180_320P_15Resolution 180*320, frame rate 15.
      AliRtcVideoProfile_180_320P_30Resolution 180*320, frame rate 30.
      AliRtcVideoProfile_240_320P_15Resolution 240*320, frame rate 15.
      AliRtcVideoProfile_360_480P_15Resolution 360*480, frame rate 15.
      AliRtcVideoProfile_360_480P_30Resolution 360*480, frame rate 30.
      AliRtcVideoProfile_360_640P_15Resolution 360*640, frame rate 15.
      AliRtcVideoProfile_360_640P_30Resolution 360*640, frame rate 30.
      AliRtcVideoProfile_480_640P_15Resolution 480*640, frame rate 15.
      AliRtcVideoProfile_480_640P_30Resolution 480*640, frame rate 30.
      AliRtcVideoProfile_720_960P_15Resolution 720*960, frame rate 15.
      AliRtcVideoProfile_720_960P_30Resolution 720*960, frame rate 30.
      AliRtcVideoProfile_720_1280P_15Resolution 720*1280, frame rate 15.
      AliRtcVideoProfile_720_1280P_30Resolution 720*1280, frame rate 30.
      AliRtcVideoProfile_1080_1920P_15Resolution 1080*1920, frame rate 15.
      AliRtcVideoProfile_1080_1920P_30Resolution 1080*1920, frame rate 30.
      AliRtcVideoProfile_480_640P_15_1500KbResolution 480*640, frame rate 15,150 0Kb bit rate.
      AliRtcVideoProfile_900_1600P_20Resolution 900*1600, frame rate 20.
      AliRtcVideoProfile_360_640P_15_800KbResolution 360*640, frame rate 15,800Kb bit rate.
      AliRtcVideoProfile_480_840P_15_500KbResolution 480*840, frame rate 15,500Kb bit rate.
      AliRtcVideoProfile_480_840P_15_800KbResolution 480*840, frame rate 15,800Kb bit rate.
      AliRtcVideoProfile_540_960P_15_800KbResolution 540*960, frame rate 15,800Kb bit rate.
      AliRtcVideoProfile_540_960P_15_1200KbResolution 540*960, frame rate 15,120 0Kb bit rate.
      AliRtcVideoProfile_MaxThe placeholder value.
    • Mac video quality parameters.
      Enumeration NameDescription
      AliRtcVideoProfile_DefaultBy default, the resolution is 480*640 and the frame rate is 15.
      AliRtcVideoProfile_180_240P_15Resolution 180*240, frame rate 15.
      AliRtcVideoProfile_180_320P_15Resolution 180*320, frame rate 15.
      AliRtcVideoProfile_180_320P_30Resolution 180*320, frame rate 30.
      AliRtcVideoProfile_240_320P_15Resolution 240*320, frame rate 15.
      AliRtcVideoProfile_360_480P_15Resolution 360*480, frame rate 15.
      AliRtcVideoProfile_360_480P_30Resolution 360*480, frame rate 30.
      AliRtcVideoProfile_360_640P_15Resolution 360*640, frame rate 15.
      AliRtcVideoProfile_360_640P_30Resolution 360*640, frame rate 30.
      AliRtcVideoProfile_480_640P_15Resolution 480*640, frame rate 15.
      AliRtcVideoProfile_480_640P_30Resolution 480*640, frame rate 30.
      AliRtcVideoProfile_720_960P_15Resolution 720*960, frame rate 15.
      AliRtcVideoProfile_720_960P_30Resolution 720*960, frame rate 30.
      AliRtcVideoProfile_720_1280P_15Resolution 720*1280, frame rate 15.
      AliRtcVideoProfile_720_1280P_30Resolution 720*1280, frame rate 30.
      AliRtcVideoProfile_1080_1920P_15Resolution 1080*1920, frame rate 15.
      AliRtcVideoProfile_1080_1920P_30Resolution 1080*1920, frame rate 30.
      AliRtcVideoProfile_480_640P_15_1500KbResolution 480*640, frame rate 15,150 0Kb bit rate.
      AliRtcVideoProfile_900_1600P_20Resolution 900*1600, frame rate 20.
      AliRtcVideoProfile_360_640P_15_800KbResolution 360*640, frame rate 15,800Kb bit rate.
      AliRtcVideoProfile_480_840P_15_500KbResolution 480*840, frame rate 15,500Kb bit rate.
      AliRtcVideoProfile_480_840P_15_800KbResolution 480*840, frame rate 15,800Kb bit rate.
      AliRtcVideoProfile_540_960P_15_800KbResolution 540*960, frame rate 15,800Kb bit rate.
      AliRtcVideoProfile_540_960P_15_1200KbResolution 540*960, frame rate 15,120 0Kb bit rate.
      AliRtcVideoProfile_MaxThe placeholder value.
  • AliRtcErrorCode: the error type.

    ParameterEnumeration NameDescription
    Error codesAliRtcErrJoinBadAppIdThe AppId does not exist.
    AliRtcErrJoinInvalidAppIdThe AppId is invalid.
    AliRtcErrJoinBadChannelThe channel does not exist.
    AliRtcErrJoinInvalidChannelThe channel has expired.
    AliRtcErrJoinBadTokenThe token does not exist.
    AliRtcErrJoinTimeoutAdding a channel timed out.
    AliRtcErrJoinBadParamThe error message returned because the format of the specified parameter is invalid.
    Audio device error codesAliRtcErrMicOpenFailThe initialization of the collection device failed.
    AliRtcErrSpeakerOpenFailThe playback device failed to be initialized.
    AliRtcErrMicInterruptAn exception occurred during collection.
    AliRtcErrSpeakerInterruptAn exception occurs during playback.
    AliRtcErrMicAuthFailThe microphone device is not authorized.
    AliRtcErrMicNotAvailableNo audio acquisition device is available.
    AliRtcErrSpeakerNotAvailableNo audio playback device is available.
    Video device error codesAliRtcErrCameraOpenFailThe initialization of the collection device failed.
    AliRtcErrCameraInterruptAn exception occurred during collection.
    AliRtcErrDisplayOpenFailFailed to initialize the rendering device.
    AliRtcErrDisplayInterruptAn exception occurred during rendering.
    Network error codesAliRtcErrIceConnectionConnectFailMedia channel establishment failed.
    AliRtcErrIceConnectionReconnectFailMedia channel reconnection failed.
    AliRtcErrIceConnectionHeartbeatTimeoutSignaling heartbeat times out.
    Other error codesAliRtcErrSdkInvalidStateThe SDK status is incorrect.
    AliRtcErrSessionRemovedSession has been removed.
    AliRtcErrInnerThe error code returned because a hotword vocabulary error other than the preceding ones has occurred.
    AliRtcErrAudioBufferFullBuffer queues are saturated and used for external delivery of bare data.
  • AliRtcAuthInfo: the authentication information.

    Important The session id field is removed in 1.9 and later versions.
    ParameterTypeDescription
    channelNSString *Channel number.
    user_idNSString *The ID of the user.
    appidNSString *The ID of the application.
    nonceNSString *The random code of the token.
    tokenNSString *The token.
    gslbNSArrayThe address of the origin server.
    timestamplong longTimestamp.
    agentNSArraySet the proxy server address (the default state does not need to be passed).
    roleNSString *The type of the role. The default value is empty, indicating that this feature is not involved. Valid values:
    • pub: the anchor role.
    • sub: the audience role.
    For more information, see How can I implement role authentication?.
  • AliVideoCanvas: renders a canvas.

    ParameterTypeDescription
    viewAliRenderView *Renders a view and inherits the UIView class. You must create a view (view) before creating a view.
    renderModeAliRtcRenderModeThe rendering mode. Default value: AliRtcRenderModeAuto (Auto mode).
    mirrorModeAliRtcRenderMirrorModeThe image mode. Default value: Pre-image.
  • AliRtcRenderMirrorMode: image mode.

    Enumeration NameDescription
    AliRtcRenderMirrorModeOnlyFrontCameraPreviewEnabledOnly the front camera previews the mirror image, and the rest are not mirrored.
    AliRtcRenderMirrorModeAllEnabledAll images.
    AliRtcRenderMirrorModeAllDisabledAll images are not mirrored.
  • AliRtcOnByeType:OnBye type (messages kicked out of the channel by the server).

    Enumeration NameDescription
    AliRtcOnByeBeKickedOutThe current user is kicked off the channel.
    AliRtcOnByeChannelDestroyThe channel is over and needs to leave the meeting.
    AliRtcOnByeUserReplacedIf the same UserID is added to a channel on another device, the current device is offline.
  • AliRtcAudioNumChannel: the audio channel type.

    Enumeration NameDescription
    AliRtcMonoAudioMono audio.
    AliRtcStereoAudioStereo audio.
  • AudioSamplerate: sample rate.

    Enumeration NameDescription
    AliRtcAudioSampleRate_80008000.
    AliRtcAudioSampleRate_1102511025.
    AliRtcAudioSampleRate_1600016000.
    AliRtcAudioSampleRate_2205022050.
    AliRtcAudioSampleRate_3200032000.
    AliRtcAudioSampleRate_4410044100.
    AliRtcAudioSampleRate_4800048000.
  • AliRtcChannelProfile: channel type (default is communication mode).

    Enumeration NameDescription
    AliRtcCommunicationThe communication mode.
    AliRtcInteractiveliveInteractive mode.
  • AliRtcAudioSessionOperationRestriction: the control permissions of the SDK on Audio Sessions.

    Enumeration NameDescription
    AliRtcAudioSessionOperationRestrictionNoneThere are no restrictions. The SDK fully controls AVAudioSession.
    AliRtcAudioSessionOperationRestrictionSetCategoryThe SDK cannot modify the Category of AVAudioSession.
    AliRtcAudioSessionOperationRestrictionConfigureSessionThe SDK cannot modify the configuration of AVAudioSession, including Category, Mode, and CategoryOptions.
    AliRtcAudioSessionOperationRestrictionDeactivateSessionThe SDK cannot disable the AVAudioSession activity. When you leave the channel, the AVAudioSession is still active.
  • AliRtcVideoFormat: video data format.

    Enumeration NameDescription
    AliRtcVideoFormat_UNKNOWUnknown.
    AliRtcVideoFormat_BGRABGRA.
    AliRtcVideoFormat_I420I420.
    AliRtcVideoFormat_NV21NV21.
    AliRtcVideoFormat_NV12NV12.
  • AliRtcBufferType: the video data type.

    Enumeration NameDescription
    AliRtcBufferType_Raw_DataYUV bare data.
    AliRtcBufferType_CVPixelBufferCVPixelBuffer data.
    AliRtcBufferType_TextureTexture data.
  • AliRtcAudioSource: the type of the audio bare data source.

    Enumeration NameDescription
    AliRtcAudiosourcePubIngest audio data.
    AliRtcAudiosourceSubPull audio data.
    AliRtcAudiosourceRawDataCollect bare audio data.
    AliRtcAudiosourceVolumeVolume.
    Note Mac and iOS1.16 and above support AliRtcAudiosourceVolume enumeration. The difference between the two languages: iOS supports AliRtcAudioSource all enumeration, while Mac only supports AliRtcAudiosourceVolume (volume).
  • AliRtcStats: the real-time call data of the current channel.

    ParameterTypeDescription
    sent_kbitrateint64_tthe total transmission bit rate. unit: kb.
    rcvd_kbitrateint64_tThe total received bitrate. Unit: kb.
    sent_bytesint64_tThe total amount of data sent. Unit: bytes.
    rcvd_bytesint64_tThe total amount of data received. Unit: bytes.
    video_rcvd_kbitrateint64_tthe video sending bit rate. unit: kb.
    video_sent_kbitrateint64_tthe video reception bitrate. unit: kb.
    call_durationuint64_tCall duration, unit: s.
    cpu_usagefloatThe CPU usage. Unit: %.
    sent_loss_rateint8_tThe packet loss rate from the client to the server. Unit: %.
    lastmile_delayint64_tThe latency from the client to the server. Unit: ms.
  • AliRtcRecordingQuality: recording file quality enumeration.

    Enumeration NameDescription
    AliRtcRecording_Low_QualityLow-quality file recording, small file size, average sound quality.
    AliRtcRecording_Midium_QualityMedium quality file recording, medium file volume, medium sound quality.
    AliRtcRecording_High_QualityHigh-quality file recording, large file volume and good sound quality.
  • AliRtcClientRole: the type of the role.

    Enumeration NameDescription
    AliRtcClientRoleInteractiveParticipate in interactive roles.
    AliRtcClientRoleliveWatch characters only.
  • AliRtcAudioPlayingStateCode: Music accompaniment playing status.

    Enumeration NameDescription
    AliRtcAudioPlayingStartedStart the playback.
    AliRtcAudioPlayingStoppedStop the playback.
    AliRtcAudioPlayingPausedIndicates that the player pauses a video.
    AliRtcAudioPlayingResumedThe playback is resumed.
    AliRtcAudioPlayingEndedPlay finished.
    AliRtcAudioPlayingBufferingis buffering.
    AliRtcAudioPlayingBufferingEndThe buffer ends.
    AliRtcAudioPlayingFailedThe error message returned because the playback failed.
  • AliRtcVideoSource: the type of the bare video data source.

    Enumeration NameDescription
    AliRtcVideosourceCameraLargeTypeLarge-resolution video streams.
    AliRtcVideosourceCameraSmallTypeSmall resolution video stream.
    AliRtcVideosourceScreenShareTypeScreen sharing stream.
    AliRtcVideosourceTypeMaxPlaceholder.
  • AliRtcMuteLocalAudioMode: local mute mode.

    Enumeration NameDescription
    AliRtcMuteAudioModeDefaultThe default mode.
    AliRtcMuteAllAudioModeMute all (microphone and external input audio).
    AliRtcMuteOnlyMicAudioModeOnly mute the microphone.
    AliRtcMuteLocalAudioMaxThe placeholder value.
  • AliRtcAudioEffectReverbMode: reverb mode.

    Enumeration NameDescription
    AliRtcAudioEffectReverb_OffDisabled
    AliRtcAudioEffectReverb_Vocal_IVocal I.
    AliRtcAudioEffectReverb_Vocal_IIVocal II.
    AliRtcAudioEffectReverb_BathroomThe bathhouse.
    AliRtcAudioEffectReverb_Small_Room_BrightBright little room.
    AliRtcAudioEffectReverb_Small_Room_DarkDark little room.
    AliRtcAudioEffectReverb_Medium_RoomMedium room.
    AliRtcAudioEffectReverb_Large_RoomBig room.
    AliRtcAudioEffectReverb_Church_HallChurch corridor.
    AliRtcAudioEffectReverb_CathedralThe cathedral.
    AliRtcAudioEffectReverb_Mode_MaxPlaceholder, no meaning.
  • AliRtcAudioEffectReverbParamType: the reverb parameters of the sound effect.

    Enumeration NameDescription
    AliRtcAudioEffectReverb_Room_SizeThe room size. Valid values: 0 to 100.
    AliRtcAudioEffectReverb_Pre_DelayThe pre-delay. Unit: ms. Valid values: 0 to 200.
    AliRtcAudioEffectReverb_RevetberanceThe reverberation. Valid values: 0 to 100.
    AliRtcAudioEffectReverb_Hf_DampingThe noise reduction. Valid values: 0 to 100.
    AliRtcAudioEffectReverb_Tone_LowThe bass tone. Valid values: 0 to 100.
    AliRtcAudioEffectReverb_Tone_HighThe high pitch. Valid values: 0 to 100.
    AliRtcAudioEffectReverb_Dry_GainThe dry gain. Valid values:-20 to 10.
    AliRtcAudioEffectReverb_Wet_GainThe wet gain. Valid values:-20 to 10.
    AliRtcAudioEffectReverb_Type_MaxPlaceholder.
  • AliRtcRecordType: the recording type.

    Enumeration NameDescription
    AliRtcRecordTypeAudioAudio-only recording.
  • AliRtcRecordFormat: the recording format.

    Enumeration NameDescription
    AliRtcRecordFormatAACAAC file.
    AliRtcRecordFormatWAVWAV file.
  • AliRtcAudioQuality: the quality of the recording audio.

    Enumeration NameDescription
    AliRtcAudioQualityLowLow.
    AliRtcAudioQualityMidiuminstance.
    AliRtcAudioQualityHighHigh.
  • AliRtcVideoQuality: the quality of the recorded video.

    Enumeration NameDescription
    AliRtcVideoQualityDefaultThe default value is the same as the collection. For example, the maximum value of the collected video stream is 1080P, and the default value is 1080P.
  • AliRtcAudioSampleRate: Record audio sample rate.

    Enumeration NameDescription
    AliRtcAudioSampleRate_8000sample rate 8000.
    AliRtcAudioSampleRate_11025sample rate 11025.
    AliRtcAudioSampleRate_16000sample rate 16000.
    AliRtcAudioSampleRate_22050sample rate 22050.
    AliRtcAudioSampleRate_32000sample rate 32000.
    AliRtcAudioSampleRate_44100sample rate 44100.
    AliRtcAudioSampleRate_48000sample rate 48000.
  • AliRtcRecordAudioConfig: Record audio settings.

    ParameterTypeDescription
    sampleRateAliRtcAudioSampleRateThe audio sample rate.
    qualityAliRtcAudioQualityThe audio quality.
    enableRecordExternalRenderPCMboolSpecifies whether to allow recording of external PCM input rendering data.
  • AliRtcRecordVideoConfig: Recording video settings.

    ParameterTypeDescription
    qualityAliRtcVideoQualityThe video quality.
    sourceTypeAliRtcVideoSourceThe type of the bare video data source.
  • AliRtcLocalVideoStats: local video statistics.

    ParameterTypeDescription
    trackAliRtcVideoTrackThe type of the video stream track.
    sent_bitrateuint32_tThe bitrate of local videos that are sent.
    sent_fpsuint32_tThe frame rate of local videos that are sent.
    encode_fpsuint32_tThe frame rate of video encoding.
  • AliRtcRemoteVideoStats: remote video statistics.

    ParameterTypeDescription
    userIdNSString * _NonnullThe ID of the remote user.
    trackAliRtcVideoTrackThe type of the video stream track.
    widthuint32_tThe width.
    heightuint32_tHigh.
    decode_fpsuint32_tThe frame rate of video decoding.
    render_fpsuint32_tThe frame rate of video rendering.
    frozen_timesuint32_tThe number of stuttering times.
  • AliRtcBeautyConfig: the beauty settings.

    ParameterTypeDescription
    whiteningLevelfloatWhitening grade [0-1.0], the larger the value, the better the whitening effect.
    smoothnessLevelfloatGrinding grade [0-1.0], the larger the value, the better the grinding effect.
  • AliRtcUserVolumeInfo: the volume information format.

    ParameterTypeDescription
    uidNSString * _NonnullThe uid of the current user. 0: indicates local, 1: indicates remote mixing, and others indicate remote users.
    speech_stateBOOLtrue: indicates that you are speaking. false: indicates that you are not speaking.
    volumeintThe volume of the current callback.
  • AliRtcFeedbackType:SDK feedback problem type.

    Enumeration NameDescription
    AliRtcFeedbackVideoDeviceFailVideo equipment issues.
    AliRtcFeedbackVideoNotRenderThe video has no picture.
    AliRtcFeedbackAudioDeviceFailAudio device problem.
    AliRtcFeedbackAudioNotRenderThe audio has no sound.
    AliRtcFeedbackAudioEchoErrorThe audio echo is abnormal.
    AliRtcFeedbackChannelTypeErrorThe meeting status is abnormal. The meeting status is abnormal. The meeting status is abnormal.
    AliRtcFeedbackSDKTypeErrorOther status of the SDK is abnormal.
    AliRtcFeedbackNetworkUnfluentNetwork Catton problem.
    AliRtcFeedbackVideoBlurringVideo clarity issues.
    AliRtcFeedbackUnkonwThe unknown type.
  • AliRtcCameraDirection: the camera direction.
    Enumeration NameDescription
    AliRtcCameraDirectionInvalidInvalid.
    AliRtcCameraDirectionBackPost.
    AliRtcCameraDirectionFrontFront.
  • AliRtcAudioDataSample: audio bare data.
    ParameterTypeDescription
    dataPtrlongNaked data.
    numOfSamplesintThe number of audio sample points.
    bytesPerSampleintThe number of quantized digits.
    numOfChannelsintThe number of sound channels.
    samplesPerSecintThe sampling rate.
  • AliRtcVideoDataSample: Naked video data.
    ParameterTypeDescription
    formatAliRtcVideoFormatThe data format of the video.
    typeAliRtcBufferTypeThe type of the video data.
    pixelBufferCVPixelBufferRefiOS video texture frame data.
    dataPtrlongThe bare video data.
    dataYPtrlongThe bare data of the Y channel video.
    dataUPtrlongBare data of U-channel video.
    dataVPtrlongV channel video bare data.
    dataLengthlongThe total length of video frame data.
    strideYintY channel row spacing.
    strideUintU channel row spacing.
    strideVintV channel row spacing.
    strideintThe line spacing of video frames.
    heightintThe height of the video image.
    widthintThe width of the video image.
    rotationintThe rotation angle of the video image.
    timeStamplong longThe timestamp of the video frame.
  • AliRtcOrientationMode: the horizontal screen type.
    Enumeration NameDescription
    AliRtcOrientationModePortraitFixed vertical screen mode.
    AliRtcOrientationModeLandscapeLeftFixed the left horizontal screen mode.
    AliRtcOrientationModeLandscapeRightFixed right horizontal screen mode.
    AliRtcOrientationModeAutoAdaptive horizontal and vertical screen mode.
  • AliRtcAudioPlayingErrorCode: Music accompaniment playback error code (iOS only).
    Enumeration NameDescription
    AliRtcAudioPlayingNoErrorNo errors.
    AliRtcAudioPlayingOpenFailedOpen file error.
    AliRtcAudioPlayingDecodeFailedDecoding file error.
  • AliRtcVideoEncoderMirrorMode: Encoded video image mode.
    Enumeration NameDescription
    AliRtcVideoEncoderMirrorModeDisabledEncode the video image.
    AliRtcVideoEncoderMirrorModeEnabledThe encoded video is not mirrored.
  • AliRtcVideoEncoderConfiguration: video encoding preferences.
    ParameterTypeDescription
    mirrorModeAliRtcVideoEncoderMirrorModeThe image mode of the encoded video.
  • AliRtcVideoTextureType: texture type.
    Enumeration NameDescription
    AliRtcVideoTextureTypeUnknownNo texture specified.
    AliRtcVideoTextureTypePreTexture before rendering.
    AliRtcVideoTextureTypePostTexture after rendering.
  • AliRtcDeviceVolumeType: the device volume type.
    Enumeration NameDescription
    AliRtcDeviceVolumeTypeAutoThe SDK automatically sets the volume type (default). The SDK automatically selects an appropriate volume type. If you do not have special requirements, we recommend that you do not set it yourself.
    AliRtcDeviceVolumeTypeMediaSet this parameter to Media Volume, which is suitable for media playback scenarios. The volume can be adjusted to zero.
    AliRtcDeviceVolumeTypeVOIPSet this parameter to Call Volume, which is suitable for call scenarios. The volume cannot be adjusted to zero.