RCCallSession Class Reference

Inherits from	NSObject
Declared in	RCCallSession.h

`conversationType`

通话的会话类型

@property (nonatomic, assign, readonly) RCConversationType conversationType

Discussion

通话的会话类型

Declared In

RCCallSession.h

`callId`

通话ID

@property (nonatomic, strong, readonly, nullable) NSString *callId

Discussion

通话ID

Declared In

RCCallSession.h

`targetId`

通话的目标会话ID

@property (nonatomic, strong, readonly, nullable) NSString *targetId

Discussion

通话的目标会话ID

Declared In

RCCallSession.h

`sessionId`

RTC会话唯一标识, 用于 Server API

@property (nonatomic, strong, readonly, nullable) NSString *sessionId

Discussion

RTC会话唯一标识, 用于 Server API

Declared In

RCCallSession.h

`multiCall`

是否是多方通话

@property (nonatomic, assign, readonly, getter=isMultiCall) BOOL multiCall

Discussion

是否是多方通话

Declared In

RCCallSession.h

`extra`

通话的扩展信息

@property (nonatomic, strong, readonly, nullable) NSString *extra

Discussion

通话的扩展信息

Declared In

RCCallSession.h

`callStatus`

通话的当前状态

@property (nonatomic, assign, readonly) RCCallStatus callStatus

Discussion

通话的当前状态

Declared In

RCCallSession.h

`caller`

通话的最初发起人

@property (nonatomic, strong, readonly, nullable) NSString *caller

Discussion

通话的最初发起人

Declared In

RCCallSession.h

`inviter`

邀请当前用户加入通话的邀请者

@property (nonatomic, strong, readonly, nullable) NSString *inviter

Discussion

邀请当前用户加入通话的邀请者

Declared In

RCCallSession.h

`userProfileList`

当前的用户列表

@property (nonatomic, strong, readonly, nullable) NSArray<RCCallUserProfile*> *userProfileList

Discussion

当前的用户列表

Declared In

RCCallSession.h

`myProfile`

自己的状态

@property (nonatomic, strong, readonly, nullable) RCCallUserProfile *myProfile

Discussion

自己的状态

Declared In

RCCallSession.h

`mediaType`

当前用户使用的媒体类型

@property (nonatomic, assign, readonly) RCCallMediaType mediaType

Discussion

当前用户使用的媒体类型

Declared In

RCCallSession.h

`startTime`

通话开始的时间

@property (nonatomic, assign, readonly) long long startTime

Discussion

通话开始的时间

如果是用户呼出的通话，则startTime为通话呼出时间；如果是呼入的通话，则startTime为通话呼入时间。

Declared In

RCCallSession.h

`connectedTime`

通话接通时间

@property (nonatomic, assign, readonly) long long connectedTime

Discussion

通话接通时间

Declared In

RCCallSession.h

`disconnectReason`

通话挂断原因

@property (nonatomic, assign) RCCallDisconnectReason disconnectReason

Discussion

通话挂断原因

Declared In

RCCallSession.h

`– setDelegate:`

设置通话状态变化的监听器

- (void)setDelegate:(id<RCCallSessionDelegate>)delegate DEPRECATED_MSG_ATTRIBUTE ( "please call method addDelegate:" )

Parameters

`delegate`	通话状态变化的监听器 @discussion 设置通话状态变化的监听器 @warning 已废弃, 请使用 addDelegate: @remarks 通话设置

delegate

通话状态变化的监听器 @discussion 设置通话状态变化的监听器

@warning 已废弃, 请使用 addDelegate:

@remarks 通话设置

Discussion

设置通话状态变化的监听器

Declared In

RCCallSession.h

`– addDelegate:`

添加通话状态的监听器, 支持多代理

- (void)addDelegate:(id<RCCallSessionDelegate>)delegate

Parameters

`delegate`	通话状态变化的监听器 @discussion 添加通话状态的监听器, 支持多代理 @remarks 通话设置

delegate

通话状态变化的监听器 @discussion 添加通话状态的监听器, 支持多代理

@remarks 通话设置

Discussion

添加通话状态的监听器, 支持多代理

Declared In

RCCallSession.h

`– removeDelegate:`

删除通话状态的监听器

- (void)removeDelegate:(id<RCCallSessionDelegate>)delegate

Parameters

`delegate`	通话状态的监听器 @discussion 删除通话状态的监听器 @remarks 通话设置

delegate

通话状态的监听器 @discussion 删除通话状态的监听器

@remarks 通话设置

Discussion

删除通话状态的监听器

Declared In

RCCallSession.h

`– allDelegates`

获取所有的监听器

- (NSArray<id<RCCallSessionDelegate> > *)allDelegates

Return Value

所有注册的代理数组

Discussion

获取所有的监听器

@discussion 获取所有的监听器

@remarks 通话设置

Declared In

RCCallSession.h

`– accept:`

接听来电

- (void)accept:(RCCallMediaType)type

Parameters

`type`	接听使用的媒体类型 @discussion 接听来电 @remarks 通话管理

type

接听使用的媒体类型 @discussion 接听来电

@remarks 通话管理

Discussion

接听来电

Declared In

RCCallSession.h

`– hangup`

挂断通话

- (void)hangup

Discussion

挂断通话

@discussion 挂断通话

@remarks 通话管理

Declared In

RCCallSession.h

`– hangup:`

挂断通话

- (void)hangup:(nullable void ( ^ ) ( BOOL isSuccess , NSInteger code ))block

Parameters

`block`	挂断消息发送回调 @discussion 挂断通话 @remarks 通话管理

block

挂断消息发送回调

@discussion 挂断通话

@remarks 通话管理

Discussion

挂断通话

Declared In

RCCallSession.h

`– publishMediaResource:complete:`

观察者身份用户, 发布自己的音视频资源

- (void)publishMediaResource:(RCCallMediaType)mediaType complete:(nullable void ( ^ ) ( BOOL isSuccess , NSInteger code ))block

Parameters

`mediaType`	发布的媒体类型
`block`	发布完成的回调 @discussion 观察者身份用户, 发布自己的音视频资源 @warning 只有观察者用户可以发布音视频资源 @remarks 资源管理

mediaType

发布的媒体类型

block

发布完成的回调 @discussion 观察者身份用户, 发布自己的音视频资源

@warning 只有观察者用户可以发布音视频资源

@remarks 资源管理

Discussion

观察者身份用户, 发布自己的音视频资源

Declared In

RCCallSession.h

`– unPublishMediaResource:`

正常身份用户, 取消发布自己的音视频资源

- (void)unPublishMediaResource:(nullable void ( ^ ) ( BOOL isSuccess , NSInteger code ))block

Parameters

`block`	取消发布完成的回调 @discussion 正常身份用户, 取消发布自己的音视频资源 @warning 只有正常用户可以取消发布音视频资源 @remarks 资源管理

block

取消发布完成的回调 @discussion 正常身份用户, 取消发布自己的音视频资源

@warning 只有正常用户可以取消发布音视频资源

@remarks 资源管理

Discussion

正常身份用户, 取消发布自己的音视频资源

Declared In

RCCallSession.h

`– inviteRemoteUsers:mediaType:`

邀请用户加入通话

- (void)inviteRemoteUsers:(nullable NSArray<NSString*> *)userIdList mediaType:(RCCallMediaType)type

Parameters

`userIdList`	用户ID列表
`type`	建议被邀请者使用的媒体类型 @discussion 邀请用户加入通话 @remarks 通话管理

userIdList

用户ID列表

type

建议被邀请者使用的媒体类型 @discussion 邀请用户加入通话

@remarks 通话管理

Discussion

邀请用户加入通话

Declared In

RCCallSession.h

`– inviteRemoteUsers:observerIdList:mediaType:`

邀请用户加入通话

- (void)inviteRemoteUsers:(nullable NSArray<NSString*> *)userIdList observerIdList:(nullable NSArray<NSString*> *)observerIdList mediaType:(RCCallMediaType)type

Parameters

`userIdList`	用户ID列表
`observerIdList`	需要以观察者身份加入房间的用户ID列表
`type`	建议被邀请者使用的媒体类型 @discussion 邀请用户加入通话 @remarks 通话管理

userIdList

用户ID列表

observerIdList

需要以观察者身份加入房间的用户ID列表

type

建议被邀请者使用的媒体类型 @discussion 邀请用户加入通话

@remarks 通话管理

Discussion

邀请用户加入通话

Declared In

RCCallSession.h

`– setVideoView:userId:`

设置用户所在的视频View

- (void)setVideoView:(nullable UIView *)view userId:(nullable NSString *)userId

Parameters

`view`	视频的View @discussion 设置用户所在的视频View @remarks 视频配置
`userId`	用户ID（自己或他人）

view

视频的View @discussion 设置用户所在的视频View

@remarks 视频配置

userId

用户ID（自己或他人）

Discussion

设置用户所在的视频View

Declared In

RCCallSession.h

`– setMultiPlatformVideoView:userId:`

设置用户所在的视频View

- (int)setMultiPlatformVideoView:(nullable id<RCRTCDrawer>)view userId:(nullable NSString *)userId

Parameters

`view`	继承RCRTCDrawer 接口视频的View @discussion 设置用户所在的视频View 注意： 1.此接口需要RCCallClient中enableMultiPlatformMode设置为YES方可使用 2. view 的生命周期自己处理 @remarks 视频配置
`userId`	用户ID（自己或他人）

view

继承RCRTCDrawer 接口视频的View @discussion 设置用户所在的视频View 注意： 1.此接口需要RCCallClient中enableMultiPlatformMode设置为YES方可使用 2. view 的生命周期自己处理

@remarks 视频配置

userId

用户ID（自己或他人）

Discussion

设置用户所在的视频View

Declared In

RCCallSession.h

`– setVideoView:userId:renderMode:`

设置用户所在的视频View

- (void)setVideoView:(nullable UIView *)view userId:(nullable NSString *)userId renderMode:(RCCallRenderModel)renderMode

Parameters

`view`	userId 用户ID（自己或他人)
`userId`	视频的View
`renderMode`	视频显示模式 (默认为RCCallRenderModelHidden) @discussion 设置用户所在的视频View @remarks 视频配置

view

userId 用户ID（自己或他人)

userId

视频的View

renderMode

视频显示模式 (默认为RCCallRenderModelHidden) @discussion 设置用户所在的视频View

@remarks 视频配置

Discussion

设置用户所在的视频View

Declared In

RCCallSession.h

`– changeMediaType:`

更换自己使用的媒体类型

- (BOOL)changeMediaType:(RCCallMediaType)type

Parameters

`type`	媒体类型 @discussion 更换自己使用的媒体类型 @remarks 通话管理

type

媒体类型 @discussion 更换自己使用的媒体类型

@remarks 通话管理

Discussion

更换自己使用的媒体类型

Declared In

RCCallSession.h

`isMuted`

静音状态

@property (nonatomic, readonly) BOOL isMuted

Discussion

静音状态

Declared In

RCCallSession.h

`– setMuted:`

设置静音状态

- (BOOL)setMuted:(BOOL)muted

Parameters

`muted`	是否静音, 默认值为NO @discussion 设置静音状态 @remarks 音频配置

muted

是否静音, 默认值为NO @discussion 设置静音状态

@remarks 音频配置

Return Value

是否设置成功

Discussion

设置静音状态

Declared In

RCCallSession.h

`minimized`

是否有最小化窗口

@property (nonatomic, readonly) BOOL minimized

Discussion

是否有最小化窗口

Declared In

RCCallSession.h

`– setMinimized:`

设置是否有最小化窗口状态

- (void)setMinimized:(BOOL)minimized

Parameters

`minimized`	是否最小化 @discussion 设置是否有最小化窗口状态 @remarks 通话设置

minimized

是否最小化 @discussion 设置是否有最小化窗口状态

@remarks 通话设置

Discussion

设置是否有最小化窗口状态

Declared In

RCCallSession.h

`speakerEnabled`

扬声器状态，是否开启扬声器

@property (nonatomic, readonly) BOOL speakerEnabled

Discussion

扬声器状态，是否开启扬声器

默认值为NO。

Declared In

RCCallSession.h

`– setSpeakerEnabled:`

设置扬声器状态

- (BOOL)setSpeakerEnabled:(BOOL)speakerEnabled

Parameters

`speakerEnabled`	是否开启扬声器 @discussion 设置扬声器状态 @remarks 音频配置

speakerEnabled

是否开启扬声器 @discussion 设置扬声器状态

@remarks 音频配置

Return Value

是否设置成功

Discussion

设置扬声器状态

Declared In

RCCallSession.h

`cameraEnabled`

摄像头状态，是否开启摄像头

@property (nonatomic, readonly) BOOL cameraEnabled

Discussion

摄像头状态，是否开启摄像头

Declared In

RCCallSession.h

`– setCameraEnabled:`

设置摄像头状态

- (BOOL)setCameraEnabled:(BOOL)cameraEnabled

Parameters

`cameraEnabled`	是否开启摄像头 @discussion 音频通话的默认值为NO，视频通话的默认值为YES。 @remarks 视频配置

cameraEnabled

是否开启摄像头 @discussion 音频通话的默认值为NO，视频通话的默认值为YES。

@remarks 视频配置

Return Value

是否设置成功

Discussion

设置摄像头状态

Declared In

RCCallSession.h

`– switchCameraMode`

切换前后摄像头

- (BOOL)switchCameraMode

Return Value

是否切换成功

Discussion

切换前后摄像头

@discussion 切换前后摄像头

@remarks 视频配置

Declared In

RCCallSession.h

RCCallSession Class Reference

Overview

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Return Value

Discussion

Declared In

Parameters

Discussion

Declared In

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Parameters

Discussion

Declared In

Discussion

Declared In

Parameters

Return Value