yy::ITempAudioSession结构体 参考

[interface]临时语音聊天接口 提供创建房间、加入房间、离开房间以及在房间语音聊天的功能 注意：同一时刻只能在一个房间进行语音聊天 更多...

#include <yy-api-client.h>

Public 成员函数
virtual int	CreateRoom (unsigned int &rid)=0
	创建一个房间
virtual int	EnterRoom (unsigned int rid)=0
	加入一个房间
virtual int	LeaveRoom ()=0
	离开一个房间
virtual int	StartSpeak ()=0
	开始语音聊天
virtual int	StopSpeak ()=0
	结束语音聊天
virtual int	RegisterTempAudioSessionEvent (ITempAudioSessionEvent *e)=0
	注册临时语音事件
virtual int	UnRegisterTempAudioSessionEvent (ITempAudioSessionEvent *e)=0
	反注册临时语音事件
virtual int	GetVolume (unsigned int &vol)=0
	获取音量
virtual int	SetVolume (unsigned int vol)=0
	设置音量
virtual int	GetOwner (unsigned int &owner)=0
	获取当前使用临时语音的APPID

详细描述

[interface]临时语音聊天接口 提供创建房间、加入房间、离开房间以及在房间语音聊天的功能 注意：同一时刻只能在一个房间进行语音聊天

成员函数说明

virtual int yy::ITempAudioSession::CreateRoom ( unsigned int &  rid )

pure virtual

创建一个房间

参数

unsigned

int &rid [inout], 房间ID

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::EnterRoom ( unsigned int  rid )

pure virtual

加入一个房间

参数

unsigned

int rid [in], 房间ID

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::GetOwner ( unsigned int &  owner )

pure virtual

获取当前使用临时语音的APPID

参数

unsigned

int &owner [out]，返回值等于0表示当前没有APP使用临时语音

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::GetVolume ( unsigned int &  vol )

pure virtual

获取音量

参数

unsigned

int& vol [out]，音量值：[0, 100]

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::LeaveRoom ( )

pure virtual

离开一个房间

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::RegisterTempAudioSessionEvent ( ITempAudioSessionEvent *  e )

pure virtual

注册临时语音事件

参数

ITempAudioSessionEvent

* e [in] [not NULL]

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::SetVolume ( unsigned int  vol )

pure virtual

设置音量

参数

unsigned

int vol [in]，音量值：[0, 100]

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::StartSpeak ( )

pure virtual

开始语音聊天

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::StopSpeak ( )

pure virtual

结束语音聊天

返回

int, 0 success,其他值 error，查看错误代码表

virtual int yy::ITempAudioSession::UnRegisterTempAudioSessionEvent ( ITempAudioSessionEvent *  e )

pure virtual

反注册临时语音事件

参数

ITempAudioSessionEvent

* e [in] [not NULL]

返回

int, 0 success,其他值 error，查看错误代码表