IChannel

Public 成员函数
virtual int	join ()=0
virtual int	leave ()=0
virtual int	setLevel (int nLevel)=0
virtual int	getLevel ()=0
virtual int	setPushAudioQuality (int nQuality)=0
virtual int	setPullAudioQuality (int nQuality)=0
virtual int	pushToTalk (int nTalkOnTime)=0
virtual int	stopPushToTalk ()=0
virtual int	muteAllRemoteAudio (bool bMute)=0
virtual int	breakTalk ()=0
virtual int	enableAudioStream (bool bEnable)=0
virtual const char *	getId () const =0
virtual void	release ()=0

Protected 成员函数
virtual	~IChannel ()

构造及析构函数说明

~IChannel

virtual ~IChannel()

成员函数说明

getId

virtual const char *getId() const

获取当前频道 ID。

返回

当前频道 ID。

join

virtual int join()

加入频道

• 方法调用成功：
  • 本地用户收到回调 onJoinSuccess。
  • 所有远端用户收到回调 onMemberJoined。
• 方法调用失败：本地用户收到回调 onJoinFailure。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

注意事项：

• 同一用户只能同时加入最多 20 个频道。加入频道超限时用户会收到错误码 JOIN_CHANNEL_ERR_FAILURE。

leave

virtual int leave()

离开频道

• 方法调用成功：
  • 本地用户收到回调 onLeave 的 LEAVE_CHANNEL_ERR_OK 状态。
• 方法调用失败：本地用户收到回调 onLeave的错误代码。错误代码信息详见 LEAVE_CHANNEL_ERR。

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。错误码详见 LEAVE_CHANNEL_ERR 。

setLevel

virtual int setLevel(int nLevel)

设置等级

参数

参数	说明
nLevel	等级，值越小等级越大

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

getLevel

virtual int getLevel()

获取等级

返回

当前等级。

setPushAudioQuality

virtual int setPushAudioQuality(int nQuality)

设置推流音频质量

参数

参数	说明
nQuality	音频质量等级，默认中（1-5 低，中，高，超高，HD）

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

setPullAudioQuality

virtual int setPullAudioQuality(int nQuality)

设置拉流音频质量

参数

参数	说明
nQuality	音频质量等级，默认中（1-5 低，中，高，超高，HD）

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

pushToTalk

virtual int pushToTalk(int nTalkOnTime)

上麦

参数

参数	说明
nTalkOnTime	上麦时间限制（单位秒），0为无限制

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

stopPushToTalk

virtual int stopPushToTalk()

下麦

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

muteAllRemoteAudio

virtual int muteAllRemoteAudio(bool bMute)

静音

参数

参数	说明
bMute	true:静音；false:不静音

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

breakTalk

virtual int breakTalk()

强拆

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

enableAudioStream

virtual int enableAudioStream(bool bEnable)

启用广播媒体通道

参数

参数	说明
bEnable	true:启用；false:不启用

返回

• 0: 方法调用成功。
• ≠0: 方法调用失败。

release

virtual void release()

释放当前 IChannel 实例使用的所有资源。