Data types

更新时间:
复制 MD 格式

This topic describes the data types for the iOS SDK and Mac SDK.

Directory

Data typeDescriptionMinimum supported version
AliRtcAudioPlayingErrorCodeError codes for music accompaniment playback. (iOS only)2.1
AliRtcAudioPlayingStateCodePlayback states for music accompaniment. (iOS only)2.1
AliRtcUserVolumeInfoUser volume information.1.17
AliRtcAudioDataSampleAudio sample.2.1
AliRtcVideoDataSampleVideo sample.2.1
AliRtcChannelProfileChannel profile.1.17
AliRtcClientRoleUser role.1.17
AliRtcStatsSession statistics.1.17
AliRtcLocalVideoStatsLocal video statistics.1.17
AliRtcRemoteVideoStatsRemote video statistics.1.17
AliRtcLocalAudioStatsLocal audio statistics.1.7
AliRtcRemoteAudioStatsRemote audio statistics.1.17
AliRtcFeedbackTypeSDK feedback types.1.17
AliRtcChannelRelayEventCross-channel stream forwarding events.2.1
AliRtcChannelRelayStateCross-channel stream forwarding states.2.1
AliRtcChannelRelayConfigurationCross-channel stream forwarding configurations.2.1
AliRtcVideoObserPositionVideo data output position.2.1
AliRtcVideoFormatThe data type of the video.
  • iOS: 1.15
  • Mac: 1.16.2
AliRtcExternalDeviceTypeExternal device types. (Mac only)2.1
AliRtcExternalDeviceStateExternal device states. (Mac only)2.1
AliRtcConnectionStatusNetwork connection status.2.1
AliRtcConnectionStatusChangeReasonReasons for network connection status changes.2.1
AliRtcVideoTrackVideo stream type.1.1
AliRtcPublishStateStream ingest state.2.1
AliRtcSubscribeStateSubscription state.2.1
AliRtcUserOfflineReasonReasons for user offline.2.1
AliRtcVideoStreamTypeCamera stream type.2.1
AliRtcAudioTrackAudio stream type.1.1
AliRtcNetworkQualityNetwork quality.1.1
AliRtcOrientationModeScreen orientation modes. (iOS only)2.1
AliRtcAudioSessionOperationRestrictionSDK control permissions for Audio Session. (iOS only)1.15
AliRtcRenderModeRendering mode.1.17
AliRtcRenderMirrorModeMirror mode.1.17
AliRtcRotationModeRotation angle.2.1
AliRtcLogLevelLog level.1.17
AliRtcAudioNumChannelThe number of audio channels.1.15
AliRtcAudioSampleRateAudio recording sample rate.2.1
AliRtcRecordTypeRecord type.2.1
AliRtcRecordFormatRecord format.2.1
AliRtcAudioQualityAudio quality of the recorded audio file.2.1
AliRtcVideoQualityVideo quality of the recorded video file.1.17
AliRtcTranportAudioQualityAudio quality.2.1
AliRtcAudioProfileAudio quality mode.2.1
AliRtcAudioScenarioAudio scenario mode parameters.2.1
AliRtcMuteLocalAudioModeLocal mute mode.2.1
AliRtcRecordAudioConfigAudio recording settings.1.17
AliRtcRecordVideoConfigVideo recording settings.1.17
AliRtcRecordVideoCanvasConfigCanvas size for video recording settings. (Mac only)2.1
AliRtcRecordVideoLayoutLayout information for recorded video. (Mac only)2.1
AliRtcRecordVideoLayoutModeLayout mode for recorded video. (Mac only)2.1
AliRtcRecordVideoBgColorBackground color for recorded video. (Mac only)2.1
AliRtcRecordVideoRegionUser video configuration for recording layout. (Mac only)2.1
AliRtcRecordVideoRectangleThe user's screen position (Mac only).2.1
AliRtcRecordVideoRationalCoordinates for stream mixing recording. (Mac only)2.1
AliRtcRecordTemplateRecording template. (Mac only)2.1
AliRtcDeviceInfoDevice information. (Mac only)2.1
AliRtcBeautyConfigBasic retouching settings.1.17
AliRtcOnByeTypeEnumeration of OnBye types.2.1
AliRtcAudioEffectVoiceChangerModeVoice changer effect modes.2.1
AliRtcAudioEffectReverbModeReverb effect modes.2.1
AliRtcAudioEffectReverbParamTypeReverb effect parameters.2.1
AliRtcAudioRouteTypeAudio route. (iOS only)2.1
AliVideoCanvasRendering canvas.1.17
AliRtcTrascodingLiveStreamErrorCodeBypass stream ingest error codes.2.1
AliRtcWatermarkConfigWatermark image settings.2.1
AliRtcCameraCapturerConfigurationCamera capture preference properties.2.1
AliRtcCameraDirectionCamera direction.2.1
AliRtcCaptureOutputPreferenceCamera capture preference.2.1
AliRtcVideoEncoderFrameRateVideo encoding frame rate.2.1
AliRtcVideoEncoderBitrateVideo encoding bitrate.2.1
AliRtcVideoEncoderMirrorModeEncoded video mirror mode.2.1
AliRtcVideoEncoderOrientationModeEncoded video rotation mode.2.1
AliRtcVideoEncoderConfigurationVideo encoding preference.2.1
AliRtcScreenShareEncoderConfigurationScreen sharing encoding preference.2.1
AliRtcScreenShareConfigScreen sharing configuration. (Mac only)2.1
AliRtcScreenShareRegionScreen sharing region. (Mac only)2.1
AliRtcScreenSourceInfoScreen sharing source information. (Mac only)2.1
AliRtcScreenShareInfoScreen sharing configuration information. (Mac only)2.1
AliRtcScreenShareTypeScreen sharing type. (Mac only)2.1
AliRtcAuthInfoAuthentication information.1.17
AliRtcDeviceVolumeTypeDevice volume type. (iOS only)1.17.39
AliRtcVideoSourceRaw video data source type.1.16.2
AliRtcAudioSourceRaw audio data source type.1.15
AliRtcBufferTypeVideo data type.
  • iOS: 1.15
  • Mac: 1.16.2
AliRtcErrorCodeError code.1.9
AliRtcVideoObserAlignmentVideo output width alignment.2.4
AliRtcShowDebugViewTypeDashboard display type.2.4
AliRtcTrascodingLiveTaskStatusLiveStream status for bypass stream ingest.2.4
AliRtcLiveTranscodingDisplayTypeImage display type for bypass live streaming.2.4
AliRtcLiveTranscodingFontTypeText type for bypass live streaming.2.4
AliRtcLiveTranscodingSegmentTypeInput type for bypass live streaming.2.4
AliRtcLiveTranscodingSourceTypeInput type for bypass live streaming.2.4
AliRtcVideoStateVideo stream state change.2.4
AliRtcVideoReasonReason for the video stream state change.2.4
AliRtcLiveTranscodingCropModeClipping mode for bypass live streaming.2.4
AliRtcLiveTranscodingMediaProcessModeMedia processing mode for bypass live streaming.2.4
AliRtcLiveTranscodingStreamTypeStream type for bypass live streaming.2.4
AliRtcLiveTranscodingMixModeMode for bypass live streaming.2.4
AliRtcLiveTranscodingStateState of bypass live streaming.2.4
AliRtcLiveTranscodingTextText information for bypass live streaming.2.4
AliRtcLiveTranscodingImageImage information for bypass live streaming.2.4
AliRtcLiveTranscodingPaneCustom user pane information for bypass live streaming.2.4
AliRtcLiveTranscodingParamConfiguration for bypass live streaming.2.4
AliRtcLiveTranscodingMixParamStream mixing parameters for bypass mode.2.4
AliRtcLiveTranscodingSingleParamSingle-stream parameters for bypass mode.2.4
AliRtcLiveTranscodingTaskProfileBilling specifications for bypass live streaming.2.4
AliRtcLiveTranscodingEncodeParamEncoding parameters for bypass live streaming.2.4
AliRtcLiveTranscodingAudioSampleRateAudio sample rate for bypass live streaming.2.4
AliRtcLiveTranscodingClockWidgetClock widget for bypass live streaming.2.4
AliRtcBokehScaleModelScaling mode for background replacement. (Mac only)2.4
AliRtcAudioPlayingStateCodePlayback state for music accompaniment. (Mac only)2.4
AliRtcAudioPlayingErrorCodeError codes for music accompaniment playback. (Mac only)2.4

Details

  • AliRtcAudioPlayingErrorCode: The error codes for music accompaniment playback. (iOS only)
    Enumeration NameDescription
    AliRtcAudioPlayingNoErrorNormal state.
    AliRtcAudioPlayingOpenFailedFailed to open the file.
    AliRtcAudioPlayingDecodeFailedEncoding failed.
  • AliRtcAudioPlayingStateCode: The playback states for music accompaniment. (iOS only)
    EnumerationDescription
    AliRtcAudioPlayingStartedPlaying.
    AliRtcAudioPlayingStoppedPlayback stopped.
    AliRtcAudioPlayingPausedPlayback paused.
    AliRtcAudioPlayingResumedPlayback resumed.
    AliRtcAudioPlayingEndedPlayback finished.
    AliRtcAudioPlayingBufferingBuffering.
    AliRtcAudioPlayingBufferingEndBuffering finished.
    AliRtcAudioPlayingFailedPlayback failed.
  • AliRtcUserVolumeInfo: The volume information of a user.
    ParameterTypeDescription
    uidNSString * _NonnullThe UID of the current user. Valid values:
    • 0 indicates local.
    • 1: The remote mixed stream.
    • Other values: A remote user.
    volumeintThe volume in the current callback.
    speech_stateBOOLIndicates whether the user is speaking. `true` means the user is speaking. `false` means the user is not speaking.
  • AliRtcAudioDataSample: An audio sample.
    ParameterTypeDescription
    dataPtrlongThe UID of the current user. Valid values:
    • 0: Local.
    • 1: The remote mixed stream.
    • Other values: A remote user.
    numOfSamplesintThe number of sample points for each channel.
    bytesPerSampleintThe number of bytes per sample point. For PCM, this is typically 16 bits, which is two bytes.
    numOfChannelsintThe number of channels. Valid values:
    • 1: Mono.
    • 2: Stereo.
    samplesPerSecintThe number of sample points per second for each channel. This is the sample rate.
  • AliRtcVideoDataSample: A video sample.
    ParameterTypeDescription
    formatAliRtcVideoFormatVideo data format.
    typeAliRtcBufferTypeVideo data type.
    pixelBufferCVPixelBufferRef _NullableThe pixel buffer data.
    dataPtrlongPointer to the YUV data.
    dataYPtrlongPointer to the Y component.
    dataUPtrlongPointer to the U component.
    dataVPtrlongPointer to the V component.
    dataLengthlongThe data size.
    strideYintThe stride of the Y buffer in the YUV data.
    strideUintThe stride of the U buffer in the YUV data.
    strideVintThe stride of the V buffer in the YUV data.
    heightintThe height of the video frame.
    widthintThe width of the video frame.
    rotationintThe rotation angle of the video frame.
    timeStamplong longTimestamp.
  • AliRtcChannelProfile: The channel profile.
    EnumerationDescription
    AliRtcCommunicationCommunication mode.
    AliRtcInteractiveliveInteractive mode.
    AliRtcInteractiveWithLowLatencyLiveLow-latency interactive streaming mode.
  • AliRtcClientRole: The role of a user.
    EnumerationDescription
    AliRtcClientRoleInteractiveStreamer role.
    AliRtcClientRoleliveViewer role.
  • AliRtcStats: The statistics of a session.
    ParameterTypeDescription
    sent_kbitratelong longThe sending bitrate.
    rcvd_kbitratelong longThe receiving bitrate.
    sent_byteslong longThe number of bytes sent.
    rcvd_byteslong longThe number of bytes received.
    systemCpuUsagefloatThe system CPU usage.
    cpu_usagefloatThe CPU usage of the RTC process.
    video_rcvd_kbitratelongThe video receiving bitrate.
    video_sent_kbitratelongThe video sending bitrate.
    call_durationlongThe call duration in seconds.
    sent_loss_ratelongThe packet loss rate from the client to the server.
    sent_loss_pktslong longThe number of lost packets from the client to the server.
    sent_expected_pktslong longThe total number of packets from the client to the server.
    rcvd_loss_ratelong longThe downlink packet loss rate from the client to the server.
    rcvd_loss_pktslong longThe number of lost downlink packets from the client to the server.
    rcvd_expected_pktslong longThe total number of downlink packets from the client to the server.
    lastmile_delayintThe delay duration in milliseconds.
  • AliRtcLocalVideoStats: The statistics of a local video stream.
    ParameterTypeDescription
    trackAliRtcVideoTrackThe stream type.
    sent_bitrateunsigned intThe publishing bitrate.
    sent_fpsunsigned intThe publishing frame rate.
    encode_fpsunsigned intThe encoding frame rate.
  • AliRtcRemoteVideoStats: The statistics of a remote video stream.
    ParameterTypeDescription
    userIdNSString * _NonnullThe user ID.
    trackAliRtcVideoTrackThe video stream type.
    widthunsigned intThe width.
    heightunsigned intHigh
    decode_fpsunsigned intThe encoder output frame rate.
    render_fpsunsigned intThe renderer output frame rate.
    frozen_timesunsigned intThe number of stutters.
  • AliRtcLocalAudioStats: The statistics of a local audio stream.
    ParameterTypeDescription
    trackAliRtcAudioTrackThe audio stream type.
    sent_bitrateintThe sending bitrate in Kbps.
    sent_samplerateintThe sending sample rate.
    num_channelintThe number of sound channels.
  • AliRtcRemoteAudioStats: The statistics of a remote audio stream.
    ParameterTypeDescription
    userIdNSString * _NonnullThe UID of the remote user.
    trackAliRtcAudioTrackThe audio stream type.
    qualityunsigned intThe audio quality. For more information, see AliRtcTranportAudioQuality.
    audio_loss_rateunsigned intThe audio frame loss rate during the callback period.
    rcvd_bitrateunsigned intThe instantaneous bitrate of the received stream in Kbps.
    totalFrozenTimesunsigned intThe number of stutters.
    network_transport_delayunsigned intThe network latency from the sender to the receiver in milliseconds.
    jitter_buffer_delayunsigned intThe network latency from the receiver to the jitter buffer in milliseconds.
  • AliRtcFeedbackType: The feedback types of the SDK.
    EnumerationDescription
    AliRtcFeedbackVideoDeviceFailVideo device issue.
    AliRtcFeedbackVideoNotRenderNo video display.
    AliRtcFeedbackAudioDeviceFailAudio device issue.
    AliRtcFeedbackAudioNotRenderNo audio.
    AliRtcFeedbackAudioEchoErrorAbnormal audio echo.
    AliRtcFeedbackChannelTypeErrorThe meeting status is abnormal. For example, an error occurs when a user joins or leaves the meeting.
    AliRtcFeedbackSdkTypeErrorOther abnormal SDK states.
    AliRtcFeedbackNetworkUnfluentNetwork stutter issue.
    AliRtcFeedbackVideoBlurringVideo clarity issue.
    AliRtcFeedbackUnkonwUnknown type.
  • AliRtcChannelRelayEvent: Events related to cross-channel stream forwarding.
    EnumerationDescription
    AliRtcChannelRelayStartStart.
    AliRtcChannelRelayUpdateUpdate.
    AliRtcChannelRelayStopStop.
  • AliRtcChannelRelayState: The state of cross-channel stream forwarding.
    Enumeration nameDescription
    AliRtcChannelRelayStateInitInitialization.
    AliRtcChannelRelayStateConnectingConnecting.
    AliRtcChannelRelayStateRunningForwarding.
    AliRtcChannelRelayStateFailureForwarding failed.
  • AliRtcChannelRelayConfiguration: The configuration for cross-channel stream forwarding.
    ParameterTypeDescription
    destChannelInfosNSDictionary<NSString*,AliRtcAuthInfo*> *_NullableA collection of authentication information for the destination channels.
  • AliRtcVideoObserPosition: The position where video data is output.
    Enumeration NameDescription
    AliRtcPositionPostCaptureCaptured video data. The corresponding output callback is onCaptureVideoSample.
    AliRtcPositionPreRenderRendered video data. The corresponding output callback is onRemoteVideoSample.
    AliRtcPositionPreEncoderPre-encoded video data. The corresponding output callback is onPreEncodeVideoSample.
  • AliRtcVideoFormat: The video data format.
    EnumerationDescription
    AliRtcVideoFormat_UNKNOWUnknown.
    AliRtcVideoFormat_BGRABGRA.
    AliRtcVideoFormat_I420I420.
    AliRtcVideoFormat_NV21NV21.
    AliRtcVideoFormat_NV12NV12.
    AliRtcVideoFormat_RGBARGBA.
    AliRtcVideoFormat_I422I422.
    AliRtcVideoFormat_ARGBARGB.
    AliRtcVideoFormat_ABGRABGR.
    AliRtcVideoFormat_RGB24RGB24.
    AliRtcVideoFormat_BGR24BGR24.
    AliRtcVideoFormat_RGB565RGB565.
  • AliRtcConnectionStatus: The network connection status.
    EnumerationDescription
    AliRtcConnectionStatusInitInitialization is complete.
    AliRtcConnectionStatusDisconnectedThe network connection is disconnected.
    AliRtcConnectionStatusConnectingEstablishing a network connection.
    AliRtcConnectionStatusConnectedThe network is connected.
    AliRtcConnectionStatusReconnectingRe-establishing a network connection.
    AliRtcConnectionStatusFailedThe network connection failed.
  • AliRtcConnectionStatusChangeReason: The reason for a change in the network connection status.
    EnumerationDescription
    AliRtcConnectionChangedDummyReasonUnknown reason.
    AliRtcConnectionChangedMediaPathChangedThe media channel changed.
    AliRtcConnectionChangedSignalingHeartbeatTimeoutHeartbeat timeout.
    AliRtcConnectionChangedSignalingHeartbeatAliveHeartbeat recovered.
    AliRtcConnectionChangedSignalingHttpdnsResolvedDNS resolution succeeded.
    AliRtcConnectionChangedSignalingHttpdnsFailureDNS resolution failed.
    AliRtcConnectionChangedSignalingGslbFailureGSLB request failed.
    AliRtcConnectionChangedSignalingGslbSucccessGSLB request succeeded.
    AliRtcConnectionChangedSignalingJoinChannelFailureFailed to join the channel.
    AliRtcConnectionChangedSignalingJoinChannelSuccessJoined the channel successfully.
    AliRtcConnectionChangedSignalingLeaveRoomLeft the channel.
    AliRtcConnectionChangedSignalingConnectingEstablishing a signaling connection.
  • AliRtcVideoTrack: The video stream type.
    EnumerationDescription
    AliRtcVideoTrackNoNo video stream.
    AliRtcVideoTrackCameraCamera stream.
    AliRtcVideoTrackScreenScreen sharing stream.
    AliRtcVideoTrackBothBoth camera and screen sharing.
  • AliRtcPublishState: The state of a stream ingest.
    EnumerationDescription
    AliRtcStatsPublishIdleInitial state.
    AliRtcStatsNoPublishNot ingesting stream.
    AliRtcStatsPublishingIngesting stream.
    AliRtcStatsPublishedStream ingested.
  • AliRtcSubscribeState: The subscription state.
    EnumerationDescription
    AliRtcStatsSubscribeIdleInitial state.
    AliRtcStatsNoSubscribeNot subscribed.
    AliRtcStatsSubscribingSubscribing.
    AliRtcStatsSubscribedSubscribed.
  • AliRtcUserOfflineReason: The reason why a user goes offline.
    EnumerationDescription
    AliRtcUserOfflineQuitThe user left voluntarily.
    AliRtcUserOfflineDroppedThe user was dropped due to a timeout because no data packets were received for an extended period.
    AliRtcUserOfflineBecomeAudienceTriggered when the user role switches from streamer to viewer.
  • AliRtcVideoStreamType: The camera stream type.
    EnumerationDescription
    AliRtcVideoStreamTypeNoneNo video stream.
    AliRtcVideoStreamTypeHighHigh-volume stream.
    AliRtcVideoStreamTypeLowSmall stream
  • AliRtcAudioTrack: The audio stream type.
    EnumerationDescription
    AliRtcAudioTrackNoNo audio stream.
    AliRtcAudioTrackMicMicrophone stream.
  • AliRtcNetworkQuality: The network quality.
    EnumerationDescription
    Network_ExcellentThe network is excellent, with good fluency and clarity.
    Network_GoodThe network is good. Fluency and clarity are similar to excellent.
    Network_PoorPoor network connectivity can result in some loss of audio and video smoothness and definition, but communication is not affected.
    Network_BadThe network is poor. Video stutters severely, but audio communication is normal.
    Network_VeryBadThe network is very poor. Communication is almost impossible.
    Network_DisconnectedThe network is disconnected.
    Network_UnknowUnknown reason.
  • AliRtcOrientationMode: The screen orientation mode. (iOS only)
    EnumerationDescription
    AliRtcOrientationModePortraitFixed portrait mode.
    AliRtcOrientationModeLandscapeLeftFixed landscape left mode.
    AliRtcOrientationModePortraitUpsideDownFixed upside-down portrait mode.
    AliRtcOrientationModeLandscapeRightFixed landscape right mode.
    AliRtcOrientationModeAutoAdaptive orientation mode.
  • AliRtcAudioSessionOperationRestriction: The SDK's control permissions for the audio session. (iOS only)
    EnumerationDescription
    AliRtcAudioSessionOperationRestrictionNoneNo restrictions. The SDK has full control over the AVAudioSession.
    AliRtcAudioSessionOperationRestrictionSetCategoryThe SDK cannot modify the Category of the AVAudioSession.
    AliRtcAudioSessionOperationRestrictionConfigureSessionThe SDK cannot modify the configuration of the AVAudioSession, including its Category, Mode, and CategoryOptions.
    AliRtcAudioSessionOperationRestrictionDeactivateSessionThe SDK cannot deactivate the AVAudioSession. The AVAudioSession remains active when the user leaves the channel.
  • AliRtcRenderMode: The rendering mode.
    EnumerationDescription
    AliRtcRenderModeAutoAutomatic.
    AliRtcRenderModeStretchStretches to fill the view without maintaining the video aspect ratio.
    AliRtcRenderModeFillScales while maintaining the video aspect ratio, filling with black bars.
    AliRtcRenderModeClipScales while maintaining the video aspect ratio, and clips to fit the view.
  • AliRtcRenderMirrorMode: The mirror mode for rendering.
    EnumerationDescription
    AliRtcRenderMirrorModeOnlyFrontOnly the front camera preview is mirrored. Others are not mirrored.
    AliRtcRenderMirrorModeAllEnabledAll are mirrored.
    AliRtcRenderMirrorModeAllDisableNone are mirrored.
  • AliRtcRotationMode: The rotation angle.
    EnumerationDescription
    AliRtcRotationMode_0No rotation.
    AliRtcRotationMode_90Rotate 90 degrees.
    AliRtcRotationMode_180Rotate 180 degrees.
    AliRtcRotationMode_270Rotate 270 degrees.
  • AliRtcLogLevel: The log level.
    Enumeration nameDescription
    AliRtcLogLevelInfoStandard
    AliRtcLogLevelWarnWarning.
    AliRtcLogLevelErrorError.
    AliRtcLogLevelFatalFatal.
    AliRtcLogLevelNoneNone.
  • AliRtcAudioNumChannel: The number of audio channels.
    EnumerationDescription
    AliRtcMonoAudioMono audio.
    AliRtcStereoAudioStereo audio.
  • AliRtcAudioSampleRate: The audio recording sample rate.
    EnumerationDescription
    AliRtcAudioSampleRate_8000Sample rate of 8000 Hz.
    AliRtcAudioSampleRate_11025Sample rate of 11025 Hz.
    AliRtcAudioSampleRate_16000Sample rate of 16000 Hz.
    AliRtcAudioSampleRate_22050Sample rate of 22050 Hz.
    AliRtcAudioSampleRate_32000Sample rate of 32000 Hz.
    AliRtcAudioSampleRate_44100Sample rate of 44100 Hz.
    AliRtcAudioSampleRate_48000Sample rate of 48000 Hz.
  • AliRtcRecordType: The recording type.
    Enumeration NameDescription
    AliRtcRecordTypeAudioAudio-only recording.
  • AliRtcRecordFormat: The recording format.
    EnumerationDescription
    AliRtcRecordFormatAACAAC file.
    AliRtcRecordFormatWAVWAV file.
  • AliRtcAudioQuality: The quality of recorded audio.
    EnumerationDescription
    AliRtcAudioQualityLowLow.
    AliRtcAudioQualityMidiumIn progress.
    AliRtcAudioQualityHighHigh.
  • AliRtcVideoQuality: The quality of recorded video.
    EnumerationDescription
    AliRtcVideoQualityDefaultDefault. Same as the captured video quality.
  • AliRtcTranportAudioQuality: The audio quality for transport.
    EnumerationDescription
    AliRtcAudioQulityUnknowUnknown quality.
    AliRtcAudioQulityExcellentExcellent quality.
    AliRtcAudioQulityGoodSubjective user experience is similar to excellent, but the bitrate may be slightly lower.
    AliRtcAudioQulityPoorThe user experience is degraded, but communication is unaffected.
    AliRtcAudioQulityBadCommunication is barely possible but not smooth.
    AliRtcAudioQulityVeryBadThe network quality is very poor. Communication is almost impossible.
    AliRtcAudioQulityNetworkDisconnectedThe network connection is disconnected. Communication is impossible.
  • AliRtcAudioProfile: The audio quality mode.
    EnumerationDescription
    AliRtcEngineLowQualityModeLow audio quality mode.
    AliRtcEngineBasicQualityModeStandard audio quality mode.
    AliRtcEngineHighQualityModeHigh audio quality mode.
    AliRtcEngineStereoHighQualityModeStereo high audio quality mode.
    AliRtcEngineSuperHighQualityModeSuper high audio quality mode.
    AliRtcEngineStereoSuperHighQualityModeStereo super high audio quality mode.
  • AliRtcAudioScenario: The audio scenario mode.
    Enumeration nameDescription
    AliRtcSceneDefaultModeDefault scenario. Recommended for general audio and video communication scenarios.
    AliRtcSceneEducationModeEducation scenario. Prioritizes audio continuity and stability.
    AliRtcSceneMediaModeMedia scenario. Preserves human voice and music quality. Recommended for co-streaming in live channels.
    AliRtcSceneMusicModeMusic scenario. High-fidelity music quality. Recommended for scenarios with high music quality requirements, such as musical instrument lessons.
    AliRtcSceneChatroomModeChat room scenario. Suitable for chat scenarios where users frequently join and leave with their microphones on.
  • AliRtcMuteLocalAudioMode: The local audio muting mode.
    EnumerationDescription
    AliRtcMuteAudioModeDefaultDefault mode (mutes all audio, including microphone and external audio input).
    AliRtcMuteAllAudioModeMutes all audio (including microphone and external audio input).
    AliRtcMuteOnlyMicAudioModeMutes only the microphone.
    AliRtcMuteLocalAudioMaxPlaceholder.
  • AliRtcRecordAudioConfig: The audio recording settings.
    ParameterTypeDescription
    sampleRateAliRtcAudioSampleRateThe audio sample rate.
    qualityAliRtcAudioQualityThe audio quality.
    enableRecordExternalRenderPCMboolIndicates whether to record external PCM input rendering data.
  • AliRtcRecordVideoConfig: The video recording settings.
    ParameterTypeDescription
    qualityAliRtcVideoQualityThe video quality.
  • AliRtcBeautyConfig: The basic retouching settings.
    ParameterTypeDescription
    whiteningLevelfloatWhitening level. The value ranges from 0 to 1. A larger value provides a stronger whitening effect.
    smoothnessLevelfloatSkin smoothing level. The value ranges from 0 to 1. A larger value provides a stronger smoothing effect.
  • AliRtcOnByeType: The enumeration of OnBye types.
    EnumerationDescription
    AliRtcOnByeBeKickedOutKicked out.
    AliRtcOnByeChannelTerminatedThe channel has ended. You must leave the channel.
    AliRtcOnByeUserReplacedA user with the same UID joined the channel from another device. The current device is forced offline.
  • AliRtcAudioEffectVoiceChangerMode: The voice changer effect modes.
    EnumerationDescription
    AliRtcSdk_AudioEffect_Voice_Changer_OFFOff.
    AliRtcSdk_AudioEffect_Voice_Changer_OldmanOld man.
    AliRtcSdk_AudioEffect_Voice_Changer_BabyboyBaby boy.
    AliRtcSdk_AudioEffect_Voice_Changer_BabygirlBaby girl.
    AliRtcSdk_AudioEffect_Voice_Changer_RobotRobot.
    AliRtcSdk_AudioEffect_Voice_Changer_DaimoDevil.
    AliRtcSdk_AudioEffect_Voice_Changer_KtvKTV.
    AliRtcSdk_AudioEffect_Voice_Changer_EchoEcho.
    AliRtcSdk_AudioEffect_Voice_Changer_MAXPlaceholder. No meaning.
  • AliRtcAudioEffectReverbMode: The reverb effect modes.
    EnumerationDescription
    AliRtcAudioEffectReverb_OffOff.
    AliRtcAudioEffectReverb_Vocal_IVocal I.
    AliRtcAudioEffectReverb_Vocal_IIVocal II.
    AliRtcAudioEffectReverb_BathroomBathhouse
    AliRtcAudioEffectReverb_Small_Room_BrightBright small room.
    AliRtcAudioEffectReverb_Small_Room_DarkDark small room.
    AliRtcAudioEffectReverb_Medium_RoomMedium room.
    AliRtcAudioEffectReverb_Large_RoomLarge room.
    AliRtcAudioEffectReverb_Church_HallChurch aisle
    AliRtcAudioEffectReverb_CathedralCathedral.
    AliRtcAudioEffectReverb_Mode_MaxPlaceholder. No meaning.
  • AliRtcAudioEffectReverbParamType: The reverb effect parameters.
    EnumerationDescription
    AliRtcAudioEffectReverb_Room_SizeRoom size. The value ranges from 0 to 100.
    AliRtcAudioEffectReverb_Pre_DelayPre-delay in ms. The value ranges from 0 to 200.
    AliRtcAudioEffectReverb_RevetberanceReverberance. The value ranges from 0 to 100.
    AliRtcAudioEffectReverb_Hf_DampingDamping. The value ranges from 0 to 100.
    AliRtcAudioEffectReverb_Tone_LowLow tone. The value ranges from 0 to 100.
    AliRtcAudioEffectReverb_Tone_HighHigh tone. The value ranges from 0 to 100.
    AliRtcAudioEffectReverb_Dry_GainDry gain. The value ranges from -20 to 10.
    AliRtcAudioEffectReverb_Wet_GainWet gain. The value ranges from -20 to 10.
    AliRtcAudioEffectReverb_Type_MaxPlaceholder. No meaning.
  • AliRtcAudioRouteType: The audio route. (iOS only)
    EnumerationDescription
    AliRtcAudioRouteTypeDefaultDefault audio route.
    AliRtcAudioRouteTypeHeadsetHeadset.
    AliRtcAudioRouteTypeEarpieceEarpiece.
    AliRtcAudioRouteTypeHeadsetNoMicHeadset without a microphone.
    AliRtcAudioRouteTypeSpeakerphonePhone speaker.
    AliRtcAudioRouteTypeLoudSpeakerExternal speaker.
    AliRtcAudioRouteTypeBlueToothBluetooth headset.
  • AliVideoCanvas: The rendering canvas.
    ParameterTypeDescription
    viewUIView * _NonnullThe rendering view. Cannot be nil.
    renderModeAliRtcRenderModeThe rendering mode. The default is AliRtcRenderModeAuto.
    mirrorModeAliRtcRenderMirrorModeThe mirror mode. The default is AliRtcRenderMirrorModeOnlyFront.
    backgroundColorintThe background color in RGB Hex format.
    rotationModeAliRtcRotationModeThe video rotation angle. The default is no rotation.
    textureIdintThe texture ID.
    textureWidthintThe texture width.
    textureHeightintHigh-quality texture
  • AliRtcTrascodingLiveStreamErrorCode: Error codes for bypass stream ingest.
    EnumerationDescription
    AliRtcTrascodingLiveStreamErrorPublishOkStream ingest successful.
    AliRtcTrascodingLiveStreamErrorStreamNotFoundError: Stream not found.
    AliRtcTrascodingLiveStreamErrorStreamAlreadyExistError: The destination stream already exists.
    AliRtcTrascodingLiveStreamErrorInvalidParamError: Invalid parameter.
    AliRtcTrascodingLiveStreamErrorInternalErrorError: Internal error.
    AliRtcTrascodingLiveStreamErrorRtmpServerErrorError: RTMP service is abnormal.
    AliRtcTrascodingLiveStreamErrorRtmpStreamUrlErrorError: URL is abnormal.
    AliRtcTrascodingLiveStreamErrorPublishTimeoutError: Task timed out.
    AliRtcTrascodingLiveStreamErrorNotAuthorizedError: Operation not authorized.
  • AliRtcWatermarkConfig: The watermark image settings.
    ParameterTypeDescription
    visibleInPreviewBOOLIndicates whether the watermark is visible in the local preview.
    positionInLandscapeModeCGRectThe watermark coordinates in landscape mode.
    positionInPortraitModeCGRectThe watermark coordinates in portrait mode.
    alphafloatThe transparency.
    normalizedBOOLIndicates whether to normalize.
  • AliRtcCameraCapturerConfiguration: The preferred properties for camera capture.
    ParameterTypeDescription
    preferenceAliRtcCaptureOutputPreferenceThe capture preference.
    cameraDirectionAliRtcCameraDirectionThe camera direction.
  • AliRtcCameraDirection: The camera direction.
    EnumerationDescription
    AliRtcCameraDirectionInvalidUnknown.
    AliRtcCameraDirectionBackRear camera.
    AliRtcCameraDirectionFrontFront camera.
  • AliRtcCaptureOutputPreference: The camera capture preference.
    Enumeration NameDescription
    AliRtcCaptureOutputPreferenceAutoAutomatically adjust capture parameters.
    AliRtcCaptureOutputPreferencePerformancePrioritize device performance. Selects the camera output parameters that are closest to the setVideoProfile settings.
    AliRtcCaptureOutputPreferencePreviewPrioritize video preview quality. Selects higher camera output parameters.
  • AliRtcVideoEncoderFrameRate: The video encoding frame rate.
    EnumerationDescription
    AliRtcVideoEncoderFrameRate_FPS_55 FPS.
    AliRtcVideoEncoderFrameRate_FPS_1010 FPS.
    AliRtcVideoEncoderFrameRate_FPS_1515 FPS.
    AliRtcVideoEncoderFrameRate_FPS_2020 FPS.
    AliRtcVideoEncoderFrameRate_FPS_3030 FPS.
  • AliRtcVideoEncoderBitrate: The video encoding bitrate.
    EnumerationDescription
    AliRtcVideoEncoderStandardBitrateStandard bitrate mode.
  • AliRtcVideoEncoderMirrorMode: The mirror mode for encoded video.
    EnumerationDescription
    AliRtcVideoEncoderMirrorModeDisabledImage for video encoding
    AliRtcVideoEncoderMirrorModeEnabledDo not mirror the encoded video.
  • AliRtcVideoEncoderOrientationMode: The rotation mode for encoded video.
    EnumerationDescription
    AliRtcVideoEncoderOrientationModeAdaptiveAdaptive. Same as the captured video.
    AliRtcVideoEncoderOrientationModeFixedLandscapeFixed landscape.
    AliRtcVideoEncoderOrientationModeFixedPortraitFixed portrait.
  • AliRtcVideoEncoderConfiguration: The video encoding preferences.
    ParameterTypeDescription
    dimensionsCGSizeThe video resolution.
    frameRateNSIntegerThe video encoding frame rate.
    bitrateNSIntegerThe video encoding bitrate.
    mirrorModeAliRtcVideoEncoderMirrorModeThe encoded video mirror mode.
    orientationModeAliRtcVideoEncoderOrientationModeThe encoded video rotation mode.
    rotationModeAliRtcRotationModeThe video rotation angle.
  • AliRtcScreenShareEncoderConfiguration: The screen sharing encoding preferences.
    ParameterTypeDescription
    dimensionsCGSizeThe video resolution.
    frameRateNSIntegerThe video encoding frame rate.
    bitrateNSIntegerThe video encoding bitrate.
    rotationModeAliRtcRotationModeThe screen rotation angle.
  • AliRtcAuthInfo: The authentication information.
    ParameterTypeDescription
    channelIdNSString * _NonnullThe channel ID.
    userIdNSString * _NonnullThe user ID.
    appIdNSString * _NonnullThe application ID.
    nonceNSString * _NonnullA random string.
    tokenNSString * _NonnullThe token.
    sessionNSString * _NullableThe session.
    roleNSString * _NullableThe role type. The default value is empty, which means this feature is not used. Valid values:
    • pub: Streamer role.
    • sub: Viewer role.
    • relay: Cross-channel stream forwarding.
    To perform role-based authentication, see How to perform role-based authentication.
    gslbNSArray <NSString *> *The GSLB address.
    agentNSArray <NSString *> *Set the address of the Agent server.
    timestamplong longThe timestamp.
  • AliRtcDeviceVolumeType: The device volume type. (iOS only)
    EnumerationDescription
    AliRtcDeviceVolumeTypeAutoThe SDK automatically sets the volume type (default). The SDK automatically selects the appropriate volume type. We do not recommend setting this yourself unless you have special requirements.
    AliRtcDeviceVolumeTypeMediaSet as media volume. Suitable for media playback scenarios. The volume can be adjusted to zero.
    AliRtcDeviceVolumeTypeVOIPSet as call volume. Suitable for call scenarios. The volume cannot be adjusted to zero.
  • AliRtcVideoSource: The raw video data source type.
    EnumerationDescription
    AliRtcVideosourceCameraTypeVideo stream.
    AliRtcVideosourceScreenShareTypeScreen sharing stream.
    AliRtcVideosourceTypeMaxPlaceholder.
  • AliRtcAudioSource: The raw audio data source type.
    Enumeration nameDescription
    AliRtcAudiosourcePubPublished audio data.
    AliRtcAudiosourceSubPulls audio stream data.
    AliRtcAudiosourceRawDataCaptured raw audio data.
  • AliRtcBufferType: The video data type.
    EnumerationDescription
    AliRtcBufferType_Raw_DataRaw YUV data.
    AliRtcBufferType_CVPixelBufferCVPixelBuffer data.
  • AliRtcErrorCode: The error code.
    EnumerationDescription
    AliRtcErrNoneNone.
    AliRtcErrJoinBadAppIdThe App ID does not exist.
    AliRtcErrJoinInvalidAppIdThe App ID is invalid.
    AliRtcErrJoinBadChannelThe channel does not exist.
    AliRtcErrJoinInvalidChannelThe channel is invalid.
    AliRtcErrJoinBadTokenThe token does not exist.
    AliRtcErrJoinTimeoutTimed out when joining the channel.
    AliRtcErrJoinBadParamIncorrect parameter.
    AliRtcErrMicOpenFailCapture device initialization failed.
    AliRtcErrSpeakerOpenFailPlayback device initialization failed.
    AliRtcErrMicInterruptAn exception occurred during capture.
    AliRtcErrSpeakerInterruptAn exception occurred during playback.
    AliRtcErrMicAuthFailMicrophone device is not authorized.
    AliRtcErrMicNotAvailableNo available audio capture device.
    AliRtcErrSpeakerNotAvailableNo available audio playback device.
    AliRtcErrCameraOpenFailCapture device initialization failed.
    AliRtcErrCameraInterruptAn exception occurred during capture.
    AliRtcErrDisplayOpenFailRendering device initialization failed.
    AliRtcErrDisplayInterruptAn exception occurred during rendering.
    AliRtcErrIceConnectionConnectFailFailed to establish a media channel.
    AliRtcErrIceConnectionReconnectFailFailed to reconnect to the media channel.
    AliRtcErrIceConnectionHeartbeatTimeoutSignaling heartbeat timed out.
    AliRtcErrPublishInvaildInvalid stream ingest.
    AliRtcErrPublishNotJoinChannelFailed to ingest stream because the user is not in the channel.
    AliRtcErrPublishAudioStreamFailedFailed to push the audio stream.
    AliRtcErrPublishVideoStreamFailedFailed to push the video stream.
    AliRtcErrPublishDualStreamFailedFailed to push the dual stream.
    AliRtcErrPublishScreenShareFailedFailed to push the screen sharing stream.
    AliRtcErrPublishScreenShareConfigErrorIncorrect screen sharing configuration.
    AliRtcErrSubscribeInvaildInvalid subscription.
    AliRtcErrSubscribeNotJoinChannelSubscription error because the user is not in the channel.
    AliRtcErrSubscribeAudioStreamFailedFailed to subscribe to the audio stream.
    AliRtcErrSubscribeVideoStreamFailedFailed to subscribe to the video stream.
    AliRtcErrSubscribeDualStreamFailedFailed to subscribe to the dual stream.
    AliRtcErrSubscribeScreenShareFailedFailed to subscribe to the screen sharing stream.
    AliRtcErrCdnLiveCommunicationFailedLow-latency interactive streaming signaling failed.
    AliRtcErrCdnLiveMeidaSettingFailedIncorrect media settings for low-latency interactive streaming.
    AliRtcErrCdnLiveNoneBroadcasterNo streamer is ingesting a stream in the current low-latency interactive streaming channel.
    AliRtcErrCdnLiveNeedRestartLow-latency interactive streaming error. The application layer needs to create a new SDK instance.
    AliRtcErrCdnLiveNeedRestartAgainLaterLow-latency interactive streaming error. The application layer needs to wait for a custom interval and then create a new SDK instance.
    AliRtcErrCdnLiveServiceUnavailableThe low-latency interactive streaming service is unavailable or has been degraded.
    AliRtcErrCdnLiveMediaConnectionInterruptionNetwork interruption error in low-latency interactive streaming.
    AliRtcErrSdkInvalidStateIncorrect SDK state.
    AliRtcErrSessionRemovedThe session has been removed.
    AliRtcErrInvalidArgumentsParameter mismatch.
    AliRtcErrAudioBufferFullThe buffer queue is full. This is used for external raw data input.
    AliRtcErrVideoBufferFullThe buffer queue is full. This is used for external raw data input.
    AliRtcErrUpdateRoleChannelError setting the role in interactive mode.
    AliRtcErrInnerOther errors.
  • AliRtcExternalDeviceType: The external device types. (Mac only)
    EnumerationDescription
    AliRtcExternalTypeUnknownUnknown type.
    AliRtcExternalTypeAudioCaptureAudio capture device.
    AliRtcExternalTypeAudioPlayoutAudio playback device.
    AliRtcExternalTypeVideoCaptureVideo capture device.
  • AliRtcExternalDeviceState: The external device states. (Mac only)
    EnumerationDescription
    AliRtcExternalDeviceAddAn external device is added.
    AliRtcExternalDeviceRemoveAn external device is removed.
  • AliRtcRecordVideoCanvasConfig: The canvas size for video recording settings. (Mac only)
    ParameterTypeDescription
    canvasWidthintThe canvas width.
    canvasHeightintThe canvas height.
  • AliRtcRecordVideoLayout: The layout information for recorded video. (Mac only)
    ParameterTypeDescription
    modeAliRtcRecordVideoLayoutModeThe layout mode.
    backColorAliRtcRecordVideoBgColorThe background color.
    shapesNSMutableArray<AliRtcRecordVideoRegion *> * _NullableThe position information for each user's video.
  • AliRtcRecordVideoLayoutMode: The layout mode for recorded video. (Mac only)
    Enumeration NameDescription
    AliRtcRecordVideoLayoutMode_GRIDGrid layout.
    AliRtcRecordVideoLayoutMode_SPEAKERSpeaker layout.
    AliRtcRecordVideoLayoutMode_UNIQUESingle-stream layout.
    AliRtcRecordVideoLayoutMode_CUSTOMCustom layout.
  • AliRtcRecordVideoBgColor: The background color for recorded video. (Mac only)
    ParameterTypeDescription
    ruint8_tThe value of red in the color mix.
    guint8_tThe value of green in the color mix.
    buint8_tThe value of blue in the color mix.
  • AliRtcRecordVideoRegion: The user video configuration for the recording layout. (Mac only)
    ParameterTypeDescription
    userIdNSString * _NonnullThe user ID.
    sourceTypeAliRtcVideoSourceRaw video data source type.
    areaAliRtcRecordVideoRectangleThe position on the user's screen.
  • AliRtcRecordVideoRectangle: The user video position information. (Mac only)
    ParameterTypeDescription
    leftAliRtcRecordVideoRationalLeft margin.
    topAliRtcRecordVideoRationalTop margin.
    widthAliRtcRecordVideoRationalWidth.
    heightAliRtcRecordVideoRationalHeight.
  • AliRtcRecordVideoRational: The coordinates for stream mixing recording. (Mac only)
    ParameterTypeDescription
    numeratoruint32_tNumerator (integer).
    denominatoruint32_tDenominator (integer).
  • AliRtcRecordTemplate: The recording template. (Mac only)
    ParameterTypeDescription
    recordTypeAliRtcRecordTypeRecord type.
    recordFormatAliRtcRecordFormatRecord format.
    sampleRateAliRtcAudioSampleRateAudio recording sample rate.
    audioQualityAliRtcAudioQualityAudio recording quality.
    enableRecordExternalCapturePCMboolIndicates whether to mix and record external audio input.
    enableRecordExternalRenderPCMboolIndicates whether to mix and record external audio after rendering.
    canvasAliRtcRecordVideoCanvasConfigCanvas size for recorded video.
    fpsintFrame rate.
    bitrateintBitrate.
    isFragmentboolIndicates whether to record segmented MP4 files. The default is true.
  • AliRtcDeviceInfo: The device information. (Mac only)
    ParameterTypeDescription
    deviceNameNSString * _NullableDevice name.
    deviceIDNSString * _NullableDevice ID.
  • AliRtcScreenShareConfig: The screen sharing configuration. (Mac only)
    ParameterTypeDescription
    isShareByRegionboolIndicates whether it is a regional share.
    shareRegionAliRtcScreenShareRegion * _NonnullLayout information for regional sharing.
  • AliRtcScreenShareRegion: The screen sharing region. (Mac only)
    ParameterTypeDescription
    originXfloatThe x-coordinate.
    originYfloatThe y-coordinate.
    widthfloatThe width.
    heightfloatThe height.
  • AliRtcScreenSourceInfo: The screen sharing source information. (Mac only)
    ParameterTypeDescription
    sourceIdNSString * _NonnullThe sharing source ID.
    sourceNameNSString * _NonnullThe sharing source name.
  • AliRtcScreenShareInfo: The screen sharing configuration information. (Mac only)
    ParameterTypeDescription
    sourceTypeAliRtcScreenShareTypeThe sharing type.
    sourceIdNSString * _NonnullThe sharing source ID.
    configAliRtcScreenShareConfig * _NonnullThe screen sharing configuration.
  • AliRtcScreenShareType: The screen sharing type. (Mac only)
    EnumerationDescription
    AliRtcScreenShareDesktopDesktop sharing.
    AliRtcScreenShareWindowWindow sharing.
  • AliRtcVideoObserAlignment: The width alignment for video output.
    EnumerationDescription
    AliRtcAlignmentDefaultKeep the original video width (default).
    AliRtcAlignmentEvenWidth is even-aligned.
    AliRtcAlignment4Width is a multiple of 4.
    AliRtcAlignment8Width is a multiple of 8.
    AliRtcAlignment16Width is a multiple of 16.
  • AliRtcShowDebugViewType: The dashboard display type.
    EnumerationDescription
    AliRtcShowTypeNoneDo not display.
    AliRtcShowTypeAudioAudio.
    AliRtcShowTypeVideoVideo.
    AliRtcShowTypeNetworkNetwork.
    AliRtcShowTypeAllAll.
  • AliRtcTrascodingLiveTaskStatus: The LiveStream status for bypass stream ingest.
    EnumerationDescription
    AliRtcTrascodingLiveTaskStatusStart Task started.
    AliRtcTrascodingLiveTaskStatusUpdate Task updated.
    AliRtcTrascodingLiveTaskStatusStop Task stopped.
  • AliRtcLiveTranscodingDisplayType: The image display type for bypass live streaming.
    EnumerationDescription
    NOT_DISPLAYDo not display.
    ALWAYSAlways display.
    WHEN_NO_VIDEODisplay when there is no video.
  • AliRtcLiveTranscodingFontType: The text type for bypass live streaming.
    EnumerationDescription
    NOTO_SERIF_CJKSC_REGULARNoto Serif CJK SC Regular.
    ALIBABA_PUHUITI_REGULARAlibaba PuHuiTi Regular.
    ALIBABA_PUHUITI_BOLDAlibaba PuHuiTi Bold.
    ALIBABA_PUHUITI_HeavyAlibaba PuHuiTi Heavy.
    ALIBABA_PUHUITI_LIGHTAlibaba PuHuiTi Light.
    ALIBABA_PUHUITI_MEDIUMAlibaba PuHuiTi Medium.
  • AliRtcLiveTranscodingSegmentType: The input type for bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscodingNoBodyNo portrait segmentation.
    AliRtcLiveTranscodingBodyPortrait segmentation.
  • AliRtcLiveTranscodingSourceType: The input type for bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscodingCameraCamera.
    AliRtcLiveTranscodingShareScreenScreen sharing.
  • AliRtcVideoState: A change in the video stream state.
    EnumerationDescription
    AliRtcVideoVideoCloseClose the video stream.
    AliRtcVideoVideoOpenResume the video stream.
  • AliRtcVideoReason: The reason for a change in the video stream state.
    EnumerationDescription
    AliRTCVideoChangedByClientClient.
    AliRTCVideoChangedByServerServer.
  • AliRtcLiveTranscodingCropMode: The clipping mode for bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscodingCropCrop while maintaining the aspect ratio.
    AliRtcLiveTranscodingFillFill with black bars while maintaining the aspect ratio (default).
  • AliRtcLiveTranscodingMediaProcessMode: The media processing mode for bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscodingNormalNormal mode.
    AliRtcLiveTranscodingVirtualBackgroundVirtual background mode.
  • AliRtcLiveTranscodingStreamType: The stream type for bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscodingOriginForward the original stream.
    AliRtcLiveTranscodingAudioForward only the audio stream.
    AliRtcLiveTranscodingVideoForward only the video stream.
  • AliRtcLiveTranscodingMixMode: The mode for bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscodingSINGLESingle-stream forwarding. No stream mixing or transcoding. Only the original single stream is forwarded. No need to configure stream mixing and transcoding parameters.
    AliRtcLiveTranscodingMIXStream mixing and transcoding (default). Supports stream mixing and transcoding output.
  • AliRtcLiveTranscodingState: The state of bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscodingState_IDLEStream ingest is idle.
    AliRtcLiveTranscodingState_CONNNECTConnecting to the stream ingest server.
    AliRtcLiveTranscodingState_RUNNINGStream ingest is in progress.
    AliRtcLiveTranscodingState_RECOVERINGRecovering stream ingest.
    AliRtcLiveTranscodingState_FAILUREStream ingest failed.
    AliRtcLiveTranscodingState_ENDStream ingest ended.
  • AliRtcLiveTranscodingText: The text information for bypass live streaming.
    ParameterTypeDescription
    textNSStringText information.
    xintThe x-coordinate (pixel).
    yintThe y-coordinate (pixel).
    fontTypeAliRtcLiveTranscodingFontTypeFont for bypass live streaming.
    fontSizeintFont size.
    zOrderintThe layer order. Layer 0 is the bottom layer. Layer 1 is stacked on top of layer 0, and so on.
    fontColorintFont color.
  • AliRtcLiveTranscodingImage: The image information for bypass live streaming.
    ParameterTypeDescription
    urlNSStringImage URL.
    alphafloatTransparency. 0.0 means transparent, 1.0 means fully opaque.
    displayAliRtcLiveTranscodingDisplayTypeImage display.
    xintThe x-coordinate (pixel).
    yintThe y-coordinate (pixel).
    widthintImage width.
    heightintImage height.
    zOrderintThe layer order. Layer 0 is the bottom layer. Layer 1 is stacked on top of layer 0, and so on.
  • AliRtcLiveTranscodingPane: The custom user pane information for bypass live streaming.
    ParameterTypeDescription
    xintThe x-coordinate (pixel).
    yintThe y-coordinate (pixel).
    widthintPane width.
    heightintPane height.
    zOrderintThe layer order. Layer 0 is the bottom layer. Layer 1 is stacked on top of layer 0, and so on.
    userIdNSString *User ID.
    sourceTypeAliRtcLiveTranscodingSourceTypeStream type.
    segmentTypeAliRtcLiveTranscodingSegmentTypeInput type for bypass live streaming.
    imagesNSArray<AliRtcLiveTranscodingImage *> *Image information for bypass live streaming.
    textsNSArray<AliRtcLiveTranscodingText *> *Text information for bypass live streaming.
  • AliRtcLiveTranscodingParam: The configuration for bypass live streaming.
    ParameterTypeDescription
    mixModeAliRtcLiveTranscodingMixModeMode for bypass live streaming.
    singleParamAliRtcLiveTranscodingSingleParam *Single-stream parameters for bypass live streaming.
    mixParamAliRtcLiveTranscodingMixParamStream mixing parameters for bypass live streaming.
  • AliRtcLiveTranscodingMixParam: The stream mixing parameters for bypass mode.
    ParameterTypeDescription
    taskProfileAliRtcLiveTranscodingTaskProfileBilling specifications for bypass live streaming.
    encodeParamAliRtcLiveTranscodingEncodeParam *Encoding parameters for bypass live streaming.
    usersNSArray<AliRtcLiveTranscodingPane *> *List of users for bypass live streaming.
    backgroundColorintBackground color.
    backgroundsNSArray<AliRtcLiveTranscodingImage *> *List of background images.
    watermarksNSArray<AliRtcLiveTranscodingImage *> *List of watermark images.
    clockWidgetsNSArray<AliRtcLiveTranscodingClockWidget *> *List of clock widgets.
    cropModeAliRtcLiveTranscodingCropModeClipping mode for bypass live streaming.
    mediaProcessModeAliRtcLiveTranscodingMediaProcessModeMedia processing mode for bypass live streaming.
  • AliRtcLiveTranscodingSingleParam: The single-stream parameters for bypass mode.
    ParameterTypeDescription
    userIdNSString *User ID.
    streamTypeAliRtcLiveTranscodingStreamTypeStream type for bypass live streaming.
    sourceTypeAliRtcLiveTranscodingSourceTypeVideo stream type for bypass live streaming.
  • AliRtcLiveTranscodingTaskProfile: The billing specifications for bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscoding_Profile_1IN_1080P1IN_1080P.
    AliRtcLiveTranscoding_Profile_1IN_720P1IN_720P.
    AliRtcLiveTranscoding_Profile_1IN_360P1IN_360P.
    AliRtcLiveTranscoding_Profile_2IN_1080P2IN_1080P.
    AliRtcLiveTranscoding_Profile_2IN_720P2IN_720P.
    AliRtcLiveTranscoding_Profile_2IN_360P2IN_360P.
    AliRtcLiveTranscoding_Profile_4IN_1080P4IN_1080P.
    AliRtcLiveTranscoding_Profile_4IN_720P4IN_720P.
    AliRtcLiveTranscoding_Profile_4IN_360P4IN_360P.
    AliRtcLiveTranscoding_Profile_9IN_1080P9IN_1080P.
    AliRtcLiveTranscoding_Profile_9IN_720P9IN_720P.
    AliRtcLiveTranscoding_Profile_9IN_360P9IN_360P.
    AliRtcLiveTranscoding_Profile_12IN_1080P12IN_1080P.
    AliRtcLiveTranscoding_Profile_12IN_720P12IN_720P.
    AliRtcLiveTranscoding_Profile_12IN_360P12IN_360P.
    AliRtcLiveTranscoding_Profile_16IN_1080P16IN_1080P.
    AliRtcLiveTranscoding_Profile_16IN_720P16IN_720P.
    AliRtcLiveTranscoding_Profile_16IN_360P16IN_360P.
    AliRtcLiveTranscoding_Profile_MixedAudio-only.
  • AliRtcLiveTranscodingEncodeParam: The encoding parameters for bypass live streaming.
    ParameterTypeDescription
    videoWidthintWidth.
    videoHeightintHeight.
    videoFramerateintFrame rate.
    videoBitrateintBitrate.
    videoGopintGOP.
    audioSamplerateAliRtcLiveTranscodingAudioSampleRateAudio sample rate for bypass live streaming.
    audioBitrateintAudio bitrate.
    audioChannelsintNumber of audio channels.
  • AliRtcLiveTranscodingAudioSampleRate: The audio sample rate for bypass live streaming.
    EnumerationDescription
    AliRtcLiveTranscoding_HZ_48000Sample rate of 48000 Hz.
    AliRtcLiveTranscoding_HZ_44100Sample rate of 44100 Hz.
    AliRtcLiveTranscoding_HZ_32000Sample rate of 32000 Hz.
    AliRtcLiveTranscoding_HZ_16000Sample rate of 16000 Hz.
    AliRtcLiveTranscoding_HZ_8000Sample rate of 8000 Hz.
  • AliRtcLiveTranscodingClockWidget: The clock widget for bypass live streaming.
    ParameterTypeDescription
    xintThe x-coordinate (pixel).
    yintThe y-coordinate (pixel).
    fontSizeintFont size for bypass live streaming.
    zOrderintThe layer order. Layer 0 is the bottom layer. Layer 1 is stacked on top of layer 0, and so on.
    fontColorintFont color for bypass live streaming.
    fontTypeAliRtcLiveTranscodingFontTypeFont for bypass live streaming.
  • AliRtcBokehScaleModel: The scaling mode for background replacement. (Mac only)
    EnumerationDescription
    AliRtcBokehScaleModelCropProportional clipping.
    AliRtcBokehScaleModelFillFill with black bars.
  • AliRtcAudioPlayingStateCode: The playback state for music accompaniment. (Mac only)
    EnumerationDescription
    AliRtcAudioPlayingStartedPlayback started.
    AliRtcAudioPlayingStoppedPlayback stopped.
    AliRtcAudioPlayingPausedPlayback paused.
    AliRtcAudioPlayingResumedPlayback resumed.
    AliRtcAudioPlayingEndedPlayback finished.
    AliRtcAudioPlayingBufferingBuffering.
    AliRtcAudioPlayingBufferingEndBuffering finished.
    AliRtcAudioPlayingFailedPlayback failed.
  • AliRtcAudioPlayingErrorCode: The error codes for music accompaniment playback. (Mac only)
    EnumerationDescription
    AliRtcAudioPlayingNoErrorNo error.
    AliRtcAudioPlayingOpenFailedError opening file.
    AliRtcAudioPlayingDecodeFailedError decoding file.