tencent cloud

/*
* @name : TRRO_initGwJson
* @brief : Initializing with a String
* @input : json_str        Configuration file JSON string
* @input : mode            0 synchronous mode, always waiting
*                           -1 asynchronous mode, notify TRRO_onSignalState after successful initialization
* @return : 1 for success, other failed
*/
int TRRO_initGwJson(const char * json_str, int mode = 0);

/*
* @name : TRRO_initGwPath
* @brief : Initializing with a configuration file
* @input : cfg_path        JSON configuration file path, e.g. "./config.json"
* @input : mode            0 synchronous mode, always waiting
*                           -1 asynchronous mode, TRRO_onSignalState information after successful initialization
* @return : 1 for success, other failed
*/
int TRRO_initGwPath(const char * cfg_path, int mode = 0);

/*
* @name : TRRO_initGwPathWithLicense
* @brief : Initializing with a Configuration File and Local License
* @input : cfg_path        JSON configuration file path, e.g. "./config.json"
* @input : license_path    license file path, e.g. "./license.txt"
* @input : mode            0 synchronous mode, always waiting
*                           -1 asynchronous mode, notify TRRO_onSignalState after successful initialization
* @return : 1 for success, other failed
*/
int TRRO_initGwPathWithLicense(const char * cfg_path, const char * license_path, int mode = 0);


/*
* @name : TRRO_initGwJsonWithLicense
* @brief : Initializing with a String and Local License
* @input : json_str        Configuration file JSON string
* @input : license_path    license file path, e.g. "./license.txt"
* @input : mode            initialization mode
*                           0 synchronous mode, always waiting
*                           -1 asynchronous mode, notify TRRO_onSignalState after successful initialization
* @return : 1 for success, other failed
*/
int TRRO_initGwJsonWithLicense(const char * json_str, const char * license_path, int mode = 0);

/*
* @name : TRRO_registerSignalStateCallback
* @brief : Register signaling service connection status callback
* @input : context              Context pointer
           callback              Callback function
* @return : 1 for success, other failed
*/
int TRRO_registerSignalStateCallback(void *context, TRRO_onSignalState *callback);

Callback Definition
enum SignalState {
    kTrroReady = 0, /**< Connection established successfully */
    kTrroLost = 1, /**< Connection lost, automatic reconnection will be attempted internally */
    kTrroReup = 2, /**< Automatic reconnection successful */
    kTrroKickout = 3,
    kTrroAuthFailed = 4, /**< Incorrect username or password */
};

/*
* @name : TRRO_onSignalState
* @brief : Signaling connection status callback
* @input : context        Context pointer
*          state          kTrroReady                Connection established successfully
*                         kTrroLost                 Connection lost, automatic reconnection will be attempted internally
*                         kTrroReup                 Automatic reconnection successful
* @return : void
*/
typedef void TRRO_onSignalState(void *context, SignalState state);

/**
* @name TRRO_registerOnState
* @brief Register video connection status callback function
* @param[in]   context              Context pointer
* @param[in]   callback             Callback function
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerOnState(void* context, TRRO_OnState * callback);

Callback Function Definition
enum TrroState {
    kDisconnect = 0, /**< Disconnected */
    kConnecting = 1, /**< Connecting */
    kConnected = 2,  /**< Connected */
    kDisconnecting = 3, /**< Disconnecting */
};

/**
* @name TRRO_onState
* @brief Video connection status callback
* @param[in]     context        Context pointer
* @param[in]     stream_id      video stream id
* @param[in]     state          TrroState connection status
* @return void
*/
typedef void TRRO_OnState(void* context, int stream_id, int state);

/**
* @name TRRO_registerLatencyCallback
* @brief Register latency callback function
* @param[in]   context              Context pointer
* @param[in]   callback             Callback function
* @return  1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerLatencyCallback(void *context, TRRO_onLatencyReport *callback);

/**
* @name TRRO_onLatencyReport
* @brief Delayed message callback
* @param[in]     context        Context pointer
* @param[in]     stream_id      Stream ID
* @param[in]     vcct           Video control closed-loop delay, equal to video uplink delay (excluding capture) + control downlink delay
* @return void 
*/
typedef void TRRO_onLatencyReport(void *context, int stream_id, int vcct);

/**
* @name  TRRO_registerMediaState
* @brief Register network status
* @param[in]   context              Context pointer
* @param[in]   callback             Callback function
* @return  1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerMediaState(void* context, TRRO_onMediaState * callback);

/**
* @name TRRO_onMediaState
* @brief Media transmission status callback
* @param[in]    context      Callback context pointer
* @param[in]    stream_id    Stream ID 
* @param[in]   fps          Frames per second
* @param[in]   bps          Bits per second
* @param[in]   rtt          Round-trip time
* @param[in]   lost         Total packet loss
* @param[in]   packets_send Total number of packets sent
* @param[in]   stun         NAT traversal mode 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_registerAudioMediaState
* @brief Registering Audio Status Callback
* @param[in]   context              Context pointer
* @param[in]   callback             Callback function
* @return  1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerAudioMediaState(void* context, TRRO_onMediaState * callback);


/**
* @name TRRO_registerEncodeFrameInfoCallback
* @brief Registering Encoding Suggestion Callback Function
* @param[in]    context              Context pointer
* @param[in]    callback             Callback function
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerEncodeFrameInfoCallback(void *context, TRRO_onEncodeFrameInfo *callback);

Callback Function Definition
/**
* @name TRRO_onEncodeFrameInfo
* @brief Encoding suggestion callback, applicable to external input encoding frame scenarios
* @param[in]     context        Context pointer
* @param[in]     stream_id      Stream ID
* @param[in]     type           Callback type, 0: Force keyframe request, 1: Bitrate update request 
* @param[in]     bitrate        Effective when type is 1, indicates the suggested input encoding data bitrate, in kbps 
* @return void 
*/
typedef void TRRO_onEncodeFrameInfo(void *context, int stream_id, int type, int bitrate);

/**
* @name TRRO_start
* @brief Start the audio and video transmission service, to be called after successful initialization (synchronous mode init returns success or asynchronous mode initialization TRRO_onSignalState notifies the connection is Ready)
* @param[in] void
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_start();

/**
* @name TRRO_stop
* @brief Destroy the SDK and release SDK resources
* @param[in] void
* @return void
*/
extern "C" TRRO_EXPORT void TRRO_stop();

/**
* @name  TRRO_registerVideoCaptureCallback
* @brief Register video capture data callback function
* @param[in]   context              Context pointer
* @param[in]   callback             Callback function
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerVideoCaptureCallback(void* context, TRRO_onVideoCaptureData * callback);

/**
* @name TRRO_onVideoCaptureData
* @brief Video frame capture callback
* @param[in]     context        Context pointer, returns the context passed in during registration
* @param[in]     data           Video data
* @param[in]     width          Width
* @param[in]     height         Height
* @param[in]     type           Video format, 0 YUV420, 4 YUYV
* @param[in]     stream_id      Stream number
* @return void 
*/
typedef void TRRO_onVideoCaptureData(void *context, const char* data, int width, int height, int type, int stream_id);

/**
* @name TRRO_sendControlData
* @brief Send data to remote devices
* @param[in] msg Message body
* @param[in] len            Message body length
* @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 Register Remote Device Message Callback Function
* @param[in]   context              Context pointer, returns this context pointer during callback
* @param[in]   callback             Callback function
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerControlDataCallback(void* context, TRRO_onControlData * callback);

Callback Function Definition
/**
* @name TRRO_onControlData
* @brief Receive Remote Device Message Callback
* @param[in]     context        Context pointer, returns the context passed in during registration
* @param[in]     controller_id  Remote device ID
* @param[in]     msg            Message body
* @param[in]     len            Message body length
* @param[in]     qos            Message qos type 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 Register callback for remote device control permission request notification
* @param[in]   context              Context pointer
* @param[in]   callback             Callback function
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerOperationPermissionRequest(void *context, TRRO_onOperationPermissionRequest *callback);

/**
* @name TRRO_onOperationPermissionRequest
* @brief Notification of remote device control permission request
* @param[in]     remote_devid        Remote device ID requesting permission
* @param[in]     permission           Requested permission, refer to TrroPermission, 0: guest (view only), 1: master (full control)
* @return void 
*/
typedef void TRRO_onOperationPermissionRequest(void* context, const char* remote_devid, int permission);

/**
 * @name  TRRO_setOperationPermission
 * @brief Set remote device control permissions. Currently, only one remote device can have master permission at a time. If a remote device already has master permission, calling this API to set master permission will automatically revoke the previous device's master permission and set the new device.
 * @param[in]  remote_devid         Remote device ID to set permissions
 * @param[in]  permission           Refer to TrroPermission, 0 guest, view only, 1 master, full control
 * @return 1 for success, other failed
 */
extern "C" TRRO_EXPORT int TRRO_setOperationPermission(const char* remote_devid, int permission);

/**
* @name  TRRO_reinitRtc(Experimental)
* @brief Reconfiguration, currently only supports resetting extended capture protocols such as normal/combine/rtsp_enc
* @param[in] config   Reconfigure JSON Data
*/
extern "C" TRRO_EXPORT int TRRO_reinitRtc(const char * config);

/**
* @name  TRRO_audioMute(Experimental)
* @brief Mute the audio of the remote deviceID
* @param[in] userid  Pullstream End ID
* @param[in] mute    Whether to mute
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_audioMute(const char* userid, bool mute);

/**
 * MediaDeviceType device type enumeration
 */
 enum MediaDeviceType {
    ///Microphone type device
    MediaDeviceTypeMic = 0,
    ///Speaker type device
    MediaDeviceTypeSpeaker = 1,
};

/**
* @name  TRRO_getDeviceCount(Experimental)
* @brief Query the number of audio devices based on MediaDeviceType.
* @param[in] type Audio device type
* @return Number of devices
*/
extern "C" TRRO_EXPORT int TRRO_getDeviceCount(MediaDeviceType type);


/**
* @name  TRRO_getDeviceName(Experimental)
* @brief Query the device name based on MediaDeviceType and index.
* @param[in] type Device type
* @param[in] index Device index, value is [0, TRRO_getDeviceCount)
* @return Device name, returns null on failure
*/
extern "C" TRRO_EXPORT const char* TRRO_getDeviceName(MediaDeviceType type, int index);



/**
* @name  TRRO_setCurrentDevice(Experimental)
* @brief Set the current capture or playback device based on MediaDeviceType and index.
* @param[in] type Device type
* @param[in] index Device index, value is [0, TRRO_getDeviceCount)
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_setCurrentDevice(MediaDeviceType type, int index);


/**
* @name  TRRO_registerLogCallback
* @brief Register log callback function
* @param[in]   context              Context pointer
* @param[in]   callback             Callback function
* @return 1 for success, other failed
*/
extern "C" TRRO_EXPORT int TRRO_registerLogCallback(void *context, TRRO_OnLogData *callback);