Typedefs | Functions
msp_cmn.h File Reference

Mobile Speech Platform Common Interface Header File. More...

#include "msp_types.h"
Include dependency graph for msp_cmn.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef int(* DownloadResultCB) (const void *data, long dataLen, void *userData)
 
typedef int(* DownloadStatusCB) (int errorCode, long param1, const void *param2, void *userData)
 
typedef void(* msp_status_ntf_handler) (int type, int status, int param1, const void *param2, void *userData)
 
typedef int(* NLPSearchCB) (const char *sessionID, int errorCode, int status, const void *result, long rsltLen, void *userData)
 
typedef int(MSPAPIProc_MSPAppendData) (void *data, unsigned int dataLen, unsigned int dataStatus)
 
typedef int(MSPAPIProc_MSPDownload) (const char *dataName, const char *params, DownloadStatusCB statusCb, DownloadResultCB resultCb, void *userData)
 
typedef const void *(MSPAPIProc_MSPDownloadData) (const char *params, unsigned int *dataLen, int *errorCode)
 
typedef const void *(MSPAPIProc_MSPDownloadDataW) (const wchar_t *params, unsigned int *dataLen, int *errorCode)
 
typedef int(MSPAPIProc_MSPDownloadW) (const wchar_t *wdataName, const wchar_t *wparams, DownloadStatusCB statusCb, DownloadResultCB resultCb, void *userData)
 
typedef int(MSPAPIProc_MSPGetParam) (const char *paramName, char *paramValue, unsigned int *valueLen)
 
typedef const char *(MSPAPIProc_MSPGetResult) (unsigned int *rsltLen, int *rsltStatus, int *errorCode)
 
typedef const char *(MSPAPIProc_MSPGetVersion) (const char *verName, int *errorCode)
 
typedef int(MSPAPIProc_MSPLogin) (const char *usr, const char *pwd, const char *params)
 
typedef int(MSPAPIProc_MSPLoginW) (const wchar_t *usr, const wchar_t *pwd, const wchar_t *params)
 
typedef int(MSPAPIProc_MSPLogout) ()
 
typedef int(MSPAPIProc_MSPLogoutW) ()
 
typedef const char *(MSPAPIProc_MSPNlpSearch) (const char *params, const char *text, unsigned int textLen, int *errorCode, NLPSearchCB callback, void *userData)
 
typedef const char *(MSPAPIProc_MSPRegisterNotify) (msp_status_ntf_handler statusCb, void *userData)
 
typedef const char *(MSPAPIProc_MSPSearch) (const char *params, const char *text, unsigned int *dataLen, int *errorCode)
 
typedef int(MSPAPIProc_MSPSetParam) (const char *paramName, const char *paramValue)
 
typedef int(MSPAPIProc_MSPUpload) (const char *dataName, const char *params, const char *dataID)
 
typedef const char *(MSPAPIProc_MSPUploadData) (const char *dataName, void *data, unsigned int dataLen, const char *params, int *errorCode)
 

Functions

wchar_t * Mbytes2Wchar (const char *mbstr)
 
int MSPAPI MSPAppendData (void *data, unsigned int dataLen, unsigned int dataStatus)
 
int MSPAPI MSPDownload (const char *dataName, const char *params, DownloadStatusCB statusCb, DownloadResultCB resultCb, void *userData)
 
const void *MSPAPI MSPDownloadData (const char *params, unsigned int *dataLen, int *errorCode)
 
const void *MSPAPI MSPDownloadDataW (const wchar_t *params, unsigned int *dataLen, int *errorCode)
 
int MSPAPI MSPDownloadW (const wchar_t *wdataName, const wchar_t *wparams, DownloadStatusCB statusCb, DownloadResultCB resultCb, void *userData)
 
int MSPAPI MSPGetParam (const char *paramName, char *paramValue, unsigned int *valueLen)
 
const char *MSPAPI MSPGetResult (unsigned int *rsltLen, int *rsltStatus, int *errorCode)
 
const char *MSPAPI MSPGetVersion (const char *verName, int *errorCode)
 
int MSPAPI MSPLogin (const char *usr, const char *pwd, const char *params)
 
int MSPAPI MSPLoginW (const wchar_t *usr, const wchar_t *pwd, const wchar_t *params)
 
int MSPAPI MSPLogout ()
 user logout interface More...
 
int MSPAPI MSPLogoutW ()
 
int MSPAPI MSPNlpSchCancel (const char *sessionID, const char *hints)
 
const char *MSPAPI MSPNlpSearch (const char *params, const char *text, unsigned int textLen, int *errorCode, NLPSearchCB callback, void *userData)
 
int MSPAPI MSPRegisterNotify (msp_status_ntf_handler statusCb, void *userData)
 
const char *MSPAPI MSPSearch (const char *params, const char *text, unsigned int *dataLen, int *errorCode)
 
int MSPAPI MSPSetParam (const char *paramName, const char *paramValue)
 
int MSPAPI MSPUpload (const char *dataName, const char *params, const char *dataID)
 
const char *MSPAPI MSPUploadData (const char *dataName, void *data, unsigned int dataLen, const char *params, int *errorCode)
 
char * Wchar2Mbytes (const wchar_t *wcstr)
 

Detailed Description

Mobile Speech Platform Common Interface Header File.

This file contains the quick common programming interface (API) declarations

of MSP. Developer can include this file in your project to build applications.

For more information, please read the developer guide.

Use of this software is subject to certain restrictions and limitations set

forth in a license agreement entered into between iFLYTEK, Co,LTD.

and the licensee of this software. Please refer to the license

agreement for license use rights and restrictions.

Copyright (C) 1999 - 2012 by ANHUI USTC iFLYTEK, Co,LTD.

             All rights reserved.
Author
Speech Dept. iFLYTEK.
Version
1.0
Date
2012/09/01
See also

History:

index version date author notes

0 1.0 2012/09/01 MSC40 Create this file

Definition in file msp_cmn.h.

Typedef Documentation

typedef int(* DownloadResultCB) (const void *data, long dataLen, void *userData)

Definition at line 236 of file msp_cmn.h.

typedef int(* DownloadStatusCB) (int errorCode, long param1, const void *param2, void *userData)

Definition at line 234 of file msp_cmn.h.

typedef void(* msp_status_ntf_handler) (int type, int status, int param1, const void *param2, void *userData)

Definition at line 494 of file msp_cmn.h.

typedef int(* NLPSearchCB) (const char *sessionID, int errorCode, int status, const void *result, long rsltLen, void *userData)

Definition at line 461 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPAppendData) (void *data, unsigned int dataLen, unsigned int dataStatus)

Definition at line 276 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPDownload) (const char *dataName, const char *params, DownloadStatusCB statusCb, DownloadResultCB resultCb, void *userData)

Definition at line 241 of file msp_cmn.h.

typedef const void*(MSPAPI* Proc_MSPDownloadData) (const char *params, unsigned int *dataLen, int *errorCode)

Definition at line 421 of file msp_cmn.h.

typedef const void*(MSPAPI* Proc_MSPDownloadDataW) (const wchar_t *params, unsigned int *dataLen, int *errorCode)

Definition at line 427 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPDownloadW) (const wchar_t *wdataName, const wchar_t *wparams, DownloadStatusCB statusCb, DownloadResultCB resultCb, void *userData)

Definition at line 247 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPGetParam) (const char *paramName, char *paramValue, unsigned int *valueLen)

Definition at line 358 of file msp_cmn.h.

typedef const char*(MSPAPI* Proc_MSPGetResult) (unsigned int *rsltLen, int *rsltStatus, int *errorCode)

Definition at line 304 of file msp_cmn.h.

typedef const char*(MSPAPI* Proc_MSPGetVersion) (const char *verName, int *errorCode)

Definition at line 524 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPLogin) (const char *usr, const char *pwd, const char *params)

Definition at line 146 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPLoginW) (const wchar_t *usr, const wchar_t *pwd, const wchar_t *params)

Definition at line 152 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPLogout) ()

Definition at line 176 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPLogoutW) ()

Definition at line 182 of file msp_cmn.h.

typedef const char*(MSPAPI* Proc_MSPNlpSearch) (const char *params, const char *text, unsigned int textLen, int *errorCode, NLPSearchCB callback, void *userData)

Definition at line 467 of file msp_cmn.h.

typedef const char*(MSPAPI* Proc_MSPRegisterNotify) (msp_status_ntf_handler statusCb, void *userData)

Definition at line 498 of file msp_cmn.h.

typedef const char*(MSPAPI* Proc_MSPSearch) (const char *params, const char *text, unsigned int *dataLen, int *errorCode)

Definition at line 458 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPSetParam) (const char *paramName, const char *paramValue)

Definition at line 330 of file msp_cmn.h.

typedef int(MSPAPI* Proc_MSPUpload) (const char *dataName, const char *params, const char *dataID)

Definition at line 212 of file msp_cmn.h.

typedef const char*(MSPAPI* Proc_MSPUploadData) (const char *dataName, void *data, unsigned int dataLen, const char *params, int *errorCode)

Definition at line 391 of file msp_cmn.h.

Function Documentation

wchar_t* Mbytes2Wchar ( const char *  mbstr)
int MSPAPI MSPAppendData ( void *  data,
unsigned int  dataLen,
unsigned int  dataStatus 
)
int MSPAPI MSPDownload ( const char *  dataName,
const char *  params,
DownloadStatusCB  statusCb,
DownloadResultCB  resultCb,
void *  userData 
)
const void* MSPAPI MSPDownloadData ( const char *  params,
unsigned int *  dataLen,
int *  errorCode 
)
const void* MSPAPI MSPDownloadDataW ( const wchar_t *  params,
unsigned int *  dataLen,
int *  errorCode 
)
int MSPAPI MSPDownloadW ( const wchar_t *  wdataName,
const wchar_t *  wparams,
DownloadStatusCB  statusCb,
DownloadResultCB  resultCb,
void *  userData 
)
int MSPAPI MSPGetParam ( const char *  paramName,
char *  paramValue,
unsigned int *  valueLen 
)
const char* MSPAPI MSPGetResult ( unsigned int *  rsltLen,
int *  rsltStatus,
int *  errorCode 
)
const char* MSPAPI MSPGetVersion ( const char *  verName,
int *  errorCode 
)
int MSPAPI MSPLogin ( const char *  usr,
const char *  pwd,
const char *  params 
)
int MSPAPI MSPLoginW ( const wchar_t *  usr,
const wchar_t *  pwd,
const wchar_t *  params 
)
MSPLogout ( )

user logout interface

User logout

Returns
int MSPAPI - Return 0 in success, otherwise return error code.
See also
int MSPAPI MSPLogoutW ( )
int MSPAPI MSPNlpSchCancel ( const char *  sessionID,
const char *  hints 
)
const char* MSPAPI MSPNlpSearch ( const char *  params,
const char *  text,
unsigned int  textLen,
int *  errorCode,
NLPSearchCB  callback,
void *  userData 
)
int MSPAPI MSPRegisterNotify ( msp_status_ntf_handler  statusCb,
void *  userData 
)
const char* MSPAPI MSPSearch ( const char *  params,
const char *  text,
unsigned int *  dataLen,
int *  errorCode 
)
int MSPAPI MSPSetParam ( const char *  paramName,
const char *  paramValue 
)
int MSPAPI MSPUpload ( const char *  dataName,
const char *  params,
const char *  dataID 
)
const char* MSPAPI MSPUploadData ( const char *  dataName,
void *  data,
unsigned int  dataLen,
const char *  params,
int *  errorCode 
)
char* Wchar2Mbytes ( const wchar_t *  wcstr)


xbot_talker
Author(s): wangxiaoyun
autogenerated on Sat Oct 10 2020 03:27:54