C/C++ 现场设备 SDK API

/*
* @name :  TRRO_initGwJson
* @brief : 使用字符串初始化
* @input : json_str        配置文件json字符串
* @input : mode             0 同步模式，一直等待
*                           -1 异步模式，初始化成功后通知TRRO_onSignalState
* @return : 1 for success, other failed
*/
int TRRO_initGwJson(const char * json_str, int mode = 0);

/*
* @name :  TRRO_initGwPath
* @brief : 使用配置文件初始化
* @input : cfg_path        json配置文件路径名，e.g. "./config.json"
* @input : mode             0  同步模式一直等待
*                           -1 异步模式，初始化成功后TRRO_onSignalState信息
* @return : 1 for success, other failed
*/
int TRRO_initGwPath(const char * cfg_path, int mode = 0);

/*
* @name :  TRRO_initGwPathWithLicense
* @brief : 使用配置文件和本地license初始化
* @input : cfg_path        json配置文件路径名，e.g. "./config.json"
* @input : license_path    license文件路径名，e.g. "./license.txt"
* @input : mode             0 同步模式一直等待
*                           -1 异步模式 初始化成功后通知TRRO_onSignalState
* @return : 1 for success, other failed
*/
int TRRO_initGwPathWithLicense(const char * cfg_path, const char * license_path, int mode = 0);


/*
* @name :  TRRO_initGwJsonWithLicense
* @brief : 使用字符串和本地license初始化
* @input : json_str        配置文件json字符串
* @input : license_path    license文件路径名，e.g. "./license.txt"
* @input : mode            初始化模式
*                            0 同步模式一直等待
*                           -1 异步模式, 初始化成功后通知TRRO_onSignalState
* @return : 1 for success, other failed
*/
int TRRO_initGwJsonWithLicense(const char * json_str, const char * license_path, int mode = 0);

/*
* @name :  TRRO_registerSignalStateCallback
* @brief : 注册信令服务连接状态回调
* @input : context              上下文
           callback             回调函数
* @return : 1 for success, other failed
*/
int TRRO_registerSignalStateCallback(void *context, TRRO_onSignalState *callback);

回调定义
enum SignalState {
    kTrroReady = 0, /**< 连接建立成功 */
    kTrroLost = 1,  /**< 连接断开，内部会进行自动重连 */
    kTrroReup = 2,  /**< 自动重连成功 */
    kTrroKickout = 3,
    kTrroAuthFailed = 4,  /**< 用户名或者密码错误 */
};

/*
* @name :  TRRO_onSignalState
* @brief : 信令连接状态回调
* @input : context        上下文
*          state          kTrroReady                连接建立成功
*                         kTrroLost                 连接断开，内部会进行自动重连
*                         kTrroReup                 自动重连成功
* @return : void
*/
typedef void TRRO_onSignalState(void *context, SignalState state);

/**
* @name TRRO_registerOnState
* @brief 注册视频连接状态回调函数
* @param[in]   context              上下文
* @param[in]   callback             回调函数
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerOnState(void* context, TRRO_OnState * callback);

回调函数定义
enum TrroState {
    kDisconnect = 0, /**< 断连 */
    kConnecting = 1, /**< 连接中 */
    kConnected = 2,  /**< 已连接 */
    kDisconnecting = 3, /**< 已断连 */
};

/**
* @name TRRO_onState
* @brief 视频连接状态回调
* @param[in]     context        上下文
* @param[in]     stream_id      视频流id
* @param[in]     state          TrroState连接状态
* @return void
*/
typedef void TRRO_OnState(void* context, int stream_id, int state);

/**
* @name TRRO_registerLatencyCallback
* @brief 注册时延回调函数
* @param[in]   context              上下文
* @param[in]   callback             回调函数
* @return  1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerLatencyCallback(void *context, TRRO_onLatencyReport *callback);

/**
* @name TRRO_onLatencyReport
* @brief 延迟信息回调
* @param[in]     context        上下文
* @param[in]     stream_id      流ID
* @param[in]     vcct           视频控制闭环时延， 等于视频上行延迟（不含采集）+控制下行延迟
* @return void 
*/
typedef void TRRO_onLatencyReport(void *context, int stream_id, int vcct);

/**
* @name  TRRO_registerMediaState
* @brief 注册网络状态
* @param[in]   context              上下文
* @param[in]   callback             回调函数
* @return  1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerMediaState(void* context, TRRO_onMediaState * callback);

/**
* @name TRRO_onMediaState
* @brief 媒体传输状态回调
* @param[in]    context      回调上下文指针
* @param[in]    stream_id    流ID 
* @param[in]   fps          每秒帧数目
* @param[in]   bps          每秒数据量
* @param[in]   rtt          封包来回时间
* @param[in]   lost         总丢包数目
* @param[in]   packets_send 总发送数目
* @param[in]   stun         穿网模式 0：host, 1：srflx, 2：prflx, 3：relay
* @return void 
*/
typedef void TRRO_onMediaState(void* context, int stream_id, int fps, int bps, int rtt, long long lost, long long packets_send, int stun);

/**
* @name TRRO_registerEncodeFrameInfoCallback
* @brief 注册编码建议信息回调函数
* @param[in]    context              上下文
* @param[in]    callback             回调函数
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerEncodeFrameInfoCallback(void *context, TRRO_onEncodeFrameInfo *callback);

回调函数定义
/**
* @name TRRO_onEncodeFrameInfo
* @brief 编码建议信息回调，适用于外部输入编码帧场景
* @param[in]     context        上下文
* @param[in]     stream_id      流ID
* @param[in]     type           回调类型， 0：强制关键帧请求 ,  1 码率更新请求 
* @param[in]     bitrate        type为1时有效，表示建议输入的编码数据码率，单位kbps 
* @return void 
*/
typedef void TRRO_onEncodeFrameInfo(void *context, int stream_id, int type, int bitrate);

/**
* @name TRRO_start
* @brief 启动音视频传输业务， 需要等待初始化成功后调用（同步模式init返回成功 或 异步模式初始化TRRO_onSignalState通知连接Read）
* @param[in] void
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_start();

/**
* @name TRRO_stop
* @brief 销毁SDK，释放sdk资源
* @param[in]  void
* @return void
*/
extern "C" TRRO_EXPORT void TRRO_stop();

/**
* @name  TRRO_registerVideoCaptureCallback
* @brief 注册视频采集数据回调函数
* @param[in]   context              上下文
* @param[in]   callback             回调函数
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerVideoCaptureCallback(void* context, TRRO_onVideoCaptureData * callback);

/**
* @name TRRO_onVideoCaptureData
* @brief 采集视频帧回调
* @param[in]     context        上下文指针，返回注册时传入的context
* @param[in]     data           视频数据
* @param[in]     width          宽
* @param[in]     height         高
* @param[in]     type           视频格式,0 YUV420, 4 YUYV
* @param[in]     stream_id      流号
* @return void 
*/
typedef void TRRO_onVideoCaptureData(void *context, const char* data, int width, int height, int type, int stream_id);

/**
* @name   TRRO_sendControlData
* @brief  向远端设备发送数据
* @param[in] msg            消息体
* @param[in] len            消息体长度
* @param[in] qos            0:unreliable 1:reliable
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_sendControlData(const char* msg, int len, int qos = 0);

/**
* @name TRRO_registerControlDataCallback
* @brief 注册远端设备消息回调函数
* @param[in]   context              上下文指针，回调时会返回该上下文指针
* @param[in]   callback             回调函数
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerControlDataCallback(void* context, TRRO_onControlData * callback);

回调函数定义
/**
* @name TRRO_onControlData
* @brief 接收远端设备消息回调
* @param[in]     context        上下文指针，返回注册时传入的context
* @param[in]     controller_id  远端设备ID
* @param[in]     msg            消息体内容
* @param[in]     len            消息体长度
* @param[in]     qos            消息qos类型 0:unreliable, 1:reliable
* @return void
*/
typedef void TRRO_onControlData(void *context, const char *controller_id, const char* msg, int len, int qos);

/**
* @name  TRRO_registerOperationPermissionRequest
* @brief 注册远端设备操控权限请求通知回调
* @param[in]   context              上下文
* @param[in]   callback             回调函数
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerOperationPermissionRequest(void *context, TRRO_onOperationPermissionRequest *callback);

/**
* @name TRRO_onOperationPermissionRequest
* @brief 远端设备操控权限申请通知
* @param[in]     remote_devid        请求权限的remote deviceId
* @param[in]     permission          请求的权限，参考TrroPermission，  0: guest 只有观看权限,  1: master 完全控制权限
* @return void 
*/
typedef void TRRO_onOperationPermissionRequest(void* context, const char* remote_devid, int permission);

/**
 * @name  TRRO_setOperationPermission
 * @brief 设置远端设备操控权限，目前同时只能有一个远端设备有master权限，若已有远端设备是master权限，调用该接口设置master权限，会自动取消之前设备的master权限然后设置新设备；
 * @param[in]  remote_devid         设置权限的对端设备id
 * @param[in]  permission           参考 TrroPermission， 0 guest，只有观看权、1 master， 完全控制权限
 * @return 1 for success, other failed
 */
extern "C" TRRO_EXPORT int TRRO_setOperationPermission(const char* remote_devid, int permission);

/**
* @name  TRRO_reinitRtc(Experimental)
* @brief 重配置，当前仅支持重置normal/combine/rtsp_enc等扩展采集协议配置
* @param[in] config   重配置json数据
*/
extern "C" TRRO_EXPORT int TRRO_reinitRtc(const char * config);

/**
* @name  TRRO_audioMute(Experimental)
* @brief Mute 拉流端的音频 仅Server模式
* @param[in] userid  拉流端id
* @param[in] mute    是否mute
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_audioMute(const char* userid, bool mute);

/**
* @name  TRRO_registerLogCallback
* @brief 注册日志回调函数
* @param[in]   context              上下文
* @param[in]   callback             回调函数
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerLogCallback(void *context, TRRO_OnLogData *callback);

/**
* @name TRRO_OnLogData
* @brief 日志回调
* @param[in]     context        上下文
* @param[in]     msg            日志内容
* @param[in]     level          日志级别,参考枚举TrroLogLevel
* @return void 
*/
typedef void TRRO_OnLogData(void *context, const char *msg, int level);

/**
* @name TRRO_registerOnErrorEvent
* @brief 注册错误事件回调函数
* @param[in] context              上下文
* @param[in] callback             回调函数
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerOnErrorEvent(void* context, TRRO_OnErrorEvent * callback);

/**
* @name TRRO_OnErrorEvent
* @brief 错误信息回调
* @param[in] context        上下文
* @param[in] error_code     错误码  为负值
* @param[in] error_msg      错误信息
* @return void
*/
typedef void TRRO_OnErrorEvent(void* context, int error_code,  const char* error_msg);

/**
* @name  getErrorMsg
* @brief 根据错误码，返回错误信息。
* @param[in] errorCode   错误码
* @return errorMsg   排查帮助信息
*/
extern "C" TRRO_EXPORT const char* getErrorMsg(int errorCode);

/**
* @name TRRO_startRecorder(Experimental)
* @brief 启动录制
* @param[in]   recorderID           录制ID (若想录制SDK采集流，id需设置成对应stream， config文件中stream_config需加上 “record_on”:1)
* @param[in]   format               录制格式：0 ：264
* @param[in]   width                编码宽
* @param[in]   heigh                编码高
* @param[in]   jump                 录制跳帧数（隔几帧录一帧）
* @param[in]   fps                  编码帧率
* @param[in]   bps                  码率
* @param[in]   filename             文件名
* @param[in]   config               录制选项（保留）
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_startRecorder(int recorderID, int format, int width, int heigh, int jump, int fps, int bps,
                                  const char* filename,  const char* config);

/**
* @name TRRO_sendRecordVideoData(Experimental)
* @brief 发送录制数据
* @param[in]   recorderID           录制ID
* @param[in]   data                 录制数据
* @param[in]   width                数据源宽
* @param[in]   height               数据源高
* @param[in]   size                 录制数据大小
* @param[in]   format               视频源格式 1 yuv420 , 4 YUYV
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_sendRecordVideoData(int recorderID, const char* data, int width, int height, int format);

/** 
 * @name    TRRO_switchRecorderFile(Experimental)
 * @brief   切换录制文件
 * @param[in]    recorderID     录制ID
 * @param[in]    filename        文件名
 * @return   1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_switchRecorderFile(int recorderID, const char* filename);

/**
* @name   Trro_TRRO_OnStatestopRecorder(Experimental)
* @brief  停止录制
* @param[in]   recorderID      录制ID
* @return  1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_stopRecorder(int recorderID);

/**
 * @name TRRO_onVideoCaptureFrame
 * @brief 外部调用 TRRO_startVideoCapture 时的数据回调
 * @param[in] context      上下文
 * @param[in] capture_id   采集视频的当前源 ID
 * @param[in] data         采集的视频数据
 * @param[in] length       采集的视频数据长度
 * @param[in] width        采集的视频宽度
 * @param[in] height       采集的视频高度
 * @param[in] color_format 采集的视频格式
 * @return void
 */
typedef void TRRO_onVideoCaptureFrame(void *context, unsigned long long capture_id, const char* data, int length, int width, int height, TrroColor color_format);


/**
* @name  TRRO_startVideoCapture
* @brief 开始摄像头采集
* @param[in] context   上下文
* @param[in] url       采集路径，摄像头为 /dev/video*, rtsp 时是 rtsp 的地址
* @param[in] protocol  kRTSP 为网络摄像头 rtsp协议采集，kV4L2_MMAP 为 USB/GMSL 等摄像头 V4L2 协议采集，kV4L2_DMA用于nvidia jetson平台V4L2采集
* @param[in] TrroColor 采集视频格式，V4L2 协议为摄像头图像格式，RTSP 协议采集为目标回调格式
* @param[in] width     采集视频宽度
* @param[in] height    采集视频高度
* @param[in] fps       采集视频帧率
* @param[in] callback  采集视频回
* @param[in, out] capture_id 采集标识符，用于区分不同的采集，传入为指针形式，支持值指定或者自动生成(当(*capture_id) > 0时使用指定传入值，为0使用sdk自动生成值)
* @return 开始采集失败则返回错误码，返回1表示成功ocol, TrroColor color_format, int width, int height, int fps, TRRO_onVideoCaptureFrame callback, unsigned long long* capture_id);