This topic describes the data types for the iOS SDK and Mac SDK.
Directory
| Data type | Description | Minimum supported version |
| AliRtcAudioPlayingErrorCode | Error codes for music accompaniment playback. (iOS only) | 2.1 |
| AliRtcAudioPlayingStateCode | Playback states for music accompaniment. (iOS only) | 2.1 |
| AliRtcUserVolumeInfo | User volume information. | 1.17 |
| AliRtcAudioDataSample | Audio sample. | 2.1 |
| AliRtcVideoDataSample | Video sample. | 2.1 |
| AliRtcChannelProfile | Channel profile. | 1.17 |
| AliRtcClientRole | User role. | 1.17 |
| AliRtcStats | Session statistics. | 1.17 |
| AliRtcLocalVideoStats | Local video statistics. | 1.17 |
| AliRtcRemoteVideoStats | Remote video statistics. | 1.17 |
| AliRtcLocalAudioStats | Local audio statistics. | 1.7 |
| AliRtcRemoteAudioStats | Remote audio statistics. | 1.17 |
| AliRtcFeedbackType | SDK feedback types. | 1.17 |
| AliRtcChannelRelayEvent | Cross-channel stream forwarding events. | 2.1 |
| AliRtcChannelRelayState | Cross-channel stream forwarding states. | 2.1 |
| AliRtcChannelRelayConfiguration | Cross-channel stream forwarding configurations. | 2.1 |
| AliRtcVideoObserPosition | Video data output position. | 2.1 |
| AliRtcVideoFormat | The data type of the video. |
|
| AliRtcExternalDeviceType | External device types. (Mac only) | 2.1 |
| AliRtcExternalDeviceState | External device states. (Mac only) | 2.1 |
| AliRtcConnectionStatus | Network connection status. | 2.1 |
| AliRtcConnectionStatusChangeReason | Reasons for network connection status changes. | 2.1 |
| AliRtcVideoTrack | Video stream type. | 1.1 |
| AliRtcPublishState | Stream ingest state. | 2.1 |
| AliRtcSubscribeState | Subscription state. | 2.1 |
| AliRtcUserOfflineReason | Reasons for user offline. | 2.1 |
| AliRtcVideoStreamType | Camera stream type. | 2.1 |
| AliRtcAudioTrack | Audio stream type. | 1.1 |
| AliRtcNetworkQuality | Network quality. | 1.1 |
| AliRtcOrientationMode | Screen orientation modes. (iOS only) | 2.1 |
| AliRtcAudioSessionOperationRestriction | SDK control permissions for Audio Session. (iOS only) | 1.15 |
| AliRtcRenderMode | Rendering mode. | 1.17 |
| AliRtcRenderMirrorMode | Mirror mode. | 1.17 |
| AliRtcRotationMode | Rotation angle. | 2.1 |
| AliRtcLogLevel | Log level. | 1.17 |
| AliRtcAudioNumChannel | The number of audio channels. | 1.15 |
| AliRtcAudioSampleRate | Audio recording sample rate. | 2.1 |
| AliRtcRecordType | Record type. | 2.1 |
| AliRtcRecordFormat | Record format. | 2.1 |
| AliRtcAudioQuality | Audio quality of the recorded audio file. | 2.1 |
| AliRtcVideoQuality | Video quality of the recorded video file. | 1.17 |
| AliRtcTranportAudioQuality | Audio quality. | 2.1 |
| AliRtcAudioProfile | Audio quality mode. | 2.1 |
| AliRtcAudioScenario | Audio scenario mode parameters. | 2.1 |
| AliRtcMuteLocalAudioMode | Local mute mode. | 2.1 |
| AliRtcRecordAudioConfig | Audio recording settings. | 1.17 |
| AliRtcRecordVideoConfig | Video recording settings. | 1.17 |
| AliRtcRecordVideoCanvasConfig | Canvas size for video recording settings. (Mac only) | 2.1 |
| AliRtcRecordVideoLayout | Layout information for recorded video. (Mac only) | 2.1 |
| AliRtcRecordVideoLayoutMode | Layout mode for recorded video. (Mac only) | 2.1 |
| AliRtcRecordVideoBgColor | Background color for recorded video. (Mac only) | 2.1 |
| AliRtcRecordVideoRegion | User video configuration for recording layout. (Mac only) | 2.1 |
| AliRtcRecordVideoRectangle | The user's screen position (Mac only). | 2.1 |
| AliRtcRecordVideoRational | Coordinates for stream mixing recording. (Mac only) | 2.1 |
| AliRtcRecordTemplate | Recording template. (Mac only) | 2.1 |
| AliRtcDeviceInfo | Device information. (Mac only) | 2.1 |
| AliRtcBeautyConfig | Basic retouching settings. | 1.17 |
| AliRtcOnByeType | Enumeration of OnBye types. | 2.1 |
| AliRtcAudioEffectVoiceChangerMode | Voice changer effect modes. | 2.1 |
| AliRtcAudioEffectReverbMode | Reverb effect modes. | 2.1 |
| AliRtcAudioEffectReverbParamType | Reverb effect parameters. | 2.1 |
| AliRtcAudioRouteType | Audio route. (iOS only) | 2.1 |
| AliVideoCanvas | Rendering canvas. | 1.17 |
| AliRtcTrascodingLiveStreamErrorCode | Bypass stream ingest error codes. | 2.1 |
| AliRtcWatermarkConfig | Watermark image settings. | 2.1 |
| AliRtcCameraCapturerConfiguration | Camera capture preference properties. | 2.1 |
| AliRtcCameraDirection | Camera direction. | 2.1 |
| AliRtcCaptureOutputPreference | Camera capture preference. | 2.1 |
| AliRtcVideoEncoderFrameRate | Video encoding frame rate. | 2.1 |
| AliRtcVideoEncoderBitrate | Video encoding bitrate. | 2.1 |
| AliRtcVideoEncoderMirrorMode | Encoded video mirror mode. | 2.1 |
| AliRtcVideoEncoderOrientationMode | Encoded video rotation mode. | 2.1 |
| AliRtcVideoEncoderConfiguration | Video encoding preference. | 2.1 |
| AliRtcScreenShareEncoderConfiguration | Screen sharing encoding preference. | 2.1 |
| AliRtcScreenShareConfig | Screen sharing configuration. (Mac only) | 2.1 |
| AliRtcScreenShareRegion | Screen sharing region. (Mac only) | 2.1 |
| AliRtcScreenSourceInfo | Screen sharing source information. (Mac only) | 2.1 |
| AliRtcScreenShareInfo | Screen sharing configuration information. (Mac only) | 2.1 |
| AliRtcScreenShareType | Screen sharing type. (Mac only) | 2.1 |
| AliRtcAuthInfo | Authentication information. | 1.17 |
| AliRtcDeviceVolumeType | Device volume type. (iOS only) | 1.17.39 |
| AliRtcVideoSource | Raw video data source type. | 1.16.2 |
| AliRtcAudioSource | Raw audio data source type. | 1.15 |
| AliRtcBufferType | Video data type. |
|
| AliRtcErrorCode | Error code. | 1.9 |
| AliRtcVideoObserAlignment | Video output width alignment. | 2.4 |
| AliRtcShowDebugViewType | Dashboard display type. | 2.4 |
| AliRtcTrascodingLiveTaskStatus | LiveStream status for bypass stream ingest. | 2.4 |
| AliRtcLiveTranscodingDisplayType | Image display type for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingFontType | Text type for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingSegmentType | Input type for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingSourceType | Input type for bypass live streaming. | 2.4 |
| AliRtcVideoState | Video stream state change. | 2.4 |
| AliRtcVideoReason | Reason for the video stream state change. | 2.4 |
| AliRtcLiveTranscodingCropMode | Clipping mode for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingMediaProcessMode | Media processing mode for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingStreamType | Stream type for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingMixMode | Mode for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingState | State of bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingText | Text information for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingImage | Image information for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingPane | Custom user pane information for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingParam | Configuration for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingMixParam | Stream mixing parameters for bypass mode. | 2.4 |
| AliRtcLiveTranscodingSingleParam | Single-stream parameters for bypass mode. | 2.4 |
| AliRtcLiveTranscodingTaskProfile | Billing specifications for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingEncodeParam | Encoding parameters for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingAudioSampleRate | Audio sample rate for bypass live streaming. | 2.4 |
| AliRtcLiveTranscodingClockWidget | Clock widget for bypass live streaming. | 2.4 |
| AliRtcBokehScaleModel | Scaling mode for background replacement. (Mac only) | 2.4 |
| AliRtcAudioPlayingStateCode | Playback state for music accompaniment. (Mac only) | 2.4 |
| AliRtcAudioPlayingErrorCode | Error codes for music accompaniment playback. (Mac only) | 2.4 |
Details
- AliRtcAudioPlayingErrorCode: The error codes for music accompaniment playback. (iOS only)
Enumeration Name Description AliRtcAudioPlayingNoError Normal state. AliRtcAudioPlayingOpenFailed Failed to open the file. AliRtcAudioPlayingDecodeFailed Encoding failed. - AliRtcAudioPlayingStateCode: The playback states for music accompaniment. (iOS only)
Enumeration Description AliRtcAudioPlayingStarted Playing. AliRtcAudioPlayingStopped Playback stopped. AliRtcAudioPlayingPaused Playback paused. AliRtcAudioPlayingResumed Playback resumed. AliRtcAudioPlayingEnded Playback finished. AliRtcAudioPlayingBuffering Buffering. AliRtcAudioPlayingBufferingEnd Buffering finished. AliRtcAudioPlayingFailed Playback failed. - AliRtcUserVolumeInfo: The volume information of a user.
Parameter Type Description uid NSString * _Nonnull The UID of the current user. Valid values: - 0 indicates local.
- 1: The remote mixed stream.
- Other values: A remote user.
volume int The volume in the current callback. speech_state BOOL Indicates whether the user is speaking. `true` means the user is speaking. `false` means the user is not speaking. - AliRtcAudioDataSample: An audio sample.
Parameter Type Description dataPtr long The UID of the current user. Valid values: - 0: Local.
- 1: The remote mixed stream.
- Other values: A remote user.
numOfSamples int The number of sample points for each channel. bytesPerSample int The number of bytes per sample point. For PCM, this is typically 16 bits, which is two bytes. numOfChannels int The number of channels. Valid values: - 1: Mono.
- 2: Stereo.
samplesPerSec int The number of sample points per second for each channel. This is the sample rate. - AliRtcVideoDataSample: A video sample.
Parameter Type Description format AliRtcVideoFormat Video data format. type AliRtcBufferType Video data type. pixelBuffer CVPixelBufferRef _Nullable The pixel buffer data. dataPtr long Pointer to the YUV data. dataYPtr long Pointer to the Y component. dataUPtr long Pointer to the U component. dataVPtr long Pointer to the V component. dataLength long The data size. strideY int The stride of the Y buffer in the YUV data. strideU int The stride of the U buffer in the YUV data. strideV int The stride of the V buffer in the YUV data. height int The height of the video frame. width int The width of the video frame. rotation int The rotation angle of the video frame. timeStamp long long Timestamp. - AliRtcChannelProfile: The channel profile.
Enumeration Description AliRtcCommunication Communication mode. AliRtcInteractivelive Interactive mode. AliRtcInteractiveWithLowLatencyLive Low-latency interactive streaming mode. - AliRtcClientRole: The role of a user.
Enumeration Description AliRtcClientRoleInteractive Streamer role. AliRtcClientRolelive Viewer role. - AliRtcStats: The statistics of a session.
Parameter Type Description sent_kbitrate long long The sending bitrate. rcvd_kbitrate long long The receiving bitrate. sent_bytes long long The number of bytes sent. rcvd_bytes long long The number of bytes received. systemCpuUsage float The system CPU usage. cpu_usage float The CPU usage of the RTC process. video_rcvd_kbitrate long The video receiving bitrate. video_sent_kbitrate long The video sending bitrate. call_duration long The call duration in seconds. sent_loss_rate long The packet loss rate from the client to the server. sent_loss_pkts long long The number of lost packets from the client to the server. sent_expected_pkts long long The total number of packets from the client to the server. rcvd_loss_rate long long The downlink packet loss rate from the client to the server. rcvd_loss_pkts long long The number of lost downlink packets from the client to the server. rcvd_expected_pkts long long The total number of downlink packets from the client to the server. lastmile_delay int The delay duration in milliseconds. - AliRtcLocalVideoStats: The statistics of a local video stream.
Parameter Type Description track AliRtcVideoTrack The stream type. sent_bitrate unsigned int The publishing bitrate. sent_fps unsigned int The publishing frame rate. encode_fps unsigned int The encoding frame rate. - AliRtcRemoteVideoStats: The statistics of a remote video stream.
Parameter Type Description userId NSString * _Nonnull The user ID. track AliRtcVideoTrack The video stream type. width unsigned int The width. height unsigned int High decode_fps unsigned int The encoder output frame rate. render_fps unsigned int The renderer output frame rate. frozen_times unsigned int The number of stutters. - AliRtcLocalAudioStats: The statistics of a local audio stream.
Parameter Type Description track AliRtcAudioTrack The audio stream type. sent_bitrate int The sending bitrate in Kbps. sent_samplerate int The sending sample rate. num_channel int The number of sound channels. - AliRtcRemoteAudioStats: The statistics of a remote audio stream.
Parameter Type Description userId NSString * _Nonnull The UID of the remote user. track AliRtcAudioTrack The audio stream type. quality unsigned int The audio quality. For more information, see AliRtcTranportAudioQuality. audio_loss_rate unsigned int The audio frame loss rate during the callback period. rcvd_bitrate unsigned int The instantaneous bitrate of the received stream in Kbps. totalFrozenTimes unsigned int The number of stutters. network_transport_delay unsigned int The network latency from the sender to the receiver in milliseconds. jitter_buffer_delay unsigned int The network latency from the receiver to the jitter buffer in milliseconds. - AliRtcFeedbackType: The feedback types of the SDK.
Enumeration Description AliRtcFeedbackVideoDeviceFail Video device issue. AliRtcFeedbackVideoNotRender No video display. AliRtcFeedbackAudioDeviceFail Audio device issue. AliRtcFeedbackAudioNotRender No audio. AliRtcFeedbackAudioEchoError Abnormal audio echo. AliRtcFeedbackChannelTypeError The meeting status is abnormal. For example, an error occurs when a user joins or leaves the meeting. AliRtcFeedbackSdkTypeError Other abnormal SDK states. AliRtcFeedbackNetworkUnfluent Network stutter issue. AliRtcFeedbackVideoBlurring Video clarity issue. AliRtcFeedbackUnkonw Unknown type. - AliRtcChannelRelayEvent: Events related to cross-channel stream forwarding.
Enumeration Description AliRtcChannelRelayStart Start. AliRtcChannelRelayUpdate Update. AliRtcChannelRelayStop Stop. - AliRtcChannelRelayState: The state of cross-channel stream forwarding.
Enumeration name Description AliRtcChannelRelayStateInit Initialization. AliRtcChannelRelayStateConnecting Connecting. AliRtcChannelRelayStateRunning Forwarding. AliRtcChannelRelayStateFailure Forwarding failed. - AliRtcChannelRelayConfiguration: The configuration for cross-channel stream forwarding.
Parameter Type Description destChannelInfos NSDictionary<NSString*,AliRtcAuthInfo*> *_Nullable A collection of authentication information for the destination channels. - AliRtcVideoObserPosition: The position where video data is output.
Enumeration Name Description AliRtcPositionPostCapture Captured video data. The corresponding output callback is onCaptureVideoSample. AliRtcPositionPreRender Rendered video data. The corresponding output callback is onRemoteVideoSample. AliRtcPositionPreEncoder Pre-encoded video data. The corresponding output callback is onPreEncodeVideoSample. - AliRtcVideoFormat: The video data format.
Enumeration Description AliRtcVideoFormat_UNKNOW Unknown. AliRtcVideoFormat_BGRA BGRA. AliRtcVideoFormat_I420 I420. AliRtcVideoFormat_NV21 NV21. AliRtcVideoFormat_NV12 NV12. AliRtcVideoFormat_RGBA RGBA. AliRtcVideoFormat_I422 I422. AliRtcVideoFormat_ARGB ARGB. AliRtcVideoFormat_ABGR ABGR. AliRtcVideoFormat_RGB24 RGB24. AliRtcVideoFormat_BGR24 BGR24. AliRtcVideoFormat_RGB565 RGB565. - AliRtcConnectionStatus: The network connection status.
Enumeration Description AliRtcConnectionStatusInit Initialization is complete. AliRtcConnectionStatusDisconnected The network connection is disconnected. AliRtcConnectionStatusConnecting Establishing a network connection. AliRtcConnectionStatusConnected The network is connected. AliRtcConnectionStatusReconnecting Re-establishing a network connection. AliRtcConnectionStatusFailed The network connection failed. - AliRtcConnectionStatusChangeReason: The reason for a change in the network connection status.
Enumeration Description AliRtcConnectionChangedDummyReason Unknown reason. AliRtcConnectionChangedMediaPathChanged The media channel changed. AliRtcConnectionChangedSignalingHeartbeatTimeout Heartbeat timeout. AliRtcConnectionChangedSignalingHeartbeatAlive Heartbeat recovered. AliRtcConnectionChangedSignalingHttpdnsResolved DNS resolution succeeded. AliRtcConnectionChangedSignalingHttpdnsFailure DNS resolution failed. AliRtcConnectionChangedSignalingGslbFailure GSLB request failed. AliRtcConnectionChangedSignalingGslbSucccess GSLB request succeeded. AliRtcConnectionChangedSignalingJoinChannelFailure Failed to join the channel. AliRtcConnectionChangedSignalingJoinChannelSuccess Joined the channel successfully. AliRtcConnectionChangedSignalingLeaveRoom Left the channel. AliRtcConnectionChangedSignalingConnecting Establishing a signaling connection. - AliRtcVideoTrack: The video stream type.
Enumeration Description AliRtcVideoTrackNo No video stream. AliRtcVideoTrackCamera Camera stream. AliRtcVideoTrackScreen Screen sharing stream. AliRtcVideoTrackBoth Both camera and screen sharing. - AliRtcPublishState: The state of a stream ingest.
Enumeration Description AliRtcStatsPublishIdle Initial state. AliRtcStatsNoPublish Not ingesting stream. AliRtcStatsPublishing Ingesting stream. AliRtcStatsPublished Stream ingested. - AliRtcSubscribeState: The subscription state.
Enumeration Description AliRtcStatsSubscribeIdle Initial state. AliRtcStatsNoSubscribe Not subscribed. AliRtcStatsSubscribing Subscribing. AliRtcStatsSubscribed Subscribed. - AliRtcUserOfflineReason: The reason why a user goes offline.
Enumeration Description AliRtcUserOfflineQuit The user left voluntarily. AliRtcUserOfflineDropped The user was dropped due to a timeout because no data packets were received for an extended period. AliRtcUserOfflineBecomeAudience Triggered when the user role switches from streamer to viewer. - AliRtcVideoStreamType: The camera stream type.
Enumeration Description AliRtcVideoStreamTypeNone No video stream. AliRtcVideoStreamTypeHigh High-volume stream. AliRtcVideoStreamTypeLow Small stream - AliRtcAudioTrack: The audio stream type.
Enumeration Description AliRtcAudioTrackNo No audio stream. AliRtcAudioTrackMic Microphone stream. - AliRtcNetworkQuality: The network quality.
Enumeration Description Network_Excellent The network is excellent, with good fluency and clarity. Network_Good The network is good. Fluency and clarity are similar to excellent. Network_Poor Poor network connectivity can result in some loss of audio and video smoothness and definition, but communication is not affected. Network_Bad The network is poor. Video stutters severely, but audio communication is normal. Network_VeryBad The network is very poor. Communication is almost impossible. Network_Disconnected The network is disconnected. Network_Unknow Unknown reason. - AliRtcOrientationMode: The screen orientation mode. (iOS only)
Enumeration Description AliRtcOrientationModePortrait Fixed portrait mode. AliRtcOrientationModeLandscapeLeft Fixed landscape left mode. AliRtcOrientationModePortraitUpsideDown Fixed upside-down portrait mode. AliRtcOrientationModeLandscapeRight Fixed landscape right mode. AliRtcOrientationModeAuto Adaptive orientation mode. - AliRtcAudioSessionOperationRestriction: The SDK's control permissions for the audio session. (iOS only)
Enumeration Description AliRtcAudioSessionOperationRestrictionNone No restrictions. The SDK has full control over the AVAudioSession. AliRtcAudioSessionOperationRestrictionSetCategory The SDK cannot modify the Category of the AVAudioSession. AliRtcAudioSessionOperationRestrictionConfigureSession The SDK cannot modify the configuration of the AVAudioSession, including its Category, Mode, and CategoryOptions. AliRtcAudioSessionOperationRestrictionDeactivateSession The SDK cannot deactivate the AVAudioSession. The AVAudioSession remains active when the user leaves the channel. - AliRtcRenderMode: The rendering mode.
Enumeration Description AliRtcRenderModeAuto Automatic. AliRtcRenderModeStretch Stretches to fill the view without maintaining the video aspect ratio. AliRtcRenderModeFill Scales while maintaining the video aspect ratio, filling with black bars. AliRtcRenderModeClip Scales while maintaining the video aspect ratio, and clips to fit the view. - AliRtcRenderMirrorMode: The mirror mode for rendering.
Enumeration Description AliRtcRenderMirrorModeOnlyFront Only the front camera preview is mirrored. Others are not mirrored. AliRtcRenderMirrorModeAllEnabled All are mirrored. AliRtcRenderMirrorModeAllDisable None are mirrored. - AliRtcRotationMode: The rotation angle.
Enumeration Description AliRtcRotationMode_0 No rotation. AliRtcRotationMode_90 Rotate 90 degrees. AliRtcRotationMode_180 Rotate 180 degrees. AliRtcRotationMode_270 Rotate 270 degrees. - AliRtcLogLevel: The log level.
Enumeration name Description AliRtcLogLevelInfo Standard AliRtcLogLevelWarn Warning. AliRtcLogLevelError Error. AliRtcLogLevelFatal Fatal. AliRtcLogLevelNone None. - AliRtcAudioNumChannel: The number of audio channels.
Enumeration Description AliRtcMonoAudio Mono audio. AliRtcStereoAudio Stereo audio. - AliRtcAudioSampleRate: The audio recording sample rate.
Enumeration Description AliRtcAudioSampleRate_8000 Sample rate of 8000 Hz. AliRtcAudioSampleRate_11025 Sample rate of 11025 Hz. AliRtcAudioSampleRate_16000 Sample rate of 16000 Hz. AliRtcAudioSampleRate_22050 Sample rate of 22050 Hz. AliRtcAudioSampleRate_32000 Sample rate of 32000 Hz. AliRtcAudioSampleRate_44100 Sample rate of 44100 Hz. AliRtcAudioSampleRate_48000 Sample rate of 48000 Hz. - AliRtcRecordType: The recording type.
Enumeration Name Description AliRtcRecordTypeAudio Audio-only recording. - AliRtcRecordFormat: The recording format.
Enumeration Description AliRtcRecordFormatAAC AAC file. AliRtcRecordFormatWAV WAV file. - AliRtcAudioQuality: The quality of recorded audio.
Enumeration Description AliRtcAudioQualityLow Low. AliRtcAudioQualityMidium In progress. AliRtcAudioQualityHigh High. - AliRtcVideoQuality: The quality of recorded video.
Enumeration Description AliRtcVideoQualityDefault Default. Same as the captured video quality. - AliRtcTranportAudioQuality: The audio quality for transport.
Enumeration Description AliRtcAudioQulityUnknow Unknown quality. AliRtcAudioQulityExcellent Excellent quality. AliRtcAudioQulityGood Subjective user experience is similar to excellent, but the bitrate may be slightly lower. AliRtcAudioQulityPoor The user experience is degraded, but communication is unaffected. AliRtcAudioQulityBad Communication is barely possible but not smooth. AliRtcAudioQulityVeryBad The network quality is very poor. Communication is almost impossible. AliRtcAudioQulityNetworkDisconnected The network connection is disconnected. Communication is impossible. - AliRtcAudioProfile: The audio quality mode.
Enumeration Description AliRtcEngineLowQualityMode Low audio quality mode. AliRtcEngineBasicQualityMode Standard audio quality mode. AliRtcEngineHighQualityMode High audio quality mode. AliRtcEngineStereoHighQualityMode Stereo high audio quality mode. AliRtcEngineSuperHighQualityMode Super high audio quality mode. AliRtcEngineStereoSuperHighQualityMode Stereo super high audio quality mode. - AliRtcAudioScenario: The audio scenario mode.
Enumeration name Description AliRtcSceneDefaultMode Default scenario. Recommended for general audio and video communication scenarios. AliRtcSceneEducationMode Education scenario. Prioritizes audio continuity and stability. AliRtcSceneMediaMode Media scenario. Preserves human voice and music quality. Recommended for co-streaming in live channels. AliRtcSceneMusicMode Music scenario. High-fidelity music quality. Recommended for scenarios with high music quality requirements, such as musical instrument lessons. AliRtcSceneChatroomMode Chat room scenario. Suitable for chat scenarios where users frequently join and leave with their microphones on. - AliRtcMuteLocalAudioMode: The local audio muting mode.
Enumeration Description AliRtcMuteAudioModeDefault Default mode (mutes all audio, including microphone and external audio input). AliRtcMuteAllAudioMode Mutes all audio (including microphone and external audio input). AliRtcMuteOnlyMicAudioMode Mutes only the microphone. AliRtcMuteLocalAudioMax Placeholder. - AliRtcRecordAudioConfig: The audio recording settings.
Parameter Type Description sampleRate AliRtcAudioSampleRate The audio sample rate. quality AliRtcAudioQuality The audio quality. enableRecordExternalRenderPCM bool Indicates whether to record external PCM input rendering data. - AliRtcRecordVideoConfig: The video recording settings.
Parameter Type Description quality AliRtcVideoQuality The video quality. - AliRtcBeautyConfig: The basic retouching settings.
Parameter Type Description whiteningLevel float Whitening level. The value ranges from 0 to 1. A larger value provides a stronger whitening effect. smoothnessLevel float Skin smoothing level. The value ranges from 0 to 1. A larger value provides a stronger smoothing effect. - AliRtcOnByeType: The enumeration of OnBye types.
Enumeration Description AliRtcOnByeBeKickedOut Kicked out. AliRtcOnByeChannelTerminated The channel has ended. You must leave the channel. AliRtcOnByeUserReplaced A user with the same UID joined the channel from another device. The current device is forced offline. - AliRtcAudioEffectVoiceChangerMode: The voice changer effect modes.
Enumeration Description AliRtcSdk_AudioEffect_Voice_Changer_OFF Off. AliRtcSdk_AudioEffect_Voice_Changer_Oldman Old man. AliRtcSdk_AudioEffect_Voice_Changer_Babyboy Baby boy. AliRtcSdk_AudioEffect_Voice_Changer_Babygirl Baby girl. AliRtcSdk_AudioEffect_Voice_Changer_Robot Robot. AliRtcSdk_AudioEffect_Voice_Changer_Daimo Devil. AliRtcSdk_AudioEffect_Voice_Changer_Ktv KTV. AliRtcSdk_AudioEffect_Voice_Changer_Echo Echo. AliRtcSdk_AudioEffect_Voice_Changer_MAX Placeholder. No meaning. - AliRtcAudioEffectReverbMode: The reverb effect modes.
Enumeration Description AliRtcAudioEffectReverb_Off Off. AliRtcAudioEffectReverb_Vocal_I Vocal I. AliRtcAudioEffectReverb_Vocal_II Vocal II. AliRtcAudioEffectReverb_Bathroom Bathhouse AliRtcAudioEffectReverb_Small_Room_Bright Bright small room. AliRtcAudioEffectReverb_Small_Room_Dark Dark small room. AliRtcAudioEffectReverb_Medium_Room Medium room. AliRtcAudioEffectReverb_Large_Room Large room. AliRtcAudioEffectReverb_Church_Hall Church aisle AliRtcAudioEffectReverb_Cathedral Cathedral. AliRtcAudioEffectReverb_Mode_Max Placeholder. No meaning. - AliRtcAudioEffectReverbParamType: The reverb effect parameters.
Enumeration Description AliRtcAudioEffectReverb_Room_Size Room size. The value ranges from 0 to 100. AliRtcAudioEffectReverb_Pre_Delay Pre-delay in ms. The value ranges from 0 to 200. AliRtcAudioEffectReverb_Revetberance Reverberance. The value ranges from 0 to 100. AliRtcAudioEffectReverb_Hf_Damping Damping. The value ranges from 0 to 100. AliRtcAudioEffectReverb_Tone_Low Low tone. The value ranges from 0 to 100. AliRtcAudioEffectReverb_Tone_High High tone. The value ranges from 0 to 100. AliRtcAudioEffectReverb_Dry_Gain Dry gain. The value ranges from -20 to 10. AliRtcAudioEffectReverb_Wet_Gain Wet gain. The value ranges from -20 to 10. AliRtcAudioEffectReverb_Type_Max Placeholder. No meaning. - AliRtcAudioRouteType: The audio route. (iOS only)
Enumeration Description AliRtcAudioRouteTypeDefault Default audio route. AliRtcAudioRouteTypeHeadset Headset. AliRtcAudioRouteTypeEarpiece Earpiece. AliRtcAudioRouteTypeHeadsetNoMic Headset without a microphone. AliRtcAudioRouteTypeSpeakerphone Phone speaker. AliRtcAudioRouteTypeLoudSpeaker External speaker. AliRtcAudioRouteTypeBlueTooth Bluetooth headset. - AliVideoCanvas: The rendering canvas.
Parameter Type Description view UIView * _Nonnull The rendering view. Cannot be nil. renderMode AliRtcRenderMode The rendering mode. The default is AliRtcRenderModeAuto. mirrorMode AliRtcRenderMirrorMode The mirror mode. The default is AliRtcRenderMirrorModeOnlyFront. backgroundColor int The background color in RGB Hex format. rotationMode AliRtcRotationMode The video rotation angle. The default is no rotation. textureId int The texture ID. textureWidth int The texture width. textureHeight int High-quality texture - AliRtcTrascodingLiveStreamErrorCode: Error codes for bypass stream ingest.
Enumeration Description AliRtcTrascodingLiveStreamErrorPublishOk Stream ingest successful. AliRtcTrascodingLiveStreamErrorStreamNotFound Error: Stream not found. AliRtcTrascodingLiveStreamErrorStreamAlreadyExist Error: The destination stream already exists. AliRtcTrascodingLiveStreamErrorInvalidParam Error: Invalid parameter. AliRtcTrascodingLiveStreamErrorInternalError Error: Internal error. AliRtcTrascodingLiveStreamErrorRtmpServerError Error: RTMP service is abnormal. AliRtcTrascodingLiveStreamErrorRtmpStreamUrlError Error: URL is abnormal. AliRtcTrascodingLiveStreamErrorPublishTimeout Error: Task timed out. AliRtcTrascodingLiveStreamErrorNotAuthorized Error: Operation not authorized. - AliRtcWatermarkConfig: The watermark image settings.
Parameter Type Description visibleInPreview BOOL Indicates whether the watermark is visible in the local preview. positionInLandscapeMode CGRect The watermark coordinates in landscape mode. positionInPortraitMode CGRect The watermark coordinates in portrait mode. alpha float The transparency. normalized BOOL Indicates whether to normalize. - AliRtcCameraCapturerConfiguration: The preferred properties for camera capture.
Parameter Type Description preference AliRtcCaptureOutputPreference The capture preference. cameraDirection AliRtcCameraDirection The camera direction. - AliRtcCameraDirection: The camera direction.
Enumeration Description AliRtcCameraDirectionInvalid Unknown. AliRtcCameraDirectionBack Rear camera. AliRtcCameraDirectionFront Front camera. - AliRtcCaptureOutputPreference: The camera capture preference.
Enumeration Name Description AliRtcCaptureOutputPreferenceAuto Automatically adjust capture parameters. AliRtcCaptureOutputPreferencePerformance Prioritize device performance. Selects the camera output parameters that are closest to the setVideoProfile settings. AliRtcCaptureOutputPreferencePreview Prioritize video preview quality. Selects higher camera output parameters. - AliRtcVideoEncoderFrameRate: The video encoding frame rate.
Enumeration Description AliRtcVideoEncoderFrameRate_FPS_5 5 FPS. AliRtcVideoEncoderFrameRate_FPS_10 10 FPS. AliRtcVideoEncoderFrameRate_FPS_15 15 FPS. AliRtcVideoEncoderFrameRate_FPS_20 20 FPS. AliRtcVideoEncoderFrameRate_FPS_30 30 FPS. - AliRtcVideoEncoderBitrate: The video encoding bitrate.
Enumeration Description AliRtcVideoEncoderStandardBitrate Standard bitrate mode. - AliRtcVideoEncoderMirrorMode: The mirror mode for encoded video.
Enumeration Description AliRtcVideoEncoderMirrorModeDisabled Image for video encoding AliRtcVideoEncoderMirrorModeEnabled Do not mirror the encoded video. - AliRtcVideoEncoderOrientationMode: The rotation mode for encoded video.
Enumeration Description AliRtcVideoEncoderOrientationModeAdaptive Adaptive. Same as the captured video. AliRtcVideoEncoderOrientationModeFixedLandscape Fixed landscape. AliRtcVideoEncoderOrientationModeFixedPortrait Fixed portrait. - AliRtcVideoEncoderConfiguration: The video encoding preferences.
Parameter Type Description dimensions CGSize The video resolution. frameRate NSInteger The video encoding frame rate. bitrate NSInteger The video encoding bitrate. mirrorMode AliRtcVideoEncoderMirrorMode The encoded video mirror mode. orientationMode AliRtcVideoEncoderOrientationMode The encoded video rotation mode. rotationMode AliRtcRotationMode The video rotation angle. - AliRtcScreenShareEncoderConfiguration: The screen sharing encoding preferences.
Parameter Type Description dimensions CGSize The video resolution. frameRate NSInteger The video encoding frame rate. bitrate NSInteger The video encoding bitrate. rotationMode AliRtcRotationMode The screen rotation angle. - AliRtcAuthInfo: The authentication information.
Parameter Type Description channelId NSString * _Nonnull The channel ID. userId NSString * _Nonnull The user ID. appId NSString * _Nonnull The application ID. nonce NSString * _Nonnull A random string. token NSString * _Nonnull The token. session NSString * _Nullable The session. role NSString * _Nullable The 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.
gslb NSArray <NSString *> * The GSLB address. agent NSArray <NSString *> * Set the address of the Agent server. timestamp long long The timestamp. - AliRtcDeviceVolumeType: The device volume type. (iOS only)
Enumeration Description AliRtcDeviceVolumeTypeAuto The 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. AliRtcDeviceVolumeTypeMedia Set as media volume. Suitable for media playback scenarios. The volume can be adjusted to zero. AliRtcDeviceVolumeTypeVOIP Set as call volume. Suitable for call scenarios. The volume cannot be adjusted to zero. - AliRtcVideoSource: The raw video data source type.
Enumeration Description AliRtcVideosourceCameraType Video stream. AliRtcVideosourceScreenShareType Screen sharing stream. AliRtcVideosourceTypeMax Placeholder. - AliRtcAudioSource: The raw audio data source type.
Enumeration name Description AliRtcAudiosourcePub Published audio data. AliRtcAudiosourceSub Pulls audio stream data. AliRtcAudiosourceRawData Captured raw audio data. - AliRtcBufferType: The video data type.
Enumeration Description AliRtcBufferType_Raw_Data Raw YUV data. AliRtcBufferType_CVPixelBuffer CVPixelBuffer data. - AliRtcErrorCode: The error code.
Enumeration Description AliRtcErrNone None. AliRtcErrJoinBadAppId The App ID does not exist. AliRtcErrJoinInvalidAppId The App ID is invalid. AliRtcErrJoinBadChannel The channel does not exist. AliRtcErrJoinInvalidChannel The channel is invalid. AliRtcErrJoinBadToken The token does not exist. AliRtcErrJoinTimeout Timed out when joining the channel. AliRtcErrJoinBadParam Incorrect parameter. AliRtcErrMicOpenFail Capture device initialization failed. AliRtcErrSpeakerOpenFail Playback device initialization failed. AliRtcErrMicInterrupt An exception occurred during capture. AliRtcErrSpeakerInterrupt An exception occurred during playback. AliRtcErrMicAuthFail Microphone device is not authorized. AliRtcErrMicNotAvailable No available audio capture device. AliRtcErrSpeakerNotAvailable No available audio playback device. AliRtcErrCameraOpenFail Capture device initialization failed. AliRtcErrCameraInterrupt An exception occurred during capture. AliRtcErrDisplayOpenFail Rendering device initialization failed. AliRtcErrDisplayInterrupt An exception occurred during rendering. AliRtcErrIceConnectionConnectFail Failed to establish a media channel. AliRtcErrIceConnectionReconnectFail Failed to reconnect to the media channel. AliRtcErrIceConnectionHeartbeatTimeout Signaling heartbeat timed out. AliRtcErrPublishInvaild Invalid stream ingest. AliRtcErrPublishNotJoinChannel Failed to ingest stream because the user is not in the channel. AliRtcErrPublishAudioStreamFailed Failed to push the audio stream. AliRtcErrPublishVideoStreamFailed Failed to push the video stream. AliRtcErrPublishDualStreamFailed Failed to push the dual stream. AliRtcErrPublishScreenShareFailed Failed to push the screen sharing stream. AliRtcErrPublishScreenShareConfigError Incorrect screen sharing configuration. AliRtcErrSubscribeInvaild Invalid subscription. AliRtcErrSubscribeNotJoinChannel Subscription error because the user is not in the channel. AliRtcErrSubscribeAudioStreamFailed Failed to subscribe to the audio stream. AliRtcErrSubscribeVideoStreamFailed Failed to subscribe to the video stream. AliRtcErrSubscribeDualStreamFailed Failed to subscribe to the dual stream. AliRtcErrSubscribeScreenShareFailed Failed to subscribe to the screen sharing stream. AliRtcErrCdnLiveCommunicationFailed Low-latency interactive streaming signaling failed. AliRtcErrCdnLiveMeidaSettingFailed Incorrect media settings for low-latency interactive streaming. AliRtcErrCdnLiveNoneBroadcaster No streamer is ingesting a stream in the current low-latency interactive streaming channel. AliRtcErrCdnLiveNeedRestart Low-latency interactive streaming error. The application layer needs to create a new SDK instance. AliRtcErrCdnLiveNeedRestartAgainLater Low-latency interactive streaming error. The application layer needs to wait for a custom interval and then create a new SDK instance. AliRtcErrCdnLiveServiceUnavailable The low-latency interactive streaming service is unavailable or has been degraded. AliRtcErrCdnLiveMediaConnectionInterruption Network interruption error in low-latency interactive streaming. AliRtcErrSdkInvalidState Incorrect SDK state. AliRtcErrSessionRemoved The session has been removed. AliRtcErrInvalidArguments Parameter mismatch. AliRtcErrAudioBufferFull The buffer queue is full. This is used for external raw data input. AliRtcErrVideoBufferFull The buffer queue is full. This is used for external raw data input. AliRtcErrUpdateRoleChannel Error setting the role in interactive mode. AliRtcErrInner Other errors. - AliRtcExternalDeviceType: The external device types. (Mac only)
Enumeration Description AliRtcExternalTypeUnknown Unknown type. AliRtcExternalTypeAudioCapture Audio capture device. AliRtcExternalTypeAudioPlayout Audio playback device. AliRtcExternalTypeVideoCapture Video capture device. - AliRtcExternalDeviceState: The external device states. (Mac only)
Enumeration Description AliRtcExternalDeviceAdd An external device is added. AliRtcExternalDeviceRemove An external device is removed. - AliRtcRecordVideoCanvasConfig: The canvas size for video recording settings. (Mac only)
Parameter Type Description canvasWidth int The canvas width. canvasHeight int The canvas height. - AliRtcRecordVideoLayout: The layout information for recorded video. (Mac only)
Parameter Type Description mode AliRtcRecordVideoLayoutMode The layout mode. backColor AliRtcRecordVideoBgColor The background color. shapes NSMutableArray<AliRtcRecordVideoRegion *> * _Nullable The position information for each user's video. - AliRtcRecordVideoLayoutMode: The layout mode for recorded video. (Mac only)
Enumeration Name Description AliRtcRecordVideoLayoutMode_GRID Grid layout. AliRtcRecordVideoLayoutMode_SPEAKER Speaker layout. AliRtcRecordVideoLayoutMode_UNIQUE Single-stream layout. AliRtcRecordVideoLayoutMode_CUSTOM Custom layout. - AliRtcRecordVideoBgColor: The background color for recorded video. (Mac only)
Parameter Type Description r uint8_t The value of red in the color mix. g uint8_t The value of green in the color mix. b uint8_t The value of blue in the color mix. - AliRtcRecordVideoRegion: The user video configuration for the recording layout. (Mac only)
Parameter Type Description userId NSString * _Nonnull The user ID. sourceType AliRtcVideoSource Raw video data source type. area AliRtcRecordVideoRectangle The position on the user's screen. - AliRtcRecordVideoRectangle: The user video position information. (Mac only)
Parameter Type Description left AliRtcRecordVideoRational Left margin. top AliRtcRecordVideoRational Top margin. width AliRtcRecordVideoRational Width. height AliRtcRecordVideoRational Height. - AliRtcRecordVideoRational: The coordinates for stream mixing recording. (Mac only)
Parameter Type Description numerator uint32_t Numerator (integer). denominator uint32_t Denominator (integer). - AliRtcRecordTemplate: The recording template. (Mac only)
Parameter Type Description recordType AliRtcRecordType Record type. recordFormat AliRtcRecordFormat Record format. sampleRate AliRtcAudioSampleRate Audio recording sample rate. audioQuality AliRtcAudioQuality Audio recording quality. enableRecordExternalCapturePCM bool Indicates whether to mix and record external audio input. enableRecordExternalRenderPCM bool Indicates whether to mix and record external audio after rendering. canvas AliRtcRecordVideoCanvasConfig Canvas size for recorded video. fps int Frame rate. bitrate int Bitrate. isFragment bool Indicates whether to record segmented MP4 files. The default is true. - AliRtcDeviceInfo: The device information. (Mac only)
Parameter Type Description deviceName NSString * _Nullable Device name. deviceID NSString * _Nullable Device ID. - AliRtcScreenShareConfig: The screen sharing configuration. (Mac only)
Parameter Type Description isShareByRegion bool Indicates whether it is a regional share. shareRegion AliRtcScreenShareRegion * _Nonnull Layout information for regional sharing. - AliRtcScreenShareRegion: The screen sharing region. (Mac only)
Parameter Type Description originX float The x-coordinate. originY float The y-coordinate. width float The width. height float The height. - AliRtcScreenSourceInfo: The screen sharing source information. (Mac only)
Parameter Type Description sourceId NSString * _Nonnull The sharing source ID. sourceName NSString * _Nonnull The sharing source name. - AliRtcScreenShareInfo: The screen sharing configuration information. (Mac only)
Parameter Type Description sourceType AliRtcScreenShareType The sharing type. sourceId NSString * _Nonnull The sharing source ID. config AliRtcScreenShareConfig * _Nonnull The screen sharing configuration. - AliRtcScreenShareType: The screen sharing type. (Mac only)
Enumeration Description AliRtcScreenShareDesktop Desktop sharing. AliRtcScreenShareWindow Window sharing. - AliRtcVideoObserAlignment: The width alignment for video output.
Enumeration Description AliRtcAlignmentDefault Keep the original video width (default). AliRtcAlignmentEven Width is even-aligned. AliRtcAlignment4 Width is a multiple of 4. AliRtcAlignment8 Width is a multiple of 8. AliRtcAlignment16 Width is a multiple of 16. - AliRtcShowDebugViewType: The dashboard display type.
Enumeration Description AliRtcShowTypeNone Do not display. AliRtcShowTypeAudio Audio. AliRtcShowTypeVideo Video. AliRtcShowTypeNetwork Network. AliRtcShowTypeAll All. - AliRtcTrascodingLiveTaskStatus: The LiveStream status for bypass stream ingest.
Enumeration Description AliRtcTrascodingLiveTaskStatusStart Task started. AliRtcTrascodingLiveTaskStatusUpdate Task updated. AliRtcTrascodingLiveTaskStatusStop Task stopped. - AliRtcLiveTranscodingDisplayType: The image display type for bypass live streaming.
Enumeration Description NOT_DISPLAY Do not display. ALWAYS Always display. WHEN_NO_VIDEO Display when there is no video. - AliRtcLiveTranscodingFontType: The text type for bypass live streaming.
Enumeration Description NOTO_SERIF_CJKSC_REGULAR Noto Serif CJK SC Regular. ALIBABA_PUHUITI_REGULAR Alibaba PuHuiTi Regular. ALIBABA_PUHUITI_BOLD Alibaba PuHuiTi Bold. ALIBABA_PUHUITI_Heavy Alibaba PuHuiTi Heavy. ALIBABA_PUHUITI_LIGHT Alibaba PuHuiTi Light. ALIBABA_PUHUITI_MEDIUM Alibaba PuHuiTi Medium. - AliRtcLiveTranscodingSegmentType: The input type for bypass live streaming.
Enumeration Description AliRtcLiveTranscodingNoBody No portrait segmentation. AliRtcLiveTranscodingBody Portrait segmentation. - AliRtcLiveTranscodingSourceType: The input type for bypass live streaming.
Enumeration Description AliRtcLiveTranscodingCamera Camera. AliRtcLiveTranscodingShareScreen Screen sharing. - AliRtcVideoState: A change in the video stream state.
Enumeration Description AliRtcVideoVideoClose Close the video stream. AliRtcVideoVideoOpen Resume the video stream. - AliRtcVideoReason: The reason for a change in the video stream state.
Enumeration Description AliRTCVideoChangedByClient Client. AliRTCVideoChangedByServer Server. - AliRtcLiveTranscodingCropMode: The clipping mode for bypass live streaming.
Enumeration Description AliRtcLiveTranscodingCrop Crop while maintaining the aspect ratio. AliRtcLiveTranscodingFill Fill with black bars while maintaining the aspect ratio (default). - AliRtcLiveTranscodingMediaProcessMode: The media processing mode for bypass live streaming.
Enumeration Description AliRtcLiveTranscodingNormal Normal mode. AliRtcLiveTranscodingVirtualBackground Virtual background mode. - AliRtcLiveTranscodingStreamType: The stream type for bypass live streaming.
Enumeration Description AliRtcLiveTranscodingOrigin Forward the original stream. AliRtcLiveTranscodingAudio Forward only the audio stream. AliRtcLiveTranscodingVideo Forward only the video stream. - AliRtcLiveTranscodingMixMode: The mode for bypass live streaming.
Enumeration Description AliRtcLiveTranscodingSINGLE Single-stream forwarding. No stream mixing or transcoding. Only the original single stream is forwarded. No need to configure stream mixing and transcoding parameters. AliRtcLiveTranscodingMIX Stream mixing and transcoding (default). Supports stream mixing and transcoding output. - AliRtcLiveTranscodingState: The state of bypass live streaming.
Enumeration Description AliRtcLiveTranscodingState_IDLE Stream ingest is idle. AliRtcLiveTranscodingState_CONNNECT Connecting to the stream ingest server. AliRtcLiveTranscodingState_RUNNING Stream ingest is in progress. AliRtcLiveTranscodingState_RECOVERING Recovering stream ingest. AliRtcLiveTranscodingState_FAILURE Stream ingest failed. AliRtcLiveTranscodingState_END Stream ingest ended. - AliRtcLiveTranscodingText: The text information for bypass live streaming.
Parameter Type Description text NSString Text information. x int The x-coordinate (pixel). y int The y-coordinate (pixel). fontType AliRtcLiveTranscodingFontType Font for bypass live streaming. fontSize int Font size. zOrder int The layer order. Layer 0 is the bottom layer. Layer 1 is stacked on top of layer 0, and so on. fontColor int Font color. - AliRtcLiveTranscodingImage: The image information for bypass live streaming.
Parameter Type Description url NSString Image URL. alpha float Transparency. 0.0 means transparent, 1.0 means fully opaque. display AliRtcLiveTranscodingDisplayType Image display. x int The x-coordinate (pixel). y int The y-coordinate (pixel). width int Image width. height int Image height. zOrder int The 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.
Parameter Type Description x int The x-coordinate (pixel). y int The y-coordinate (pixel). width int Pane width. height int Pane height. zOrder int The layer order. Layer 0 is the bottom layer. Layer 1 is stacked on top of layer 0, and so on. userId NSString * User ID. sourceType AliRtcLiveTranscodingSourceType Stream type. segmentType AliRtcLiveTranscodingSegmentType Input type for bypass live streaming. images NSArray<AliRtcLiveTranscodingImage *> * Image information for bypass live streaming. texts NSArray<AliRtcLiveTranscodingText *> * Text information for bypass live streaming. - AliRtcLiveTranscodingParam: The configuration for bypass live streaming.
Parameter Type Description mixMode AliRtcLiveTranscodingMixMode Mode for bypass live streaming. singleParam AliRtcLiveTranscodingSingleParam * Single-stream parameters for bypass live streaming. mixParam AliRtcLiveTranscodingMixParam Stream mixing parameters for bypass live streaming. - AliRtcLiveTranscodingMixParam: The stream mixing parameters for bypass mode.
Parameter Type Description taskProfile AliRtcLiveTranscodingTaskProfile Billing specifications for bypass live streaming. encodeParam AliRtcLiveTranscodingEncodeParam * Encoding parameters for bypass live streaming. users NSArray<AliRtcLiveTranscodingPane *> * List of users for bypass live streaming. backgroundColor int Background color. backgrounds NSArray<AliRtcLiveTranscodingImage *> * List of background images. watermarks NSArray<AliRtcLiveTranscodingImage *> * List of watermark images. clockWidgets NSArray<AliRtcLiveTranscodingClockWidget *> * List of clock widgets. cropMode AliRtcLiveTranscodingCropMode Clipping mode for bypass live streaming. mediaProcessMode AliRtcLiveTranscodingMediaProcessMode Media processing mode for bypass live streaming. - AliRtcLiveTranscodingSingleParam: The single-stream parameters for bypass mode.
Parameter Type Description userId NSString * User ID. streamType AliRtcLiveTranscodingStreamType Stream type for bypass live streaming. sourceType AliRtcLiveTranscodingSourceType Video stream type for bypass live streaming. - AliRtcLiveTranscodingTaskProfile: The billing specifications for bypass live streaming.
Enumeration Description AliRtcLiveTranscoding_Profile_1IN_1080P 1IN_1080P. AliRtcLiveTranscoding_Profile_1IN_720P 1IN_720P. AliRtcLiveTranscoding_Profile_1IN_360P 1IN_360P. AliRtcLiveTranscoding_Profile_2IN_1080P 2IN_1080P. AliRtcLiveTranscoding_Profile_2IN_720P 2IN_720P. AliRtcLiveTranscoding_Profile_2IN_360P 2IN_360P. AliRtcLiveTranscoding_Profile_4IN_1080P 4IN_1080P. AliRtcLiveTranscoding_Profile_4IN_720P 4IN_720P. AliRtcLiveTranscoding_Profile_4IN_360P 4IN_360P. AliRtcLiveTranscoding_Profile_9IN_1080P 9IN_1080P. AliRtcLiveTranscoding_Profile_9IN_720P 9IN_720P. AliRtcLiveTranscoding_Profile_9IN_360P 9IN_360P. AliRtcLiveTranscoding_Profile_12IN_1080P 12IN_1080P. AliRtcLiveTranscoding_Profile_12IN_720P 12IN_720P. AliRtcLiveTranscoding_Profile_12IN_360P 12IN_360P. AliRtcLiveTranscoding_Profile_16IN_1080P 16IN_1080P. AliRtcLiveTranscoding_Profile_16IN_720P 16IN_720P. AliRtcLiveTranscoding_Profile_16IN_360P 16IN_360P. AliRtcLiveTranscoding_Profile_Mixed Audio-only. - AliRtcLiveTranscodingEncodeParam: The encoding parameters for bypass live streaming.
Parameter Type Description videoWidth int Width. videoHeight int Height. videoFramerate int Frame rate. videoBitrate int Bitrate. videoGop int GOP. audioSamplerate AliRtcLiveTranscodingAudioSampleRate Audio sample rate for bypass live streaming. audioBitrate int Audio bitrate. audioChannels int Number of audio channels. - AliRtcLiveTranscodingAudioSampleRate: The audio sample rate for bypass live streaming.
Enumeration Description AliRtcLiveTranscoding_HZ_48000 Sample rate of 48000 Hz. AliRtcLiveTranscoding_HZ_44100 Sample rate of 44100 Hz. AliRtcLiveTranscoding_HZ_32000 Sample rate of 32000 Hz. AliRtcLiveTranscoding_HZ_16000 Sample rate of 16000 Hz. AliRtcLiveTranscoding_HZ_8000 Sample rate of 8000 Hz. - AliRtcLiveTranscodingClockWidget: The clock widget for bypass live streaming.
Parameter Type Description x int The x-coordinate (pixel). y int The y-coordinate (pixel). fontSize int Font size for bypass live streaming. zOrder int The layer order. Layer 0 is the bottom layer. Layer 1 is stacked on top of layer 0, and so on. fontColor int Font color for bypass live streaming. fontType AliRtcLiveTranscodingFontType Font for bypass live streaming. - AliRtcBokehScaleModel: The scaling mode for background replacement. (Mac only)
Enumeration Description AliRtcBokehScaleModelCrop Proportional clipping. AliRtcBokehScaleModelFill Fill with black bars. - AliRtcAudioPlayingStateCode: The playback state for music accompaniment. (Mac only)
Enumeration Description AliRtcAudioPlayingStarted Playback started. AliRtcAudioPlayingStopped Playback stopped. AliRtcAudioPlayingPaused Playback paused. AliRtcAudioPlayingResumed Playback resumed. AliRtcAudioPlayingEnded Playback finished. AliRtcAudioPlayingBuffering Buffering. AliRtcAudioPlayingBufferingEnd Buffering finished. AliRtcAudioPlayingFailed Playback failed. - AliRtcAudioPlayingErrorCode: The error codes for music accompaniment playback. (Mac only)
Enumeration Description AliRtcAudioPlayingNoError No error. AliRtcAudioPlayingOpenFailed Error opening file. AliRtcAudioPlayingDecodeFailed Error decoding file.
该文章对您有帮助吗?