API reference for iOS

List of operations by function

AUIRoomEngine

The AUIRoomEngine API is a non-UI interface for audio and video call components. If the existing interaction does not meet your business requirements, you can use the API to encapsulate custom API operations based on your business requirements.

Static members or methods

The following table lists the API operations about the static members or methods under AUIRoomEngine.

AUIRoomEngineDelegate

AUIRoomEngineDelegate is an API of channel engine callback events. You can use the callback method to listen for the callback events that you are interested in.

AUIRoomRenderView

The following table lists the API operations about video rendering views.

AUIRoomRenderViewDefaultLayout

The following table lists the API operations about a layout container that is used to manage video rendering views.

AUIRoomEngine

The AUIRoomEngine API is a non-UI interface for audio and video call components. If the existing interaction does not meet your business requirements, you can use the API to encapsulate custom API operations based on your business requirements.

init: the constructor used to create and initialize a RoomEngine instance.

override public init()

destroy: releases the related objects within a RoomEngine instance.

public func destroy()

addObserver: adds the observer that listens for a channel event callback.

public func addObserver(delegate: AUIRoomEngine.AUIRoomEngineDelegate)

removeObserver: removes the observer that listens for a channel event callback.

public func removeObserver(delegate: AUIRoomEngine.AUIRoomEngineDelegate)

roomUser: obtains the current channel user.

lazy public private(set) var roomUser: AUIRoomEngine.AUIRoomUser?

roomConfig: obtains channel configurations.

public private(set) var roomConfig: AUIRoomEngine.AUIRoomEngineConfig? { get }

renderViewLayout: sets or obtains video rendering views in a layout container.

public var renderViewLayout: AUIRoomEngine.AUIRoomRenderViewLayoutProtocol?

startPreview: starts the preview.

public func startPreview(completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

stopPreview: stops the preview.

public func stopPreview(completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

create: creates a channel.

public func create(completed: @escaping (_ roomId: String?, _ error: NSError?) -> Void)

join: joins a channel.

public func join(config: AUIRoomEngine.AUIRoomEngineConfig, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

leave: leaves a channel.

public func leave(completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

isJoin: specifies whether to join a channel.

public var isJoin: Bool { get }

requestJoin: invites other users to join a channel.

public func requestJoin(roomId: String, userId: String, extra: [AnyHashable : Any]? = nil, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

cancelRequestJoin: cancels a request for inviting other users to join a channel.

public func cancelRequestJoin(roomId: String, userId: String, extra: [AnyHashable : Any]? = nil, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

responseJoin: responds to an invitation to join a channel.

public func responseJoin(roomId: String, userId: String, agree: Bool, extra: [AnyHashable : Any]? = nil, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

startPublish: starts stream ingest.

public func startPublish(completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

stopPublish: stops stream ingest.

public func stopPublish(completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

isPublishing: determines whether a stream is being ingested.

public private(set) var isPublishing: Bool { get }

requestPublish: invites other users to ingest streams.

public func requestPublish(userId: String, extra: [AnyHashable : Any]? = nil, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

cancelRequestPublish: cancels a request for inviting other users to ingest streams.

public func cancelRequestPublish(userId: String, extra: [AnyHashable : Any]? = nil, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

responsePublish: responds to a stream ingest invitation.

public func responsePublish(userId: String, agree: Bool, extra: [AnyHashable : Any]? = nil, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

switchCamera: enables or disables the camera.

public func switchCamera(off: Bool, userId: String, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

switchMicrophone: enables or disables the microphone.

public func switchMicrophone(off: Bool, userId: String, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

switchPreviewMirror: enables or disables the mirroring mode for the preview.

public func switchPreviewMirror(on: Bool)

getIsPreviewMirror: determines whether the mirroring mode is enabled for the preview.

public func getIsPreviewMirror() -> Bool

setCameraType: switches between the front and rear cameras.

public func setCameraType(type: AUIRoomEngine.AUIRoomEngineCameraType)

getCameraType: obtains the current camera type, which is the front camera or the rear camera.

public func getCameraType() -> AUIRoomEngine.AUIRoomEngineCameraType

switchAudioOutput: switches the audio output type. You can set the speaker or the handset as the audio output device.

public func switchAudioOutput(type: AUIRoomEngine.AUIRoomEngineAudioOutputType)

getAudioOutputType: obtains the audio output type. You can set the speaker or the handset as the audio output device.

public func getAudioOutputType() -> AUIRoomEngine.AUIRoomEngineAudioOutputType

sendCustomMessage: sends a custom message to a user.

public func sendCustomMessage(message: [AnyHashable : Any], roomId: String?, userId: String? = nil, skipAudit: Bool = true, completed: AUIRoomEngine.AUIRoomEngineCompleted? = nil)

getRTCEngine: obtains an underlying RTC engine instance.

public func getRTCEngine() -> AnyObject?

registerSDK: registers an SDK.

public static func registerSDK(scene: String)

currrentUser: obtains or sets the current logon user.

public static var currrentUser: AUIRoomEngine.AUIRoomUser?

login: logs on to the ApsaraVideo MediaBox SDK app.

public static func login(token: String, completed: AUIRoomEngine.AUIRoomEngineCompleted?)

The following table describes the parameters in the previous syntax.

logout: logs off from the ApsaraVideo MediaBox SDK app.

public static func logout(completed: AUIRoomEngine.AUIRoomEngineCompleted?)

isLogin: specifies whether to log on to the ApsaraVideo MediaBox SDK app.

public static var isLogin: Bool { get }

getMessageService: obtains an interactive messaging instance.

public static func getMessageService() -> AUIMessageServiceProtocol

AUIRoomEngineDelegate

AUIRoomEngineDelegate is an API of channel engine callback events. You can use the callback method to listen for the callback events that you are interested in.

onJoined: the callback that is triggered when a user joins a channel.

@objc optional func onJoined(user: AUIRoomEngine.AUIRoomUser)

onLeaved: the callback that is triggered when a user leaves a channel.

@objc optional func onLeaved(user: AUIRoomEngine.AUIRoomUser)

onReceivedRequestJoin: the callback that is triggered when an invitation to join a channel is received.

@objc optional func onReceivedRequestJoin(user: AUIRoomEngine.AUIRoomUser, roomId: String, extra: [AnyHashable : Any]?)

onReceivedCancelRequestJoin: the callback that is triggered when an invitation to join a channel is canceled.

@objc optional func onReceivedCancelRequestJoin(user: AUIRoomEngine.AUIRoomUser, roomId: String, extra: [AnyHashable : Any]?)

onReceivedResponseJoin: the callback that is triggered when the response indicating that an invitee joins a channel is received.

@objc optional func onReceivedResponseJoin(user: AUIRoomEngine.AUIRoomUser, roomId: String, agree: Bool, extra: [AnyHashable : Any]?)

onStartedPublish: the callback that is triggered when the response indicating that a user starts stream ingest is received.

@objc optional func onStartedPublish(user: AUIRoomEngine.AUIRoomUser)

onStopedPublish: the callback that is triggered when the response indicating that a user stops stream ingest is received.

@objc optional func onStopedPublish(user: AUIRoomEngine.AUIRoomUser)

onReceivedRequestPublish: the callback that is triggered when a stream ingest invitation is received.

@objc optional func onReceivedRequestPublish(user: AUIRoomEngine.AUIRoomUser, extra: [AnyHashable : Any]?, completed: @escaping (_ agree: Bool, _ extra: [AnyHashable : Any]?) -> Void)

onReceivedCancelRequestPublish: the callback that is triggered when a stream ingest invitation is canceled.

@objc optional func onReceivedCancelRequestPublish(user: AUIRoomEngine.AUIRoomUser, extra: [AnyHashable : Any]?)

onReceivedResponsePublish: the callback that is triggered when the response indicating that an invitee ingests a stream is received.

@objc optional func onReceivedResponsePublish(user: AUIRoomEngine.AUIRoomUser, agree: Bool, extra: [AnyHashable : Any]?)

onReceivedMicrophoneStateChanged: the callback that is triggered when a request for switching the microphone status is received.

@objc optional func onReceivedMicrophoneStateChanged(user: AUIRoomEngine.AUIRoomUser, off: Bool)

onReceivedCameraStateChanged: the callback that is triggered when a request for switching the camera status is received.

@objc optional func onReceivedCameraStateChanged(user: AUIRoomEngine.AUIRoomUser, off: Bool)

onMicrophoneStateChanged: the callback that is triggered when an audio stream changes between the muted and unmuted states.

@objc optional func onMicrophoneStateChanged(user: AUIRoomEngine.AUIRoomUser, off: Bool)

onCameraStateChanged: the callback that is triggered when a black video frame is sent in a video stream.

@objc optional func onCameraStateChanged(user: AUIRoomEngine.AUIRoomUser, off: Bool)

onReceivedCustomMessage: the callback that is triggered when a custom message is received.

@objc optional func onReceivedCustomMessage(user: AUIRoomEngine.AUIRoomUser, message: [AnyHashable : Any])

onError: the callback that is triggered when an error occurs.

@objc optional func onError(_ error: Error)

AUIRoomRenderView

The section lists the API operations about video rendering views.

style: sets or obtains the view style. The view style is a normal view, large view, or small view.

open var style: AUIRoomEngine.AUIRoomRenderView.Style

user: obtains the current user who ingests and pulls a stream.

public let user: AUIRoomEngine.AUIRoomUser

displayView: obtains the current rendering view.

public let displayView: UIView

renderMode: obtains the rendering mode of the current rendering view. The rendering mode is the auto mode, stretching mode, padding mode, or cropping mode.

public var renderMode: AUIRoomEngine.AUIRoomRenderView.RenderMode

AUIRoomRenderViewDefaultLayout

The section lists the API operations about a layout container that is used to manage video rendering views.

dimensions: obtains the resolution of a rendering view.

public private(set) var dimensions: CGSize { get }

getRenderViewList: obtains video rendering views.

public func getRenderViewList() -> [AUIRoomEngine.AUIRoomRenderView]

createRenderView: creates a video rendering view.

open func createRenderView(user: AUIRoomEngine.AUIRoomUser) -> AUIRoomEngine.AUIRoomRenderView?

createRenderViewCallback: creates a video rendering view by using a callback method.

public var createRenderViewCallback: ((_ user: AUIRoomEngine.AUIRoomUser, _ dimensions: CGSize?) -> AUIRoomEngine.AUIRoomRenderView?)?

willInsertRenderView: is about to insert a rendering view into a layout container.

open func willInsertRenderView(renderView: AUIRoomEngine.AUIRoomRenderView) -> Int

insertRenderView: inserts a rendering view into a layout container.

open func insertRenderView(renderView: AUIRoomEngine.AUIRoomRenderView)

removeRenderView: removes a rendering view from a layout container.

open func removeRenderView(renderView: AUIRoomEngine.AUIRoomRenderView)

willLayoutRenderViewList: is about to implement the layout of video rendering views in a container.

open func willLayoutRenderViewList()

layoutRenderViewList: implements the layout of video rendering views in a container.

open func layoutRenderViewList()

smallStyleRenderViewDefaultFrame: obtains the size of a rendering view when the rendering view is set as a small view.

open var smallStyleRenderViewDefaultFrame: CGRect { get }

smallStyleRenderViewSafeEdge: obtains the margin of a rendering view in a layout container when the rendering view is set as a small view.

open var smallStyleRenderViewSafeEdge: UIEdgeInsets { get }