ApsaraVideo Live:AliRtcEngine interface

Creates an `AliRtcEngine` instance.

+ (instancetype _Nonnull )sharedInstance:(id<AliRtcEngineDelegate>_Nullable)delegate extras:(NSString *_Nullable)extras;

Parameters

Destroys the SDK instance.

+ (void)destroy;

Destroys the engine with a callback.

+ (void)destroy:(id<AliRtcEngineDestroyDelegate>_Nullable)delegate;

Parameters

Sets whether to enable H5 compatibility mode.

+ (void)setH5CompatibleMode:(BOOL)comp;

Parameters

Checks whether H5 compatibility mode is enabled.

+ (BOOL)getH5CompatibleMode;

Return value

Returns `YES` if H5 compatibility is enabled or `NO` if H5 compatibility is disabled.

Sets the channel profile.

- (int)setChannelProfile:(AliRtcChannelProfile)profile;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

You can call this method only before you join a channel. You cannot change the channel profile during a session, but you can change it after you leave the channel.

Sets the audio profile.

- (int)setAudioProfile:(AliRtcAudioProfile)audio_profile audio_scene:(AliRtcAudioScenario)audio_scene;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Checks whether the current mode is audio-only.

- (BOOL)isAudioOnly;

Return value

Returns `YES` for audio-only mode or `NO` for audio and video mode.

Sets the mode to audio-only or audio and video.

- (int)setAudioOnlyMode:(BOOL)audioOnly;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Joins a channel.

- (int)joinChannel:(NSString _Nonnull)token channelId:(NSString _Nullable)channelId userId:(NSString _Nullable)userId name:(NSString _Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString _Nonnull channel, NSString _Nonnull userId, NSInteger elapsed))onResult;

After you successfully join a channel, you must call `leaveChannel` to leave the current channel before you can join another one. If you fail to join a channel, you can try to join again without calling `leaveChannel`.

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Joins a channel.

- (int)joinChannel:(AliRtcAuthInfo _Nonnull)authInfo name:(NSString _Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString _Nonnull channel, NSString _Nonnull userId, NSInteger elapsed))onResult;

After you successfully join a channel, you must call `leaveChannel` to leave the current channel before you can join another one. If you fail to join a channel, you can try to join again without calling `leaveChannel`.

Parameters

Joins a channel.

- (int)joinChannel:(AliRtcAuthInfo _Nonnull)authInfo name:(NSString _Nullable)userName onResult:(void(^_Nullable)(NSInteger errCode, NSString _Nonnull channel, NSInteger elapsed))onResult;

After you successfully join a channel, you must call `leaveChannel` to leave the current channel before you can join another one. If you fail to join a channel, you can try to join again without calling `leaveChannel`.

Parameters

Joins a channel.

- (int)joinChannel:(NSString _Nonnull)token channelParam:(AliRtcChannelParam _Nonnull)channelParam onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString _Nonnull channel, NSString _Nonnull userId, NSInteger elapsed))onResult;

After you successfully join a channel, you must call `leaveChannel` to leave the current channel before you can join another one. If you fail to join a channel, you can try to join again without calling `leaveChannel`.

Parameters

Leaves the current channel.

- (int)leaveChannel;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Checks whether the user is in the channel.

- (BOOL)isInCall;

Return value

Returns `YES` if the user is in the channel or `NO` if the user is not in the channel.

Sets the user role.

- (int)setClientRole:(AliRtcClientRole)role;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the user role.

- (AliRtcClientRole)getClientRole;

Return value

Returns the current user role.

Refreshes the authentication information.

- (int)refreshAuthInfo:(AliRtcAuthInfo _Nonnull)authInfo;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Refreshes the authentication information.

- (int)refreshAuthInfoWithToken:(NSString _Nonnull)token;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Enables or disables publishing of the local audio stream.

- (int)publishLocalAudioStream:(BOOL)enabled;

Parameters

Returns

Returns 0 if the method call is successful or a non-zero value if it fails.

Checks whether the local audio stream is being published.

- (BOOL)isLocalAudioStreamPublished;

Return value

Returns `YES` if publishing is allowed or `NO` if publishing is not allowed.

Sets whether to subscribe to remote audio streams by default.

- (int)setDefaultSubscribeAllRemoteAudioStreams:(BOOL)sub;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops or resumes receiving all remote audio streams.

- (int)subscribeAllRemoteAudioStreams:(BOOL)sub;

Parameters

Returns

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops or resumes receiving the audio stream of a specific remote user.

- (int)subscribeRemoteAudioStream:(NSString _Nonnull)uid sub:(BOOL)sub;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Enables or disables publishing of the local camera stream.

- (int)publishLocalVideoStream:(BOOL)enabled;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Checks whether the local camera stream is being published.

- (BOOL)isLocalVideoStreamPublished;

Return value

Returns `YES` if the camera stream is published or `NO` if the camera stream is not published.

Sets whether to subscribe to remote video streams by default.

- (int)setDefaultSubscribeAllRemoteVideoStreams:(BOOL)sub;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops or resumes receiving all remote video streams.

- (int)subscribeAllRemoteVideoStreams:(BOOL)sub;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops or resumes receiving the media stream of a specific remote user.

- (int)subscribeRemoteMediaStream:(NSString _Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack subVideo:(BOOL)subVideo subAudio:(BOOL)subAudio;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops or resumes receiving the media stream of a specific remote user.

- (int)subscribeRemoteMediaStream:(NSString _Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack audioTrack:(AliRtcAudioTrack)audioTrack;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Subscribes to the stream of a specified user in another channel.

- (int)subscribeRemoteDestChannelStream:(NSString _Nonnull)channelId uid:(NSString _Nonnull)uid track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Mutes or unmutes the local microphone.

- (int)muteLocalMic:(BOOL)mute mode:(AliRtcMuteLocalAudioMode)mode;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops or resumes playing a remote audio stream.

- (int)muteRemoteAudioPlaying:(NSString _Nonnull)uid mute:(BOOL)mute;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops or resumes playing all remote audio streams.

- (int)muteAllRemoteAudioPlaying:(BOOL)mute;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Starts audio capture.

- (void)startAudioCapture;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Starts audio capture.

- (void)startAudioCapture:(BOOL)keepAlive;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops audio capture. This method corresponds to `startAudioCapture`.

- (void)stopAudioCapture;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Starts local audio and video recording.

- (BOOL)startRecord:(AliRtcRecordType)recordType recordFormat:(AliRtcRecordFormat)recordFormat filePath:(NSString)filePath audioConfig:(AliRtcRecordAudioConfig)audioConfig videoConfig:(AliRtcRecordVideoConfig)videoConfig;

Parameters

Return value

Returns `TRUE` on success or another value on failure.

Stops the current recording operation.

- (void)stopRecord;

Return value

None

Tests the playback of an audio file from a specified path.

- (int)playAudioFileTest:(NSString _Nonnull)filePath;

Parameters

Return value

Returns 0 on success or another value on failure.

Stops playing the current audio file.

- (int)stopAudioFileTest;

Return value

Returns 0 on success or another value on failure.

Enables or disables the volume and speaker detection callback.

- (int)enableAudioVolumeIndication:(NSInteger)interval smooth:(NSInteger)smooth reportVad:(NSInteger)reportVad;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Enables or disables the in-ear monitoring feature.

- (int)enableEarBack:(BOOL)enable;

Parameters

Response description

Returns 0 if the method call is successful or a non-zero value if it fails.

You can set the output volume for in-ear monitoring.

- (int)setEarBackVolume:(NSInteger)volume;

Parameters

Return value

A return value of 0 indicates success. A non-zero value indicates failure.

Sets the voice changer effect mode.

- (int)setAudioEffectVoiceChangerMode:(AliRtcAudioEffectVoiceChangerMode)mode;

Parameters

Return value

Returns 0 on success or a non-zero value on failure.

- (int)setAudioEffectPitchValue:(double)value;

Parameters

Return value

Returns 0 if the method was called successfully or another value if the call failed.

Sets the audio reverberation effect mode.

- (int)setAudioEffectReverbMode:(AliRtcAudioEffectReverbMode)mode;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the audio reverberation effect mode.

- (int)setAudioEffectReverbParamType:(AliRtcAudioEffectReverbParamType)type value:(float)value;

Parameters

Response description

Returns 0 if the method call is successful or a non-zero value if it fails.

Registers an external audio input stream.

- (int)addExternalAudioStream:(AliRtcExternalAudioStreamConfig _Nonnull)config;

Parameters

Response Description

If successful, this method returns a value greater than 0, which is the external audio stream ID. Otherwise, it returns a failure code.

- (int)pushExternalAudioStream:(int)streamId rawData:(AliRtcAudioFrame _Nonnull)audioFrame;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the publishing volume of a specified external audio stream.

- (int)setExternalAudioStream:(int)streamId publishVolume:(int)publishVolume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the publishing volume of a specified external audio stream.

- (int)getExternalAudioStreamPublishVolume:(int)streamId;

Parameters

Return value

Returns the publishing volume in the range of [0, 100]. A value less than 0 indicates failure.

Sets the local playback volume of a specified external audio stream.

- (int)setExternalAudioStream:(int)streamId playoutVolume:(int)playoutVolume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the local playback volume of a specified external audio stream.

- (int)getExternalAudioStreamPlayoutVolume:(int)streamId;

Parameters

Return value

Returns the playback volume in the range of [0, 100]. A value less than 0 indicates failure.

Preloads a specified sound effect file into memory.

- (int)preloadAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString _Nonnull)filePath;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Unloads the sound effect file with the specified ID from memory.

- (int)unloadAudioEffectWithSoundId:(NSInteger)soundId;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Plays the sound effect file with the specified ID.

- (int)playAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString _Nonnull)filePath cycles:(NSInteger)cycles publish:(BOOL)publish;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops playing the sound effect with the specified ID.

- (int)stopAudioEffectWithSoundId:(NSInteger)soundId;

Parameters

Returns

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops all currently playing sound effects.

- (int)stopAllAudioEffects;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Pauses the playback of the sound effect with the specified ID.

- (int)pauseAudioEffectWithSoundId:(NSInteger)soundId;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Pauses all currently playing sound effects.

- (int)pauseAllAudioEffects;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Resumes the playback of the sound effect with the specified ID.

- (int)resumeAudioEffectWithSoundId:(NSInteger)soundId;

Parameters

Response Description

Returns 0 if the method call is successful or a non-zero value if it fails.

Resumes playback of all paused sound effects.

- (int)resumeAllAudioEffects;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the mixing volume of a specified sound effect in the published stream.

- (int)setAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the mixing volume of a specified sound effect in the published stream.

- (int)getAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId;

Parameters

Response Description

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the mixing volume for publishing all sound effects.

- (int)setAllAudioEffectsPublishVolume:(NSInteger)volume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the local playback volume of a sound effect.

- (int)setAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

Parameters

Returns

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the local playback volume of a sound effect.

- (int)getAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the local playback volume for all sound effects.

- (int)setAllAudioEffectsPlayoutVolume:(NSInteger)volume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the rendering window and drawing parameters for the local preview.

- (int)setLocalViewConfig:(AliVideoCanvas _Nullable)viewConfig forTrack:(AliRtcVideoTrack)track;

Parameters

Response Description

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets camera capture preferences.

- (int)setCameraCapturerConfiguration:(AliRtcCameraCapturerConfiguration _Nonnull)config;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Disables or re-enables local video capture.

- (int)enableLocalVideo:(BOOL)enable;

Parameters

Response Description

Returns 0 if the method call is successful or a non-zero value if it fails.

Mutes or unmutes the local camera.

- (int)muteLocalCamera:(BOOL)mute forTrack:(AliRtcVideoTrack)track;

This method only controls whether to send black frames on the specified video stream. The local preview remains on the last frame, and capture and data sending do not stop. To stop capture, use `enableLocalVideo`. To stop sending video data, use `publishLocalVideoStream`.

Parameters

Response description

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the rendering window and drawing parameters for a remote video.

- (int)setRemoteViewConfig:(AliVideoCanvas _Nullable)canvas uid:(NSString _Nonnull)uid forTrack:(AliRtcVideoTrack)track;

You can switch windows before or after you call the `joinChannel` method. If `canvas` or `view` is `nil`, rendering of the corresponding stream stops. To reset the render mode during playback, keep the other member variables in the canvas unchanged and modify only `renderMode`. To reset the mirror mode during playback, keep the other member variables in the canvas unchanged and modify only `mirrorMode`.

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Checks whether the camera is on.

- (BOOL)isCameraOn;

Response description

Returns `YES` if the camera is on or `NO` if the camera is not on.

Sets video encoding properties.

- (void)setVideoEncoderConfiguration:(AliRtcVideoEncoderConfiguration _Nonnull)config;

Parameters

Sets video decoding properties.

- (void)setVideoDecoderConfiguration:(AliRtcVideoDecoderConfiguration _Nonnull)config;

Parameters

Starts the local preview, which automatically turns on the camera.

- (int)startPreview;

If no view is set, the preview is not available. You can start the preview before you call the `joinChannel` method.

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops the local preview.

- (int)stopPreview;

`leaveChannel` automatically stops the local preview and turns off the camera. However, if a camera stream is being published, the camera is not turned off.

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Enables an external video input source.

- (int)setExternalVideoSource:(BOOL)enable sourceType:(AliRtcVideoSource)type renderMode:(AliRtcRenderMode)renderMode;

Parameters

Enter the video data.

- (int)pushExternalVideoFrame:(AliRtcVideoDataSample _Nonnull)frame sourceType:(AliRtcVideoSource)type;

Parameters

Response description

Returns 0 if the method call is successful or a non-zero value if it fails.

Starts sharing the screen stream that corresponds to the specified desktop ID.

- (int)startScreenShareWithDesktopId:(int)desktopId config:(AliRtcScreenShareConfig * _Nonnull)config;

Parameters

Return value

• 0: Success

• Other: Failure

Uses the specified window ID as a video source to share and publish a video stream.

- (int)startScreenShareWithWindowId:(int)windowId config:(AliRtcScreenShareConfig * _Nonnull)config;

Parameters

Return value

• 0: Success

• Other: Failure

Stops screen sharing.

- (int)stopScreenShare;

Parameters

None

Return value

• 0: Success

• Other: Failure

Updates the screen sharing configuration.

- (int)updateScreenShareConfig:(AliRtcScreenShareConfig * _Nonnull)config;

Parameters

Return value

• 0: Success

• Other: Failure

Checks whether the screen sharing stream is being published.

- (BOOL)isScreenSharePublished;

Parameters

None

Return value

• `TRUE`: Screen sharing is in progress.

• `FALSE`: Screen sharing is not in progress.

Starts bypass live streaming.

- (int)startPublishLiveStreamWithURL:(NSString _Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam _Nonnull)trancoding;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Updates bypass live streaming parameters.

- (int)updatePublishLiveStreamWithURL:(NSString _Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam _Nonnull)trancoding;

Parameters

Returns

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops bypass live streaming.

- (int)subscribeRemoteDestChannelAllStream:(NSString _Nonnull)channelId track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

Parameters

Response description

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the bypass live streaming status.

- (AliRtcLiveTranscodingState)GetPublishLiveStreamStateWithURL:(NSString _Nonnull)streamURL;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Starts network quality detection.

- (int)startLastmileDetect:(AliRtcNetworkQualityProbeConfig _Nonnull)config;

Parameters

Response Description

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops network quality detection.

- (int)stopLastmileDetect;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets custom parameters.

- (int)setParameter:(NSString _Nonnull)param;

Parameters

Retrieves custom parameters.

- (NSString _Nonnull)getParameter:(NSString _Nonnull)param;

Parameters

Sets audio callback parameters.

- (int)enableAudioFrameObserver:(bool)enable audioSource: (AliRtcAudioSource)audioSource config:(AliRtcAudioFrameObserverConfig_Nullable)config;

Parameters

Registers an audio data output.

- (int)registerAudioFrameObserver:(id<AliRtcAudioFrameDelegate> _Nullable)observer;

Parameters

Registers a video data output.

- (void)registerVideoSampleObserver;

Unregisters a video data output.

- (void)unregisterVideoSampleObserver;

Sets the path to save the SDK log file.

+ (int)setLogDirPath:(NSString _Nullable)logDirPath;

Parameters

Sets the log level.

- (void)setLogLevel:(AliRtcLogLevel)logLevel;

Parameters

Sets the video mirror mode.

- (int)setVideoMirrorMode:(AliRtcVideoPipelineMirrorMode)mirrorMode;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the video pipeline scaling mode.

- (void)setCapturePipelineScaleMode:(AliRtcCapturePipelineScaleMode)mode;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the SDK version number.

+ (NSString _Nonnull)getSdkVersion;

Return value

The current SDK version number as a string, for example, "2.5.0.x". This is a static method and can be called at any time to retrieve the version number.

Sets the screen sharing encoder settings.

- (void)setScreenShareEncoderConfiguration:(AliRtcScreenShareEncoderConfiguration _Nonnull)config;

Parameters

Sets the volume of a remote audio stream.

- (int)setRemoteAudioVolume:(NSString _Nonnull)uid volume:(NSInteger)volume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops or resumes subscribing to the video stream of a remote user.

- (int)subscribeRemoteVideoStream:(NSString _Nonnull)uid track:(AliRtcVideoTrack)track sub:(BOOL)sub;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Subscribes to a specified user's stream in a destination channel.

- (int)subscribeRemoteDestChannelStream:(NSString _Nonnull)channelId uid:(NSString _Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack audioTrack:(AliRtcAudioTrack)audioTrack sub:(BOOL)sub;

Parameters

Return value

A return value of 0 indicates success. A non-zero value indicates failure.

Subscribes to the streams of all users in a destination channel.

- (int)subscribeRemoteDestChannelAllStream:(NSString _Nonnull)channelId track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

Parameters

Response Description

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the recording volume.

- (int)resumeAudioAccompany;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the playback volume.

- (int)getAudioAccompanyDuration;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Starts the audio capture device test before a call.

- (int)getAudioAccompanyCurrentPosition;

Stops the pre-call audio capture device test.

- (int)setAudioAccompanyPosition:(int)pos;

Retrieves information about the audio file.

- (int)getAudioFileInfo:(NSString *_Nonnull)filePath;

Parameters

Starts accompaniment mixing.

- (int)startAudioAccompanyWithFile:(NSString *_Nonnull)filePath config:(AliRtcAudioAccompanyConfig *_Nonnull)config;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Stops accompaniment mixing.

- (int)stopAudioAccompany;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the accompaniment volume.

- (int)setAudioAccompanyVolume:(NSInteger)volume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the publishing volume of the accompaniment.

- (int)setAudioAccompanyPublishVolume:(NSInteger)volume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the publishing volume of the accompaniment.

- (int)getAudioAccompanyPublishVolume;

Return value

Returns a value in the range of [0, 100] on success or another value on failure.

Sets the local playback volume of the accompaniment.

- (int)setAudioAccompanyPlayoutVolume:(NSInteger)volume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the local playback volume of the accompaniment.

- (int)getAudioAccompanyPlayoutVolume;

Return value

Returns a value in the range of [0, 100] on success or another value on failure.

Pauses accompaniment mixing.

- (int)pauseAudioAccompany;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Resumes accompaniment mixing.

- (int)resumeAudioAccompany;

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Retrieves the duration of the accompaniment file in milliseconds.

- (int)getAudioAccompanyDuration;

Return value

Returns a value greater than or equal to 0, which is the duration of the accompaniment file in milliseconds. A value less than 0 indicates failure.

Retrieves the accompaniment playback progress in milliseconds.

- (int)getAudioAccompanyCurrentPosition;

Return value

Returns a value greater than or equal to 0, which is the accompaniment playback progress. A value less than 0 indicates failure.

Sets the playback position of the accompaniment file.

- (int)setAudioAccompanyPosition:(int)pos;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Sets the in-ear monitoring volume.

- (int)setEarBackVolume:(NSInteger)volume;

Parameters

Return value

Returns 0 if the method call is successful or a non-zero value if it fails.

Takes a snapshot of the video.

- (int)snapshotVideo:(NSString*_Nullable)userId type:(AliRtcVideoTrack)type;

Parameters

Returns

Returns 0 if the method call is successful or a non-zero value if it fails.

Sends Supplemental Enhancement Information (SEI).

- (int)sendMediaExtensionMsg:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame;

Parameters

Return value

Returns 0 on success or another value on failure.

Sends media extension information, which is implemented using SEI at the underlying layer.

- (int)sendMediaExtensionMsgEx:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame payloadType:(int)payloadType;

Parameters

Returns

Returns 0 on success or another value on failure.

Starts audio playback.

- (void)startAudioPlayer;

Stops audio playback.

- (void)stopAudioPlayer;

Deletes an external audio stream.

- (int)removeExternalAudioStream:(int)streamId;

Parameters

Returns

Returns 0 on success or another value on failure.

Retrieves the timeline time.

-(long long)getNetworkTime;

Parameters

Return value

The timestamp.

Sends a data channel message.

-(int) sendDataChannelMessage:(AliRtcDataChannelMsg* _Nonnull)controlMsg;

The ARTC SDK lets you send and receive custom messages. This feature lets you send custom real-time messages while you transmit audio and video data. For example, you can call this interface to transmit real-time control instructions, status synchronization data, or other business messages along with the audio and video. For more information, see Send and receive custom messages.

Related callbacks

• After the sender successfully enables the custom message channel, they can call this method to send custom messages. The receiver listens for the onDataChannelMessage callback to receive them.

Limits

• Users with the streamer role can send and receive messages. Users with the viewer role can only receive messages.

• You must call `setParameter` to enable the custom message channel.

• Data sending is limited as follows:

  • The bitrate is capped at 30 KB/s.

  • The data channel can send a maximum of 60 data packets per second, with each packet up to 1 KB in size.

Parameters

Return value

Returns 0 on success or another value on failure.

Sets the device orientation.

- (int)setDeviceOrientationMode:(AliRtcOrientationMode)mode;

Parameters

Return value

Returns 0 on success or another value on failure.

Registers a video data output object.

- (void)registerVideoFrameWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

Parameters

Unregisters a video data output object.

- (void)unregisterVideoSampleWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

Parameters

This callback is triggered when the network connection status changes.

- (void)onConnectionStatusChange:(AliRtcConnectionStatus)status reason:(AliRtcConnectionStatusChangeReason)reason;

Parameters

This callback is triggered when a local device exception occurs. Your application must handle this callback.

- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg;

Parameters

This callback notifies you that the user authentication information is about to expire. The authentication expires 30 seconds after this notification is received. Your application must handle this callback.

- (void)onAuthInfoWillExpire;

This callback is triggered when the server returns an information expiration message because the user called an interface that requires authentication.

- (void)onAuthInfoExpired;

This callback returns the result of joining a channel. This callback is equivalent to the block operation of the `joinChannel` method. You can use either one to handle events after you join a channel.

- (void)onJoinChannelResult:(int)result channel:(NSString *_Nonnull)channel userId:(NSString *_Nonnull)userId elapsed:(int) elapsed;

Parameters

This callback returns the result of joining a channel. This callback is equivalent to the block operation of the `joinChannel` method. You can use either one to handle events after you join a channel.

- (void)onJoinChannelResult:(int)result channel:(NSString *_Nonnull)channel elapsed:(int) elapsed;

Parameters

This callback returns the result of leaving a channel. It is returned after you call the `leaveChannel` method. If you call `destroy` immediately after `leaveChannel`, you will not receive this callback.

- (void)onLeaveChannelResult:(int)result stats:(AliRtcStats)stats;

Parameters

This callback is triggered when a remote user goes offline.

- (void)onRemoteUserOffLineNotify:(NSString *_Nonnull)uid offlineReason:(AliRtcUserOfflineReason)reason;

Parameters

This callback is triggered when a remote user comes online.

- (void)onRemoteUserOnLineNotify:(NSString *_Nonnull)uid elapsed:(int)elapsed;

Parameters

This callback is triggered when a remote user's stream changes.

- (void)onRemoteTrackAvailableNotify:(NSString *_Nonnull)uid audioTrack:(AliRtcAudioTrack)audioTrack videoTrack:(AliRtcVideoTrack)videoTrack;

Parameters

This callback is triggered when the user is kicked out by the server or the channel is closed.

- (void)onBye:(int)code;

Parameters

This callback is triggered when the audio publishing state changes.

- (void)onAudioPublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

This callback is triggered when the audio subscription state changes.

- (void)onAudioSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

This callback notifies you that a user has muted their audio.

- (void)onUserAudioMuted:(NSString *_Nonnull)uid audioMuted:(BOOL)isMute;

Parameters

This callback notifies you that a user's audio has been interrupted. This typically occurs when the audio is preempted by a phone call.

- (void)onUserAudioInterruptedBegin:(NSString *_Nonnull)uid;

Parameters

This callback notifies you that a user's audio interruption has ended.

- (void)onUserAudioInterruptedEnded:(NSString *_Nonnull)uid;

Parameters

This callback is triggered when the video publishing state changes.

- (void)onVideoPublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

This callback is triggered when the camera stream subscription state changes.

- (void)onVideoSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

This callback notifies you that a user has muted their video.

- (void)onUserVideoMuted:(NSString *_Nonnull)uid videoMuted:(BOOL)isMute;

Parameters

This callback notifies you that local video capture has been disabled or re-enabled.

- (void)onUserVideoEnabled:(NSString *_Nullable)uid videoEnabled:(BOOL)isEnable;

Parameters

This callback is triggered when a remote user's application moves to the background.

- (void)onUserWillResignActive:(NSString *_Nonnull)uid;

Parameters

This callback is triggered when a remote user's application returns to the foreground.

- (void)onUserWillBecomeActive:(NSString *_Nonnull)uid;

Parameters

This callback provides real-time data and is triggered every 2 seconds.

- (void)onRtcStats:(AliRtcStats)stats;

Parameters

This callback is triggered when local sound effect playback finishes.

- (void)onAudioEffectFinished:(int)soundId;

Parameters

This callback provides the audio volume, speech status, and UID of the subscribed audio.

- (void)onAudioVolumeCallback:(NSArray <AliRtcUserVolumeInfo *> *_Nullable)array totalVolume:(int)totalVolume;

Parameters

This callback provides the current speaker.

- (void)onActiveSpeaker:(NSString *_Nonnull)uid;

Parameters

This callback is triggered when the bypass stream publishing state changes.

- (void)onPublishLiveStreamStateChanged:(NSString *_Nonnull)streamURL state:(AliRtcLiveTranscodingState)state errCode:(AliRtcTrascodingLiveStreamErrorCode)errCode;

Parameters

This callback is triggered when the bypass task state changes.

- (void)onPublishTaskStateChanged:(NSString *_Nonnull)streamURL state:(AliRtcTrascodingLiveTaskStatus)state;

Parameters

This callback is triggered when the network quality changes.

- (void)onNetworkQualityChanged:(NSString *_Nonnull)uid upNetworkQuality:(AliRtcNetworkQuality)upQuality downNetworkQuality:(AliRtcNetworkQuality)downQuality;

Parameters

This callback provides the result of network quality detection.

- (void)onLastmileDetectResultWithQuality:(AliRtcNetworkQuality)networkQuality;

Parameters

This callback provides the result of network quality detection.

- (void)onLastmileDetectResultWithBandWidth:(int)code result:(AliRtcNetworkQualityProbeResult* _Nonnull)result;

Parameters

This callback is triggered when the audio publishing state changes.

- (void)onAudioPublishStateChanged:(AliRtcAudioTrack)track oldState:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

This callback is triggered when the screen sharing publishing state changes.

- (void)onScreenSharePublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

This callback is triggered when the audio stream subscription state changes.

- (void)onAudioSubscribeStateChanged:(NSString *_Nonnull)uid track:(AliRtcAudioTrack)track oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

This callback is triggered when the screen sharing stream subscription state changes.

- (void)onScreenShareSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

This callback is triggered when the user role changes.

- (void)onUpdateRoleNotifyWithOldRole:(AliRtcClientRole)oldRole newRole:(AliRtcClientRole)newRole;

Parameters

This callback notifies the application if an engine error occurs.

- (void)onOccurError:(int)error message:(NSString *_Nonnull)message;

Parameters

This callback is triggered when the first audio packet is sent.

- (void)onFirstAudioPacketSentWithTimecost:(AliRtcAudioTrack)track timeCost:(int)timeCost;

Parameters

This callback is triggered when the first video frame is received.

- (void)onFirstVideoFrameReceivedWithUid:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack timeCost:(int)timeCost;

Parameters

This callback is triggered when the first video packet is sent.

- (void)onFirstVideoPacketSentWithVideoTrack:(AliRtcVideoTrack)videoTrack timeCost:(int)timeCost;

Parameters

This callback is triggered when the first audio packet is received.

- (void)onFirstAudioPacketReceivedWithUid:(NSString *_Nonnull)uid track:(AliRtcAudioTrack)track timeCost:(int)timeCost;

Parameters

This callback is triggered when the first remote audio frame is decoded.

- (void)onFirstRemoteAudioDecodedWithUid:(NSString *_Nonnull)uid track:(AliRtcAudioTrack)track elapsed:(int)elapsed;

Parameters

This callback is triggered when the first video frame of a remote user is displayed.

- (void)onFirstRemoteVideoFrameDrawn:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack width:(int)width height:(int)height elapsed:(int)elapsed;

Parameters

This callback is triggered when the first video frame is displayed in the preview.

- (void)onFirstLocalVideoFrameDrawn:(int)width height:(int)height elapsed:(int)elapsed;

Parameters

This callback provides the volume from the pre-call audio capture test.

- (void)onTestAudioVolumeCallback:(int)volume;

Parameters

This callback provides the local accompaniment playback state.

- (void)onAudioAccompanyStateChanged:(AliRtcAudioAccompanyStateCode)playState errorCode:(AliRtcAudioAccompanyErrorCode)errorCode;

Parameters

Occurs when a remote user starts accompaniment playback.

- (void)onRemoteAudioAccompanyStarted:(NSString *_Nonnull)uid;

Parameters

This callback is triggered when a remote user finishes accompaniment playback.

- (void)onRemoteAudioAccompanyFinished:(NSString *_Nonnull)uid;

Parameters