BMXRTCEngine Class Reference#

Inherits from NSObject
Declared in floo_proxy.h

Overview#

@interface RTC Engine

Properties#

swigCMemOwn#

@property (nonatomic) BOOL swigCMemOwn

swigCPtr#

@property (nonatomic) void *swigCPtr

Instance Methods#

addDelegate:#

添加聊天監聽者

- (void)addDelegate:(id<BMXRTCEngineProtocol>)aDelegate

Parameters#

listener
聊天監聽者

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="addDelegate:" %}{% endlanying_code_snippet %}

addDelegate:delegateQueue:#

- (void)addDelegate:(id<BMXRTCEngineProtocol>)aDelegate delegateQueue:(dispatch_queue_t)aQueue

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="addDelegate:delegateQueue:" %}{% endlanying_code_snippet %}

addRTCEngineListener:#

- (void)addRTCEngineListener:(id<BMXRTCEngineProtocol>)listener

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="addRTCEngineListener:" %}{% endlanying_code_snippet %}

dealloc#

- (void)dealloc

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="dealloc" %}{% endlanying_code_snippet %}

destroy#

銷燬音視訊Engine

- (void)destroy

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="destroy" %}{% endlanying_code_snippet %}

getRTCConfig#

取得RTC設定

- (BMXRTCConfig *)getRTCConfig

Return Value#

BMXRTCConfig

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="getRTCConfig" %}{% endlanying_code_snippet %}

initWithCptr:swigOwnCObject:#

- (id)initWithCptr:(void )cptr swigOwnCObject:(BOOL)ownCObject*

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="initWithCptr:swigOwnCObject:" %}{% endlanying_code_snippet %}

joinRoomWithAuth:#

加入頻道

- (BMXErrorCode)joinRoomWithAuth:(BMXRoomAuth )auth*

Parameters#

auth
加入頻道時的認證信息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="joinRoomWithAuth:" %}{% endlanying_code_snippet %}

leaveRoom#

離開頻道

- (BMXErrorCode)leaveRoom

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="leaveRoom" %}{% endlanying_code_snippet %}

muteLocalAudioWithMute:#

打開關閉本地音訊

- (BMXErrorCode)muteLocalAudioWithMute:(BOOL)mute

Parameters#

mute
true為打開，false為關閉

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="muteLocalAudioWithMute:" %}{% endlanying_code_snippet %}

muteLocalVideoWithType:mute:#

打開關閉本地視訊

- (BMXErrorCode)muteLocalVideoWithType:(BMXVideoMediaType)type mute:(BOOL)mute

Parameters#

type
視訊流類型

mute
true為打開，false為關閉

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="muteLocalVideoWithType:mute:" %}{% endlanying_code_snippet %}

muteRemoteAudioWithStream:mute:#

打開關閉遠端音訊

- (BMXErrorCode)muteRemoteAudioWithStream:(BMXStream )stream mute:(BOOL)mute*

Parameters#

stream
遠端流

mute
true為打開，false為關閉

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="muteRemoteAudioWithStream:mute:" %}{% endlanying_code_snippet %}

muteRemoteVideoWithStream:mute:#

打開關閉遠端視訊

- (BMXErrorCode)muteRemoteVideoWithStream:(BMXStream )stream mute:(BOOL)mute*

Parameters#

stream
遠端流

mute
true為打開，false為關閉

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="muteRemoteVideoWithStream:mute:" %}{% endlanying_code_snippet %}

publishWithType:hasVideo:hasAudio:#

發佈流信息

- (BMXErrorCode)publishWithType:(BMXVideoMediaType)type hasVideo:(BOOL)hasVideo hasAudio:(BOOL)hasAudio

Parameters#

type
流媒體類型

hasVideo
是否存在視訊流

hasAudio
是否存在音訊流

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="publishWithType:hasVideo:hasAudio:" %}{% endlanying_code_snippet %}

removeDelegate:#

移除聊天監聽者

- (void)removeDelegate:(id<BMXRTCEngineProtocol>)aDelegate

Parameters#

listener
聊天監聽者

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="removeDelegate:" %}{% endlanying_code_snippet %}

removeRTCEngineListener:#

- (void)removeRTCEngineListener:(id<BMXRTCEngineProtocol>)listener

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="removeRTCEngineListener:" %}{% endlanying_code_snippet %}

setAudioProfile:#

設定音訊編碼格式

- (BMXErrorCode)setAudioProfile:(BMXAudioProfile)profile

Parameters#

profile
音訊編碼格式

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="setAudioProfile:" %}{% endlanying_code_snippet %}

setRoomType:#

設定Room的類型

- (BMXErrorCode)setRoomType:(BMXRoomType)type

Parameters#

type
Room類型

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="setRoomType:" %}{% endlanying_code_snippet %}

setStreamRole:#

設定流操作權限

- (BMXErrorCode)setStreamRole:(BMXStreamRole)role

Parameters#

role
操作權限，推流、拉流、推拉流。

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="setStreamRole:" %}{% endlanying_code_snippet %}

setVideoCodec:#

設定視訊編碼格式類型

- (BMXErrorCode)setVideoCodec:(BMXVideoCodec)codec

Parameters#

codec
VP8編碼、H264編碼

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="setVideoCodec:" %}{% endlanying_code_snippet %}

setVideoProfile:#

設定視訊編碼格式類型

- (BMXErrorCode)setVideoProfile:(BMXVideoConfig )videoConfig*

Parameters#

codec
VP8編碼、H264編碼

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="setVideoProfile:" %}{% endlanying_code_snippet %}

startPreviewWithCanvas:#

開啟本地渲染

- (BMXErrorCode)startPreviewWithCanvas:(BMXVideoCanvas )canvas*

Parameters#

canvas
畫布屬性信息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="startPreviewWithCanvas:" %}{% endlanying_code_snippet %}

startRemoteViewWithCanvas:#

開啟遠端渲染

- (BMXErrorCode)startRemoteViewWithCanvas:(BMXVideoCanvas )canvas*

Parameters#

canvas
畫布屬性信息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="startRemoteViewWithCanvas:" %}{% endlanying_code_snippet %}

stopPreviewWithCanvas:#

停止本地渲染

- (BMXErrorCode)stopPreviewWithCanvas:(BMXVideoCanvas )canvas*

Parameters#

canvas
畫布屬性信息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="stopPreviewWithCanvas:" %}{% endlanying_code_snippet %}

stopRemoteViewWithCanvas:#

停止遠端渲染

- (BMXErrorCode)stopRemoteViewWithCanvas:(BMXVideoCanvas )canvas*

Parameters#

canvas
畫布屬性信息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="stopRemoteViewWithCanvas:" %}{% endlanying_code_snippet %}

subscribeWithStream:#

訂閱流信息

- (BMXErrorCode)subscribeWithStream:(BMXStream )stream*

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="subscribeWithStream:" %}{% endlanying_code_snippet %}

switchCamera#

切換攝像頭

- (BMXErrorCode)switchCamera

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="switchCamera" %}{% endlanying_code_snippet %}

unPublishWithType:#

停止發佈流

- (BMXErrorCode)unPublishWithType:(BMXVideoMediaType)type

Parameters#

type
流媒體類型

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="unPublishWithType:" %}{% endlanying_code_snippet %}

unSubscribeWithStream:#

停止訂閱流

- (BMXErrorCode)unSubscribeWithStream:(BMXStream )stream*

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXRTCEngine",function="unSubscribeWithStream:" %}{% endlanying_code_snippet %}