rtc.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537
  1. /**
  2. * Copyright (c) 2019-2021 Paul-Louis Ageneau
  3. *
  4. * This Source Code Form is subject to the terms of the Mozilla Public
  5. * License, v. 2.0. If a copy of the MPL was not distributed with this
  6. * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  7. */
  8. #ifndef RTC_C_API
  9. #define RTC_C_API
  10. #include "version.h"
  11. #ifdef __cplusplus
  12. extern "C" {
  13. #endif
  14. #include <stdbool.h>
  15. #include <stdint.h>
  16. #ifdef RTC_STATIC
  17. #define RTC_C_EXPORT
  18. #else // dynamic library
  19. #ifdef _WIN32
  20. #ifdef RTC_EXPORTS
  21. #define RTC_C_EXPORT __declspec(dllexport) // building the library
  22. #else
  23. #define RTC_C_EXPORT __declspec(dllimport) // using the library
  24. #endif
  25. #else // not WIN32
  26. #define RTC_C_EXPORT
  27. #endif
  28. #endif
  29. #ifndef RTC_ENABLE_WEBSOCKET
  30. #define RTC_ENABLE_WEBSOCKET 1
  31. #endif
  32. #ifndef RTC_ENABLE_MEDIA
  33. #define RTC_ENABLE_MEDIA 1
  34. #endif
  35. #define RTC_DEFAULT_MTU 1280 // IPv6 minimum guaranteed MTU
  36. #if RTC_ENABLE_MEDIA
  37. #define RTC_DEFAULT_MAX_FRAGMENT_SIZE ((uint16_t)(RTC_DEFAULT_MTU - 12 - 8 - 40)) // SRTP/UDP/IPv6
  38. #define RTC_DEFAULT_MAX_STORED_PACKET_COUNT 512
  39. // Deprecated, do not use
  40. #define RTC_DEFAULT_MAXIMUM_FRAGMENT_SIZE RTC_DEFAULT_MAX_FRAGMENT_SIZE
  41. #define RTC_DEFAULT_MAXIMUM_PACKET_COUNT_FOR_NACK_CACHE RTC_DEFAULT_MAX_STORED_PACKET_COUNT
  42. #endif
  43. #ifdef _WIN32
  44. #ifdef CAPI_STDCALL
  45. #define RTC_API __stdcall
  46. #else
  47. #define RTC_API
  48. #endif
  49. #else // not WIN32
  50. #define RTC_API
  51. #endif
  52. #if defined(__GNUC__) || defined(__clang__)
  53. #define RTC_DEPRECATED __attribute__((deprecated))
  54. #elif defined(_MSC_VER)
  55. #define RTC_DEPRECATED __declspec(deprecated)
  56. #else
  57. #define DEPRECATED
  58. #endif
  59. // libdatachannel C API
  60. typedef enum {
  61. RTC_NEW = 0,
  62. RTC_CONNECTING = 1,
  63. RTC_CONNECTED = 2,
  64. RTC_DISCONNECTED = 3,
  65. RTC_FAILED = 4,
  66. RTC_CLOSED = 5
  67. } rtcState;
  68. typedef enum {
  69. RTC_ICE_NEW = 0,
  70. RTC_ICE_CHECKING = 1,
  71. RTC_ICE_CONNECTED = 2,
  72. RTC_ICE_COMPLETED = 3,
  73. RTC_ICE_FAILED = 4,
  74. RTC_ICE_DISCONNECTED = 5,
  75. RTC_ICE_CLOSED = 6
  76. } rtcIceState;
  77. typedef enum {
  78. RTC_GATHERING_NEW = 0,
  79. RTC_GATHERING_INPROGRESS = 1,
  80. RTC_GATHERING_COMPLETE = 2
  81. } rtcGatheringState;
  82. typedef enum {
  83. RTC_SIGNALING_STABLE = 0,
  84. RTC_SIGNALING_HAVE_LOCAL_OFFER = 1,
  85. RTC_SIGNALING_HAVE_REMOTE_OFFER = 2,
  86. RTC_SIGNALING_HAVE_LOCAL_PRANSWER = 3,
  87. RTC_SIGNALING_HAVE_REMOTE_PRANSWER = 4,
  88. } rtcSignalingState;
  89. typedef enum { // Don't change, it must match plog severity
  90. RTC_LOG_NONE = 0,
  91. RTC_LOG_FATAL = 1,
  92. RTC_LOG_ERROR = 2,
  93. RTC_LOG_WARNING = 3,
  94. RTC_LOG_INFO = 4,
  95. RTC_LOG_DEBUG = 5,
  96. RTC_LOG_VERBOSE = 6
  97. } rtcLogLevel;
  98. typedef enum {
  99. RTC_CERTIFICATE_DEFAULT = 0, // ECDSA
  100. RTC_CERTIFICATE_ECDSA = 1,
  101. RTC_CERTIFICATE_RSA = 2,
  102. } rtcCertificateType;
  103. typedef enum {
  104. // video
  105. RTC_CODEC_H264 = 0,
  106. RTC_CODEC_VP8 = 1,
  107. RTC_CODEC_VP9 = 2,
  108. RTC_CODEC_H265 = 3,
  109. RTC_CODEC_AV1 = 4,
  110. // audio
  111. RTC_CODEC_OPUS = 128,
  112. RTC_CODEC_PCMU = 129,
  113. RTC_CODEC_PCMA = 130,
  114. RTC_CODEC_AAC = 131,
  115. RTC_CODEC_G722 = 132,
  116. } rtcCodec;
  117. typedef enum {
  118. RTC_DIRECTION_UNKNOWN = 0,
  119. RTC_DIRECTION_SENDONLY = 1,
  120. RTC_DIRECTION_RECVONLY = 2,
  121. RTC_DIRECTION_SENDRECV = 3,
  122. RTC_DIRECTION_INACTIVE = 4
  123. } rtcDirection;
  124. typedef enum { RTC_TRANSPORT_POLICY_ALL = 0, RTC_TRANSPORT_POLICY_RELAY = 1 } rtcTransportPolicy;
  125. #define RTC_ERR_SUCCESS 0
  126. #define RTC_ERR_INVALID -1 // invalid argument
  127. #define RTC_ERR_FAILURE -2 // runtime error
  128. #define RTC_ERR_NOT_AVAIL -3 // element not available
  129. #define RTC_ERR_TOO_SMALL -4 // buffer too small
  130. typedef void(RTC_API *rtcLogCallbackFunc)(rtcLogLevel level, const char *message);
  131. typedef void(RTC_API *rtcDescriptionCallbackFunc)(int pc, const char *sdp, const char *type,
  132. void *ptr);
  133. typedef void(RTC_API *rtcCandidateCallbackFunc)(int pc, const char *cand, const char *mid,
  134. void *ptr);
  135. typedef void(RTC_API *rtcStateChangeCallbackFunc)(int pc, rtcState state, void *ptr);
  136. typedef void(RTC_API *rtcIceStateChangeCallbackFunc)(int pc, rtcIceState state, void *ptr);
  137. typedef void(RTC_API *rtcGatheringStateCallbackFunc)(int pc, rtcGatheringState state, void *ptr);
  138. typedef void(RTC_API *rtcSignalingStateCallbackFunc)(int pc, rtcSignalingState state, void *ptr);
  139. typedef void(RTC_API *rtcDataChannelCallbackFunc)(int pc, int dc, void *ptr);
  140. typedef void(RTC_API *rtcTrackCallbackFunc)(int pc, int tr, void *ptr);
  141. typedef void(RTC_API *rtcOpenCallbackFunc)(int id, void *ptr);
  142. typedef void(RTC_API *rtcClosedCallbackFunc)(int id, void *ptr);
  143. typedef void(RTC_API *rtcErrorCallbackFunc)(int id, const char *error, void *ptr);
  144. typedef void(RTC_API *rtcMessageCallbackFunc)(int id, const char *message, int size, void *ptr);
  145. typedef void *(RTC_API *rtcInterceptorCallbackFunc)(int pc, const char *message, int size,
  146. void *ptr);
  147. typedef void(RTC_API *rtcBufferedAmountLowCallbackFunc)(int id, void *ptr);
  148. typedef void(RTC_API *rtcAvailableCallbackFunc)(int id, void *ptr);
  149. typedef void(RTC_API *rtcPliHandlerCallbackFunc)(int tr, void *ptr);
  150. typedef void(RTC_API *rtcRembHandlerCallbackFunc)(int tr, unsigned int bitrate, void *ptr);
  151. // Log
  152. // NULL cb on the first call will log to stdout
  153. RTC_C_EXPORT void rtcInitLogger(rtcLogLevel level, rtcLogCallbackFunc cb);
  154. // User pointer
  155. RTC_C_EXPORT void rtcSetUserPointer(int id, void *ptr);
  156. RTC_C_EXPORT void *rtcGetUserPointer(int i);
  157. // PeerConnection
  158. typedef struct {
  159. const char **iceServers;
  160. int iceServersCount;
  161. const char *proxyServer; // libnice only
  162. const char *bindAddress; // libjuice only, NULL means any
  163. rtcCertificateType certificateType;
  164. rtcTransportPolicy iceTransportPolicy;
  165. bool enableIceTcp; // libnice only
  166. bool enableIceUdpMux; // libjuice only
  167. bool disableAutoNegotiation;
  168. bool forceMediaTransport;
  169. uint16_t portRangeBegin; // 0 means automatic
  170. uint16_t portRangeEnd; // 0 means automatic
  171. int mtu; // <= 0 means automatic
  172. int maxMessageSize; // <= 0 means default
  173. } rtcConfiguration;
  174. RTC_C_EXPORT int rtcCreatePeerConnection(const rtcConfiguration *config); // returns pc id
  175. RTC_C_EXPORT int rtcClosePeerConnection(int pc);
  176. RTC_C_EXPORT int rtcDeletePeerConnection(int pc);
  177. RTC_C_EXPORT int rtcSetLocalDescriptionCallback(int pc, rtcDescriptionCallbackFunc cb);
  178. RTC_C_EXPORT int rtcSetLocalCandidateCallback(int pc, rtcCandidateCallbackFunc cb);
  179. RTC_C_EXPORT int rtcSetStateChangeCallback(int pc, rtcStateChangeCallbackFunc cb);
  180. RTC_C_EXPORT int rtcSetIceStateChangeCallback(int pc, rtcIceStateChangeCallbackFunc cb);
  181. RTC_C_EXPORT int rtcSetGatheringStateChangeCallback(int pc, rtcGatheringStateCallbackFunc cb);
  182. RTC_C_EXPORT int rtcSetSignalingStateChangeCallback(int pc, rtcSignalingStateCallbackFunc cb);
  183. RTC_C_EXPORT int rtcSetLocalDescription(int pc, const char *type); // type may be NULL
  184. RTC_C_EXPORT int rtcSetRemoteDescription(int pc, const char *sdp, const char *type);
  185. RTC_C_EXPORT int rtcAddRemoteCandidate(int pc, const char *cand, const char *mid);
  186. RTC_C_EXPORT int rtcGetLocalDescription(int pc, char *buffer, int size);
  187. RTC_C_EXPORT int rtcGetRemoteDescription(int pc, char *buffer, int size);
  188. RTC_C_EXPORT int rtcGetLocalDescriptionType(int pc, char *buffer, int size);
  189. RTC_C_EXPORT int rtcGetRemoteDescriptionType(int pc, char *buffer, int size);
  190. // For specific use cases only
  191. RTC_C_EXPORT int rtcCreateOffer(int pc, char *buffer, int size);
  192. RTC_C_EXPORT int rtcCreateAnswer(int pc, char *buffer, int size);
  193. RTC_C_EXPORT int rtcGetLocalAddress(int pc, char *buffer, int size);
  194. RTC_C_EXPORT int rtcGetRemoteAddress(int pc, char *buffer, int size);
  195. RTC_C_EXPORT int rtcGetSelectedCandidatePair(int pc, char *local, int localSize, char *remote,
  196. int remoteSize);
  197. RTC_C_EXPORT bool rtcIsNegotiationNeeded(int pc);
  198. RTC_C_EXPORT int rtcGetMaxDataChannelStream(int pc);
  199. RTC_C_EXPORT int rtcGetRemoteMaxMessageSize(int pc);
  200. // DataChannel, Track, and WebSocket common API
  201. RTC_C_EXPORT int rtcSetOpenCallback(int id, rtcOpenCallbackFunc cb);
  202. RTC_C_EXPORT int rtcSetClosedCallback(int id, rtcClosedCallbackFunc cb);
  203. RTC_C_EXPORT int rtcSetErrorCallback(int id, rtcErrorCallbackFunc cb);
  204. RTC_C_EXPORT int rtcSetMessageCallback(int id, rtcMessageCallbackFunc cb);
  205. RTC_C_EXPORT int rtcSendMessage(int id, const char *data, int size);
  206. RTC_C_EXPORT int rtcClose(int id);
  207. RTC_C_EXPORT int rtcDelete(int id);
  208. RTC_C_EXPORT bool rtcIsOpen(int id);
  209. RTC_C_EXPORT bool rtcIsClosed(int id);
  210. RTC_C_EXPORT int rtcMaxMessageSize(int id);
  211. RTC_C_EXPORT int rtcGetBufferedAmount(int id); // total size buffered to send
  212. RTC_C_EXPORT int rtcSetBufferedAmountLowThreshold(int id, int amount);
  213. RTC_C_EXPORT int rtcSetBufferedAmountLowCallback(int id, rtcBufferedAmountLowCallbackFunc cb);
  214. // DataChannel, Track, and WebSocket common extended API
  215. RTC_C_EXPORT int rtcGetAvailableAmount(int id); // total size available to receive
  216. RTC_C_EXPORT int rtcSetAvailableCallback(int id, rtcAvailableCallbackFunc cb);
  217. RTC_C_EXPORT int rtcReceiveMessage(int id, char *buffer, int *size);
  218. // DataChannel
  219. typedef struct {
  220. bool unordered;
  221. bool unreliable;
  222. unsigned int maxPacketLifeTime; // ignored if reliable
  223. unsigned int maxRetransmits; // ignored if reliable
  224. } rtcReliability;
  225. typedef struct {
  226. rtcReliability reliability;
  227. const char *protocol; // empty string if NULL
  228. bool negotiated;
  229. bool manualStream;
  230. uint16_t stream; // numeric ID 0-65534, ignored if manualStream is false
  231. } rtcDataChannelInit;
  232. RTC_C_EXPORT int rtcSetDataChannelCallback(int pc, rtcDataChannelCallbackFunc cb);
  233. RTC_C_EXPORT int rtcCreateDataChannel(int pc, const char *label); // returns dc id
  234. RTC_C_EXPORT int rtcCreateDataChannelEx(int pc, const char *label,
  235. const rtcDataChannelInit *init); // returns dc id
  236. RTC_C_EXPORT int rtcDeleteDataChannel(int dc);
  237. RTC_C_EXPORT int rtcGetDataChannelStream(int dc);
  238. RTC_C_EXPORT int rtcGetDataChannelLabel(int dc, char *buffer, int size);
  239. RTC_C_EXPORT int rtcGetDataChannelProtocol(int dc, char *buffer, int size);
  240. RTC_C_EXPORT int rtcGetDataChannelReliability(int dc, rtcReliability *reliability);
  241. // Track
  242. typedef struct {
  243. rtcDirection direction;
  244. rtcCodec codec;
  245. int payloadType;
  246. uint32_t ssrc;
  247. const char *mid;
  248. const char *name; // optional
  249. const char *msid; // optional
  250. const char *trackId; // optional, track ID used in MSID
  251. const char *profile; // optional, codec profile
  252. } rtcTrackInit;
  253. RTC_C_EXPORT int rtcSetTrackCallback(int pc, rtcTrackCallbackFunc cb);
  254. RTC_C_EXPORT int rtcAddTrack(int pc, const char *mediaDescriptionSdp); // returns tr id
  255. RTC_C_EXPORT int rtcAddTrackEx(int pc, const rtcTrackInit *init); // returns tr id
  256. RTC_C_EXPORT int rtcDeleteTrack(int tr);
  257. RTC_C_EXPORT int rtcGetTrackDescription(int tr, char *buffer, int size);
  258. RTC_C_EXPORT int rtcGetTrackMid(int tr, char *buffer, int size);
  259. RTC_C_EXPORT int rtcGetTrackDirection(int tr, rtcDirection *direction);
  260. RTC_C_EXPORT int rtcRequestKeyframe(int tr);
  261. RTC_C_EXPORT int rtcRequestBitrate(int tr, unsigned int bitrate);
  262. #if RTC_ENABLE_MEDIA
  263. // Media
  264. // Define how OBUs are packetizied in a AV1 Sample
  265. typedef enum {
  266. RTC_OBU_PACKETIZED_OBU = 0,
  267. RTC_OBU_PACKETIZED_TEMPORAL_UNIT = 1,
  268. } rtcObuPacketization;
  269. // Define how NAL units are separated in a H264/H265 sample
  270. typedef enum {
  271. RTC_NAL_SEPARATOR_LENGTH = 0, // first 4 bytes are NAL unit length
  272. RTC_NAL_SEPARATOR_LONG_START_SEQUENCE = 1, // 0x00, 0x00, 0x00, 0x01
  273. RTC_NAL_SEPARATOR_SHORT_START_SEQUENCE = 2, // 0x00, 0x00, 0x01
  274. RTC_NAL_SEPARATOR_START_SEQUENCE = 3, // long or short start sequence
  275. } rtcNalUnitSeparator;
  276. typedef struct {
  277. uint32_t ssrc;
  278. const char *cname;
  279. uint8_t payloadType;
  280. uint32_t clockRate;
  281. uint16_t sequenceNumber;
  282. uint32_t timestamp;
  283. // H264, H265, AV1
  284. uint16_t maxFragmentSize; // Maximum fragment size, 0 means default
  285. // H264/H265 only
  286. rtcNalUnitSeparator nalSeparator; // NAL unit separator
  287. // AV1 only
  288. rtcObuPacketization obuPacketization; // OBU paketization for AV1 samples
  289. uint8_t playoutDelayId;
  290. uint16_t playoutDelayMin;
  291. uint16_t playoutDelayMax;
  292. } rtcPacketizerInit;
  293. // Deprecated, do not use
  294. typedef rtcPacketizerInit rtcPacketizationHandlerInit;
  295. typedef struct {
  296. uint32_t ssrc;
  297. const char *name; // optional
  298. const char *msid; // optional
  299. const char *trackId; // optional, track ID used in MSID
  300. } rtcSsrcForTypeInit;
  301. // Opaque type used (via rtcMessage*) to reference an rtc::Message
  302. typedef void *rtcMessage;
  303. // Allocate a new opaque message.
  304. // Must be explicitly freed by rtcDeleteOpaqueMessage() unless
  305. // explicitly returned by a media interceptor callback;
  306. RTC_C_EXPORT rtcMessage *rtcCreateOpaqueMessage(void *data, int size);
  307. RTC_C_EXPORT void rtcDeleteOpaqueMessage(rtcMessage *msg);
  308. // Set MediaInterceptor on peer connection
  309. RTC_C_EXPORT int rtcSetMediaInterceptorCallback(int id, rtcInterceptorCallbackFunc cb);
  310. // Set a packetizer on track
  311. RTC_C_EXPORT int rtcSetH264Packetizer(int tr, const rtcPacketizerInit *init);
  312. RTC_C_EXPORT int rtcSetH265Packetizer(int tr, const rtcPacketizerInit *init);
  313. RTC_C_EXPORT int rtcSetAV1Packetizer(int tr, const rtcPacketizerInit *init);
  314. RTC_C_EXPORT int rtcSetOpusPacketizer(int tr, const rtcPacketizerInit *init);
  315. RTC_C_EXPORT int rtcSetAACPacketizer(int tr, const rtcPacketizerInit *init);
  316. RTC_C_EXPORT int rtcSetPCMUPacketizer(int tr, const rtcPacketizerInit *init);
  317. RTC_C_EXPORT int rtcSetPCMAPacketizer(int tr, const rtcPacketizerInit *init);
  318. RTC_C_EXPORT int rtcSetG722Packetizer(int tr, const rtcPacketizerInit *init);
  319. // Deprecated, do not use
  320. RTC_DEPRECATED static inline int
  321. rtcSetH264PacketizationHandler(int tr, const rtcPacketizationHandlerInit *init) {
  322. return rtcSetH264Packetizer(tr, init);
  323. }
  324. RTC_DEPRECATED static inline int
  325. rtcSetH265PacketizationHandler(int tr, const rtcPacketizationHandlerInit *init) {
  326. return rtcSetH265Packetizer(tr, init);
  327. }
  328. RTC_DEPRECATED static inline int
  329. rtcSetAV1PacketizationHandler(int tr, const rtcPacketizationHandlerInit *init) {
  330. return rtcSetAV1Packetizer(tr, init);
  331. }
  332. RTC_DEPRECATED static inline int
  333. rtcSetOpusPacketizationHandler(int tr, const rtcPacketizationHandlerInit *init) {
  334. return rtcSetOpusPacketizer(tr, init);
  335. }
  336. RTC_DEPRECATED static inline int
  337. rtcSetAACPacketizationHandler(int tr, const rtcPacketizationHandlerInit *init) {
  338. return rtcSetAACPacketizer(tr, init);
  339. }
  340. // Chain RtcpReceivingSession on track
  341. RTC_C_EXPORT int rtcChainRtcpReceivingSession(int tr);
  342. // Chain RtcpSrReporter on track
  343. RTC_C_EXPORT int rtcChainRtcpSrReporter(int tr);
  344. // Chain RtcpNackResponder on track
  345. RTC_C_EXPORT int rtcChainRtcpNackResponder(int tr, unsigned int maxStoredPacketsCount);
  346. // Chain PliHandler on track
  347. RTC_C_EXPORT int rtcChainPliHandler(int tr, rtcPliHandlerCallbackFunc cb);
  348. // Chain RembHandler on track
  349. RTC_C_EXPORT int rtcChainRembHandler(int tr, rtcRembHandlerCallbackFunc cb);
  350. // Transform seconds to timestamp using track's clock rate, result is written to timestamp
  351. RTC_C_EXPORT int rtcTransformSecondsToTimestamp(int id, double seconds, uint32_t *timestamp);
  352. // Transform timestamp to seconds using track's clock rate, result is written to seconds
  353. RTC_C_EXPORT int rtcTransformTimestampToSeconds(int id, uint32_t timestamp, double *seconds);
  354. // Get current timestamp, result is written to timestamp
  355. RTC_C_EXPORT int rtcGetCurrentTrackTimestamp(int id, uint32_t *timestamp);
  356. // Set RTP timestamp for track identified by given id
  357. RTC_C_EXPORT int rtcSetTrackRtpTimestamp(int id, uint32_t timestamp);
  358. // Get timestamp of last RTCP SR, result is written to timestamp
  359. RTC_C_EXPORT int rtcGetLastTrackSenderReportTimestamp(int id, uint32_t *timestamp);
  360. // Get all available payload types for given codec and stores them in buffer, does nothing if
  361. // buffer is NULL
  362. int rtcGetTrackPayloadTypesForCodec(int tr, const char *ccodec, int *buffer, int size);
  363. // Get all SSRCs for given track
  364. int rtcGetSsrcsForTrack(int tr, uint32_t *buffer, int count);
  365. // Get CName for SSRC
  366. int rtcGetCNameForSsrc(int tr, uint32_t ssrc, char *cname, int cnameSize);
  367. // Get all SSRCs for given media type in given SDP
  368. int rtcGetSsrcsForType(const char *mediaType, const char *sdp, uint32_t *buffer, int bufferSize);
  369. // Set SSRC for given media type in given SDP
  370. int rtcSetSsrcForType(const char *mediaType, const char *sdp, char *buffer, const int bufferSize,
  371. rtcSsrcForTypeInit *init);
  372. // For backward compatibility, do not use
  373. RTC_C_EXPORT RTC_DEPRECATED int rtcSetNeedsToSendRtcpSr(int id);
  374. #endif // RTC_ENABLE_MEDIA
  375. #if RTC_ENABLE_WEBSOCKET
  376. // WebSocket
  377. typedef struct {
  378. bool disableTlsVerification; // if true, don't verify the TLS certificate
  379. const char *proxyServer; // only non-authenticated http supported for now
  380. const char **protocols;
  381. int protocolsCount;
  382. int connectionTimeoutMs; // in milliseconds, 0 means default, < 0 means disabled
  383. int pingIntervalMs; // in milliseconds, 0 means default, < 0 means disabled
  384. int maxOutstandingPings; // 0 means default, < 0 means disabled
  385. int maxMessageSize; // <= 0 means default
  386. } rtcWsConfiguration;
  387. RTC_C_EXPORT int rtcCreateWebSocket(const char *url); // returns ws id
  388. RTC_C_EXPORT int rtcCreateWebSocketEx(const char *url, const rtcWsConfiguration *config);
  389. RTC_C_EXPORT int rtcDeleteWebSocket(int ws);
  390. RTC_C_EXPORT int rtcGetWebSocketRemoteAddress(int ws, char *buffer, int size);
  391. RTC_C_EXPORT int rtcGetWebSocketPath(int ws, char *buffer, int size);
  392. // WebSocketServer
  393. typedef void(RTC_API *rtcWebSocketClientCallbackFunc)(int wsserver, int ws, void *ptr);
  394. typedef struct {
  395. uint16_t port; // 0 means automatic selection
  396. bool enableTls; // if true, enable TLS (WSS)
  397. const char *certificatePemFile; // NULL for autogenerated certificate
  398. const char *keyPemFile; // NULL for autogenerated certificate
  399. const char *keyPemPass; // NULL if no pass
  400. const char *bindAddress; // NULL for any
  401. int connectionTimeoutMs; // in milliseconds, 0 means default, < 0 means disabled
  402. int maxMessageSize; // <= 0 means default
  403. } rtcWsServerConfiguration;
  404. RTC_C_EXPORT int rtcCreateWebSocketServer(const rtcWsServerConfiguration *config,
  405. rtcWebSocketClientCallbackFunc cb); // returns wsserver id
  406. RTC_C_EXPORT int rtcDeleteWebSocketServer(int wsserver);
  407. RTC_C_EXPORT int rtcGetWebSocketServerPort(int wsserver);
  408. #endif
  409. // Optional global preload and cleanup
  410. RTC_C_EXPORT void rtcPreload(void);
  411. RTC_C_EXPORT void rtcCleanup(void);
  412. // SCTP global settings
  413. typedef struct {
  414. int recvBufferSize; // in bytes, <= 0 means optimized default
  415. int sendBufferSize; // in bytes, <= 0 means optimized default
  416. int maxChunksOnQueue; // in chunks, <= 0 means optimized default
  417. int initialCongestionWindow; // in MTUs, <= 0 means optimized default
  418. int maxBurst; // in MTUs, 0 means optimized default, < 0 means disabled
  419. int congestionControlModule; // 0: RFC2581 (default), 1: HSTCP, 2: H-TCP, 3: RTCC
  420. int delayedSackTimeMs; // in milliseconds, 0 means optimized default, < 0 means disabled
  421. int minRetransmitTimeoutMs; // in milliseconds, <= 0 means optimized default
  422. int maxRetransmitTimeoutMs; // in milliseconds, <= 0 means optimized default
  423. int initialRetransmitTimeoutMs; // in milliseconds, <= 0 means optimized default
  424. int maxRetransmitAttempts; // number of retransmissions, <= 0 means optimized default
  425. int heartbeatIntervalMs; // in milliseconds, <= 0 means optimized default
  426. } rtcSctpSettings;
  427. // Note: SCTP settings apply to newly-created PeerConnections only
  428. RTC_C_EXPORT int rtcSetSctpSettings(const rtcSctpSettings *settings);
  429. #ifdef __cplusplus
  430. } // extern "C"
  431. #endif
  432. #endif