入門使用
會(huì)議管理
更新時(shí)間：2019-11-20
創(chuàng)建預(yù)約會(huì)議
描述
用戶創(chuàng)建預(yù)約會(huì)議。
前提是鑒權(quán)登錄成功和會(huì)議環(huán)境參數(shù)已設(shè)置。
業(yè)務(wù)流程
圖1 預(yù)約會(huì)議流程
-
UI調(diào)用tsdk_book_conference()預(yù)約會(huì)議，會(huì)議參數(shù)結(jié)構(gòu)為TSDK_S_BOOK_CONF_INFO，SDK發(fā)送預(yù)約會(huì)議請(qǐng)求至?xí)h服務(wù)器。
說明：
- 在預(yù)約會(huì)議時(shí)，會(huì)議開始時(shí)間（start_time）、會(huì)議方數(shù)（size）、會(huì)議類型（conf_type）、媒體類型（conf_media_type）和與會(huì)者信息（attendee_num&attendee_list）必選，其他參數(shù)可選；
- 按具體需求填寫會(huì)議方數(shù)，當(dāng)實(shí)際與會(huì)者數(shù)目多于設(shè)置的方數(shù)時(shí)，服務(wù)會(huì)自動(dòng)擴(kuò)大會(huì)議方數(shù)，當(dāng)填寫方數(shù)小于3時(shí)，服務(wù)器默認(rèn)會(huì)議方數(shù)為3。
- 預(yù)約會(huì)議，會(huì)議類型應(yīng)選TSDK_E_CONF_RESERVED。
- 服務(wù)器默認(rèn)時(shí)間為UTC時(shí)間，在預(yù)約時(shí)需將預(yù)約時(shí)間轉(zhuǎn)換為UTC時(shí)間。
代碼示例：-(BOOL)tsdkConfctrlBookConf:(NSArray *)attendeeArray mediaType:(EC_CONF_MEDIATYPE)mediaType startTime:(NSDate *)startTime confLen:(int)confLen subject:(NSString *)subject { TSDK_S_BOOK_CONF_INFO *bookConfInfoUportal = (TSDK_S_BOOK_CONF_INFO *)malloc(sizeof(TSDK_S_BOOK_CONF_INFO)); memset_s(bookConfInfoUportal, sizeof(TSDK_S_BOOK_CONF_INFO), 0, sizeof(TSDK_S_BOOK_CONF_INFO)); if (subject.length > 0 && subject != nil) { strcpy(bookConfInfoUportal->subject, [subject UTF8String]); } bookConfInfoUportal->conf_type = TSDK_E_CONF_INSTANT; if (startTime != nil) { NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init]; [dateFormatter setDateFormat:@"yyyy-MM-dd HH:mm"]; NSString *startTimeStr = [dateFormatter stringFromDate:startTime]; NSString *utcStr = [self getUTCFormateLocalDate:startTimeStr]; DDLogInfo(@"start time : %@, utc time: %@",startTimeStr,utcStr); strcpy(bookConfInfoUportal->start_time, [utcStr UTF8String]); bookConfInfoUportal->duration = confLen; bookConfInfoUportal->conf_type = TSDK_E_CONF_RESERVED; } if (attendeeArray.count == 0) { bookConfInfoUportal->size = 5; bookConfInfoUportal->attendee_num = 0; bookConfInfoUportal->attendee_list = NULL; }else{ bookConfInfoUportal->size = (TSDK_UINT32)attendeeArray.count * 2; bookConfInfoUportal->attendee_num = (TSDK_UINT32)attendeeArray.count; bookConfInfoUportal->attendee_list = [self returnAttendeeWithArray:attendeeArray]; } bookConfInfoUportal->conf_media_type = (TSDK_E_CONF_MEDIA_TYPE)mediaType; bookConfInfoUportal->is_hd_conf = TSDK_FALSE; bookConfInfoUportal->is_multi_stream_conf = TSDK_FALSE; bookConfInfoUportal->is_auto_record = TSDK_FALSE; bookConfInfoUportal->is_auto_prolong = TSDK_TRUE; bookConfInfoUportal->is_auto_mute = TSDK_FALSE; bookConfInfoUportal->welcome_prompt = TSDK_E_CONF_WARNING_DEFAULT; bookConfInfoUportal->enter_prompt = TSDK_E_CONF_WARNING_DEFAULT; bookConfInfoUportal->leave_prompt = TSDK_E_CONF_WARNING_DEFAULT; bookConfInfoUportal->reminder = TSDK_E_CONF_REMINDER_NONE; bookConfInfoUportal->language = TSDK_E_CONF_LANGUAGE_ZH_CN; TSDK_RESULT ret = tsdk_book_conference(bookConfInfoUportal); DDLogInfo(@"tsdk_book_conference result : %d",ret); free(bookConfInfoUportal); return ret == TSDK_SUCCESS ? YES : NO; } -
SDK在收到服務(wù)器返回的會(huì)議預(yù)約結(jié)果響應(yīng)后，向UI上報(bào)預(yù)約會(huì)議結(jié)果通知TSDK_E_CONF_EVT_BOOK_CONF_RESULT，對(duì)應(yīng)的結(jié)果數(shù)據(jù)結(jié)構(gòu)為TSDK_S_CONF_BASE_INFO。
代碼示例：
case TSDK_E_CONF_EVT_BOOK_CONF_RESULT: { DDLogInfo(@"TSDK_E_CONF_EVT_BOOK_CONF_RESULT"); BOOL result = notify.param1 == TSDK_SUCCESS; if (!result) { DDLogError(@"TSDK_E_CONF_EVT_BOOK_CONF_RESULT,error:%@",[NSString stringWithUTF8String:(TSDK_CHAR *)notify.data]); return; } TSDK_S_CONF_BASE_INFO *confListInfo = (TSDK_S_CONF_BASE_INFO *)notify.data; }
注意事項(xiàng)
無。
創(chuàng)建即時(shí)會(huì)議
描述
用戶創(chuàng)建立即會(huì)議。
說明：
立即會(huì)議創(chuàng)建成功后，用戶的SIP號(hào)碼自動(dòng)入會(huì)，用戶作為會(huì)議主席召集其他與會(huì)者加入會(huì)議。
前提條件
- 鑒權(quán)登錄成功。
- SIP號(hào)碼已成功注冊(cè)。
- 會(huì)議環(huán)境參數(shù)已設(shè)置。
業(yè)務(wù)流程
圖2 創(chuàng)建立即會(huì)議流程
-
UI調(diào)用tsdk_book_conference()創(chuàng)建立即會(huì)議，會(huì)議參數(shù)結(jié)構(gòu)為TSDK_S_BOOK_CONF_INFO；SDK發(fā)送創(chuàng)建會(huì)議請(qǐng)求至?xí)h服務(wù)器。
說明：
在創(chuàng)建即時(shí)會(huì)議時(shí)，會(huì)議方數(shù)（size）、會(huì)議類型（conf_type），媒體類型（conf_media_type）和與會(huì)者信息（attendee_num&attendee_list）必選，其他參數(shù)可選。
- 預(yù)約會(huì)議，會(huì)議類型應(yīng)選TSDK_E_CONF_INSTANT。
- 會(huì)議開始時(shí)間不用指定。
- 服務(wù)器默認(rèn)時(shí)間為UTC時(shí)間，在預(yù)約時(shí)需將預(yù)約時(shí)間轉(zhuǎn)換為UTC時(shí)間。
代碼示例：-(BOOL)tsdkConfctrlBookConf:(NSArray *)attendeeArray mediaType:(EC_CONF_MEDIATYPE)mediaType startTime:(NSDate *)startTime confLen:(int)confLen subject:(NSString *)subject { TSDK_S_BOOK_CONF_INFO *bookConfInfoUportal = (TSDK_S_BOOK_CONF_INFO *)malloc(sizeof(TSDK_S_BOOK_CONF_INFO)); memset_s(bookConfInfoUportal, sizeof(TSDK_S_BOOK_CONF_INFO), 0, sizeof(TSDK_S_BOOK_CONF_INFO)); if (subject.length > 0 && subject != nil) { strcpy(bookConfInfoUportal->subject, [subject UTF8String]); } bookConfInfoUportal->conf_type = TSDK_E_CONF_INSTANT; if (startTime != nil) { NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init]; [dateFormatter setDateFormat:@"yyyy-MM-dd HH:mm"]; NSString *startTimeStr = [dateFormatter stringFromDate:startTime]; NSString *utcStr = [self getUTCFormateLocalDate:startTimeStr]; DDLogInfo(@"start time : %@, utc time: %@",startTimeStr,utcStr); strcpy(bookConfInfoUportal->start_time, [utcStr UTF8String]); bookConfInfoUportal->duration = confLen; bookConfInfoUportal->conf_type = TSDK_E_CONF_RESERVED; } if (attendeeArray.count == 0) { bookConfInfoUportal->size = 5; bookConfInfoUportal->attendee_num = 0; bookConfInfoUportal->attendee_list = NULL; }else{ bookConfInfoUportal->size = (TSDK_UINT32)attendeeArray.count * 2; bookConfInfoUportal->attendee_num = (TSDK_UINT32)attendeeArray.count; bookConfInfoUportal->attendee_list = [self returnAttendeeWithArray:attendeeArray]; } bookConfInfoUportal->conf_media_type = (TSDK_E_CONF_MEDIA_TYPE)mediaType; bookConfInfoUportal->is_hd_conf = TSDK_FALSE; bookConfInfoUportal->is_multi_stream_conf = TSDK_FALSE; bookConfInfoUportal->is_auto_record = TSDK_FALSE; bookConfInfoUportal->is_auto_prolong = TSDK_TRUE; bookConfInfoUportal->is_auto_mute = TSDK_FALSE; bookConfInfoUportal->welcome_prompt = TSDK_E_CONF_WARNING_DEFAULT; bookConfInfoUportal->enter_prompt = TSDK_E_CONF_WARNING_DEFAULT; bookConfInfoUportal->leave_prompt = TSDK_E_CONF_WARNING_DEFAULT; bookConfInfoUportal->reminder = TSDK_E_CONF_REMINDER_NONE; bookConfInfoUportal->language = TSDK_E_CONF_LANGUAGE_ZH_CN; TSDK_RESULT ret = tsdk_book_conference(bookConfInfoUportal); DDLogInfo(@"tsdk_book_conference result : %d",ret); free(bookConfInfoUportal); return ret == TSDK_SUCCESS ? YES : NO; } -
SDK在收到服務(wù)器返回的立即會(huì)議創(chuàng)建響應(yīng)后，向UI上報(bào)會(huì)議創(chuàng)建結(jié)果通知TSDK_E_CONF_EVT_BOOK_CONF_RESULT，對(duì)應(yīng)的結(jié)果數(shù)據(jù)結(jié)構(gòu)為TSDK_S_CONF_BASE_INFO，UI應(yīng)提示創(chuàng)建會(huì)議成功。
代碼示例：
case TSDK_E_CONF_EVT_BOOK_CONF_RESULT: { DDLogInfo(@"TSDK_E_CONF_EVT_BOOK_CONF_RESULT"); BOOL result = notify.param1 == TSDK_SUCCESS; if (!result) { DDLogError(@"TSDK_E_CONF_EVT_BOOK_CONF_RESULT,error:%@",[NSString stringWithUTF8String:(TSDK_CHAR *)notify.data]); return; } TSDK_S_CONF_BASE_INFO *confListInfo = (TSDK_S_CONF_BASE_INFO *)notify.data; } -
SDK在收到服務(wù)器返回的加入會(huì)議響應(yīng)后，向UI上報(bào)加入會(huì)議結(jié)果通知TSDK_E_CONF_EVT_JOIN_CONF_RESULT，對(duì)應(yīng)的結(jié)果數(shù)據(jù)結(jié)構(gòu)為TSDK_S_JOIN_CONF_IND_INFO，并返回conf handle，后續(xù)會(huì)控時(shí)使用，此時(shí)， UI可跳轉(zhuǎn)至?xí)h界面。
說明：
- 在加入會(huì)議時(shí)，會(huì)請(qǐng)求會(huì)議權(quán)限，若請(qǐng)求失敗，則會(huì)向UI上報(bào)會(huì)議權(quán)限請(qǐng)求失敗通知TSDK_E_CONF_EVT_REQUEST_CONF_RIGHT_FAILED，UI提示申請(qǐng)會(huì)控權(quán)限失敗，若請(qǐng)求成功，則不上報(bào)。
- 若應(yīng)用程序是以多流的方式(SVC)成功加入會(huì)議，則此結(jié)果通知中會(huì)攜帶SVC信息，包含 is_svc_conf (是否多流會(huì)議)、svc_label_count(可使用的多流Label數(shù)) 和 svc_label (多流Label 表)，應(yīng)用程序應(yīng)保存多流“Label”信息，用于后繼流程中“綁定SVC視頻窗口”、"選看SVC與會(huì)者"和“設(shè)置SVC窗口和與會(huì)者關(guān)系”等操作。
代碼示例：case TSDK_E_CONF_EVT_JOIN_CONF_RESULT: { DDLogInfo(@"TSDK_E_CONF_EVT_JOIN_CONF_RESULT"); BOOL result = notify.param2 == TSDK_SUCCESS; if (!result) { DDLogError(@"TSDK_E_CONF_EVT_JOIN_CONF_RESULT,error:%@",[NSString stringWithUTF8String:(TSDK_CHAR *)notify.data]); return; } _confHandle = notify.param1; TSDK_S_JOIN_CONF_IND_INFO *confInfo = (TSDK_S_JOIN_CONF_IND_INFO *)notify.data; _currentCallId = confInfo->call_id; dispatch_async(dispatch_get_main_queue(), ^{ // go conference [self goConferenceRunView:nil]; [self respondsECConferenceDelegateWithType:CONF_E_CONNECT result:nil]; [[NSNotificationCenter defaultCenter] postNotificationName:TUP_CALL_REMOVE_CALL_VIEW_NOTIFY object:nil]; }); } break; -
SDK收到會(huì)議狀態(tài)更新通知，向UI上報(bào)會(huì)議信息及狀態(tài)更新事件TSDK_E_CONF_EVT_INFO_AND_STATUS_UPDATE，UI刷新會(huì)議成員列表和會(huì)議信息。
代碼示例：
case TSDK_E_CONF_EVT_INFO_AND_STATUS_UPDATE: { DDLogInfo(@"TSDK_E_CONF_EVT_INFO_AND_STATUS_UPDATE"); [self handleAttendeeUpdateNotify:notify]; } break; -
若會(huì)議包含數(shù)據(jù)會(huì)議能力，SDK會(huì)向UI上報(bào)獲取數(shù)據(jù)會(huì)議參數(shù)結(jié)果TSDK_E_CONF_EVT_GET_DATACONF_PARAM_RESULT。
代碼示例：
case TSDK_E_CONF_EVT_GET_DATACONF_PARAM_RESULT: { DDLogInfo(@"TSDK_E_CONF_EVT_GET_DATACONF_PARAM_RESULT"); BOOL result = notify.param2 == TSDK_SUCCESS; if (!result) { DDLogError(@"TSDK_E_CONF_EVT_GET_DATACONF_PARAM_RESULT,error:%@",[NSString stringWithUTF8String:(TSDK_CHAR *)notify.data]); return; } dispatch_async(dispatch_get_main_queue(), ^{ [self joinDataConference]; [self startHeartBeatTimer]; }); } break; -
此時(shí)UI可選擇自動(dòng)加入或用戶選擇加入數(shù)據(jù)會(huì)議，調(diào)用加入數(shù)據(jù)會(huì)議接口tsdk_join_data_conference()，SDK發(fā)送創(chuàng)建會(huì)議請(qǐng)求至?xí)h服務(wù)器。
代碼示例：
-(void)joinDataConference { TSDK_RESULT result = tsdk_join_data_conference(_confHandle); DDLogInfo(@"tsdk_join_data_conference ret: %d", result); } -
SDK在收服務(wù)器加入數(shù)據(jù)會(huì)議響應(yīng)后，向UI上報(bào)數(shù)據(jù)會(huì)議加入結(jié)果通知TSDK_E_CONF_EVT_JOIN_DATA_CONF_RESULT，若成功，則UI刷新界面，提示加入數(shù)據(jù)會(huì)議成功，若失敗，則提示加入數(shù)據(jù)會(huì)議失敗。
說明：
在加入數(shù)據(jù)會(huì)議后，會(huì)向UI上報(bào)會(huì)議信息及狀態(tài)更新事件TSDK_E_CONF_EVT_INFO_AND_STATUS_UPDATE，UI刷新會(huì)議成員列表和會(huì)議信息。
代碼示例：case TSDK_E_CONF_EVT_JOIN_DATA_CONF_RESULT: { DDLogInfo(@"TSDK_E_CONF_EVT_JOIN_DATA_CONF_RESULT"); NSDictionary *resultInfo = nil; BOOL isSuccess = notify.param2 == TSDK_SUCCESS; resultInfo = @{ UCCONF_RESULT_KEY :[NSNumber numberWithBool:isSuccess] }; [self respondsECConferenceDelegateWithType:DATA_CONF_JOIN_RESOULT result:resultInfo]; } break;
注意事項(xiàng)
無。
查詢會(huì)議列表
描述
用戶查詢自己“創(chuàng)建”的和“待參加”的預(yù)約會(huì)議信息。
前提條件
- 鑒權(quán)登錄成功。
- 會(huì)議環(huán)境參數(shù)已設(shè)置。
業(yè)務(wù)流程
圖3 查詢會(huì)議列表流程
-
UI調(diào)用tsdk_query_conference_list()查詢會(huì)議列表，查詢會(huì)議列表的請(qǐng)求信息結(jié)構(gòu)為TSDK_S_QUERY_CONF_LIST_REQ。
說明：
1、會(huì)議權(quán)限（conf_right）用于指定要查詢的會(huì)議權(quán)限類型，包含查詢創(chuàng)建的會(huì)議、待參加的會(huì)議或創(chuàng)建和待參加的會(huì)議，可選填；
2、請(qǐng)求會(huì)議列表頁(yè)索引（page_index），取值從1開始，建議與應(yīng)用程序與會(huì)議列表的頁(yè)簽對(duì)應(yīng)，必須要有明確值；
3、會(huì)議列表每頁(yè)的會(huì)議個(gè)數(shù)（page_size），建議與應(yīng)用程序會(huì)議列表個(gè)數(shù)相同，必須要有明確值。
4、返回來的時(shí)間為UTC時(shí)間，UI進(jìn)行頁(yè)面呈現(xiàn)之前需要將UTC時(shí)間轉(zhuǎn)換為本地時(shí)間。
代碼示例：-(BOOL)obtainConferenceListWithPageIndex:(int)pageIndex pageSize:(int)pageSize { TSDK_S_QUERY_CONF_LIST_REQ conflistInfo; memset(&conflistInfo, 0, sizeof(TSDK_S_QUERY_CONF_LIST_REQ)); conflistInfo.conf_right = TSDK_E_CONF_RIGHT_CREATE_JOIN; conflistInfo.is_include_end = TSDK_FALSE; conflistInfo.page_index = pageIndex; conflistInfo.page_size = pageSize; int result = tsdk_query_conference_list(&conflistInfo); DDLogInfo(@"tsdk_query_conference_list result: %d",result); return result == TSDK_SUCCESS ? YES : NO; } -
SDK在收到服務(wù)器返回的查詢會(huì)議列表響應(yīng)后，向UI上報(bào)查詢會(huì)議列表結(jié)果通知TSDK_E_CONF_EVT_QUERY_CONF_LIST_RESULT，對(duì)應(yīng)的結(jié)果數(shù)據(jù)結(jié)構(gòu)為TSDK_S_CONF_LIST_INFO。
說明：
1、查詢會(huì)議列表只返回會(huì)議的概要信息，如需查詢會(huì)議詳情（包括與會(huì)者信息），需要“查詢會(huì)議詳情”；
2、會(huì)議的主席密碼需要“查詢會(huì)議詳情”獲取。
代碼示例：case TSDK_E_CONF_EVT_QUERY_CONF_LIST_RESULT: { DDLogInfo(@"TSDK_E_CONF_EVT_QUERY_CONF_LIST_RESULT"); BOOL result = notify.param1 == TSDK_SUCCESS; if (!result) { DDLogError(@"TSDK_E_CONF_EVT_QUERY_CONF_LIST_RESULT,error:%@",[NSString stringWithUTF8String:(TSDK_CHAR *)notify.data]); return; } [self handleGetConfListResult:notify]; } break;
注意事項(xiàng)
無。
查詢會(huì)議詳情
描述
用戶查詢指定會(huì)議的詳細(xì)信息。
前提條件
- 鑒權(quán)登錄成功。
- 會(huì)議環(huán)境參數(shù)已設(shè)置。
業(yè)務(wù)流程
圖4 查詢會(huì)議詳情流程
-
UI調(diào)用tsdk_query_conference_detail查詢會(huì)議詳情，請(qǐng)求信息結(jié)構(gòu)為TSDK_S_QUERY_CONF_DETAIL_REQ。
說明：
請(qǐng)求消息結(jié)構(gòu)TSDK_S_QUERY_CONF_DETAIL_REQ中，
- conf_id：需要查詢的會(huì)議ID，通過查詢列表或其他方式獲??；
- page_index：請(qǐng)求與會(huì)者列表頁(yè)索引，取值從1開始，建議與應(yīng)用程序與會(huì)者列表的頁(yè)簽對(duì)應(yīng)；
- page_size：與會(huì)者列表每頁(yè)的與會(huì)者個(gè)數(shù)，建議與應(yīng)用程序與會(huì)者列表個(gè)數(shù)相同。
代碼示例：-(BOOL)obtainConferenceDetailInfoWithConfId:(NSString *)confId Page:(int)pageIndex pageSize:(int)pageSize { if (confId.length == 0) { DDLogInfo(@"current confId is nil"); return NO; } TSDK_S_QUERY_CONF_DETAIL_REQ confInfo; memset(&confInfo, 0, sizeof(TSDK_S_QUERY_CONF_LIST_REQ)); if (confId.length > 0 && confId != nil) { strcpy(confInfo.conf_id, [confId UTF8String]); } confInfo.page_size = pageSize; confInfo.page_index = pageIndex; int getConfInfoRestult = tsdk_query_conference_detail(&confInfo); DDLogInfo(@"tsdk_query_conference_detail result: %d",getConfInfoRestult); return getConfInfoRestult == TSDK_SUCCESS ? YES : NO; } -
SDK在收到服務(wù)器返回的查詢會(huì)議詳情響應(yīng)后，向UI上報(bào)查詢結(jié)果事件TSDK_E_CONF_EVT_QUERY_CONF_DETAIL_RESULT，對(duì)應(yīng)的結(jié)果數(shù)據(jù)結(jié)構(gòu)為TSDK_S_CONF_DETAIL_INFO。
代碼示例：
case TSDK_E_CONF_EVT_QUERY_CONF_DETAIL_RESULT: { DDLogInfo(@"TSDK_E_CONF_EVT_QUERY_CONF_DETAIL_RESULT"); BOOL result = notify.param1 == TSDK_SUCCESS; if (!result) { DDLogError(@"TSDK_E_CONF_EVT_QUERY_CONF_DETAIL_RESULT,error:%@",[NSString stringWithUTF8String:(TSDK_CHAR *)notify.data]); return; } [self handleGetConfInfoResult:notify]; } break;
注意事項(xiàng)
無。
