MTC 会议接口 更多

宏定义
#define	MTC_CONF_ERR_NO   (MTC_EBASE_CONF + 0)
	MTC 会议状态代码（没有错误或终止代码）。 更多
#define	MTC_CONF_ERR_AUTH_FAILED   (MTC_EBASE_CONF + 1)
	认证失败，无效用户或密码。
#define	MTC_CONF_ERR_SESS_TMR   (MTC_EBASE_CONF + 2)
	会议刷新错误。
#define	MTC_CONF_ERR_FORBIDDEN   (MTC_EBASE_CONF + 3)
	会议禁止。
#define	MTC_CONF_ERR_NOT_FOUND   (MTC_EBASE_CONF + 4)
	会议成员未发现。
#define	MTC_CONF_ERR_NOT_ACPTED   (MTC_EBASE_CONF + 5)
	会议不被接受。
#define	MTC_CONF_ERR_TEMP_UNAVAIL   (MTC_EBASE_CONF + 6)
	会议成员临时不可用。
#define	MTC_CONF_ERR_REQ_TERMED   (MTC_EBASE_CONF + 7)
	会议请求超时。
#define	MTC_CONF_ERR_INTERNAL_ERR   (MTC_EBASE_CONF + 8)
	服务器内部错误。
#define	MTC_CONF_ERR_SRV_UNAVAIL   (MTC_EBASE_CONF + 9)
	服务不可用。
#define	MTC_CONF_ERR_OTHER   (MTC_EBASE_CONF + 10)
	其他错误。
#define	MTC_CONF_PARTP_STATE_PENDING   (MTC_EBASE_CONF + 11)
	MTC 会议成员状态类型 更多
#define	MTC_CONF_PARTP_STATE_DIALINGIN   (MTC_EBASE_CONF + 12)
	成员呼入
#define	MTC_CONF_PARTP_STATE_DIALINGOUT   (MTC_EBASE_CONF + 13)
	成员呼出
#define	MTC_CONF_PARTP_STATE_ALERTING   (MTC_EBASE_CONF + 14)
	成员振铃
#define	MTC_CONF_PARTP_STATE_CONNED   (MTC_EBASE_CONF + 15)
	成员连接
#define	MTC_CONF_PARTP_STATE_ONHOLD   (MTC_EBASE_CONF + 16)
	成员保持
#define	MTC_CONF_PARTP_STATE_DISCING   (MTC_EBASE_CONF + 17)
	成员正取消连接
#define	MTC_CONF_PARTP_STATE_DISCED   (MTC_EBASE_CONF + 18)
	成员已取消连接

函数
ZFUNC ZULONG	Mtc_ConfCreate (ZFUNC_VOID)
	MTC 会议创建。 更多
ZFUNC ZINT	Mtc_ConfSetup (ZULONG dwConfId, ZCOOKIE zCookie)
	MTC 作为创建者设立一个新的会议。 更多
ZFUNC ZINT	Mtc_ConfJoin (ZULONG dwConfId, ZCOOKIE zCookie, ZCHAR *pcUri)
	MTC 加入一个已存在的会议。 更多
ZFUNC ZINT	Mtc_ConfAlert (ZULONG dwConfId, ZCOOKIE zCookie)
	MTC 提示一个呼入会议邀请，它将由 Mtc_ConfCbSetIncoming 所设置的回调函数通知。 更多
ZFUNC ZINT	Mtc_ConfAcpt (ZULONG dwConfId, ZCOOKIE zCookie)
	MTC 接受呼入会议邀请，它将由 Mtc_ConfCbSetIncoming 所设置的回调通知。 更多
ZFUNC ZINT	Mtc_ConfHold (ZULONG dwConfId, ZBOOL bHold)
	MTC 会议保持 更多
ZFUNC ZINT	Mtc_ConfSubs (ZULONG dwConfId)
	MTC 订阅会议事件。（不立即执行） 更多
ZFUNC ZINT	Mtc_ConfIvtSess (ZULONG dwConfId, ZULONG dwSessId)
	MTC 邀请与你共同会话的新成员 到会议。（不立即执行） 更多
ZFUNC ZINT	Mtc_ConfTerm (ZULONG dwConfId, ZULONG dwReason)
	MTC 会议终止。 更多
ZFUNC ZCOOKIE	Mtc_ConfGetCookie (ZULONG dwConfId)
	MTC 会议获取 cookie 值。 更多
ZFUNC ZINT	Mtc_ConfGetPeerUri (ZULONG dwConfId, ZCHAR **ppcDispName, ZCHAR **ppcUri)
	MTC 会议获取对方 URI 和显示名称。 更多
ZFUNC ZINT	Mtc_ConfGetConfUri (ZULONG dwConfId, ZCHAR **ppcDispName, ZCHAR **ppcUri)
	MTC 会议获取会议 URI 和显示名称。 更多
ZFUNC ZINT	Mtc_ConfGetInitiatorUri (ZULONG dwConfId, ZCHAR **ppcDispName, ZCHAR **ppcUri)
	MTC 会议获取发起人 URI 和显示名称。 更多

详细描述

MTC 会议接口

本文件包含会议接口函数。这些函数 用于管理会议。

宏定义说明

#define MTC_CONF_ERR_NO   (MTC_EBASE_CONF + 0)

MTC 会议状态代码（没有错误或终止代码）。

没有错误。

#define MTC_CONF_PARTP_STATE_PENDING   (MTC_EBASE_CONF + 11)

MTC 会议成员状态类型

成员挂起

函数说明

ZFUNC ZINT Mtc_ConfAcpt (ZULONG dwConfId, ZCOOKIE zCookie )

MTC 接受呼入会议邀请，它将由 Mtc_ConfCbSetIncoming 所设置的回调通知。

若接受会议邀请，GUI将由 Mtc_ConfCbSetConned 所设置的回调通知。

参数

[in]	dwConfId	你想要接受的会议的ID。
[in]	zCookie	与UI资源相一致的会议。

返回值

ZOK	成功。
ZFAILED	失败。

参见

Mtc_ConfCbSetIncoming, Mtc_ConfAlert

ZFUNC ZINT Mtc_ConfAlert (ZULONG dwConfId, ZCOOKIE zCookie )

MTC 提示一个呼入会议邀请，它将由 Mtc_ConfCbSetIncoming 所设置的回调函数通知。

参数

[in]	dwConfId	你想要加入的会议的ID。
[in]	zCookie	与UI资源相一致的会议。

返回值

ZOK	成功。
ZFAILED	失败。

该函数用来告知会议邀请方你已经接收了 邀请并在UI层面给用户提示。用户应该做出 决定是否接受会议邀请。

参见

Mtc_ConfCbSetIncoming, Mtc_ConfAcpt

ZFUNC ZULONG Mtc_ConfCreate (ZFUNC_VOID )

MTC 会议创建。

返回

新建会议的ID，若成功，否则返回 ZMAXULONG。

与会话创建的方式不同，这一函数仅分配 会议资源。若你想设置或加入一个会议，你需要 通过调用其他函数一步步进行。

参见

Mtc_ConfSetup, Mtc_ConfJoin

ZFUNC ZINT Mtc_ConfGetConfUri (ZULONG dwConfId, ZCHAR ** ppcDispName, ZCHAR ** ppcUri )

MTC 会议获取会议 URI 和显示名称。

参数

[in]	dwConfId	你想要获取的会议的ID。
[out]	ppcDispName	会议显示名称。
[out]	ppcUri	会议URI。

调用方必须先复制出参数在使用。

返回值

ZOK	成功。
ZFAILED	失败。

参见

Mtc_ConfGetPeerUri, Mtc_ConfGetInitiatorUri

ZFUNC ZCOOKIE Mtc_ConfGetCookie (ZULONG dwConfId)

MTC 会议获取 cookie 值。

参数

[in]

dwConfId

你想要从中获取 cookie 值的会议的ID。

返回

会议 cookie。

cookie 值可由 Mtc_ConfSetup, Mtc_ConfJoin 或 Mtc_ConfAcpt 预先设置。

参见

Mtc_ConfSetup, Mtc_ConfJoin, Mtc_ConfAcpt

ZFUNC ZINT Mtc_ConfGetInitiatorUri (ZULONG dwConfId, ZCHAR ** ppcDispName, ZCHAR ** ppcUri )

MTC 会议获取发起人 URI 和显示名称。

参数

[in]	dwConfId	你想要获取的会议的 ID。
[out]	ppcDispName	会议显示名称。
[out]	ppcUri	会议 URI。

调用方必须先复制出参数在使用。

返回值

ZOK	成功。
ZFAILED	失败。

参见

Mtc_ConfGetPeerUri, Mtc_ConfGetConfUri

ZFUNC ZINT Mtc_ConfGetPeerUri (ZULONG dwConfId, ZCHAR ** ppcDispName, ZCHAR ** ppcUri )

MTC 会议获取对方 URI 和显示名称。

参数

[in]	dwConfId	你想要获取的会议的ID。
[out]	ppcDispName	会议显示名称。
[out]	ppcUri	会议URI。

调用方必须先复制出参数在使用。

返回值

ZOK	成功。
ZFAILED	失败。

参见

Mtc_ConfGetConfUri, Mtc_ConfGetInitiatorUri

ZFUNC ZINT Mtc_ConfHold (ZULONG dwConfId, ZBOOL bHold )

MTC 会议保持

若保持会议成功，GUI将由 Mtc_ConfCbSetHoldOk 所设置的回调通知。

若取消保持会议成功，GUI将由 Mtc_ConfCbSetUnHoldOk 所设置的回调通知。

若保持会议失败，GUI将由 Mtc_ConfCbSetHoldFailed 所设置的回调通知。

若取消保持会议失败，GUI将由 Mtc_ConfCbSetUnHoldFailed 所设置的回调通知。

当接收保持会议时，GUI将由 Mtc_ConfCbSetHeld 所设置的回调通知。

当接收取消保持会议时，GUI将由 Mtc_ConfCbSetUnHeld 所设置的回调通知。

参数

[in]	dwConfId	你想要保持或取消保持的会议的ID。
[in]	bHold	指保持或取消保持的意愿。

返回值

ZOK	成功。
ZFAILED	失败。

参见

Mtc_ConfSetup

ZFUNC ZINT Mtc_ConfIvtSess (ZULONG dwConfId, ZULONG dwSessId )

MTC 邀请与你共同会话的新成员 到会议。（不立即执行）

参数

[in]	dwConfId	你想要邀请新成员进入的会议的ID。
[in]	dwSessId	你与想要邀请的新成员所在的会话的ID。

返回值

ZOK	成功。
ZFAILED	失败。

ZFUNC ZINT Mtc_ConfJoin (ZULONG dwConfId, ZCOOKIE zCookie, ZCHAR * pcUri )

MTC 加入一个已存在的会议。

若加入一个会议，GUI将由 Mtc_ConfCbSetOutgoing, Mtc_ConfCbSetAlerted, Mtc_ConfCbSetConned 所设置的回调通知。

参数

[in]	dwConfId	你想要加入的会议的ID。
[in]	zCookie	与UI资源相一致的会议。
[in]	pcUri	已存在的会议的URI。

返回值

ZOK	成功。
ZFAILED	失败。

参见

Mtc_ConfCreate, Mtc_ConfSetup

ZFUNC ZINT Mtc_ConfSetup (ZULONG dwConfId, ZCOOKIE zCookie )

MTC 作为创建者设立一个新的会议。

若作为创建者设立一个新的会议，GUI将由 Mtc_ConfCbSetOutgoing, Mtc_ConfCbSetAlerted, Mtc_ConfCbSetConned 所设置的回调通知。

当接收到会议邀请是，GUI将由 Mtc_ConfCbSetIncoming 所设置的回调通知。

参数

[in]	dwConfId	你想要设立的会议的ID.
[in]	zCookie	与UI资源相一致的会议。

返回值

ZOK	成功。
ZFAILED	失败。

参见

Mtc_ConfCreate, Mtc_ConfJoin

ZFUNC ZINT Mtc_ConfSubs (ZULONG dwConfId)

MTC 订阅会议事件。（不立即执行）

若邀请新成员加入会议或从会议提出成员，GUI将由 Mtc_ConfCbSetMdfyed 所设置的回调通知。

参数

[in]

dwConfId

你想要订阅的会议的ID。

返回值

ZOK	成功。
ZFAILED	失败。

参见

Mtc_ConfSetup

ZFUNC ZINT Mtc_ConfTerm (ZULONG dwConfId, ZULONG dwReason )

MTC 会议终止。

参数

[in]	dwConfId	你想要终止的会议的ID。
[in]	dwReason	指终止原因，这可能触发在S-CSCF触发一些服务。

返回值

ZOK	成功。
ZFAILED	失败。

事实上，Mtc_ConfTerm 并不会释放所有资源分配到该 会议。它仅开启一个终止程序。所有资源将被 自动释放，当程序结束。

参见

Mtc_ConfSetup, Mtc_ConfJoin, EN_MTC_CALL_TERM_REASON_TYPE