You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2468 lines
76 KiB
2468 lines
76 KiB
/************************************************************************ |
|
|
|
Copyright (c) 2005-2011 by Juphoon System Software, Inc. |
|
All rights reserved. |
|
|
|
This software is confidential and proprietary to Juphoon System, |
|
Inc. No part of this software may be reproduced, stored, transmitted, |
|
disclosed or used in any form or by any means other than as expressly |
|
provided by the written license agreement between Juphoon and its |
|
licensee. |
|
|
|
THIS SOFTWARE IS PROVIDED BY JUPHOON "AS IS" AND ANY EXPRESS OR |
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
ARE DISCLAIMED. IN NO EVENT SHALL JUPHOON BE LIABLE FOR ANY DIRECT, |
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
|
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
|
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
|
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
POSSIBILITY OF SUCH DAMAGE. |
|
|
|
Juphoon System Software, Inc. |
|
Email: support@juphoon.com |
|
Web: http://www.juphoon.com |
|
|
|
************************************************************************/ |
|
/************************************************* |
|
File name : mtc_conf2.h |
|
Module : rich session enabler |
|
Author : binbin.zhu |
|
Created on : 2018-03-05 |
|
Description : |
|
Data structure and function declare required by mtc conference |
|
|
|
Modify History: |
|
1. Date: Author: Modification: |
|
*************************************************/ |
|
#ifndef _MTC_CONF2_H__ |
|
#define _MTC_CONF2_H__ |
|
|
|
#include "mtc_def.h" |
|
|
|
/** |
|
* @file |
|
* @brief MTC Conference Interfaces2 |
|
* |
|
* This file includes session and conference interface function. |
|
*/ |
|
#ifdef __cplusplus |
|
extern "C" { |
|
#endif |
|
|
|
/** @brief MTC conf regular type */ |
|
typedef enum EN_MTC_CONF_REGULAR_TYPE |
|
{ |
|
EN_MTC_CONF_REGULAR_NONE, /**< none. */ |
|
EN_MTC_CONF_REGULAR_DAILY, /**< daily. */ |
|
EN_MTC_CONF_REGULAR_WEEKLY, /**< weekly. */ |
|
EN_MTC_CONF_REGULAR_TWO_WEEKS, /**< two week. */ |
|
EN_MTC_CONF_REGULAR_MOUTH, /**< mouth. */ |
|
EN_MTC_CONF_REGULAR_YEAR, /**< year. */ |
|
} EN_MTC_CONF_REGULAR_TYPE; |
|
|
|
/** @brief MTC conf state type */ |
|
typedef enum EN_MTC_CONF_STATE_TYPE |
|
{ |
|
EN_MTC_CONF_STATE_ALL = -1, /**< All state. */ |
|
EN_MTC_CONF_STATE_RESERVED = 0, /**< Reserved. */ |
|
EN_MTC_CONF_STATE_STARTED, /**< Started. */ |
|
EN_MTC_CONF_STATE_CANCELED, /**< Canceled. */ |
|
EN_MTC_CONF_STATE_ENDED, /**< Ended. */ |
|
} EN_MTC_CONF_STATE_TYPE; |
|
|
|
/** @brief MTC conf id type */ |
|
typedef enum EN_MTC_CONF_ID_TYPE |
|
{ |
|
EN_MTC_CONF_ID_GROUP = 0, /**< GroupId. */ |
|
} EN_MTC_CONF_ID_TYPE; |
|
|
|
/** @brief MTC conf property type */ |
|
typedef enum EN_MTC_CONF_PROERTY_TYPE |
|
{ |
|
EN_MTC_CONF_PROERTY_JOINMUTE = 0, /**< Join mute property. */ |
|
EN_MTC_CONF_PROERTY_ALLOW_ACTOR_UNMUTE, /**< Allow actor un-mute. */ |
|
} EN_MTC_CONF_PROERTY_TYPE; |
|
|
|
/** @brief MTC conf member property type */ |
|
typedef enum EN_MTC_CONF_MEMBER_PROERTY_TYPE |
|
{ |
|
EN_MTC_CONF_MEMBER_PROERTY_RECORD = 0, /**< Record property. */ |
|
EN_MTC_CONF_MEMBER_PROERTY_SCREENSHARE = 1, /**< Screen Share property. */ |
|
EN_MTC_CONF_MEMBER_PROERTY_FOCUS = 2, /**< Focus property. */ |
|
EN_MTC_CONF_MEMBER_PROERTY_HANDSUP = 3, /**< Hands up property. */ |
|
} EN_MTC_CONF_MEMBER_PROERTY_TYPE; |
|
|
|
/** |
|
* @defgroup MtcConfKey MTC notification key of conference event. |
|
* @{ |
|
*/ |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* if the chairman video is open, the value maybe 0/1. |
|
*/ |
|
#define MtcConfIsOpenedChairmanVideoKey "isOpenedChairmanVideo" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* if the member video is open, the value maybe 0/1. |
|
*/ |
|
#define MtcConfIsOpenedMemberVideoKey "isOpenedMemberVideo" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* if allow join conference before chairman, the value maybe 0/1. |
|
*/ |
|
#define MtcConfAllowJoinBeforeChairmanKey "isJoinConferenceBeforeChairman" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* if save the media of conference, the value maybe 0/1. |
|
*/ |
|
#define MtcConfIsSaveMediaKey "isSaveMedia" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* role value of actor. |
|
*/ |
|
#define MtcConfRoleExKey "role" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* state value of actor. |
|
*/ |
|
#define MtcConfStateExKey "state" |
|
|
|
/** |
|
* @brief A key whose value is a number in json format reflecting |
|
* if allow actors to un-mute self, the value maybe 0/1. |
|
*/ |
|
#define MtcConfIsAllowActorUnmuteKey "isAllowMemberUnMute" |
|
|
|
/** |
|
* @brief A key whose value is a boolean in json format reflecting |
|
* if server close the conference when only one actor. |
|
*/ |
|
#define MtcConfCloseWhenAloneKey "MtcConfCloseWhenAloneKey" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* if is chairman, the value maybe 0/1. |
|
*/ |
|
#define MtcConfIsChairmanKey "isChairman" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* if the user's conf id. |
|
*/ |
|
#define MtcConfRoomIdKey "MtcConfRoomIdKey" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* userIdentity id. |
|
*/ |
|
#define MtcConfUserIdentityKey "userIdentity" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the third user id. |
|
*/ |
|
#define MtcConfThirdUserIdKey "userId" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the expand info. |
|
*/ |
|
#define MtcConfExpandKey "confExpand" |
|
|
|
/** |
|
* @brief A key whose value is a string object reflecting |
|
* the group id of conference members. |
|
*/ |
|
#define MtcConfGroupIdKey "MtcConfGroupIdKey" |
|
|
|
/** |
|
* @brief A key whose value is a string object reflecting |
|
* the user id of conference members. |
|
*/ |
|
#define MtcConfInfoUserIdKey "MtcConfInfoUserIdKey" |
|
|
|
/** |
|
* @brief A key whose value is an array in json format reflecting |
|
* invite members of the conference, each item of element contains |
|
* @ref MtcConfInfoUserIdKey, |
|
* @ref MtcConfDisplayNameKey. |
|
*/ |
|
#define MtcConfCandListKey "MtcConfCandListKey" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the start info of conference, which contains |
|
* @ref MtcConfInfoContentKey, @ref MtcConfCandListKey. |
|
*/ |
|
#define MtcConfStartInfoKey "MtcConfStartInfoKey" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the end info of conference. |
|
*/ |
|
#define MtcConfEndInfoKey "MtcConfEndInfoKey" |
|
|
|
/** |
|
* @brief A key whose value is a string object reflecting |
|
* the info type of message in conference. |
|
*/ |
|
#define MtcConfInfoTypeKey "MtcConfInfoTypeKey" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the content of message in conference. |
|
*/ |
|
#define MtcConfInfoContentKey "MtcConfInfoContentKey" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the more info of conference, the detail info is defined by user, which contains |
|
* @ref MtcConfGroupIdKey, @ref MtcConfInfoTypeKey, @ref MtcConfStartInfoKey, |
|
* @ref MtcConfEndInfoKey. |
|
*/ |
|
#define MtcConfMoreInfoKey "confMoreInfo" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the user name. |
|
*/ |
|
#define MtcConfUserNameKey "memberName" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* whether record enable. |
|
*/ |
|
#define MtcConfIsRecordEnableKey "isRecord" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* whether screenShare enable. |
|
*/ |
|
#define MtcConfIsScreenShareEnableKey "isScreenShare" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* whether focus enable. |
|
*/ |
|
#define MtcConfIsFocusEnableKey "isFocus" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* whether hands up. |
|
*/ |
|
#define MtcConfIsHandsUpKey "isHandsUp" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* whether the member is waiting or not. |
|
*/ |
|
#define MtcConfIsWaitingKey "isWaiting" |
|
|
|
/** |
|
* @brief A key whose value is an array in json format reflecting |
|
* if the members of the conference, each item of element must contain |
|
* @ref MtcConfUserIdentityKey, |
|
* @ref MtcConfUserNameKey, |
|
* @ref MtcConfIsChairmanKey, |
|
* @ref MtcConfIsRecordEnableKey, |
|
* @ref MtcConfIsScreenShareEnableKey, |
|
* @ref MtcConfIsFocusEnableKey, |
|
* @ref MtcConfExpandKey, |
|
* which maybe contain @ref MtcConfExpandKey, @ref MtcConfIsWaitingKey. |
|
*/ |
|
#define MtcConfMembersListKey "memberList" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* the regular type of conference @ref EN_MTC_CONF_REGULAR_TYPE. |
|
*/ |
|
#define MtcConfRegularTypeKey "regularType" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the ack id of message. |
|
*/ |
|
#define MtcConfAckIdKey "ackId" |
|
|
|
/** |
|
* @brief A key whose value is a boolean object in json format reflecting |
|
* the conference is all mute or not. |
|
*/ |
|
#define MtcConfIsAllMuteKey "isAllMute" |
|
|
|
/** |
|
* @brief A key whose value is a boolean object in json format reflecting |
|
* the conference is locked or not. |
|
*/ |
|
#define MtcConfIsLockKey "isConfLock" |
|
|
|
/** |
|
* @brief A key whose value is a boolean object in json format reflecting |
|
* the member is all mute or not. |
|
*/ |
|
#define MtcConfIsMemberMuteKey "isMemberMute" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the type of message, the value of this key maybe |
|
* @ref MtcConfMessageTypeAllMuteKey, |
|
* @ref MtcConfMessageTypeMuteKey, |
|
* @ref MtcConfMessageTypeKickKey, |
|
* @ref MtcConfMessageTypeMemberExpandKey, |
|
* @ref MtcConfMessageTypeChangeChairmanKey, |
|
* @ref MtcConfMessageTypeLeaveKey, |
|
* @ref MtcConfMessageTypeJoinKey, |
|
* @ref MtcConfMessageTypeLockKey, |
|
* @ref MtcConfMessageTypeDelayKey, |
|
* @ref MtcConfMessageTypeVideoChangeKey, |
|
* @ref MtcConfMessageTypeNickNameChangeKey, |
|
* @ref MtcConfMessageTypeInviteKey, |
|
* @ref MtcConfMessageTypeDelayRemindKey, |
|
* @ref MtcConfMessageTypeRecordKey, |
|
* @ref MtcConfMessageTypeScreenShareKey, |
|
* @ref MtcConfMessageTypeFocusKey, |
|
* @ref MtcConfMessageTypeHandsUpKey, |
|
* @ref MtcConfMessageTypeReservedConfStartKey, |
|
* @ref MtcConfMessageTypeMemberUpdateKey, |
|
* @ref MtcConfMessageTypeJoinOkKey, |
|
* @ref MtcConfMessageTypeAllowActorUnmuteKey. |
|
*/ |
|
#define MtcConfMessageTypeKey "messageType" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* join ok message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeJoinOkKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfInfoKey:{ |
|
MtcConfIdentityKey:"xxxxx", |
|
MtcConfKeepDurationKey:30, |
|
MtcConfOwnerConfIdKey:"xxxx", |
|
MtcConfStartKey:"", |
|
MtcConfEndKey:"", |
|
MtcConfStatusKey:1, |
|
MtcConfCreaterIdentityKey:"xxxxx", |
|
MtcConfPwdKey:"xxxxx", |
|
MtcConfIsLockKey:1, |
|
MtcConfIsAllMuteKey:1, |
|
MtcConfIsOpenedVideoKey:1, |
|
MtcConfTitleNameKey:"xxxx", |
|
MtcConfUuidKey:"xxxxx" |
|
} |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfUserNameKey:"", |
|
MtcConfExpandKey:"", |
|
MtcConfIsChairmanKey:0, |
|
MtcConfIdentityKey:"xxxxx", |
|
MtcConfIsOpenedChairmanVideoKey:1, |
|
MtcConfIsMemberMuteKey:0, |
|
MtcConfThirdUserIdKey:"xxxxx", |
|
MtcConfIsRecordEnableKey:0, |
|
MtcConfIsScreenShareEnableKey:0, |
|
MtcConfIsFocusEnableKey:0 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeJoinOkKey "joinOk" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the all mute message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeAllMuteKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfInfoKey:{ |
|
MtcConfIsAllMuteKey:0, |
|
} |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeAllMuteKey "allMute" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the all mute message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeAllowActorUnmuteKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfInfoKey:{ |
|
MtcConfIsAllMuteKey:0, |
|
} |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeAllowActorUnmuteKey "allowMemberUnMute" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the mute message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeMuteKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsMemberMuteKey:0, |
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeMuteKey "mute" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the kick message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeKickKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeKickKey "kick" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the member expand message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeMemberExpandKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfExpandKey:"", |
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeMemberExpandKey "memberExpand" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the chairman changed message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeChangeChairmanKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsChairmanKey:0, |
|
}, |
|
{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsChairmanKey:1, |
|
}] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeChangeChairmanKey "changeChairman" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the member leave message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeLeaveKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeLeaveKey "leave" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the member join message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeJoinKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfUserNameKey:"", |
|
MtcConfExpandKey:"", |
|
MtcConfIsChairmanKey:0, |
|
MtcConfIdentityKey:"xxxxx", |
|
MtcConfIsOpenedChairmanVideoKey:1, |
|
MtcConfIsMemberMuteKey:0, |
|
MtcConfThirdUserIdKey:"xxxxx", |
|
MtcConfIsRecordEnableKey:0, |
|
MtcConfIsScreenShareEnableKey:0, |
|
MtcConfIsFocusEnableKey:0, |
|
MtcConfRoleExKey:14, |
|
MtcConfStateExKey:7 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
MtcConfUriKey:"xxxx", |
|
MtcConfIdKey:323232, |
|
MtcConfNumberKey:45453535, |
|
MtcConfCapacityKey:6 |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeJoinKey "join" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the conference locked message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeLockKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfInfoKey:{ |
|
MtcConfIsLockKey:1, |
|
} |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeLockKey "lock" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the actor changed message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessagePartpChangedKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfUserNameKey:"", |
|
MtcConfExpandKey:"", |
|
MtcConfIsChairmanKey:0, |
|
MtcConfIdentityKey:"xxxxx", |
|
MtcConfIsOpenedChairmanVideoKey:1, |
|
MtcConfIsMemberMuteKey:0, |
|
MtcConfThirdUserIdKey:"xxxxx", |
|
MtcConfIsRecordEnableKey:0, |
|
MtcConfIsScreenShareEnableKey:0, |
|
MtcConfIsFocusEnableKey:0, |
|
MtcConfRoleExKey:14, |
|
MtcConfStateExKey:7 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
MtcConfIdKey:323232, |
|
MtcConfNumberKey:45453535 |
|
* } |
|
*/ |
|
#define MtcConfMessagePartpChangedKey "roleStateChange" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the conference delay message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeDelayKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfInfoKey:{ |
|
MtcConfKeepDurationKey:30, |
|
} |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeDelayKey "delay" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the conference share message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeInviteKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfInfoKey:{ |
|
MtcConfIdentityKey:"xxxxx", |
|
MtcConfKeepDurationKey:30, |
|
MtcConfOwnerConfIdKey:"xxxx", |
|
MtcConfStartKey:"", |
|
MtcConfEndKey:"", |
|
MtcConfStatusKey:1, |
|
MtcConfCreaterIdentityKey:"xxxxx", |
|
MtcConfPwdKey:"xxxxx", |
|
MtcConfIsLockKey:1, |
|
MtcConfIsAllMuteKey:1, |
|
MtcConfIsOpenedVideoKey:1, |
|
MtcConfTitleNameKey:"xxxx", |
|
MtcConfUuidKey:"xxxxx" |
|
} |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfUserNameKey:"", |
|
MtcConfExpandKey:"", |
|
MtcConfIsChairmanKey:0, |
|
MtcConfIdentityKey:"xxxxx", |
|
MtcConfIsOpenedChairmanVideoKey:1, |
|
MtcConfIsMemberMuteKey:0, |
|
MtcConfThirdUserIdKey:"xxxxx", |
|
MtcConfIsRecordEnableKey:0, |
|
MtcConfIsScreenShareEnableKey:0, |
|
MtcConfIsFocusEnableKey:0 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeInviteKey "invite" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the user video change, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeVideoChangeKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsOpenedMemberVideoKey:0 |
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeVideoChangeKey "video" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the user nick name change, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeNickNameChangeKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"xxxxxx", |
|
MtcConfUserNameKey:"xxxxx" |
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeNickNameChangeKey "memberName" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* reserved conference start, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeReservedConfStartKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfInfoKey:{ |
|
MtcConfIdentityKey:"xxxxx", |
|
MtcConfKeepDurationKey:30, |
|
MtcConfOwnerConfIdKey:"xxxx", |
|
MtcConfStartKey:"", |
|
MtcConfEndKey:"", |
|
MtcConfStatusKey:1, |
|
MtcConfCreaterIdentityKey:"xxxxx", |
|
MtcConfPwdKey:"xxxxx", |
|
MtcConfIsLockKey:1, |
|
MtcConfIsAllMuteKey:1, |
|
MtcConfIsOpenedVideoKey:1, |
|
MtcConfTitleNameKey:"xxxx", |
|
MtcConfUuidKey:"xxxxx" |
|
} |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfUserNameKey:"", |
|
MtcConfExpandKey:"", |
|
MtcConfIsChairmanKey:0, |
|
MtcConfIdentityKey:"xxxxx", |
|
MtcConfIsOpenedChairmanVideoKey:1, |
|
MtcConfIsMemberMuteKey:0, |
|
MtcConfThirdUserIdKey:"xxxxx", |
|
MtcConfIsRecordEnableKey:0, |
|
MtcConfIsScreenShareEnableKey:0, |
|
MtcConfIsFocusEnableKey:0 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeReservedConfStartKey "reserveConfStart" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the message of delay remind, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeDelayRemindKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeDelayRemindKey "delayRemind" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the conference record property message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeRecordKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsRecordEnableKey:0 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeRecordKey "record" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the conference screen share property message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeScreenShareKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsScreenShareEnableKey:0 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeScreenShareKey "screenShare" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the conference focus property message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeFocusKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsFocusEnableKey:0 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeFocusKey "focus" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the conference hands up property message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeHandsUpKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsHandsUpKey:0 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeHandsUpKey "handsUp" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the user reject to join message, the detail info of this message like |
|
* { |
|
MtcConfMessageTypeKey:MtcConfMessageTypeMemberUpdateKey, |
|
MtcConfAckIdKey:"xxxxxxx", |
|
MtcConfMembersListKey:[{ |
|
MtcConfUserIdentityKey:"", |
|
MtcConfIsHandsUpKey:0 |
|
|
|
},..] |
|
MtcConfChangeUserKey:"xxxxx", |
|
* } |
|
*/ |
|
#define MtcConfMessageTypeMemberUpdateKey "updateMember" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the message of conference. |
|
*/ |
|
#define MtcConfInfoKey "conference" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the user who make the change. |
|
*/ |
|
#define MtcConfChangeUserKey "changeUser" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the id of conference. |
|
*/ |
|
#define MtcConfIdentityKey "confId" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the unique id of conference. |
|
*/ |
|
#define MtcConfUuidKey "confUuid" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the create uri of conference. |
|
*/ |
|
#define MtcConfCreaterIdentityKey "createUserIdentity" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the title of conference. |
|
*/ |
|
#define MtcConfTitleNameKey "title" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* the conference is video conference, the value maybe 0/1. |
|
*/ |
|
#define MtcConfIsVideoTypeKey "mediaType" |
|
|
|
/** |
|
* @brief A key whose value is a boolen object in json format reflecting |
|
* the conference is opened video or not. |
|
*/ |
|
#define MtcConfIsOpenedVideoKey "isConfOpenVideo" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* the status of conference. |
|
*/ |
|
#define MtcConfStatusKey "confStatus" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the start time of conference. |
|
*/ |
|
#define MtcConfStartKey "startTime" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the end time of conference. |
|
*/ |
|
#define MtcConfEndKey "endTime" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* the duration of conference. |
|
*/ |
|
#define MtcConfKeepDurationKey "keepDuration" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the password of conference. |
|
*/ |
|
#define MtcConfPwdKey "password" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* the member count of conference. |
|
*/ |
|
#define MtcConfMemberCountKey "memberCount" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the owner conference id. |
|
*/ |
|
#define MtcConfOwnerConfIdKey "ownerConfId" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the create time of conference. |
|
*/ |
|
#define MtcConfCreateTimeKey "createTime" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json format reflecting |
|
* the modify time of conference. |
|
*/ |
|
#define MtcConfModifyTimeKey "modifiedTime" |
|
|
|
/** |
|
* @brief A key whose value is a number object in json format reflecting |
|
* the max sender of conference. |
|
*/ |
|
#define MtcConfMaxSenderNumKey "maxsender" |
|
|
|
/** |
|
* @brief A key whose value is a string object in json array format reflecting |
|
* the video user list of conference. |
|
*/ |
|
#define MtcConfVideoUsersListKey "videoUserIdentities" |
|
|
|
/** |
|
* @brief A key whose value is a json object reflecting |
|
* conference detail info, which contains |
|
* @ref MtcConfIdentityKey, // |
|
* @ref MtcConfCreaterIdentityKey, |
|
* @ref MtcConfPasswordKey, |
|
* @ref MtcConfStartKey, |
|
* @ref MtcConfKeepDurationKey, |
|
* @ref MtcConfTitleNameKey, |
|
* @ref MtcConfIsVideoTypeKey, |
|
* @ref MtcConfStatusKey, |
|
* @ref MtcConfOwnerConfIdKey, |
|
* @ref MtcConfUuidKey, |
|
* @ref MtcConfEndKey, |
|
* May be contains @ref MtcConfIsOpenedChairmanVideoKey, |
|
* @ref MtcConfIsOpenedMemberVideoKey, |
|
* @ref MtcConfAllowJoinBeforeChairmanKey, |
|
* @ref MtcConfIsSaveMediaKey, |
|
* @ref MtcConfIsAllowActorUnmuteKey, |
|
* @ref MtcConfMemberCountKey, |
|
* @ref MtcConfMembersListKey, |
|
* @ref MtcConfCreateTimeKey, |
|
* @ref MtcConfModifyTimeKey, |
|
* @ref MtcConfRegularTypeKey, |
|
* @ref MtcConfMaxSenderNumKey, |
|
* @ref MtcConfVideoUsersListKey. |
|
*/ |
|
#define MtcConfDetailKey "MtcConfDetailKey" |
|
|
|
/** |
|
* @brief A key whose value is a json array object reflecting |
|
* conference list, each elem contains |
|
* @ref MtcConfIdentityKey, @ref MtcConfCreaterIdentityKey, |
|
* @ref MtcConfIsOpenedChairmanVideoKey, |
|
* @ref MtcConfIsOpenedMemberVideoKey, |
|
* @ref MtcConfAllowJoinBeforeChairmanKey, |
|
* @ref MtcConfIsSaveMediaKey, |
|
* @ref MtcConfIsAllowActorUnmuteKey, |
|
* @ref MtcConfPasswordKey, |
|
* @ref MtcConfMemberCountKey, |
|
* @ref MtcConfMembersListKey, |
|
* @ref MtcConfStartKey, |
|
* @ref MtcConfKeepDurationKey, |
|
* @ref MtcConfTitleNameKey, |
|
* @ref MtcConfIsVideoTypeKey, |
|
* @ref MtcConfStatusKey, |
|
* @ref MtcConfCreateTimeKey, |
|
* @ref MtcConfModifyTimeKey, |
|
* @ref MtcConfOwnerConfIdKey, |
|
* @ref MtcConfUuidKey, |
|
* @ref MtcConfEndKey, |
|
* @ref MtcConfRegularTypeKey. |
|
*/ |
|
#define MtcConfListKey "MtcConfListKey" |
|
|
|
/** |
|
* @brief A key whose value is a json array object reflecting |
|
* added conference, each elem contains |
|
* @ref MtcConfIdentityKey, @ref MtcConfCreaterIdentityKey, |
|
* @ref MtcConfIsOpenedChairmanVideoKey, |
|
* @ref MtcConfIsOpenedMemberVideoKey, |
|
* @ref MtcConfAllowJoinBeforeChairmanKey, |
|
* @ref MtcConfIsSaveMediaKey, |
|
* @ref MtcConfIsAllowActorUnmuteKey, |
|
* @ref MtcConfPasswordKey, |
|
* @ref MtcConfMemberCountKey, |
|
* @ref MtcConfMembersListKey, |
|
* @ref MtcConfStartKey, |
|
* @ref MtcConfKeepDurationKey, |
|
* @ref MtcConfTitleNameKey, |
|
* @ref MtcConfIsVideoTypeKey, |
|
* @ref MtcConfStatusKey, |
|
* @ref MtcConfCreateTimeKey, |
|
* @ref MtcConfModifyTimeKey, |
|
* @ref MtcConfOwnerConfIdKey, |
|
* @ref MtcConfUuidKey, |
|
* @ref MtcConfEndKey, |
|
* @ref MtcConfRegularTypeKey. |
|
*/ |
|
#define MtcConfAddedListKey "MtcConfAddedListKey" |
|
|
|
/** |
|
* @brief A key whose value is a json array object reflecting |
|
* updated conference, each elem contains |
|
* @ref MtcConfIdentityKey, @ref MtcConfCreaterIdentityKey, |
|
* @ref MtcConfIsOpenedChairmanVideoKey, |
|
* @ref MtcConfIsOpenedMemberVideoKey, |
|
* @ref MtcConfAllowJoinBeforeChairmanKey, |
|
* @ref MtcConfIsSaveMediaKey, |
|
* @ref MtcConfIsAllowActorUnmuteKey, |
|
* @ref MtcConfPasswordKey, |
|
* @ref MtcConfMemberCountKey, |
|
* @ref MtcConfMembersListKey, |
|
* @ref MtcConfStartKey, |
|
* @ref MtcConfKeepDurationKey, |
|
* @ref MtcConfTitleNameKey, |
|
* @ref MtcConfIsVideoTypeKey, |
|
* @ref MtcConfStatusKey, |
|
* @ref MtcConfCreateTimeKey, |
|
* @ref MtcConfModifyTimeKey, |
|
* @ref MtcConfOwnerConfIdKey, |
|
* @ref MtcConfUuidKey, |
|
* @ref MtcConfEndKey, |
|
* @ref MtcConfRegularTypeKey. |
|
*/ |
|
#define MtcConfUpdatedListKey "MtcConfUpdatedListKey" |
|
|
|
/** |
|
* @brief A key whose value is a json array object reflecting |
|
* removed conference, each elem stands confUuid. |
|
*/ |
|
#define MtcConfRemovedListKey "MtcConfRemovedListKey" |
|
|
|
/** |
|
* @brief A key whose value is a number object reflecting |
|
* updateTime of conference list. |
|
*/ |
|
#define MtcConfUpdateTimeKey "MtcConfUpdateTimeKey" |
|
|
|
/** |
|
* @brief A key whose value is a string in json reflecting |
|
* the user config. |
|
*/ |
|
#define MtcConfUserExCfgKey "MtcConfUserExCfgKey" |
|
|
|
/** |
|
* @brief A key whose value is a number in json reflecting |
|
* the number of reserved conference. |
|
*/ |
|
#define MtcConfReserveCountKey "reserveConf" |
|
|
|
/** |
|
* @brief A key whose value is a number in json reflecting |
|
* the number of started conferenced. |
|
*/ |
|
#define MtcConfStartedCountKey "startConf" |
|
|
|
/** |
|
* @brief A key whose value is a number in json reflecting |
|
* the number of canceled conference. |
|
*/ |
|
#define MtcConfCanceledCountKey "cancelConf" |
|
|
|
/** |
|
* @brief A key whose value is a number in json reflecting |
|
* the number of ended conference. |
|
*/ |
|
#define MtcConfEndedCountKey "endConf" |
|
|
|
/** |
|
* @brief A key whose value is an object in json reflecting |
|
* the number info of conference, |
|
* @ref MtcConfReserveCountKey, @ref MtcConfStartedCountKey, |
|
* @ref MtcConfCanceledCountKey, @ref MtcConfEndedCountKey. |
|
*/ |
|
#define MtcConfCountKey "MtcConfCountKey" |
|
|
|
/** |
|
* @brief A key whose value is a number in json reflecting |
|
* the property type of conference. |
|
*/ |
|
#define MtcConfPropertyTypeKey "MtcConfPropertyTypeKey" |
|
|
|
/** |
|
* @brief A key whose value is a boolean in json reflecting |
|
* the enable value of conference property. |
|
*/ |
|
#define MtcConfPropertyValueKey "MtcConfPropertyValueKey" |
|
|
|
/** |
|
* @brief A key whose value is a number in json reflecting |
|
* the type of query id. |
|
*/ |
|
#define MtcConfIdTypeKey "MtcConfIdTypeKey" |
|
|
|
/** @} */ |
|
|
|
/** |
|
* @defgroup MtcConfNotification MTC notification of conference event. |
|
* @{ |
|
*/ |
|
|
|
/** |
|
* @brief Posted when conference resource reserved. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfNumberKey @ref MtcConfUuidKey. |
|
*/ |
|
#define MtcConf2ReserveOkNotification "MtcConf2ReserveOkNotification" |
|
|
|
/** |
|
* @brief Posted when conference resource reserve failed. |
|
*/ |
|
#define MtcConf2ReserveDidFailNotification "MtcConf2ReserveDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when conference resource reserved. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfNumberKey @ref MtcConfUuidKey. |
|
*/ |
|
#define MtcConf2EditReserveOkNotification "MtcConf2EditReserveOkNotification" |
|
|
|
/** |
|
* @brief Posted when conference resource reserve failed. |
|
*/ |
|
#define MtcConf2EditReserveDidFailNotification "MtcConf2EditReserveDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when conference resource ternimated. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfNumberKey, @ref MtcConfIdKey. |
|
*/ |
|
#define MtcConf2TerminateOkNotification "MtcConf2TerminateOkNotification" |
|
|
|
/** |
|
* @brief Posted when conference ternimate failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2TerminateDidFailNotification "MtcConf2TerminateDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when conference delay ok. |
|
* |
|
*/ |
|
#define MtcConf2DelayOkNotification "MtcConf2DelayOkNotification" |
|
|
|
/** |
|
* @brief Posted when conference delay failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2DelayDidFailNotification "MtcConf2DelayDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when conference lock ok. |
|
* |
|
*/ |
|
#define MtcConf2LockOkNotification "MtcConf2LockOkNotification" |
|
|
|
/** |
|
* @brief Posted when conference lock failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2LockDidFailNotification "MtcConf2LockDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when conference unlock ok. |
|
* |
|
*/ |
|
#define MtcConf2UnlockOkNotification "MtcConf2UnlockOkNotification" |
|
|
|
/** |
|
* @brief Posted when conference unlock failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2UnlockDidFailNotification "MtcConf2UnlockDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when invite members ok. |
|
* |
|
*/ |
|
#define MtcConf2InviteOkNotification "MtcConf2InviteOkNotification" |
|
|
|
/** |
|
* @brief Posted when invite members failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2InviteDidFailNotification "MtcConf2InviteDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when decline invite ok. |
|
* |
|
*/ |
|
#define MtcConf2DeclineInviteOkNotification "MtcConf2DeclineInviteOkNotification" |
|
|
|
/** |
|
* @brief Posted when decline invite failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2DeclineInviteDidFailNotification "MtcConf2DeclineInviteDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when change chairman successfully. |
|
* |
|
*/ |
|
#define MtcConf2ChangeChairmanOkNotification "MtcConf2ChangeChairmanOkNotification" |
|
|
|
/** |
|
* @brief Posted when change chairman failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2ChangeChairmanDidFailNotification "MtcConf2ChangeChairmanDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when send ack successfully. |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfAckIdKey. |
|
* |
|
*/ |
|
#define MtcConf2AckOkNotification "MtcConf2AckOkNotification" |
|
|
|
/** |
|
* @brief Posted when send ack failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2AckDidFailNotification "MtcConf2AckDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when send message successfully. |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfNumberKey. |
|
* |
|
*/ |
|
#define MtcConf2SetExCfgOkNotification "MtcConf2SetExCfgOkNotification" |
|
|
|
/** |
|
* @brief Posted when send message failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2SetExCfgDidFailNotification "MtcConf2SetExCfgDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when cancel reservation OK. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfNumberKey. |
|
*/ |
|
#define MtcConf2CancelReservationOkNotification "MtcConf2CancelReservationOkNotification" |
|
|
|
/** |
|
* @brief Posted when cancel reservation failed. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2CancelReservationDidFailNotification "MtcConf2CancelReservationDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when refresh conference successfully. |
|
* If refresh for diff, the pcInfo of this notification contains |
|
* @ref MtcConfAddedListKey, @ref MtcConfUpdatedListKey, |
|
* @ref MtcConfRemovedListKey, @ref MtcConfUpdateTimeKey. |
|
* If refresh all, the pcInfo of this notification contains |
|
* @ref MtcConfListKey, @ref MtcConfUpdateTimeKey. |
|
* |
|
*/ |
|
#define MtcConf2RefreshOkNotification "MtcConf2RefreshOkNotification" |
|
|
|
/** |
|
* @brief Posted when refresh conference failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2RefreshDidFailNotification "MtcConf2RefreshDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when query conference successfully. |
|
* |
|
*/ |
|
#define MtcConf2QueryOkNotification "MtcConf2QueryOkNotification" |
|
|
|
/** |
|
* @brief Posted when query conference failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2QueryDidFailNotification "MtcConf2QueryDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when query conference successfully. |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdTypeKey, @ref MtcConfDetailKey. |
|
* |
|
*/ |
|
#define MtcConf2QueryByIdOkNotification "MtcConf2QueryByIdOkNotification" |
|
|
|
/** |
|
* @brief Posted when query conference failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2QueryByIdDidFailNotification "MtcConf2QueryByIdDidFailNotification" |
|
|
|
|
|
/** |
|
* @brief Posted when query reserved conference successfully, |
|
* The pcInfo of this notification contains @ref MtcConfDetailKey. |
|
* |
|
*/ |
|
#define MtcConf2QueryReservedOkNotification "MtcConf2QueryReservedOkNotification" |
|
|
|
/** |
|
* @brief Posted when query reserved conference failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2QueryReservedDidFailNotification "MtcConf2QueryReservedDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when query going conference successfully, |
|
* The pcInfo of this notification contains @ref MtcConfDetailKey. |
|
* |
|
*/ |
|
#define MtcConf2QueryGoingOkNotification "MtcConf2QueryGoingOkNotification" |
|
|
|
/** |
|
* @brief Posted when query reserved conference failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey |
|
*/ |
|
#define MtcConf2QueryGoingDidFailNotification "MtcConf2QueryGoingDidFailNotification" |
|
|
|
/** |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfPartpLstKey |
|
* @ref MtcConfTitleKey, |
|
* @ref MtcConfDataKey |
|
* @ref MtcConfScreenUserKey |
|
* @ref MtcConfViewModeKey |
|
* @ref MtcConfQualityGradeKey |
|
* @ref MtcConfVideoSquareKey |
|
* @ref MtcConfPropUserDefined |
|
* @ref MtcConfPropDocumentUri |
|
* @ref MtcConfPropDocumentPageId |
|
* @ref MtcRegionIdKey |
|
* @ref MtcRegionNameKey |
|
* @ref MtcRegionDescKey |
|
* @ref MtcConfCapacityKey. |
|
*/ |
|
#define MtcConf2JoinOkNotification "MtcConf2JoinOkNotification" |
|
|
|
/** |
|
* @brief Posted when join to a conference failed. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfEventKey |
|
* @ref MtcConfReasonKey. |
|
*/ |
|
#define MtcConf2JoinDidFailNotification "MtcConf2JoinDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when there is another user has joined to the conference. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfUserUriKey |
|
* @ref MtcConfDisplayNameKey |
|
* @ref MtcConfRoleKey |
|
* @ref MtcConfStateKey |
|
* @ref MtcConfCapacityKey. |
|
*/ |
|
#define MtcConf2JoinedNotification "MtcConf2JoinedNotification" |
|
|
|
/** |
|
* @brief Posted when leaved from the conference. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfEventKey |
|
* @ref MtcConfReasonKey |
|
*/ |
|
#define MtcConf2DidLeaveNotification "MtcConf2DidLeaveNotification" |
|
|
|
/** |
|
* @brief Posted when there is another user has leaved from the conference. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfUserUriKey. |
|
*/ |
|
#define MtcConf2LeavedNotification "MtcConf2LeavedNotification" |
|
|
|
/** |
|
* @brief Posted when a participant's state changed. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfUserUriKey |
|
* @ref MtcConfStateKey. |
|
* @ref MtcConfRoleKey |
|
* @ref MtcConfDisplayNameKey |
|
*/ |
|
#define MtcConf2ParticipantChangedNotification "MtcConf2ParticipantChangedNotification" |
|
|
|
/** |
|
* @brief Posted when conference property changed. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfTitleKey |
|
* @ref MtcConfDataKey |
|
* @ref MtcConfScreenUserKey |
|
* @ref MtcConfPropUserDefined |
|
* @ref MtcConfPropDocumentUri |
|
* @ref MtcConfPropDocumentPageId |
|
*/ |
|
#define MtcConf2PropertyChangedNotfication "MtcConf2PropertyChangedNotfication" |
|
|
|
/** |
|
* @brief Posted when volume energy changed. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfPartpVolumeLstKey. |
|
*/ |
|
#define MtcConf2VolumeChangedNotification "MtcConf2VolumeChangedNotification" |
|
|
|
/** |
|
* @brief Posted when volume energy changed. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfPartpNetworkStatusListKey. |
|
* @ref MtcConfIsUpstreamKey. |
|
*/ |
|
#define MtcConf2NetworkStatusChangedNotification "MtcConf2NetworkStatusChangedNotification" |
|
|
|
/** |
|
* @brief Posted when render state changed. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfPartpVideoStateLstKey |
|
* @ref MtcConfScreenStateKey |
|
*/ |
|
#define MtcConf2RenderChangedNotification "MtcConf2RenderChangedNotification" |
|
|
|
/** |
|
* @brief Posted when render tag changed. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfPartpVideoTagLstKey |
|
*/ |
|
#define MtcConf2RenderTagChangedNotification "MtcConf2RenderTagChangedNotification" |
|
|
|
/** |
|
* @brief Posted when received text message. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfUserUriKey |
|
* @ref MtcConfTextKey. |
|
*/ |
|
#define MtcConf2TextReceivedNotification "MtcConf2TextReceivedNotification" |
|
|
|
/** |
|
* @brief Posted when received data message. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey, |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfUserUriKey |
|
* @ref MtcConfDataTypeKey |
|
* @ref MtcConfDataContentKey. |
|
*/ |
|
#define MtcConf2DataReceivedNotification "MtcConf2DataReceivedNotification" |
|
|
|
/** |
|
* @brief Posted when received bypass data message. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey, |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfDataTypeKey |
|
* @ref MtcConfDataContentKey. |
|
*/ |
|
#define MtcConf2BypassDataReceivedNotification "MtcConf2BypassDataReceivedNotification" |
|
|
|
/** |
|
* @brief Posted when there is an error. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfIdKey |
|
* @ref MtcConfNumberKey |
|
* @ref MtcConfEventKey |
|
* @ref MtcConfReasonKey. |
|
*/ |
|
#define MtcConf2ErrorNotification "MtcConf2ErrorNotification" |
|
|
|
/** |
|
* @brief Posted when reve message. |
|
* |
|
* The pcInfo of this notification contains |
|
* @ref MtcConfAckIdKey |
|
* @ref MtcConfMessageTypeKey |
|
* @ref MtcConfChangeUserKey. |
|
* Maybe contains @ref MtcConfInfoKey or @ref MtcConfMembersListKey. |
|
*/ |
|
#define MtcConf2MessageReceivedNotification "MtcConf2MessageReceivedNotification" |
|
|
|
/** |
|
* @brief Posted when change user's displayname successfully. |
|
* The pcInfo of this notification contains @ref MtcConfIdKey. |
|
* |
|
*/ |
|
#define MtcConf2ChangeDisplayNameOkNotification "MtcConf2ChangeDisplayNameOkNotification" |
|
|
|
/** |
|
* @brief Posted when change user's dispalyname failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey, @ref MtcConfIdKey. |
|
*/ |
|
#define MtcConf2ChangeDisplayNameDidFailNotification "MtcConf2ChangeDisplayNameDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when set conference property successfully. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfPropertyTypeKey, @ref MtcConfPropertyValueKey, @ref MtcConfIdKey. |
|
* |
|
*/ |
|
#define MtcConf2SetPropertyOkNotification "MtcConf2SetPropertyOkNotification" |
|
|
|
/** |
|
* @brief Posted when set conference property failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey, |
|
* @ref MtcConfPropertyTypeKey, @ref MtcConfIdKey. |
|
*/ |
|
#define MtcConf2SetPropertyDidFailNotification "MtcConf2SetPropertyDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when set member property successfully. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfPropertyTypeKey, @ref MtcConfPropertyValueKey, @ref MtcConfIdKey. |
|
* |
|
*/ |
|
#define MtcConf2SetMemberPropertyOkNotification "MtcConf2SetMemberPropertyOkNotification" |
|
|
|
/** |
|
* @brief Posted when set member property failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey, @ref MtcConfIdKey. |
|
*/ |
|
#define MtcConf2SetMemberPropertyDidFailNotification "MtcConf2SetMemberPropertyDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when mute user ok. |
|
* The pcInfo of this notification contains, @ref MtcConfIdKey. |
|
* |
|
*/ |
|
#define MtcConf2MuteUserOkNotification "MtcConf2MuteUserOkNotification" |
|
|
|
/** |
|
* @brief Posted when mute user failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey, @ref MtcConfIdKey. |
|
*/ |
|
#define MtcConf2MuteUserDidFailNotification "MtcConf2MuteUserDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when un-mute user ok. |
|
* The pcInfo of this notification contains, @ref MtcConfIdKey. |
|
* |
|
*/ |
|
#define MtcConf2UnmuteUserOkNotification "MtcConf2UnmuteUserOkNotification" |
|
|
|
/** |
|
* @brief Posted when un-mute user failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey, @ref MtcConfIdKey. |
|
*/ |
|
#define MtcConf2UnmuteUserDidFailNotification "MtcConf2UnmuteUserDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when open user video ok. |
|
* The pcInfo of this notification contains, @ref MtcConfIdKey. |
|
* |
|
*/ |
|
#define MtcConf2OpenUserVideoOkNotification "MtcConf2OpenUserVideoOkNotification" |
|
|
|
/** |
|
* @brief Posted when open user video failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey, @ref MtcConfIdKey. |
|
*/ |
|
#define MtcConf2OpenUserVideoDidFailNotification "MtcConf2OpenUserVideoDidFailNotification" |
|
|
|
/** |
|
* @brief Posted when close user videook. |
|
* The pcInfo of this notification contains, @ref MtcConfIdKey. |
|
* |
|
*/ |
|
#define MtcConf2CloseUserVideoOkNotification "MtcConf2CloseUserVideoOkNotification" |
|
|
|
/** |
|
* @brief Posted when close user video failed. |
|
|
|
* The pcInfo of this notification contains |
|
* @ref MtcConfReasonKey, @ref MtcConfDetailReasonKey, @ref MtcConfIdKey. |
|
*/ |
|
#define MtcConf2CloseUserVideoDidFailNotification "MtcConf2CloseUserVideoDidFailNotification" |
|
|
|
/** @} */ |
|
|
|
#ifdef __cplusplus |
|
} |
|
#endif |
|
|
|
#ifdef __cplusplus |
|
EXPORT_FLAG { |
|
#endif |
|
|
|
/** |
|
* @brief Start a meeting room directily. The room is identified by room ID. |
|
* |
|
* @param iRegionId The region ID. |
|
* @param pcRoomId The User Defined ID of room, "0" for generate roomid by jsmconf server. |
|
* @param zCookie The cookie value. |
|
* @param pcDisplayName The display name string. |
|
* @param bVideo Video flag. |
|
* @param pcParm The json string, param key is @ref MtcConfPropKey, |
|
* @ref MtcConfViewModeKey, @ref MtcConfStateKey, |
|
* @ref MtcConfMaxSenderKey, @ref MtcConfMoreInfoKey. |
|
* |
|
* @return The conference ID when send request successfully. |
|
* Otherwise return ZMAXUINT. |
|
*/ |
|
MTCFUNC ZUINT Mtc_Conf2Start(ZINT iRegionId, |
|
ZCONST ZCHAR *pcRoomId, ZCOOKIE zCookie, ZCONST ZCHAR *pcDisplayName, |
|
ZBOOL bVideo, ZCONST ZCHAR *pcParm); |
|
|
|
/** |
|
* @brief Join a conf directily. |
|
* |
|
* @param iRegionId The region ID. |
|
* @param pcRoomId The User Defined ID of room. |
|
* @param zCookie The cookie value. |
|
* @param pcDisplayName The display name string. |
|
* @param bVideo Video flag. |
|
* @param pcParm The json string, param key is @ref MtcConfPropKey, |
|
* @ref MtcConfViewModeKey, @ref MtcConfStateKey, |
|
* @ref MtcConfUuidKey, @ref MtcConfMaxSenderKey. |
|
* |
|
* @return The conference ID when send request successfully. |
|
* Otherwise return ZMAXUINT. |
|
*/ |
|
MTCFUNC ZUINT Mtc_Conf2Join(ZINT iRegionId, |
|
ZCONST ZCHAR *pcRoomId, ZCOOKIE zCookie, ZCONST ZCHAR *pcDisplayName, |
|
ZBOOL bVideo, ZCONST ZCHAR *pcParm); |
|
|
|
/** |
|
* @brief Reserve a conference resource. |
|
* |
|
* If conference resource reserved successfully, |
|
* @ref MtcConf2ReserveOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2ReserveDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] pcParm Conference info, which must contains |
|
* @ref MtcConfCreaterIdentityKey, |
|
* @ref MtcConfTitleNameKey, |
|
* @ref MtcConfIsVideoTypeKey, |
|
* @ref MtcConfStartKey, |
|
* @ref MtcConfKeepDurationKey, |
|
* @ref MtcConfMemberCountKey, |
|
* @ref MtcConfOwnerConfIdKey, |
|
* @ref MtcConfMembersListKey, |
|
* which maybe contains |
|
* @ref MtcConfIsOpenedChairmanVideoKey, |
|
* @ref MtcConfIsOpenedMemberVideoKey, |
|
* @ref MtcConfAllowJoinBeforeChairmanKey, |
|
* @ref MtcConfIsSaveMediaKey, |
|
* @ref MtcConfIsAllowActorUnmuteKey, |
|
* @ref MtcConfPwdKey, |
|
* @ref MtcConfExpandKey, |
|
* @ref MtcConfRegularTypeKey. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Reserve(ZCOOKIE zCookie, ZCONST ZCHAR *pcParm); |
|
|
|
/** |
|
* @brief Cancel a reserve conference. |
|
* |
|
* @param zCookie The cookie value. |
|
* @param pcConfUuid The unique id of conference. |
|
* |
|
* @return ZOK when send request successfully. |
|
* Otherwise return ZFAILED. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2CancelReserve(ZCOOKIE zCookie, ZCONST ZCHAR *pcConfUuid); |
|
|
|
/** |
|
* @brief Reserve a conference resource. |
|
* |
|
* If conference edit successfully, |
|
* @ref MtcConf2EditReserveOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2EditReserveDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] pcConfUuid The unique id of conference. |
|
* @param [in] pcParm Conference info, which contains |
|
* @ref MtcConfIsOpenedChairmanVideoKey, |
|
* @ref MtcConfIsOpenedMemberVideoKey, |
|
* @ref MtcConfAllowJoinBeforeChairmanKey, |
|
* @ref MtcConfIsSaveMediaKey, |
|
* @ref MtcConfIsAllowActorUnmuteKey, |
|
* @ref MtcConfPasswordKey, |
|
* @ref MtcConfCapacityKey, |
|
* @ref MtcConfMembersListKey, |
|
* @ref MtcConfStartTimeKey, |
|
* @ref MtcConfDurationKey, |
|
* @ref MtcConfTitleKey, |
|
* @ref MtcConfIsVideoKey, |
|
* @ref MtcConfRegularTypeKey. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2EditReserve(ZCOOKIE zCookie, ZCONST ZCHAR *pcConfUuid, ZCONST ZCHAR *pcParm); |
|
|
|
/** |
|
* @brief Leave a conference. |
|
* |
|
* When leave the conference successfully, |
|
* @ref MtcConf2DidLeaveNotification will be notified. |
|
* |
|
* @param [in] iConfId The ID of conference which you want leave. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Leave(ZUINT iConfId); |
|
|
|
/** |
|
* @brief Kick users from conference. |
|
* |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] pcMembersUri, for one user, use uri directly, |
|
* for multi-users, use json array, each item contain the user uri. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2KickUsers(ZUINT iConfId, ZCONST ZCHAR *pcMembersUri); |
|
|
|
/** |
|
* @brief Delay conference. |
|
* |
|
* If conference delay successfully, |
|
* @ref MtcConf2DelayOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2DelayDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of the conference. |
|
* @param [in] iDelay, delay time in minute. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Delay(ZCOOKIE zCookie, ZUINT iConfId, ZINT iDelay); |
|
|
|
/** |
|
* @brief Lock or unlock conference. |
|
* |
|
* If conference lock/unlock successfully, |
|
* @ref MtcConf2LockOkNotification or @ref MtcConf2UnlockOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2LockDidFailNotification or @ref MtcConf2UnlockDidFailNotificationwill be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The Id of the conference. |
|
* @param [in] bLock, lock or not. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Lock(ZCOOKIE zCookie, ZUINT iConfId, ZBOOL bLock); |
|
|
|
/** |
|
* @brief Mute users. |
|
* If conference mute/unmute successfully, |
|
* @ref MtcConf2MuteUserOkNotification or @ref MtcConf2UnmuteUserOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2MuteUserDidFailNotification or @ref MtcConf2UnmuteUserDidFailNotificationwill be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of the conference. |
|
* @param [in] bMute, mute or not. |
|
* @param [in] pcMembers, for one user, use uri directly, |
|
* for multi-users, use json array, each item contain the user uri. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2MuteUsers(ZCOOKIE zCookie, ZUINT iConfId, ZBOOL bMute, ZCONST ZCHAR *pcMembers); |
|
|
|
/** |
|
* @brief Set participant's role. |
|
* |
|
* @param [in] iConfId The ID of the conference. |
|
* @param [in] pcUris The user's URI, "" for self, |
|
* json array for multi-users or "xxx" for signal user. |
|
* @param iMask The mask of value, @ref MtcConfRole. |
|
* @param iValue The value, @ref MtcConfRole. |
|
* |
|
* @return ZOK when succeed. ZFAILED when failed. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetRoleX(ZUINT iConfId, ZCONST ZCHAR *pcUris, |
|
ZUINT iMask, ZUINT iValue); |
|
|
|
/** |
|
* @brief Set participant's state. |
|
* |
|
* @param [in] iConfId The ID of the conference. |
|
* @param [in] pcUris The user's URI, "" for self, |
|
* json array for multi-users or "xxx" for signal user. |
|
* @param iMask The mask of value, @ref MtcConfRole. |
|
* @param iValue The value, @ref MtcConfRole. |
|
* |
|
* @return ZOK when succeed. ZFAILED when failed. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetStateX(ZUINT iConfId, ZCONST ZCHAR *pcUris, |
|
ZUINT iMask, ZUINT iValue); |
|
|
|
/** |
|
* @brief Share conference. |
|
* |
|
* If conference delay successfully, |
|
* @ref MtcConf2InviteOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2InviteDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of the conference. |
|
* @param [in] pcMembers, json array format, each elem is json object which contains |
|
* @ref MtcConfUserIdentityKey, @ref MtcConfExpandKey. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Invite(ZCOOKIE zCookie, ZUINT iConfId, ZCONST ZCHAR *pcMembers); |
|
|
|
|
|
/** |
|
* @brief Change chairman. |
|
* |
|
* If conference delay successfully, |
|
* @ref MtcConf2ChangeChairmanOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2ChangeChairmanDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of the conference. |
|
* @param [in] pcNewChairman, the use uri of new chairman. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2ChangeChairman(ZCOOKIE zCookie, ZUINT iConfId, ZCONST ZCHAR *pcNewChairman); |
|
|
|
/** |
|
* @brief Ack to server. |
|
* |
|
* If send ack successfully, |
|
* @ref MtcConf2AckOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2AckDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] pcAckId, The ackid of the message. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Ack(ZCOOKIE zCookie, ZCONST ZCHAR *pcAckId); |
|
|
|
/** |
|
* @brief Ack to server. |
|
* |
|
* If send ack successfully, |
|
* @ref MtcConf2SetExCfgOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2SetExCfgDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId, The ID of the conference. |
|
* @param [in] pcMessage, json array, each elem is a json object which contain |
|
* @ref MtcConfUserIdentityKey, @ref MtcConfUserExCfgKey. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetExCfg(ZCOOKIE zCookie, ZUINT iConfId, ZCONST ZCHAR *pcMessage); |
|
|
|
|
|
/** |
|
* @brief Refresh all conference of user. |
|
* |
|
* If send ack successfully, |
|
* @ref MtcConf2RefreshOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2RefreshDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] qwBaseTime, The base time. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Refresh(ZCOOKIE zCookie, ZINT64 qwBaseTime); |
|
|
|
/** |
|
* @brief Start media sending. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] iMediaOption Media option @ref MtcConfMedia. |
|
* |
|
* @retval ZOK Start media sending successfully, and request has sent to server. |
|
* If request failed, @ref MtcConf2ErrorNotification will be notified. |
|
* @retval ZFAILED Fail to start media sending. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2StartSend(ZUINT iConfId, ZUINT iMediaOption); |
|
|
|
/** |
|
* @brief Stop media sending. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] iMediaOption Media option @ref MtcConfMedia. |
|
* |
|
* @retval ZOK Stop media sending successfully, and request has sent to server. |
|
* If request failed, @ref MtcConf2ErrorNotification will be notified. |
|
* @retval ZFAILED Fail to stop media sending. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2StopSend(ZUINT iConfId, ZUINT iMediaOption); |
|
|
|
/** |
|
* @brief MTC session subscribe audio of the meeting. |
|
* |
|
* @param [in] iConfId The ID of session which you want to set. |
|
* @param [in] bSubscribe Indicate whether to subscribe the voice. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SubscribeAudio(ZUINT iConfId, ZBOOL bSubscribe); |
|
|
|
/** |
|
* @brief MTC session subscribe audio of one user in meeting. |
|
* |
|
* @param [in] iConfId The ID of session which you want to set. |
|
* @param [in] pcUserUri The Uri of user which you want to set. |
|
* @param [in] bSubscribe Indicate whether to subscribe the voice. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SubscribeUserAudio(ZUINT iConfId, ZCONST ZCHAR* pcUserUri, ZBOOL bSubscribe); |
|
|
|
/** |
|
* @brief Request to change conference parameters. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] pcCmd The command name, @ref MtcConfReq. |
|
* @param [in] pcParm The parameter string, reference each command description. |
|
* |
|
* @retval ZOK Command has been sent out successfully. |
|
* When server accept the command, there will be |
|
* a @ref MtcConf2ParticipantChangedNotification |
|
* notification. |
|
* When server reject the command or timeout, there will be |
|
* a @ref MtcConf2ErrorNotification notification. |
|
* @retval ZFAILED Fail to sent the command. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Command(ZUINT iConfId, ZCONST ZCHAR *pcCmd, |
|
ZCONST ZCHAR *pcParm); |
|
|
|
/** |
|
* @brief Set video capture device for conference. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] pcName Capture device name. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetVideoCapture(ZUINT iConfId, ZCONST ZCHAR *pcName); |
|
|
|
/** |
|
* @brief Start conference CDN service |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* |
|
* @retval ZOK |
|
* @retval ZFAILED Fail to start CDN service. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2StartCdn(ZUINT iConfId); |
|
|
|
/** |
|
* @brief Stop conference CDN service. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* |
|
* @retval ZOK |
|
* @retval ZFAILED Fail to stop CDN service. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2StopCdn(ZUINT iConfId); |
|
|
|
/** |
|
* @brief Get statistics. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] pcName The statistics name. @ref MtcConfStatistics. |
|
* @param [in] pcParm The statistics parameter. @ref MtcConfStatistics for detail. |
|
* |
|
* @return Statistics string. |
|
* ZNULL indicates failed. |
|
*/ |
|
MTCFUNC ZCONST ZCHAR * Mtc_Conf2GetStatistics(ZUINT iConfId, |
|
ZCONST ZCHAR *pcName, ZCONST ZCHAR *pcParm); |
|
|
|
/** |
|
* @brief Get the user list which audio this user didn't subscribed . |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* |
|
* @return information which is a object in JSON when succeed. It contains @ref MtcConfMemberListKey |
|
* @return ZNULL when failed. |
|
*/ |
|
MTCFUNC ZCONST ZCHAR * Mtc_Conf2GetAudioMutedUserList(ZUINT iConfId); |
|
|
|
/** |
|
* @brief Send bypass data in the conference. |
|
* |
|
* @param [in] iConfId The ID of conference in which you chat. |
|
* @param [in] pcType The data type. |
|
* @param [in] pcContent The data content. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SendBypassData(ZUINT iConfId, ZCONST ZCHAR *pcType, |
|
ZCONST ZCHAR *pcContent); |
|
|
|
/** |
|
* @brief Send text in the conference. |
|
* |
|
* @param [in] iConfId The ID of conference in which you chat. |
|
* @param [in] pcUserUri The URI of target user, NULL will broadcast. |
|
* @param [in] pcText The UTF8 encoding message |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SendText(ZUINT iConfId, ZCONST ZCHAR *pcUserUri, |
|
ZCONST ZCHAR *pcText); |
|
|
|
/** |
|
* @brief Send data in the conference. |
|
* |
|
* @param [in] iConfId The ID of conference in which you chat. |
|
* @param [in] pcUserUri The URI of target user, NULL will broadcast. |
|
* @param [in] pcType The data type. |
|
* @param [in] pcContent The data content in UTF8. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SendData(ZUINT iConfId, ZCONST ZCHAR *pcUserUri, |
|
ZCONST ZCHAR *pcType, ZCONST ZCHAR *pcContent); |
|
|
|
/** |
|
* @brief Query conference by pages. |
|
* |
|
* If query successfully, |
|
* @ref MtcConf2QueryOkNotification will be notified with |
|
* the URI of conference resource, |
|
* If query confState for -1, the pcInfo of this notification contains |
|
* @ref MtcConfCountKey. |
|
* If query confState for detail, the pcInfo of this notification contains |
|
* @ref MtcConfListKey. |
|
* Otherwise @ref MtcConf2QueryDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfState, The conf state @ref EN_MTC_CONF_STATE_TYPE. |
|
* @param [in] iPage, The page index to query. |
|
* @param [in] iCount, The page count to query. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Query(ZCOOKIE zCookie, ZINT iConfState, ZINT iPage, ZINT iCount); |
|
|
|
/** |
|
* @brief Control user's video. |
|
* |
|
* If open/close successfully, |
|
* @ref MtcConf2OpenUserVideoOkNotification or @ref MtcConf2CloseUserVideoOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2OpenUserVideoDidFailNotification or @ref MtcConf2CloseUserVideoDidFailNotificationwill be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of the conference. |
|
* @param [in] bMute, mute or not. |
|
* @param [in] pcMembers, for one user, use uri directly, |
|
* for multi-users, use json array, each item contain the user uri. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2CtrlVideo(ZCOOKIE zCookie, ZUINT iConfId, ZBOOL bOn, ZCONST ZCHAR *pcMembers); |
|
|
|
/** |
|
* @brief Query single reserved conference info. |
|
|
|
* If query successfully, |
|
* @ref MtcConf2QueryReservedOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2QueryReservedDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] pcConfUuid The unique id of conference. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2QueryReserve(ZCOOKIE zCookie, ZCONST ZCHAR *pcConfUuid); |
|
|
|
/** |
|
* @brief Change display name during conference. |
|
|
|
* If query successfully, |
|
* @ref MtcConf2ChangeDisplayNameOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2ChangeDisplayNameDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of conference number. |
|
* @param [in] pcUserUri The user's uri. |
|
* @param [in] pcDisplayName The display name to change. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2ChangeDisplayName(ZCOOKIE zCookie, ZUINT iConfId, ZCONST ZCHAR *pcUserUri, ZCONST ZCHAR *pcDisplayName); |
|
|
|
/** |
|
* @brief Query on going conference info. |
|
|
|
* If query successfully, |
|
* @ref MtcConf2QueryGoingOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2QueryGoingDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] pcRoomId The User Defined ID of room. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2QueryGoing(ZCOOKIE zCookie, ZCONST ZCHAR *pcRoomId); |
|
|
|
|
|
/** |
|
* @brief Set participant's role. |
|
* |
|
* @param iConfId The ID of conference. |
|
* @param pcUserUri The user's URI, ZNULL for self. |
|
* @param iMask The mask of value, @ref MtcConfRole. |
|
* @param iValue The value, @ref MtcConfRole. |
|
* |
|
* @return ZOK when succeed. ZFAILED when failed. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetRole(ZUINT iConfId, ZCONST ZCHAR *pcUserUri, |
|
ZUINT iMask, ZUINT iValue); |
|
|
|
/** |
|
* @brief Get roles of conference user. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* |
|
* @return The role value of conference user. |
|
*/ |
|
MTCFUNC ZUINT Mtc_Conf2GetRole(ZUINT iConfId); |
|
|
|
/** |
|
* @brief Set participant's state. |
|
* |
|
* @param iConfId The ID of conference. |
|
* @param pcUserUri The user's URI, ZNULL for self. |
|
* @param iMask The mask of value, @ref MtcConfState. |
|
* @param iValue The value, @ref MtcConfState. |
|
* |
|
* @return ZOK when succeed. ZFAILED when failed. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetState(ZUINT iConfId, ZCONST ZCHAR *pcUserUri, |
|
ZUINT iMask, ZUINT iValue); |
|
|
|
/** |
|
* @brief Set conference's property. |
|
|
|
* If set successfully, |
|
* @ref MtcConf2SetPropertyOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2SetPropertyDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] iType The type of property, @ref EN_MTC_CONF_PROERTY_TYPE. |
|
* @param [in] bEnable Enable or disable. |
|
* |
|
* @return ZOK when succeed. ZFAILED when failed. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetProperty(ZCOOKIE zCookie, ZUINT iConfId, ZINT iType, ZBOOL bEnable); |
|
|
|
/** |
|
* @brief Set participant's property. |
|
* |
|
* If set successfully, |
|
* @ref MtcConf2SetMemberPropertyOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2SetMemberPropertyDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] pcMembersUri, for one user, use uri directly, |
|
* for multi-users, use json array, each item contain the user uri. |
|
* @param [in] iType The type of property, @ref EN_MTC_CONF_MEMBER_PROERTY_TYPE. |
|
* @param [in] bEnable Enable or disable. |
|
* |
|
* @return ZOK when succeed. ZFAILED when failed. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetMemberProperty(ZCOOKIE zCookie, ZUINT iConfId, ZCONST ZCHAR *pcMembersUri, |
|
ZINT iType, ZBOOL bEnable); |
|
|
|
/** |
|
* @brief Get conference property's value. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] pcName The property name. @ref MtcConfProp |
|
* |
|
* @return Reference @ref MtcConfProp for detail. ZNULL when failed. |
|
*/ |
|
MTCFUNC ZCONST ZCHAR * Mtc_Conf2GetProp(ZUINT iConfId, ZCONST ZCHAR *pcName); |
|
|
|
/** |
|
* @brief Set conference property. |
|
* |
|
* @param iConfId The ID of conference. |
|
* @param pcName The property name. @ref MtcConfProp |
|
* @param pcValue The property value. Use ZNULL to delete this value. |
|
* |
|
* @return ZOK when succeed. ZFAILED when failed. |
|
* |
|
* If specific property is not found, it will create new one. |
|
* If same property is found, it replace the value. |
|
* |
|
* Other participants will be notified by @ref MtcConf2PropertyChangedNotfication |
|
* when property was set. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetProp(ZUINT iConfId, ZCONST ZCHAR *pcName, |
|
ZCONST ZCHAR *pcValue); |
|
|
|
/** |
|
* @brief Set screen capture device for conference. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] pcName Capture device name. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetScreenCapture(ZUINT iConfId, ZCONST ZCHAR *pcName); |
|
|
|
/** |
|
* @brief Set user for conference shared screen. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* @param [in] pcUserUri The URI of user. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetScreenUser(ZUINT iConfId, ZCONST ZCHAR *pcUserUri); |
|
|
|
/** |
|
* @brief Invite users. |
|
* |
|
* If invite successfully, |
|
* @ref MtcConf2InviteOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2InviteDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iConfId The ID of conference which you want invite. |
|
* @param [in] pcMembers, string in json which is defined by user, which contains |
|
* @ref MtcConfMembersListKey. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2InviteX(ZCOOKIE zCookie, ZUINT iConfId, ZCONST ZCHAR *pcMembers); |
|
|
|
|
|
/** |
|
* @brief Terminate a conference . |
|
* |
|
* If conference terminate successfully, |
|
* @ref MtcConf2TerminateOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2TerminateDidFailNotification will be notified. |
|
* |
|
* @param [in] iConfId The ID of conference which you want term. |
|
* @param [in] pcInfo More info in json foramt, which in key-value form. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2Terminate(ZUINT iConfId, ZCONST ZCHAR *pcInfo); |
|
|
|
/** |
|
* @brief Get count of conference participants. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* |
|
* @return The count of participants. |
|
*/ |
|
MTCFUNC ZUINT Mtc_Conf2GetPartpCount(ZUINT iConfId); |
|
|
|
/** |
|
* @brief Decline invite to a conference . |
|
* |
|
* If decline successfully, |
|
* @ref MtcConf2DeclineInviteOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2DeclineInviteDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] pcRoomId The User Defined ID of room. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_ConfDeclineInviteX(ZCOOKIE zCookie, ZCONST ZCHAR *pcRoomId); |
|
|
|
|
|
/** |
|
* @brief Query a conference by id(s), such as groupId . |
|
* |
|
* If query successfully, |
|
* @ref MtcConf2QueryByIdOkNotification will be notified with |
|
* the URI of conference resource. |
|
* Otherwise @ref MtcConf2QueryByIdDidFailNotification will be notified. |
|
* |
|
* @param [in] zCookie Used to correspond conference with UI resource. |
|
* @param [in] iType Id type @ref EN_MTC_CONF_ID_TYPE. |
|
* @param [in] pcId Id value, such as group id. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_ConfQueryById(ZCOOKIE zCookie, ZINT iType, ZCONST ZCHAR* pcId); |
|
|
|
/** |
|
* @brief Get the current speaker volume level |
|
* Only the current existence of audio playback, @ref MTC_CONF_TEST_SPK, |
|
* or when meeting someone speak, will have to play the volume level |
|
* |
|
* @return Playback volume range 0-100 |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2DspGetSpkLevel(); |
|
|
|
/** |
|
* @brief Set the current speaker gain |
|
* @param [in] iGain gain value, volume range 0-100. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2DspSetSpkGain(int iGain); |
|
|
|
/** |
|
* @brief Get json statistics. |
|
* |
|
* @param [in] iConfId The ID of conference. |
|
* |
|
* @return Statistics string. |
|
* ZNULL indicates failed. |
|
*/ |
|
MTCFUNC ZCONST ZCHAR * Mtc_Conf2GetJsonStats(ZUINT iConfId); |
|
|
|
/** |
|
* @brief MTC session get the mute status of speaker. |
|
* |
|
* @param [in] iConfId The ID of session which you want to get. |
|
* |
|
* @retval ZTRUE on muted. |
|
* @retval ZFALSE on not muted. |
|
* |
|
* @see @ref Mtc_Conf2SetSpkMute |
|
*/ |
|
MTCFUNC ZBOOL Mtc_Conf2GetSpkMute(ZUINT iConfId); |
|
|
|
/** |
|
* @brief MTC session set the mute status of speaker. |
|
* |
|
* @param [in] iConfId The ID of session which you want to set. |
|
* @param [in] bMute Indicate whether to mute the speaker. |
|
* |
|
* @retval ZOK on succeed. |
|
* @retval ZFAILED on failure. |
|
* |
|
* @see @ref Mtc_Conf2GetSpkMute |
|
*/ |
|
MTCFUNC ZINT Mtc_Conf2SetSpkMute(ZUINT iConfId, ZBOOL bMute); |
|
|
|
#ifdef __cplusplus |
|
} |
|
#endif |
|
|
|
#endif /* _MTC_CONF2_H__ */
|
|
|