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:

Add a RTC engine listener

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

Parameters

listener

Declared In

• floo_proxy.h

Example:

addDelegate:delegateQueue:

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

Example:

addRTCEngineListener:

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

Example:

dealloc

- (void)dealloc

Example:

destroy

Destroy the RTC engine

- (void)destroy

Declared In

• floo_proxy.h

Example:

getRTCConfig

Get RTC config

- (BMXRTCConfig *)getRTCConfig

Return Value

BMXRTCConfig

Declared In

• floo_proxy.h

Example:

initWithCptr:swigOwnCObject:

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

Example:

joinRoomWithAuth:

Join a room

- (BMXErrorCode)joinRoomWithAuth:(BMXRoomAuth *)*auth*

Parameters

auth
Authorization information

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

leaveRoom

Leave a room

- (BMXErrorCode)leaveRoom

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

muteLocalAudioWithMute:

Mute or unmute my audio

- (BMXErrorCode)muteLocalAudioWithMute:(BOOL)*mute*

Parameters

mute

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

muteLocalVideoWithType:mute:

Mute or unmute my video

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

Parameters

type
Video media type

mute

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

muteRemoteAudioWithStream:mute:

Mute or unmute remote video

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

Parameters

stream

mute

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

muteRemoteVideoWithStream:mute:

Mute or unmute remote video

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

Parameters

stream

mute

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

publishWithType:hasVideo:hasAudio:

Publish my video and audio streams

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

Parameters

type
Stream type

hasVideo

hasAudio

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

removeDelegate:

Remove a RTC engine listener

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

Parameters

listener

Declared In

• floo_proxy.h

Example:

removeRTCEngineListener:

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

Example:

setAudioProfile:

Set audio settings

- (BMXErrorCode)setAudioProfile:(BMXAudioProfile)*profile*

Parameters

profile

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setRoomType:

Set the room type

- (BMXErrorCode)setRoomType:(BMXRoomType)*type*

Parameters

type
Room类型

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setStreamRole:

Set stream operation permissions

- (BMXErrorCode)setStreamRole:(BMXStreamRole)*role*

Parameters

role

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setVideoCodec:

Set video codec

- (BMXErrorCode)setVideoCodec:(BMXVideoCodec)*codec*

Parameters

codec

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

setVideoProfile:

Set video codec

- (BMXErrorCode)setVideoProfile:(BMXVideoConfig *)*videoConfig*

Parameters

codec

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

startPreviewWithCanvas:

Start previewing local video

- (BMXErrorCode)startPreviewWithCanvas:(BMXVideoCanvas *)*canvas*

Parameters

canvas

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

startRemoteViewWithCanvas:

Start previewing remote video

- (BMXErrorCode)startRemoteViewWithCanvas:(BMXVideoCanvas *)*canvas*

Parameters

canvas

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

stopPreviewWithCanvas:

Stop previewing local video

- (BMXErrorCode)stopPreviewWithCanvas:(BMXVideoCanvas *)*canvas*

Parameters

canvas

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

stopRemoteViewWithCanvas:

Stop previewing remote video

- (BMXErrorCode)stopRemoteViewWithCanvas:(BMXVideoCanvas *)*canvas*

Parameters

canvas

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

subscribeWithStream:

Subscribe a stream

- (BMXErrorCode)subscribeWithStream:(BMXStream *)*stream*

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

switchCamera

Switch cameras

- (BMXErrorCode)switchCamera

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

unPublishWithType:

Unpublish my video and audio streams

- (BMXErrorCode)unPublishWithType:(BMXVideoMediaType)*type*

Parameters

type
Stream type

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example:

unSubscribeWithStream:

Unsubscribe a stream

- (BMXErrorCode)unSubscribeWithStream:(BMXStream *)*stream*

Return Value

BMXErrorCode

Declared In

• floo_proxy.h

Example: