Amazon Kinesis Webrtc C SDK
Include.h
Go to the documentation of this file.
1 /*
2  * Main public include file
3  */
4 #ifndef __KINESIS_VIDEO_WEBRTC_CLIENT_INCLUDE__
5 #define __KINESIS_VIDEO_WEBRTC_CLIENT_INCLUDE__
6 
7 #pragma once
8 
9 #ifdef __cplusplus
10 extern "C" {
11 #endif
12 
14 // Public headers
16 #if defined(__clang__)
17 #pragma clang diagnostic push
18 #pragma clang diagnostic ignored "-Wgnu-zero-variadic-macro-arguments"
19 #endif
20 #include <com/amazonaws/kinesis/video/client/Include.h>
21 #include <com/amazonaws/kinesis/video/common/Include.h>
24 #if defined(__clang__)
25 #pragma clang diagnostic pop
26 #endif
27 
28 /* TODO: Potentially move these call to PIC instead. Moving to PIC in the future would not cause any backward compatibility issues */
29 #define PROFILE_CALL(f, msg) \
30  do { \
31  startTimeInMacro = GETTIME(); \
32  f; \
33  DLOGP("[%s] Time taken: %" PRIu64 " ms", (msg), (GETTIME() - startTimeInMacro) / HUNDREDS_OF_NANOS_IN_A_MILLISECOND); \
34  } while (FALSE)
35 
36 #define PROFILE_CALL_WITH_T_OBJ(f, t, msg) \
37  do { \
38  startTimeInMacro = GETTIME(); \
39  f; \
40  t = (GETTIME() - startTimeInMacro) / HUNDREDS_OF_NANOS_IN_A_MILLISECOND; \
41  DLOGP("[%s] Time taken: %" PRIu64 " ms", (msg), (t)); \
42  } while (FALSE)
43 
44 #define PROFILE_WITH_START_TIME(t, msg) \
45  do { \
46  DLOGP("[%s] Time taken: %" PRIu64 " ms", msg, (GETTIME() - (t)) / HUNDREDS_OF_NANOS_IN_A_MILLISECOND); \
47  } while (FALSE)
48 
49 #define PROFILE_CALL_WITH_START_END_T_OBJ(f, s, e, d, msg) \
50  do { \
51  s = GETTIME() / HUNDREDS_OF_NANOS_IN_A_MILLISECOND; \
52  f; \
53  e = GETTIME() / HUNDREDS_OF_NANOS_IN_A_MILLISECOND; \
54  d = ((e) - (s)); \
55  DLOGP("[%s] Time taken: %" PRIu64 " ms", (msg), (d)); \
56  } while (FALSE)
57 
58 #define PROFILE_WITH_START_END_TIME_OBJ(t1, t2, d, msg) \
59  do { \
60  t1 = (t1 / HUNDREDS_OF_NANOS_IN_A_MILLISECOND); \
61  t2 = (GETTIME() / HUNDREDS_OF_NANOS_IN_A_MILLISECOND); \
62  d = ((t2) - (t1)); \
63  DLOGP("[%s] Time taken: %" PRIu64 " ms", (msg), (d)); \
64  } while (FALSE)
65 
66 #define PROFILE_WITH_START_TIME_OBJ(t1, t2, msg) \
67  do { \
68  t2 = (GETTIME() - (t1)) / HUNDREDS_OF_NANOS_IN_A_MILLISECOND; \
69  DLOGP("[%s] Time taken: %" PRIu64 " ms", (msg), t2); \
70  } while (FALSE)
71 
78 #define STATUS_WEBRTC_BASE 0x55000000
79 
83 
89 #define STATUS_SESSION_DESCRIPTION_INIT_NOT_OBJECT STATUS_WEBRTC_BASE + 0x00000001
90 #define STATUS_SESSION_DESCRIPTION_INIT_MISSING_SDP_OR_TYPE_MEMBER STATUS_WEBRTC_BASE + 0x00000002
91 #define STATUS_SESSION_DESCRIPTION_INIT_INVALID_TYPE STATUS_WEBRTC_BASE + 0x00000003
92 #define STATUS_SESSION_DESCRIPTION_INIT_MISSING_SDP STATUS_WEBRTC_BASE + 0x00000004
93 #define STATUS_SESSION_DESCRIPTION_INIT_MISSING_TYPE STATUS_WEBRTC_BASE + 0x00000005
94 #define STATUS_SESSION_DESCRIPTION_INIT_MAX_SDP_LEN_EXCEEDED STATUS_WEBRTC_BASE + 0x00000006
95 #define STATUS_SESSION_DESCRIPTION_INVALID_SESSION_DESCRIPTION STATUS_WEBRTC_BASE + 0x00000007
96 #define STATUS_SESSION_DESCRIPTION_MISSING_ICE_VALUES STATUS_WEBRTC_BASE + 0x00000008
97 #define STATUS_SESSION_DESCRIPTION_MISSING_CERTIFICATE_FINGERPRINT STATUS_WEBRTC_BASE + 0x00000009
98 #define STATUS_SESSION_DESCRIPTION_MAX_MEDIA_COUNT STATUS_WEBRTC_BASE + 0x0000000A
104 
110 #define STATUS_SDP_BASE STATUS_WEBRTC_BASE + 0x01000000
111 #define STATUS_SDP_MISSING_ITEMS STATUS_SDP_BASE + 0x00000001
112 #define STATUS_SDP_ATTRIBUTES_ERROR STATUS_SDP_BASE + 0x00000002
113 #define STATUS_SDP_BANDWIDTH_ERROR STATUS_SDP_BASE + 0x00000003
114 #define STATUS_SDP_CONNECTION_INFORMATION_ERROR STATUS_SDP_BASE + 0x00000004
115 #define STATUS_SDP_EMAIL_ADDRESS_ERROR STATUS_SDP_BASE + 0x00000005
116 #define STATUS_SDP_ENCYRPTION_KEY_ERROR STATUS_SDP_BASE + 0x00000006
117 #define STATUS_SDP_INFORMATION_ERROR STATUS_SDP_BASE + 0x00000007
118 #define STATUS_SDP_MEDIA_NAME_ERROR STATUS_SDP_BASE + 0x00000008
119 #define STATUS_SDP_ORIGIN_ERROR STATUS_SDP_BASE + 0x00000009
120 #define STATUS_SDP_PHONE_NUMBER_ERROR STATUS_SDP_BASE + 0x0000000A
121 #define STATUS_SDP_TIME_DECRYPTION_ERROR STATUS_SDP_BASE + 0x0000000B
122 #define STATUS_SDP_TIMEZONE_ERROR STATUS_SDP_BASE + 0x0000000C
123 #define STATUS_SDP_URI_ERROR STATUS_SDP_BASE + 0x0000000D
124 #define STATUS_SDP_VERSION_ERROR STATUS_SDP_BASE + 0x0000000E
125 #define STATUS_SDP_ATTRIBUTE_MAX_EXCEEDED STATUS_SDP_BASE + 0x0000000F
131 
136 #define STATUS_STUN_BASE STATUS_SDP_BASE + 0x01000000
137 #define STATUS_STUN_MESSAGE_INTEGRITY_NOT_LAST STATUS_STUN_BASE + 0x00000001
138 #define STATUS_STUN_MESSAGE_INTEGRITY_SIZE_ALIGNMENT STATUS_STUN_BASE + 0x00000002
139 #define STATUS_STUN_FINGERPRINT_NOT_LAST STATUS_STUN_BASE + 0x00000003
140 #define STATUS_STUN_MAGIC_COOKIE_MISMATCH STATUS_STUN_BASE + 0x00000004
141 #define STATUS_STUN_INVALID_ADDRESS_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000005
142 #define STATUS_STUN_INVALID_USERNAME_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000006
143 #define STATUS_STUN_INVALID_MESSAGE_INTEGRITY_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000007
144 #define STATUS_STUN_INVALID_FINGERPRINT_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000008
145 #define STATUS_STUN_MULTIPLE_MESSAGE_INTEGRITY_ATTRIBUTES STATUS_STUN_BASE + 0x00000009
146 #define STATUS_STUN_MULTIPLE_FINGERPRINT_ATTRIBUTES STATUS_STUN_BASE + 0x0000000A
147 #define STATUS_STUN_ATTRIBUTES_AFTER_FINGERPRINT_MESSAGE_INTEGRITY STATUS_STUN_BASE + 0x0000000B
148 #define STATUS_STUN_MESSAGE_INTEGRITY_AFTER_FINGERPRINT STATUS_STUN_BASE + 0x0000000C
149 #define STATUS_STUN_MAX_ATTRIBUTE_COUNT STATUS_STUN_BASE + 0x0000000D
150 #define STATUS_STUN_MESSAGE_INTEGRITY_MISMATCH STATUS_STUN_BASE + 0x0000000E
151 #define STATUS_STUN_FINGERPRINT_MISMATCH STATUS_STUN_BASE + 0x0000000F
152 #define STATUS_STUN_INVALID_PRIORITY_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000010
153 #define STATUS_STUN_INVALID_USE_CANDIDATE_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000011
154 #define STATUS_STUN_INVALID_LIFETIME_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000012
155 #define STATUS_STUN_INVALID_REQUESTED_TRANSPORT_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000013
156 #define STATUS_STUN_INVALID_REALM_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000014
157 #define STATUS_STUN_INVALID_NONCE_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000015
158 #define STATUS_STUN_INVALID_ERROR_CODE_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000016
159 #define STATUS_STUN_INVALID_ICE_CONTROL_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000017
160 #define STATUS_STUN_INVALID_CHANNEL_NUMBER_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000018
161 #define STATUS_STUN_INVALID_CHANGE_REQUEST_ATTRIBUTE_LENGTH STATUS_STUN_BASE + 0x00000019
167 
172 #define STATUS_NETWORKING_BASE STATUS_STUN_BASE + 0x01000000
173 #define STATUS_GET_LOCAL_IP_ADDRESSES_FAILED STATUS_NETWORKING_BASE + 0x00000016
174 #define STATUS_CREATE_UDP_SOCKET_FAILED STATUS_NETWORKING_BASE + 0x00000017
175 #define STATUS_BINDING_SOCKET_FAILED STATUS_NETWORKING_BASE + 0x00000018
176 #define STATUS_GET_PORT_NUMBER_FAILED STATUS_NETWORKING_BASE + 0x00000019
177 #define STATUS_SEND_DATA_FAILED STATUS_NETWORKING_BASE + 0x0000001a
178 #define STATUS_RESOLVE_HOSTNAME_FAILED STATUS_NETWORKING_BASE + 0x0000001b
179 #define STATUS_HOSTNAME_NOT_FOUND STATUS_NETWORKING_BASE + 0x0000001c
180 #define STATUS_SOCKET_CONNECT_FAILED STATUS_NETWORKING_BASE + 0x0000001d
181 #define STATUS_CREATE_SSL_FAILED STATUS_NETWORKING_BASE + 0x0000001e
182 #define STATUS_SSL_CONNECTION_FAILED STATUS_NETWORKING_BASE + 0x0000001f
183 #define STATUS_SECURE_SOCKET_READ_FAILED STATUS_NETWORKING_BASE + 0x00000020
184 #define STATUS_SOCKET_CONNECTION_NOT_READY_TO_SEND STATUS_NETWORKING_BASE + 0x00000021
185 #define STATUS_SOCKET_CONNECTION_CLOSED_ALREADY STATUS_NETWORKING_BASE + 0x00000022
186 #define STATUS_SOCKET_SET_SEND_BUFFER_SIZE_FAILED STATUS_NETWORKING_BASE + 0x00000023
187 #define STATUS_GET_SOCKET_FLAG_FAILED STATUS_NETWORKING_BASE + 0x00000024
188 #define STATUS_SET_SOCKET_FLAG_FAILED STATUS_NETWORKING_BASE + 0x00000025
189 #define STATUS_CLOSE_SOCKET_FAILED STATUS_NETWORKING_BASE + 0x00000026
190 #define STATUS_CREATE_SOCKET_PAIR_FAILED STATUS_NETWORKING_BASE + 0x00000027
191 #define STATUS_SOCKET_WRITE_FAILED STATUS_NETWORKING_BASE + 0X00000028
192 #define STATUS_INVALID_ADDRESS_LENGTH STATUS_NETWORKING_BASE + 0X00000029
193 
199 
204 #define STATUS_DTLS_BASE STATUS_NETWORKING_BASE + 0x01000000
205 #define STATUS_CERTIFICATE_GENERATION_FAILED STATUS_DTLS_BASE + 0x00000001
206 #define STATUS_SSL_CTX_CREATION_FAILED STATUS_DTLS_BASE + 0x00000002
207 #define STATUS_SSL_REMOTE_CERTIFICATE_VERIFICATION_FAILED STATUS_DTLS_BASE + 0x00000003
208 #define STATUS_SSL_PACKET_BEFORE_DTLS_READY STATUS_DTLS_BASE + 0x00000004
209 #define STATUS_SSL_UNKNOWN_SRTP_PROFILE STATUS_DTLS_BASE + 0x00000005
210 #define STATUS_SSL_INVALID_CERTIFICATE_BITS STATUS_DTLS_BASE + 0x00000006
211 #define STATUS_DTLS_SESSION_ALREADY_FREED STATUS_DTLS_BASE + 0x00000007
217 
222 #define STATUS_ICE_BASE STATUS_DTLS_BASE + 0x01000000
223 #define STATUS_ICE_AGENT_NO_SELECTED_CANDIDATE_AVAILABLE STATUS_ICE_BASE + 0x00000001
224 #define STATUS_ICE_CANDIDATE_STRING_MISSING_PORT STATUS_ICE_BASE + 0x00000002
225 #define STATUS_ICE_CANDIDATE_STRING_MISSING_IP STATUS_ICE_BASE + 0x00000003
226 #define STATUS_ICE_CANDIDATE_STRING_INVALID_IP STATUS_ICE_BASE + 0x00000004
227 #define STATUS_ICE_CANDIDATE_STRING_IS_TCP STATUS_ICE_BASE + 0x00000005
228 #define STATUS_ICE_FAILED_TO_COMPUTE_MD5_FOR_LONG_TERM_CREDENTIAL STATUS_ICE_BASE + 0x00000006
229 #define STATUS_ICE_URL_INVALID_PREFIX STATUS_ICE_BASE + 0x00000007
230 #define STATUS_ICE_URL_TURN_MISSING_USERNAME STATUS_ICE_BASE + 0x00000008
231 #define STATUS_ICE_URL_TURN_MISSING_CREDENTIAL STATUS_ICE_BASE + 0x00000009
232 #define STATUS_ICE_AGENT_STATE_CHANGE_FAILED STATUS_ICE_BASE + 0x0000000a
233 #define STATUS_ICE_NO_LOCAL_CANDIDATE_AVAILABLE_AFTER_GATHERING_TIMEOUT STATUS_ICE_BASE + 0x0000000b
234 #define STATUS_ICE_AGENT_TERMINATED_ALREADY STATUS_ICE_BASE + 0x0000000c
235 #define STATUS_ICE_NO_CONNECTED_CANDIDATE_PAIR STATUS_ICE_BASE + 0x0000000d
236 #define STATUS_ICE_CANDIDATE_PAIR_LIST_EMPTY STATUS_ICE_BASE + 0x0000000e
237 #define STATUS_ICE_NOMINATED_CANDIDATE_NOT_CONNECTED STATUS_ICE_BASE + 0x00000010
238 #define STATUS_ICE_CANDIDATE_INIT_MALFORMED STATUS_ICE_BASE + 0x00000011
239 #define STATUS_ICE_CANDIDATE_MISSING_CANDIDATE STATUS_ICE_BASE + 0x00000012
240 #define STATUS_ICE_FAILED_TO_NOMINATE_CANDIDATE_PAIR STATUS_ICE_BASE + 0x00000013
241 #define STATUS_ICE_MAX_REMOTE_CANDIDATE_COUNT_EXCEEDED STATUS_ICE_BASE + 0x00000014
242 #define STATUS_ICE_INVALID_STATE STATUS_ICE_BASE + 0x0000001c
243 #define STATUS_ICE_NO_LOCAL_HOST_CANDIDATE_AVAILABLE STATUS_ICE_BASE + 0x0000001d
244 #define STATUS_ICE_NO_NOMINATED_VALID_CANDIDATE_PAIR_AVAILABLE STATUS_ICE_BASE + 0x0000001e
245 #define STATUS_TURN_CONNECTION_NO_HOST_INTERFACE_FOUND STATUS_ICE_BASE + 0x0000001f
246 #define STATUS_TURN_CONNECTION_STATE_TRANSITION_TIMEOUT STATUS_ICE_BASE + 0x00000020
247 #define STATUS_TURN_CONNECTION_FAILED_TO_CREATE_PERMISSION STATUS_ICE_BASE + 0x00000021
248 #define STATUS_TURN_CONNECTION_FAILED_TO_BIND_CHANNEL STATUS_ICE_BASE + 0x00000022
249 #define STATUS_TURN_NEW_DATA_CHANNEL_MSG_HEADER_BEFORE_PREVIOUS_MSG_FINISH STATUS_ICE_BASE + 0x00000023
250 #define STATUS_TURN_MISSING_CHANNEL_DATA_HEADER STATUS_ICE_BASE + 0x00000024
251 #define STATUS_ICE_FAILED_TO_RECOVER_FROM_DISCONNECTION STATUS_ICE_BASE + 0x00000025
252 #define STATUS_ICE_NO_AVAILABLE_ICE_CANDIDATE_PAIR STATUS_ICE_BASE + 0x00000026
253 #define STATUS_TURN_CONNECTION_PEER_NOT_USABLE STATUS_ICE_BASE + 0x00000027
254 #define STATUS_ICE_SERVER_INDEX_INVALID STATUS_ICE_BASE + 0x00000028
255 #define STATUS_ICE_CANDIDATE_STRING_MISSING_TYPE STATUS_ICE_BASE + 0x00000029
256 #define STATUS_TURN_CONNECTION_ALLOCATION_FAILED STATUS_ICE_BASE + 0x0000002a
257 #define STATUS_TURN_INVALID_STATE STATUS_ICE_BASE + 0x0000002b
258 #define STATUS_TURN_CONNECTION_GET_CREDENTIALS_FAILED STATUS_ICE_BASE + 0x0000002c
259 
265 
270 #define STATUS_SRTP_BASE STATUS_ICE_BASE + 0x01000000
271 #define STATUS_SRTP_DECRYPT_FAILED STATUS_SRTP_BASE + 0x00000001
272 #define STATUS_SRTP_ENCRYPT_FAILED STATUS_SRTP_BASE + 0x00000002
273 #define STATUS_SRTP_TRANSMIT_SESSION_CREATION_FAILED STATUS_SRTP_BASE + 0x00000003
274 #define STATUS_SRTP_RECEIVE_SESSION_CREATION_FAILED STATUS_SRTP_BASE + 0x00000004
275 #define STATUS_SRTP_INIT_FAILED STATUS_SRTP_BASE + 0x00000005
276 #define STATUS_SRTP_NOT_READY_YET STATUS_SRTP_BASE + 0x00000006
282 
287 #define STATUS_RTP_BASE STATUS_SRTP_BASE + 0x01000000
288 #define STATUS_RTP_INPUT_PACKET_TOO_SMALL STATUS_RTP_BASE + 0x00000001
289 #define STATUS_RTP_INPUT_MTU_TOO_SMALL STATUS_RTP_BASE + 0x00000002
290 #define STATUS_RTP_INVALID_NALU STATUS_RTP_BASE + 0x00000003
291 #define STATUS_RTP_INVALID_EXTENSION_LEN STATUS_RTP_BASE + 0x00000004
297 
302 #define STATUS_SIGNALING_BASE STATUS_RTP_BASE + 0x01000000
303 #define STATUS_SIGNALING_INVALID_READY_STATE STATUS_SIGNALING_BASE + 0x00000001
304 #define STATUS_SIGNALING_GET_TOKEN_CALL_FAILED STATUS_SIGNALING_BASE + 0x00000002
305 #define STATUS_SIGNALING_DESCRIBE_CALL_FAILED STATUS_SIGNALING_BASE + 0x00000003
306 #define STATUS_SIGNALING_CREATE_CALL_FAILED STATUS_SIGNALING_BASE + 0x00000004
307 #define STATUS_SIGNALING_GET_ENDPOINT_CALL_FAILED STATUS_SIGNALING_BASE + 0x00000005
308 #define STATUS_SIGNALING_GET_ICE_CONFIG_CALL_FAILED STATUS_SIGNALING_BASE + 0x00000006
309 #define STATUS_SIGNALING_READY_CALLBACK_FAILED STATUS_SIGNALING_BASE + 0x00000007
310 #define STATUS_SIGNALING_CONNECT_CALL_FAILED STATUS_SIGNALING_BASE + 0x00000008
311 #define STATUS_SIGNALING_CONNECTED_CALLBACK_FAILED STATUS_SIGNALING_BASE + 0x00000009
312 #define STATUS_SIGNALING_INVALID_CHANNEL_INFO_VERSION STATUS_SIGNALING_BASE + 0x0000000A
313 #define STATUS_SIGNALING_INVALID_SIGNALING_CALLBACKS_VERSION STATUS_SIGNALING_BASE + 0x0000000B
314 #define STATUS_SIGNALING_INVALID_CHANNEL_NAME_LENGTH STATUS_SIGNALING_BASE + 0x0000000C
315 #define STATUS_SIGNALING_INVALID_CHANNEL_ARN_LENGTH STATUS_SIGNALING_BASE + 0x0000000D
316 #define STATUS_SIGNALING_INVALID_REGION_LENGTH STATUS_SIGNALING_BASE + 0x0000000E
317 #define STATUS_SIGNALING_INVALID_CPL_LENGTH STATUS_SIGNALING_BASE + 0x0000000F
318 #define STATUS_SIGNALING_INVALID_CERTIFICATE_PATH_LENGTH STATUS_SIGNALING_BASE + 0x00000010
319 #define STATUS_SIGNALING_INVALID_AGENT_POSTFIX_LENGTH STATUS_SIGNALING_BASE + 0x00000011
320 #define STATUS_SIGNALING_INVALID_AGENT_LENGTH STATUS_SIGNALING_BASE + 0x00000012
321 #define STATUS_SIGNALING_INVALID_KMS_KEY_LENGTH STATUS_SIGNALING_BASE + 0x00000013
322 #define STATUS_SIGNALING_LWS_CREATE_CONTEXT_FAILED STATUS_SIGNALING_BASE + 0x00000014
323 #define STATUS_SIGNALING_LWS_CLIENT_CONNECT_FAILED STATUS_SIGNALING_BASE + 0x00000015
324 #define STATUS_SIGNALING_CHANNEL_BEING_DELETED STATUS_SIGNALING_BASE + 0x00000016
325 #define STATUS_SIGNALING_INVALID_CLIENT_INFO_VERSION STATUS_SIGNALING_BASE + 0x00000017
326 #define STATUS_SIGNALING_INVALID_CLIENT_INFO_CLIENT_LENGTH STATUS_SIGNALING_BASE + 0x00000018
327 #define STATUS_SIGNALING_MAX_ICE_CONFIG_COUNT STATUS_SIGNALING_BASE + 0x00000019
328 #define STATUS_SIGNALING_MAX_ICE_URI_COUNT STATUS_SIGNALING_BASE + 0x0000001A
329 #define STATUS_SIGNALING_MAX_ICE_URI_LEN STATUS_SIGNALING_BASE + 0x0000001B
330 #define STATUS_SIGNALING_NO_CONFIG_SPECIFIED STATUS_SIGNALING_BASE + 0x0000001C
331 #define STATUS_SIGNALING_INVALID_ICE_CONFIG_INFO_VERSION STATUS_SIGNALING_BASE + 0x0000001D
332 #define STATUS_SIGNALING_NO_CONFIG_URI_SPECIFIED STATUS_SIGNALING_BASE + 0x0000001E
333 #define STATUS_SIGNALING_NO_ARN_RETURNED_ON_CREATE STATUS_SIGNALING_BASE + 0x0000001F
334 #define STATUS_SIGNALING_MISSING_ENDPOINTS_IN_GET_ENDPOINT STATUS_SIGNALING_BASE + 0x00000020
335 #define STATUS_SIGNALING_INVALID_MESSAGE_TYPE STATUS_SIGNALING_BASE + 0x00000021
336 #define STATUS_SIGNALING_INVALID_SIGNALING_MESSAGE_VERSION STATUS_SIGNALING_BASE + 0x00000022
337 #define STATUS_SIGNALING_NO_PEER_CLIENT_ID_IN_MESSAGE STATUS_SIGNALING_BASE + 0x00000023
338 #define STATUS_SIGNALING_MESSAGE_DELIVERY_FAILED STATUS_SIGNALING_BASE + 0x00000024
339 #define STATUS_SIGNALING_MAX_MESSAGE_LEN_AFTER_ENCODING STATUS_SIGNALING_BASE + 0x00000025
340 #define STATUS_SIGNALING_RECEIVE_BINARY_DATA_NOT_SUPPORTED STATUS_SIGNALING_BASE + 0x00000026
341 #define STATUS_SIGNALING_RECEIVE_EMPTY_DATA_NOT_SUPPORTED STATUS_SIGNALING_BASE + 0x00000027
342 #define STATUS_SIGNALING_RECEIVED_MESSAGE_LARGER_THAN_MAX_DATA_LEN STATUS_SIGNALING_BASE + 0x00000028
343 #define STATUS_SIGNALING_INVALID_PAYLOAD_LEN_IN_MESSAGE STATUS_SIGNALING_BASE + 0x00000029
344 #define STATUS_SIGNALING_NO_PAYLOAD_IN_MESSAGE STATUS_SIGNALING_BASE + 0x0000002A
345 #define STATUS_SIGNALING_DUPLICATE_MESSAGE_BEING_SENT STATUS_SIGNALING_BASE + 0x0000002B
346 #define STATUS_SIGNALING_ICE_TTL_LESS_THAN_GRACE_PERIOD STATUS_SIGNALING_BASE + 0x0000002C
347 #define STATUS_SIGNALING_DISCONNECTED_CALLBACK_FAILED STATUS_SIGNALING_BASE + 0x0000002D
348 #define STATUS_SIGNALING_INVALID_MESSAGE_TTL_VALUE STATUS_SIGNALING_BASE + 0x0000002E
349 #define STATUS_SIGNALING_ICE_CONFIG_REFRESH_FAILED STATUS_SIGNALING_BASE + 0x0000002F
350 #define STATUS_SIGNALING_RECONNECT_FAILED STATUS_SIGNALING_BASE + 0x00000030
351 #define STATUS_SIGNALING_DELETE_CALL_FAILED STATUS_SIGNALING_BASE + 0x00000031
352 #define STATUS_SIGNALING_INVALID_METRICS_VERSION STATUS_SIGNALING_BASE + 0x00000032
353 #define STATUS_SIGNALING_INVALID_CLIENT_INFO_CACHE_FILE_PATH_LEN STATUS_SIGNALING_BASE + 0x00000033
354 #define STATUS_SIGNALING_LWS_CALL_FAILED STATUS_SIGNALING_BASE + 0x00000034
355 #define STATUS_SIGNALING_INVALID_STREAM_ARN_LENGTH STATUS_SIGNALING_BASE + 0x00000035
356 #define STATUS_SIGNALING_MISMATCH_MEDIA_STORAGE_CONFIG STATUS_SIGNALING_BASE + 0x00000036
357 #define STATUS_SIGNALING_UPDATE_MEDIA_STORAGE_CONFIG STATUS_SIGNALING_BASE + 0x00000037
358 #define STATUS_SIGNALING_MEDIA_STORAGE_DISABLED STATUS_SIGNALING_BASE + 0x00000038
359 #define STATUS_SIGNALING_INVALID_CHANNEL_ARN STATUS_SIGNALING_BASE + 0x00000039
360 #define STATUS_SIGNALING_JOIN_SESSION_CALL_FAILED STATUS_SIGNALING_BASE + 0x0000004a
361 #define STATUS_SIGNALING_JOIN_SESSION_CONNECTED_FAILED STATUS_SIGNALING_BASE + 0x0000004b
362 #define STATUS_SIGNALING_DESCRIBE_MEDIA_CALL_FAILED STATUS_SIGNALING_BASE + 0x0000004c
363 
369 
375 #define STATUS_PEERCONNECTION_BASE STATUS_SIGNALING_BASE + 0x01000000
376 #define STATUS_PEERCONNECTION_CREATE_ANSWER_WITHOUT_REMOTE_DESCRIPTION STATUS_PEERCONNECTION_BASE + 0x00000001
377 #define STATUS_PEERCONNECTION_CODEC_INVALID STATUS_PEERCONNECTION_BASE + 0x00000002
378 #define STATUS_PEERCONNECTION_CODEC_MAX_EXCEEDED STATUS_PEERCONNECTION_BASE + 0x00000003
379 #define STATUS_PEERCONNECTION_EARLY_DNS_RESOLUTION_FAILED STATUS_PEERCONNECTION_BASE + 0x00000004
385 
390 #define STATUS_SCTP_BASE STATUS_PEERCONNECTION_BASE + 0x01000000
391 #define STATUS_SCTP_SESSION_SETUP_FAILED STATUS_SCTP_BASE + 0x00000001
392 #define STATUS_SCTP_INVALID_DCEP_PACKET STATUS_SCTP_BASE + 0x00000002
398 
403 #define STATUS_RTCP_BASE STATUS_SCTP_BASE + 0x01000000
404 #define STATUS_RTCP_INPUT_PACKET_TOO_SMALL STATUS_RTCP_BASE + 0x00000001
405 #define STATUS_RTCP_INPUT_PACKET_INVALID_VERSION STATUS_RTCP_BASE + 0x00000002
406 #define STATUS_RTCP_INPUT_PACKET_LEN_MISMATCH STATUS_RTCP_BASE + 0x00000003
407 #define STATUS_RTCP_INPUT_NACK_LIST_INVALID STATUS_RTCP_BASE + 0x00000004
408 #define STATUS_RTCP_INPUT_SSRC_INVALID STATUS_RTCP_BASE + 0x00000005
409 #define STATUS_RTCP_INPUT_PARTIAL_PACKET STATUS_RTCP_BASE + 0x00000006
410 #define STATUS_RTCP_INPUT_REMB_TOO_SMALL STATUS_RTCP_BASE + 0x00000007
411 #define STATUS_RTCP_INPUT_REMB_INVALID STATUS_RTCP_BASE + 0x00000008
417 
423 #define STATUS_ROLLING_BUFFER_BASE STATUS_RTCP_BASE + 0x01000000
424 #define STATUS_ROLLING_BUFFER_NOT_IN_RANGE STATUS_ROLLING_BUFFER_BASE + 0x00000001
430 
439 #define MAX_CHANNEL_NAME_LEN 256
440 
444 #define MAX_SIGNALING_CLIENT_ID_LEN 256
445 
450 #define MAX_ICE_CONFIG_USER_NAME_LEN 256
451 
456 #define MAX_ICE_CONFIG_CREDENTIAL_LEN 256
457 
461 #define MAX_SIGNALING_ENDPOINT_URI_LEN 512
462 
466 #define MAX_CORRELATION_ID_LEN 256
467 
471 #define MAX_ERROR_TYPE_STRING_LEN 256
472 
476 #define MAX_STATUS_CODE_STRING_LEN 256
477 
481 #define MAX_MESSAGE_DESCRIPTION_LEN 1024
482 
486 #define MAX_SESSION_DESCRIPTION_INIT_SDP_LEN 25000
487 
491 #define MAX_MEDIA_STREAM_ID_LEN 255
492 
496 #define MAX_RTCCONFIGURATION_CERTIFICATES 3
497 
501 #define MAX_MEDIA_STREAM_TRACK_ID_LEN 255
502 
506 #define MAX_ICE_CANDIDATE_INIT_CANDIDATE_LEN 255
507 
511 #define MAX_DATA_CHANNEL_NAME_LEN 255
512 
516 #define MAX_DATA_CHANNEL_PROTOCOL_LEN 255
517 
521 #define MAX_SIGNALING_MESSAGE_LEN (10 * 1024)
527 
535 #define PEER_CONNECTION_CURRENT_VERSION 0
536 
540 #define CHANNEL_INFO_CURRENT_VERSION 1
541 
545 #define SIGNALING_CLIENT_INFO_CURRENT_VERSION 2
546 
550 #define SIGNALING_CLIENT_CALLBACKS_CURRENT_VERSION 0
551 
555 #define SIGNALING_CLIENT_CURRENT_VERSION 1
556 
560 #define SIGNALING_CHANNEL_DESCRIPTION_CURRENT_VERSION 0
561 
565 #define SIGNALING_ICE_CONFIG_INFO_CURRENT_VERSION 0
566 
570 #define SIGNALING_MESSAGE_CURRENT_VERSION 0
571 
575 #define RTC_ICE_METRICS_CURRENT_VERSION 0
576 
580 #define RTC_STREAM_METRICS_CURRENT_VERSION 0
581 
585 #define SIGNALING_CLIENT_METRICS_CURRENT_VERSION 1
586 
590 #define PEER_CONNECTION_METRICS_CURRENT_VERSION 0
591 
595 #define ICE_AGENT_METRICS_CURRENT_VERSION 0
596 
602 
610 #define MAX_ICE_CONFIG_URI_COUNT 4
611 
615 #define MAX_ICE_CONFIG_COUNT 5
616 
622 #define MAX_ICE_SERVERS_COUNT (MAX_ICE_CONFIG_COUNT * MAX_ICE_CONFIG_URI_COUNT + 1)
628 
636 #define SIGNALING_CREATE_TIMEOUT (10 * HUNDREDS_OF_NANOS_IN_A_SECOND)
637 
641 #define SIGNALING_CONNECT_STATE_TIMEOUT (15 * HUNDREDS_OF_NANOS_IN_A_SECOND)
642 
646 #define SIGNALING_DISCONNECT_STATE_TIMEOUT (15 * HUNDREDS_OF_NANOS_IN_A_SECOND)
647 
651 #define SIGNALING_REFRESH_ICE_CONFIG_STATE_TIMEOUT (20 * HUNDREDS_OF_NANOS_IN_A_SECOND)
652 
656 #define SIGNALING_CONNECT_TIMEOUT (5 * HUNDREDS_OF_NANOS_IN_A_SECOND)
657 
661 #define THREADPOOL_MIN_THREADS 3
662 
666 #define THREADPOOL_MAX_THREADS 10
667 
671 #define WEBRTC_THREADPOOL_MIN_THREADS_ENV_VAR (PCHAR) "AWS_KVS_WEBRTC_THREADPOOL_MIN_THREADS"
672 
676 #define WEBRTC_THREADPOOL_MAX_THREADS_ENV_VAR (PCHAR) "AWS_KVS_WEBRTC_THREADPOOL_MAX_THREADS"
677 
678 #ifdef _WIN32
682 #define SIGNALING_SEND_TIMEOUT (15 * HUNDREDS_OF_NANOS_IN_A_SECOND)
683 #else
687 #define SIGNALING_SEND_TIMEOUT (5 * HUNDREDS_OF_NANOS_IN_A_SECOND)
688 #endif
692 #define SIGNALING_DELETE_TIMEOUT (5 * HUNDREDS_OF_NANOS_IN_A_SECOND)
693 
697 #define SIGNALING_DEFAULT_MESSAGE_TTL_VALUE (60 * HUNDREDS_OF_NANOS_IN_A_SECOND)
698 
699 #define SIGNALING_JOIN_STORAGE_SESSION_WAIT_TIMEOUT (6 * HUNDREDS_OF_NANOS_IN_A_SECOND)
700 
704 #define DEFAULT_JITTER_BUFFER_MAX_LATENCY (2000L * HUNDREDS_OF_NANOS_IN_A_MILLISECOND)
710 #define SIGNALING_VALID_NAME_CHARS "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_.-"
711 
715 #define MAX_RTP_SEQUENCE_NUM ((UINT32) MAX_UINT16)
716 
720 #define MAX_RTP_TIMESTAMP ((UINT32) MAX_UINT32)
721 
725 #define KINESIS_VIDEO_STUN_URL_POSTFIX "amazonaws.com"
726 #define KINESIS_VIDEO_STUN_URL_POSTFIX_CN "amazonaws.com.cn"
727 #define KINESIS_VIDEO_STUN_URL "stun:stun.kinesisvideo.%s.%s:443"
728 #define KINESIS_VIDEO_STUN_URL_WITHOUT_PORT "stun.kinesisvideo.%s.%s"
729 
733 #define SIGNALING_DEFAULT_SSL_PORT DEFAULT_SSL_PORT_NUMBER
734 
738 #define SIGNALING_DEFAULT_NON_SSL_PORT DEFAULT_NON_SSL_PORT_NUMBER
739 
740 /* CHK_LOG_ERR_NV has been replaced with CHK_LOG_ERR. */
741 #define CHK_LOG_ERR_NV(condition) DLOGE("CHK_LOG_ERR_NV has been replaced with CHK_LOG_ERR");
742 
746 #define SIGNALING_STATES_DEFAULT_RETRY_COUNT 1
747 
751 #define SIGNALING_DEFAULT_API_CALL_CACHE_TTL (10 * HUNDREDS_OF_NANOS_IN_AN_HOUR)
752 
756 #define SIGNALING_API_CALL_CACHE_TTL_SENTINEL_VALUE 0
757 
761 #define CREATE_SIGNALING_CLIENT_RETRY_ATTEMPTS_SENTINEL_VALUE -1
762 
766 typedef UINT64 SIGNALING_CLIENT_HANDLE;
768 
772 #ifndef INVALID_SIGNALING_CLIENT_HANDLE_VALUE
773 #define INVALID_SIGNALING_CLIENT_HANDLE_VALUE ((SIGNALING_CLIENT_HANDLE) INVALID_PIC_HANDLE_VALUE)
774 #endif
775 
779 #ifndef IS_VALID_SIGNALING_CLIENT_HANDLE
780 #define IS_VALID_SIGNALING_CLIENT_HANDLE(h) ((h) != INVALID_SIGNALING_CLIENT_HANDLE_VALUE)
781 #endif
782 
786 
796 typedef enum {
806 
810 typedef enum {
813 } SDP_TYPE;
814 
818 typedef enum {
822 
826 typedef enum {
834  // RTC_CODEC_MAX **MUST** be the last enum in the list **ALWAYS** and not assigned a value
837 
843 typedef enum {
846 
849 
855 typedef enum {
861 
865 typedef enum {
871 
875 typedef enum {
884 
888 typedef enum {
915 
919 typedef enum {
923 
927 typedef enum {
932 
936 typedef enum {
943 } NAT_BEHAVIOR;
944 
948 typedef enum {
950 
967 
973 
984 typedef VOID (*RtcOnFrame)(UINT64, PFrame);
985 
993 typedef VOID (*RtcOnBandwidthEstimation)(UINT64, DOUBLE);
994 
1010 typedef VOID (*RtcOnSenderBandwidthEstimation)(UINT64, UINT32, UINT32, UINT32, UINT32, UINT64);
1011 
1021 typedef VOID (*RtcOnPictureLoss)(UINT64);
1022 
1028 typedef struct __RtcDataChannel {
1030  UINT32 id;
1034 
1040 typedef VOID (*RtcOnMessage)(UINT64, PRtcDataChannel, BOOL, PBYTE, UINT32);
1041 
1047 typedef VOID (*RtcOnOpen)(UINT64, PRtcDataChannel);
1048 
1055 typedef VOID (*RtcOnDataChannel)(UINT64, PRtcDataChannel);
1056 
1062 typedef VOID (*RtcOnIceCandidate)(UINT64, PCHAR);
1063 
1068 typedef BOOL (*IceSetInterfaceFilterFunc)(UINT64, PCHAR);
1069 
1081 
1093 typedef struct {
1094  UINT32 version;
1096 
1102 typedef struct {
1104  CHAR trackId[MAX_MEDIA_STREAM_ID_LEN + 1];
1105  CHAR streamId[MAX_MEDIA_STREAM_ID_LEN + 1];
1108 
1118 typedef struct {
1121 
1128 typedef struct {
1132 
1139 typedef struct {
1140  CHAR urls[MAX_ICE_CONFIG_URI_LEN + 1];
1141  CHAR username[MAX_ICE_CONFIG_USER_NAME_LEN + 1];
1142  CHAR credential[MAX_ICE_CONFIG_CREDENTIAL_LEN + 1];
1144 
1149 typedef struct {
1150  // The certificate bits and the size
1153 
1154  // The private key bits and the size in bytes
1155  PBYTE pPrivateKey;
1158 
1166 typedef struct {
1171 
1174 
1177 
1181 
1184 
1188 
1191 
1192  UINT32 sendBufSize;
1193 
1195 
1198 
1202 #ifdef ENABLE_STATS_CALCULATION_CONTROL
1203  BOOL enableIceStats;
1205 #endif
1207 
1214 typedef struct {
1218 
1239 
1246 typedef struct {
1253 
1259 typedef struct {
1264 
1268 typedef struct {
1269  UINT32 version;
1270 
1272 
1273  CHAR correlationId[MAX_CORRELATION_ID_LEN + 1];
1274 
1275  CHAR peerClientId[MAX_SIGNALING_CLIENT_ID_LEN + 1];
1276 
1277  UINT32 payloadLen;
1278 
1279  CHAR payload[MAX_SIGNALING_MESSAGE_LEN + 1];
1281 
1285 typedef struct {
1288 
1289  SERVICE_CALL_RESULT statusCode;
1290 
1291  CHAR errorType[MAX_ERROR_TYPE_STRING_LEN + 1];
1292 
1293  CHAR description[MAX_MESSAGE_DESCRIPTION_LEN + 1];
1295 
1299 typedef struct {
1300  UINT32 version;
1301  CHAR clientId[MAX_SIGNALING_CLIENT_ID_LEN + 1];
1302  UINT32 loggingLevel;
1310  KvsRetryStrategyCallbacks signalingRetryStrategyCallbacks;
1317 
1321 typedef struct {
1322  UINT32 version;
1323 
1325 
1326  PCHAR pChannelArn;
1330 
1331  PCHAR pRegion;
1333 
1336 
1337  PCHAR pCertPath;
1338 
1341 
1343 
1344  PCHAR pUserAgent;
1345 
1346  PCHAR pKmsKeyId;
1347 
1349 
1351 
1352  BOOL reserved;
1353 
1354  UINT64 cachingPeriod;
1358 
1359  BOOL retry;
1360 
1361  BOOL reconnect;
1362 
1363  UINT64 messageTtl;
1365 
1366  UINT32 tagCount;
1367 
1368  PTag pTags;
1369 
1370  /* --- V1 members --- */
1371 
1373 
1377 
1379 
1381 
1390 typedef struct {
1391  UINT32 version;
1392  UINT64 ttl;
1393  UINT32 uriCount;
1395  CHAR userName[MAX_ICE_CONFIG_USER_NAME_LEN + 1];
1396  CHAR password[MAX_ICE_CONFIG_CREDENTIAL_LEN + 1];
1398 
1399 typedef struct {
1401  CHAR storageStreamArn[MAX_ARN_LEN + 1];
1421 
1437 typedef STATUS (*SignalingClientErrorReportFunc)(UINT64, STATUS, PCHAR, UINT32);
1438 
1462 typedef struct {
1463  UINT32 version;
1464  UINT64 customData;
1468  GetCurrentTimeFunc getCurrentTimeFn;
1470 
1474 typedef struct {
1475  UINT32 version;
1476  CHAR channelArn[MAX_ARN_LEN + 1];
1477  CHAR channelName[MAX_CHANNEL_NAME_LEN + 1];
1480  CHAR updateVersion[MAX_UPDATE_VERSION_LEN + 1];
1482  UINT64 messageTtl;
1484  UINT64 creationTime;
1486 
1492 typedef struct {
1495 
1502 typedef struct {
1503  BOOL ordered;
1508  CHAR protocol[MAX_DATA_CHANNEL_PROTOCOL_LEN + 1];
1509  BOOL negotiated;
1517 
1529 typedef struct {
1530  UINT32 version;
1536 
1543 typedef struct {
1544  UINT32 version;
1549 
1553 typedef struct {
1554  UINT32 version;
1560 
1564 typedef struct {
1565  UINT32 version;
1568 
1572 typedef struct {
1573  UINT32 version;
1576 
1581 typedef struct {
1582  UINT64 timestamp;
1586 
1590 typedef struct {
1591  UINT32 targetBitrate;
1595  UINT16 width;
1596  UINT16 height;
1597  UINT16 bitDepth;
1607 
1623 
1631 PUBLIC_API STATUS freePeerConnection(PRtcPeerConnection*);
1632 
1646 
1657 
1668 
1679 
1689 
1699 
1712 
1725 
1738 
1748 PUBLIC_API STATUS serializeSessionDescriptionInit(PRtcSessionDescriptionInit, PCHAR, PUINT32);
1749 
1759 PUBLIC_API STATUS deserializeSessionDescriptionInit(PCHAR, UINT32, PRtcSessionDescriptionInit);
1760 
1770 PUBLIC_API STATUS deserializeRtcIceCandidateInit(PCHAR, UINT32, PRtcIceCandidateInit);
1771 
1784 
1797 
1808 PUBLIC_API STATUS restartIce(PRtcPeerConnection);
1809 
1819 PUBLIC_API STATUS closePeerConnection(PRtcPeerConnection);
1820 
1834 
1844 PUBLIC_API STATUS transceiverOnFrame(PRtcRtpTransceiver, UINT64, RtcOnFrame);
1845 
1856 
1867 
1878 PUBLIC_API STATUS freeTransceiver(PRtcRtpTransceiver*);
1879 
1885 PUBLIC_API STATUS initKvsWebRtc(VOID);
1886 
1892 PUBLIC_API STATUS deinitKvsWebRtc(VOID);
1893 
1904 PUBLIC_API STATUS addSupportedCodec(PRtcPeerConnection, RTC_CODEC);
1905 
1914 PUBLIC_API STATUS writeFrame(PRtcRtpTransceiver, PFrame);
1915 
1922 
1936 PUBLIC_API STATUS addIceCandidate(PRtcPeerConnection, PCHAR);
1937 
1955 
1965 PUBLIC_API STATUS dataChannelOnMessage(PRtcDataChannel, UINT64, RtcOnMessage);
1966 
1976 PUBLIC_API STATUS dataChannelOnOpen(PRtcDataChannel, UINT64, RtcOnOpen);
1977 
1991 PUBLIC_API STATUS dataChannelSend(PRtcDataChannel, BOOL, PBYTE, UINT32);
1992 
2006 PUBLIC_API STATUS discoverNatBehavior(PCHAR, NAT_BEHAVIOR*, NAT_BEHAVIOR*, IceSetInterfaceFilterFunc, UINT64);
2007 
2016 PUBLIC_API PCHAR getNatBehaviorStr(NAT_BEHAVIOR natBehavior);
2017 
2029 PUBLIC_API STATUS createSignalingClientSync(PSignalingClientInfo, PChannelInfo, PSignalingClientCallbacks, PAwsCredentialProvider,
2031 
2042 
2055 
2067 
2082 
2092 
2103 
2112 
2122 
2131 PUBLIC_API STATUS signalingClientGetStateString(SIGNALING_CLIENT_STATE, PCHAR*);
2132 
2150 
2158 
2166 
2174 
2193 
2201 PUBLIC_API STATUS createRtcCertificate(PRtcCertificate*);
2202 
2210 PUBLIC_API STATUS freeRtcCertificate(PRtcCertificate);
2211 
2213 #ifdef __cplusplus
2214 }
2215 #endif
2216 #endif /* __KINESIS_VIDEO_WEBRTC_CLIENT_INCLUDE__ */
CHAR DOMString[255U+1]
DOMString type is used to store strings of size 256 bytes (inclusive of '\0' character.
Definition: Stats.h:84
RTC_STATS_TYPE
Type of Stats object requested by the application Reference https://www.w3.org/TR/webrtc-stats/#rtcst...
Definition: Stats.h:108
VOID(* RtcOnOpen)(UINT64, PRtcDataChannel)
Definition: Include.h:1047
STATUS(* SignalingClientErrorReportFunc)(UINT64, STATUS, PCHAR, UINT32)
Definition: Include.h:1437
VOID(* RtcOnMessage)(UINT64, PRtcDataChannel, BOOL, PBYTE, UINT32)
RtcOnMessage is fired when a message is received for the DataChannel.
Definition: Include.h:1040
STATUS(* SignalingClientMessageReceivedFunc)(UINT64, PReceivedSignalingMessage)
Definition: Include.h:1420
VOID(* RtcOnDataChannel)(UINT64, PRtcDataChannel)
RtcOnDataChannel is fired when the remote PeerConnection creates a new DataChannel.
Definition: Include.h:1055
struct __RtcDataChannel * PRtcDataChannel
VOID(* RtcOnSenderBandwidthEstimation)(UINT64, UINT32, UINT32, UINT32, UINT32, UINT64)
RtcOnSenderBandwidthEstimation is fired everytime a bandwidth estimation value is computed by sender....
Definition: Include.h:1010
VOID(* RtcOnFrame)(UINT64, PFrame)
RtcOnFrame is fired everytime a frame is received from the remote peer. It is available via the RtpRe...
Definition: Include.h:984
STATUS(* SignalingClientStateChangedFunc)(UINT64, SIGNALING_CLIENT_STATE)
Definition: Include.h:1452
struct __RtcDataChannel RtcDataChannel
RtcDataChannel represents a bi-directional data channel between two peers.
VOID(* RtcOnIceCandidate)(UINT64, PCHAR)
RtcOnIceCandidate is fired when new iceCandidate is found. if PCHAR is NULL then candidate gathering ...
Definition: Include.h:1062
BOOL(* IceSetInterfaceFilterFunc)(UINT64, PCHAR)
IceSetInterfaceFilterFunc is fired when a callback function to filter network interfaces is assigned....
Definition: Include.h:1068
VOID(* RtcOnPictureLoss)(UINT64)
RtcOnPictureLoss is fired everytime a Picture Loss Indication (PLI) feedback message is received....
Definition: Include.h:1021
VOID(* RtcOnConnectionStateChange)(UINT64, RTC_PEER_CONNECTION_STATE)
RtcOnConnectionStateChange is fired to report a change in peer connection state.
Definition: Include.h:1075
VOID(* RtcOnBandwidthEstimation)(UINT64, DOUBLE)
RtcOnBandwidthEstimation is fired everytime a bandwidth estimation value is computed....
Definition: Include.h:993
#define MAX_ICE_CONFIG_URI_COUNT
Definition: Include.h:610
#define MAX_ICE_SERVERS_COUNT
Definition: Include.h:622
#define MAX_MEDIA_STREAM_ID_LEN
Definition: Include.h:491
#define MAX_ICE_CONFIG_CREDENTIAL_LEN
Definition: Include.h:456
#define MAX_RTCCONFIGURATION_CERTIFICATES
Definition: Include.h:496
#define MAX_ICE_CONFIG_USER_NAME_LEN
Definition: Include.h:450
#define MAX_DATA_CHANNEL_PROTOCOL_LEN
Definition: Include.h:516
#define MAX_MESSAGE_DESCRIPTION_LEN
Definition: Include.h:481
#define MAX_SESSION_DESCRIPTION_INIT_SDP_LEN
Definition: Include.h:486
#define MAX_SIGNALING_MESSAGE_LEN
Definition: Include.h:521
#define MAX_ICE_CANDIDATE_INIT_CANDIDATE_LEN
Definition: Include.h:506
#define MAX_ERROR_TYPE_STRING_LEN
Definition: Include.h:471
#define MAX_CORRELATION_ID_LEN
Definition: Include.h:466
#define MAX_SIGNALING_CLIENT_ID_LEN
Definition: Include.h:444
#define MAX_CHANNEL_NAME_LEN
Definition: Include.h:439
#define MAX_DATA_CHANNEL_NAME_LEN
Definition: Include.h:511
RTC_PEER_CONNECTION_STATE
RTC_PEER_CONNECTION_STATE Stats of RTC peer connection.
Definition: Include.h:796
RTC_RTP_TRANSCEIVER_DIRECTION
RTC_RTP_TRANSCEIVER_DIRECTION indicates direction of a transceiver.
Definition: Include.h:855
SIGNALING_CLIENT_STATE
Defines different states a signaling client traverses.
Definition: Include.h:888
SIGNALING_CHANNEL_ROLE_TYPE
Channel role type.
Definition: Include.h:927
SIGNALING_CHANNEL_TYPE
Channel type as reported by the service.
Definition: Include.h:919
SIGNALING_MESSAGE_TYPE
Defines different signaling messages.
Definition: Include.h:875
RTC_CODEC
The enum specifies the codec types for audio and video tracks.
Definition: Include.h:826
ICE_TRANSPORT_POLICY
ICE_TRANSPORT_POLICY restrict which ICE candidates are used in a session.
Definition: Include.h:843
MEDIA_STREAM_TRACK_KIND
The enum specifies the type of track in the stream.
Definition: Include.h:818
SDP_TYPE
Definition: Include.h:810
enum SIGNALING_CLIENT_STATE * PSIGNALING_CLIENT_STATE
SIGNALING_API_CALL_CACHE_TYPE
Type of caching implementation to use with the signaling client.
Definition: Include.h:948
SIGNALING_CHANNEL_STATUS
Defines channel status as reported by the service.
Definition: Include.h:865
NAT_BEHAVIOR
Detected network environment.
Definition: Include.h:936
@ RTC_PEER_CONNECTION_STATE_NONE
Starting state of peer connection.
Definition: Include.h:797
@ RTC_PEER_CONNECTION_TOTAL_STATE_COUNT
This state indicates maximum number of Peer connection states.
Definition: Include.h:804
@ RTC_PEER_CONNECTION_STATE_DISCONNECTED
This state is set when ICE Agent is disconnected.
Definition: Include.h:801
@ RTC_PEER_CONNECTION_STATE_CONNECTING
This state is set when ICE agent checks connection.
Definition: Include.h:799
@ RTC_PEER_CONNECTION_STATE_FAILED
This state is set when ICE Agent transitions to fail state.
Definition: Include.h:802
@ RTC_PEER_CONNECTION_STATE_NEW
This state is set when ICE Agent is waiting for remote credential.
Definition: Include.h:798
@ RTC_PEER_CONNECTION_STATE_CLOSED
This state leads to termination of streaming session.
Definition: Include.h:803
@ RTC_PEER_CONNECTION_STATE_CONNECTED
This state is set when CIE Agent is ready.
Definition: Include.h:800
@ RTC_RTP_TRANSCEIVER_DIRECTION_INACTIVE
This indicates that the peer can not send or receive data.
Definition: Include.h:859
@ RTC_RTP_TRANSCEIVER_DIRECTION_SENDRECV
This indicates that peer can send and receive data.
Definition: Include.h:856
@ RTC_RTP_TRANSCEIVER_DIRECTION_SENDONLY
This indicates that the peer can only send information.
Definition: Include.h:857
@ RTC_RTP_TRANSCEIVER_DIRECTION_RECVONLY
This indicates that the peer can only receive information.
Definition: Include.h:858
@ SIGNALING_CLIENT_STATE_UNKNOWN
Starting state of signaling client.
Definition: Include.h:889
@ SIGNALING_CLIENT_STATE_JOIN_SESSION
Definition: Include.h:909
@ SIGNALING_CLIENT_STATE_DESCRIBE_MEDIA
Definition: Include.h:908
@ SIGNALING_CLIENT_STATE_GET_ENDPOINT
This state is set to provide an endpoint for sending/receiving messages.
Definition: Include.h:896
@ SIGNALING_CLIENT_STATE_CONNECTED
On transitioning to this state, the timeout on the state machine is reset.
Definition: Include.h:903
@ SIGNALING_CLIENT_STATE_NEW
This state indicates a new client state.
Definition: Include.h:890
@ SIGNALING_CLIENT_STATE_READY
Definition: Include.h:899
@ SIGNALING_CLIENT_STATE_JOIN_SESSION_WAITING
Definition: Include.h:910
@ SIGNALING_CLIENT_STATE_GET_ICE_CONFIG
Definition: Include.h:897
@ SIGNALING_CLIENT_STATE_JOIN_SESSION_CONNECTED
Definition: Include.h:911
@ SIGNALING_CLIENT_STATE_DESCRIBE
Definition: Include.h:892
@ SIGNALING_CLIENT_STATE_MAX_VALUE
This state indicates maximum number of signaling client states.
Definition: Include.h:912
@ SIGNALING_CLIENT_STATE_DELETE
This state transition happens when the application calls signalingClientDeleteSync API.
Definition: Include.h:905
@ SIGNALING_CLIENT_STATE_DISCONNECTED
This state transition happens either from connect or connected state.
Definition: Include.h:904
@ SIGNALING_CLIENT_STATE_GET_CREDENTIALS
This state involves getting a token using AWS credentials.
Definition: Include.h:891
@ SIGNALING_CLIENT_STATE_DELETED
Definition: Include.h:906
@ SIGNALING_CLIENT_STATE_CREATE
Definition: Include.h:894
@ SIGNALING_CLIENT_STATE_CONNECTING
Definition: Include.h:901
@ SIGNALING_CHANNEL_ROLE_TYPE_MASTER
Channel role is master.
Definition: Include.h:929
@ SIGNALING_CHANNEL_ROLE_TYPE_VIEWER
Channel role is viewer.
Definition: Include.h:930
@ SIGNALING_CHANNEL_ROLE_TYPE_UNKNOWN
Channel role is unknown.
Definition: Include.h:928
@ SIGNALING_CHANNEL_TYPE_UNKNOWN
Channel type is unknown.
Definition: Include.h:920
@ SIGNALING_CHANNEL_TYPE_SINGLE_MASTER
Channel type is master.
Definition: Include.h:921
@ SIGNALING_MESSAGE_TYPE_STATUS_RESPONSE
This message notifies the awaiting send after checking for failure in message delivery.
Definition: Include.h:881
@ SIGNALING_MESSAGE_TYPE_RECONNECT_ICE_SERVER
This message moves signaling state back to get ICE config.
Definition: Include.h:880
@ SIGNALING_MESSAGE_TYPE_OFFER
This message type leads to checks in existence of peer id and payload in the message.
Definition: Include.h:876
@ SIGNALING_MESSAGE_TYPE_ANSWER
This message type leads to checks in length/existence of payload in the message.
Definition: Include.h:877
@ SIGNALING_MESSAGE_TYPE_UNKNOWN
This message type is set when the type of message received is unknown.
Definition: Include.h:882
@ SIGNALING_MESSAGE_TYPE_GO_AWAY
This message moves signaling back to describe state.
Definition: Include.h:879
@ SIGNALING_MESSAGE_TYPE_ICE_CANDIDATE
This message type leads to checks in length/existence of payload in the message.
Definition: Include.h:878
@ RTC_CODEC_ALAW
ALAW audio codec.
Definition: Include.h:831
@ RTC_CODEC_VP8
VP8 video codec.
Definition: Include.h:829
@ RTC_CODEC_MULAW
MULAW audio codec.
Definition: Include.h:830
@ RTC_CODEC_UNKNOWN
Definition: Include.h:832
@ RTC_CODEC_H265
H265 video codec.
Definition: Include.h:833
@ RTC_CODEC_OPUS
OPUS audio codec.
Definition: Include.h:828
@ RTC_CODEC_MAX
Placeholder for max number of supported codecs.
Definition: Include.h:835
@ RTC_CODEC_H264_PROFILE_42E01F_LEVEL_ASYMMETRY_ALLOWED_PACKETIZATION_MODE
H264 video codec.
Definition: Include.h:827
@ ICE_TRANSPORT_POLICY_ALL
The ICE Agent can use any type of candidate when this value is specified.
Definition: Include.h:847
@ ICE_TRANSPORT_POLICY_RELAY
Definition: Include.h:844
@ MEDIA_STREAM_TRACK_KIND_VIDEO
Video track. Track information is set before add transceiver.
Definition: Include.h:820
@ MEDIA_STREAM_TRACK_KIND_AUDIO
Audio track. Track information is set before add transceiver.
Definition: Include.h:819
@ SDP_TYPE_ANSWER
SessionDescription is type answer.
Definition: Include.h:812
@ SDP_TYPE_OFFER
SessionDescription is type offer.
Definition: Include.h:811
@ SIGNALING_API_CALL_CACHE_TYPE_DESCRIBE_GETENDPOINT
Definition: Include.h:951
@ SIGNALING_API_CALL_CACHE_TYPE_NONE
No caching. The calls to the backend will be made for every API.
Definition: Include.h:949
@ SIGNALING_API_CALL_CACHE_TYPE_FILE
Definition: Include.h:960
@ SIGNALING_CHANNEL_STATUS_CREATING
Signaling channel is being created.
Definition: Include.h:866
@ SIGNALING_CHANNEL_STATUS_ACTIVE
Signaling channel is active.
Definition: Include.h:867
@ SIGNALING_CHANNEL_STATUS_DELETING
Signaling channel is being deleted.
Definition: Include.h:869
@ SIGNALING_CHANNEL_STATUS_UPDATING
Signaling channel is being updated.
Definition: Include.h:868
@ NAT_BEHAVIOR_NO_UDP_CONNECTIVITY
No UDP connectvity.
Definition: Include.h:939
@ NAT_BEHAVIOR_ENDPOINT_INDEPENDENT
Nat behavior is irregardless of change in external address.
Definition: Include.h:940
@ NAT_BEHAVIOR_NOT_BEHIND_ANY_NAT
Host is not behind any NAT.
Definition: Include.h:938
@ NAT_BEHAVIOR_PORT_DEPENDENT
Nat behavior changes when external address or port is changed.
Definition: Include.h:942
@ NAT_BEHAVIOR_NONE
Dummy placeholder.
Definition: Include.h:937
@ NAT_BEHAVIOR_ADDRESS_DEPENDENT
Nat behavior changes changes when external address is changed, but remain same if only port is change...
Definition: Include.h:941
PUBLIC_API STATUS initKvsWebRtc(VOID)
Initializes global state needed for all RtcPeerConnections. It must only be called once.
Definition: PeerConnection.c:1740
PUBLIC_API STATUS setLocalDescription(PRtcPeerConnection, PRtcSessionDescriptionInit)
Instructs the RtcPeerConnection to apply the supplied RtcSessionDescriptionInit as the local descript...
Definition: PeerConnection.c:1525
PUBLIC_API STATUS freeTransceiver(PRtcRtpTransceiver *)
Frees the previously created transceiver object.
Definition: Rtp.c:52
PUBLIC_API STATUS dataChannelSend(PRtcDataChannel, BOOL, PBYTE, UINT32)
Send data via the PRtcDataChannel.
Definition: DataChannel.c:57
PUBLIC_API STATUS addIceCandidate(PRtcPeerConnection, PCHAR)
Provides a remote candidate to the ICE Agent.
Definition: PeerConnection.c:1664
PUBLIC_API STATUS createOffer(PRtcPeerConnection, PRtcSessionDescriptionInit)
Populate the provided answer that contains an RFC 3264 offer with the supported configurations for th...
Definition: PeerConnection.c:1454
PUBLIC_API STATUS peerConnectionGetCurrentLocalDescription(PRtcPeerConnection, PRtcSessionDescriptionInit)
Definition: PeerConnection.c:1288
PUBLIC_API STATUS signalingClientGetIceConfigInfoCount(SIGNALING_CLIENT_HANDLE, PUINT32)
Gets the retrieved ICE configuration information object count.
Definition: Client.c:281
PUBLIC_API STATUS dataChannelOnOpen(PRtcDataChannel, UINT64, RtcOnOpen)
Set a callback for data channel open.
Definition: DataChannel.c:92
PUBLIC_API STATUS createSignalingClientSync(PSignalingClientInfo, PChannelInfo, PSignalingClientCallbacks, PAwsCredentialProvider, PSIGNALING_CLIENT_HANDLE)
Creates a Signaling client and returns a handle to it.
Definition: Client.c:55
PUBLIC_API STATUS peerConnectionOnSenderBandwidthEstimation(PRtcPeerConnection, UINT64, RtcOnSenderBandwidthEstimation)
Set a callback for transport-wide sender bandwidth estimation results.
Definition: PeerConnection.c:1230
PUBLIC_API STATUS writeFrame(PRtcRtpTransceiver, PFrame)
Packetizes and sends media via the configuration specified by the RtcRtpTransceiver.
Definition: Rtp.c:184
PUBLIC_API STATUS peerConnectionOnDataChannel(PRtcPeerConnection, UINT64, RtcOnDataChannel)
Definition: PeerConnection.c:1179
PUBLIC_API STATUS freePeerConnection(PRtcPeerConnection *)
Free a RtcPeerConnection.
Definition: PeerConnection.c:1042
PUBLIC_API STATUS setRemoteDescription(PRtcPeerConnection, PRtcSessionDescriptionInit)
Instructs the RtcPeerConnection to apply the supplied RtcSessionDescriptionInit as the remote descrip...
Definition: PeerConnection.c:1340
PUBLIC_API STATUS rtcPeerConnectionGetMetrics(PRtcPeerConnection, PRtcRtpTransceiver, PRtcStats)
Get the relevant/all metrics based on the RTCStatsType field. This does not include any signaling rel...
Definition: Metrics.c:225
PUBLIC_API PCHAR getNatBehaviorStr(NAT_BEHAVIOR natBehavior)
Return the string representation for each NAT_BEHAVIOR enum.
Definition: NatBehaviorDiscovery.c:368
PUBLIC_API STATUS peerConnectionOnIceCandidate(PRtcPeerConnection, UINT64, RtcOnIceCandidate)
Set a callback when new Ice collects new local candidate.
Definition: PeerConnection.c:1154
PUBLIC_API STATUS addTransceiver(PRtcPeerConnection, PRtcMediaStreamTrack, PRtcRtpTransceiverInit, PRtcRtpTransceiver *)
Create a new RtcRtpTransceiver and add it to the set of transceivers.
Definition: PeerConnection.c:1542
PUBLIC_API STATUS signalingClientDisconnectSync(SIGNALING_CLIENT_HANDLE)
Disconnects the signaling client.
Definition: Client.c:247
PUBLIC_API STATUS createRtcCertificate(PRtcCertificate *)
Creates an RtcCertificate object.
Definition: Crypto.c:4
PUBLIC_API STATUS serializeSessionDescriptionInit(PRtcSessionDescriptionInit, PCHAR, PUINT32)
Create a JSON string from RtcSessionDescriptionInit.
Definition: SessionDescription.c:4
PUBLIC_API STATUS discoverNatBehavior(PCHAR, NAT_BEHAVIOR *, NAT_BEHAVIOR *, IceSetInterfaceFilterFunc, UINT64)
Use the process described in https://tools.ietf.org/html/rfc5780#section-4.3 to discover NAT behavior...
Definition: NatBehaviorDiscovery.c:261
PUBLIC_API STATUS createDataChannel(PRtcPeerConnection, PCHAR, PRtcDataChannelInit, PRtcDataChannel *)
createDataChannel creates a new RtcDataChannel object with the given label.
Definition: DataChannel.c:10
PUBLIC_API STATUS createAnswer(PRtcPeerConnection, PRtcSessionDescriptionInit)
Populate the provided answer that contains an RFC 3264 answer with the supported configurations for t...
Definition: PeerConnection.c:1496
PUBLIC_API STATUS peerConnectionGetMetrics(PRtcPeerConnection, PPeerConnectionMetrics)
Get peer connection related metrics.
Definition: PeerConnection.c:1941
PUBLIC_API STATUS dataChannelOnMessage(PRtcDataChannel, UINT64, RtcOnMessage)
Set a callback for data channel message.
Definition: DataChannel.c:75
PUBLIC_API STATUS transceiverOnPictureLoss(PRtcRtpTransceiver, UINT64, RtcOnPictureLoss)
Set a callback for picture loss packet (PLI)
Definition: Rtp.c:140
PUBLIC_API STATUS signalingClientGetIceConfigInfo(SIGNALING_CLIENT_HANDLE, UINT32, PIceConfigInfo *)
Gets the ICE configuration information object given its index.
Definition: Client.c:298
PUBLIC_API STATUS signalingClientGetStateString(SIGNALING_CLIENT_STATE, PCHAR *)
Definition: Client.c:343
PUBLIC_API STATUS closePeerConnection(PRtcPeerConnection)
Close the underlying DTLS session and IceAgent connection. Trigger RtcOnConnectionStateChange to RTC_...
Definition: PeerConnection.c:1703
PUBLIC_API STATUS signalingClientFetchSync(SIGNALING_CLIENT_HANDLE)
Fetches all assets needed to ready the state machine before attempting to connect....
Definition: Client.c:183
PUBLIC_API STATUS peerConnectionGetLocalDescription(PRtcPeerConnection, PRtcSessionDescriptionInit)
Definition: PeerConnection.c:1256
PUBLIC_API STATUS transceiverOnBandwidthEstimation(PRtcRtpTransceiver, UINT64, RtcOnBandwidthEstimation)
Set a callback for bandwidth estimation results.
Definition: Rtp.c:123
PUBLIC_API STATUS transceiverOnFrame(PRtcRtpTransceiver, UINT64, RtcOnFrame)
Set a callback for transceiver frame.
Definition: Rtp.c:106
PUBLIC_API STATUS deserializeSessionDescriptionInit(PCHAR, UINT32, PRtcSessionDescriptionInit)
Parses a JSON string and returns an allocated PSessionDescriptionInit.
Definition: SessionDescription.c:53
PUBLIC_API STATUS signalingClientGetCurrentState(SIGNALING_CLIENT_HANDLE, PSIGNALING_CLIENT_STATE)
Gets the Signaling client current state.
Definition: Client.c:315
PUBLIC_API STATUS updateEncoderStats(PRtcRtpTransceiver, PRtcEncoderStats)
call this function to update stats which depend on external encoder
Definition: Rtp.c:157
PUBLIC_API STATUS iceAgentGetMetrics(PRtcPeerConnection, PKvsIceAgentMetrics)
Get peer connection related metrics.
Definition: PeerConnection.c:1977
PUBLIC_API STATUS freeRtcCertificate(PRtcCertificate)
Frees previously generated RtcCertificate object.
Definition: Crypto.c:46
PUBLIC_API STATUS signalingClientConnectSync(SIGNALING_CLIENT_HANDLE)
Connects the signaling client to the web socket in order to send/receive messages.
Definition: Client.c:164
PUBLIC_API STATUS signalingClientGetMetrics(SIGNALING_CLIENT_HANDLE, PSignalingClientMetrics)
Get signaling related metrics.
Definition: Client.c:423
PUBLIC_API STATUS signalingClientDeleteSync(SIGNALING_CLIENT_HANDLE)
Deletes the signaling channel referenced by SIGNALING_CLIENT_HANDLE.
Definition: Client.c:264
PUBLIC_API STATUS createPeerConnection(PRtcConfiguration, PRtcPeerConnection *)
Initialize a RtcPeerConnection with the provided Configuration.
Definition: PeerConnection.c:941
PUBLIC_API STATUS restartIce(PRtcPeerConnection)
Instructs the RtcPeerConnection that ICE should be restarted. Subsequent calls to createOffer will cr...
Definition: PeerConnection.c:1681
PUBLIC_API NullableBool canTrickleIceCandidates(PRtcPeerConnection)
The canTrickleIceCandidates attribute indicates whether the remote peer is able to accept trickled IC...
Definition: PeerConnection.c:1721
PUBLIC_API STATUS deinitKvsWebRtc(VOID)
Deinitializes global state needed for all RtcPeerConnections. It must only be called once.
Definition: PeerConnection.c:1821
PUBLIC_API STATUS signalingClientSendMessageSync(SIGNALING_CLIENT_HANDLE, PSignalingMessage)
Send a message through a Signaling client.
Definition: Client.c:147
PUBLIC_API STATUS peerConnectionOnConnectionStateChange(PRtcPeerConnection, UINT64, RtcOnConnectionStateChange)
Definition: PeerConnection.c:1204
PUBLIC_API STATUS addSupportedCodec(PRtcPeerConnection, RTC_CODEC)
Adds to the list of codecs we support receiving.
Definition: PeerConnection.c:1634
PUBLIC_API STATUS deserializeRtcIceCandidateInit(PCHAR, UINT32, PRtcIceCandidateInit)
Parses a JSON string and populates a PRtcIceCandidateInit.
Definition: SessionDescription.c:1372
PUBLIC_API STATUS freeSignalingClient(PSIGNALING_CLIENT_HANDLE)
Frees the Signaling client object.
Definition: Client.c:124
struct SignalingClientCallbacks * PSignalingClientCallbacks
struct MediaStorageConfig * PMediaStorageConfig
struct SignalingClientInfo * PSignalingClientInfo
struct RtcIceServer * PRtcIceServer
struct RtcSessionDescriptionInit * PRtcSessionDescriptionInit
struct RtcRtpTransceiverInit * PRtcRtpTransceiverInit
struct KvsRtcConfiguration * PKvsRtcConfiguration
struct RtcRtpTransceiver * PRtcRtpTransceiver
struct RtcPeerConnection * PRtcPeerConnection
struct RtcMediaStreamTrack * PRtcMediaStreamTrack
struct RtcCertificate * PRtcCertificate
struct ReceivedSignalingMessage * PReceivedSignalingMessage
struct RtcConfiguration * PRtcConfiguration
struct ChannelInfo * PChannelInfo
struct SignalingMessage * PSignalingMessage
struct RtcDataChannelInit * PRtcDataChannelInit
struct RtcIceCandidateInit * PRtcIceCandidateInit
struct RtcRtpReceiver * PRtcRtpReceiver
struct SignalingChannelDescription * PSignalingChannelDescription
struct IceConfigInfo * PIceConfigInfo
#define MAX_ICE_CONFIG_URI_LEN
Definition: Stats.h:30
struct KvsIceAgentMetrics * PKvsIceAgentMetrics
struct RtcStreamMetrics * PRtcStreamMetrics
struct PeerConnectionMetrics * PPeerConnectionMetrics
struct RtcEncoderStats * PRtcEncoderStats
struct SignalingClientMetrics * PSignalingClientMetrics
struct RtcStats * PRtcStats
struct RtcIceMetrics * PRtcIceMetrics
UINT64 filterCustomData
Custom Data that can be populated by the developer while developing filter function.
Definition: Include.h:1194
PCHAR pRegion
Definition: Include.h:1331
UINT32 tagCount
Number of tags associated with the stream.
Definition: Include.h:1366
PCHAR pKmsKeyId
Optional KMS key id ARN. Maximum length is defined by MAX_ARN_LEN+1.
Definition: Include.h:1346
UINT32 uriCount
Number of Ice URI objects.
Definition: Include.h:1393
MEDIA_STREAM_TRACK_KIND kind
Kind of track - audio or video.
Definition: Include.h:1106
BOOL retry
Flag determines if a retry of the network calls is to be done on errors up to max retry times.
Definition: Include.h:1359
UINT64 signalingEndTime
Definition: Include.h:1556
BOOL storageStatus
Indicate the association between channelArn and storageStreamArn.
Definition: Include.h:1400
RtcIceServerStats rtcIceServerStats
Server related stats. Reference in Stats.h.
Definition: Include.h:1531
PCHAR pCertPath
Optional certificate path. Maximum length is defined by MAX_PATH_LEN+1.
Definition: Include.h:1337
UINT32 version
Version of peer connection structure.
Definition: Include.h:1094
SignalingClientStats signalingClientStats
Signaling client metrics stats. Reference in Stats.h.
Definition: Include.h:1558
UINT64 SIGNALING_CLIENT_HANDLE
Definition of the signaling client handle.
Definition: Include.h:766
UINT32 signalingMessagesMinimumThreads
Unused field post v1.8.1.
Definition: Include.h:1314
UINT32 sendBufSize
Socket send buffer length. Item larger then this size will get dropped. Use system default if 0.
Definition: Include.h:1192
UINT32 version
Version of the SignalingChannelDescription struct.
Definition: Include.h:1475
UINT32 version
Current version of the structure.
Definition: Include.h:1269
UINT32 version
Current version of the structure.
Definition: Include.h:1463
UINT32 certificateSize
Size of certificate in bytes (optional)
Definition: Include.h:1152
RtcRemoteInboundRtpStreamStats rtcInboundStats
Inbound RTP Stats. Reference in Stats.h.
Definition: Include.h:1545
UINT32 signalingMessagesMaximumThreads
Unused field post v1.8.1.
Definition: Include.h:1315
PTag pTags
Stream tags array.
Definition: Include.h:1368
UINT32 iceLocalCandidateGatheringTimeout
Definition: Include.h:1172
BOOL reserved
Reserved field for compatibility.
Definition: Include.h:1352
UINT64 messageTtl
Definition: Include.h:1482
PCHAR pChannelArn
Definition: Include.h:1326
KvsIceAgentStats kvsIceAgentStats
ICE agent metrics. Reference in Stats.h.
Definition: Include.h:1566
NullableUint16 maxRetransmits
Control number of times a channel retransmits data if not delivered successfully.
Definition: Include.h:1507
ICE_TRANSPORT_POLICY iceTransportPolicy
Indicates which candidates the ICE Agent is allowed to use.
Definition: Include.h:1215
UINT32 id
Definition: Include.h:1030
SIGNALING_CHANNEL_TYPE channelType
Channel type when creating.
Definition: Include.h:1348
SignalingClientErrorReportFunc errorReportFn
Error reporting function. This is an optional member.
Definition: Include.h:1466
RtcIceCandidatePairStats rtcIceCandidatePairStats
Candidate pair stats. Reference in Stats.h.
Definition: Include.h:1534
RtcTransportStats rtcTransportStats
Transport stats. Reference in Stats.h.
Definition: Include.h:1547
UINT64 signalingCallTime
Definition: Include.h:1557
RTC_CODEC codec
non-standard, codec that the track is using
Definition: Include.h:1103
SDP_TYPE type
Indicates an offer/answer SDP type.
Definition: Include.h:1247
RtcIceCandidateStats localRtcIceCandidateStats
Local candidate stats. Reference in Stats.h.
Definition: Include.h:1532
KvsRtcConfiguration kvsRtcConfiguration
Non-standard configuration options.
Definition: Include.h:1217
RTC_RTP_TRANSCEIVER_DIRECTION direction
Transceiver direction - SENDONLY, RECVONLY, SENDRECV.
Definition: Include.h:1493
UINT64 cachingPeriod
Definition: Include.h:1354
UINT32 version
Version of the structure.
Definition: Include.h:1322
UINT32 version
Version of the struct.
Definition: Include.h:1391
RtcOutboundRtpStreamStats rtcOutboundStats
Outbound RTP Stats. Reference in Stats.h.
Definition: Include.h:1546
RTC_RTP_TRANSCEIVER_DIRECTION direction
Transceiver direction.
Definition: Include.h:1129
UINT16 bitDepth
Only valid for video. bits per pixel (24, 30, 36), note it's not per channel but per pixel.
Definition: Include.h:1597
KvsRetryStrategyCallbacks signalingRetryStrategyCallbacks
Retry strategy callbacks used while creating signaling client.
Definition: Include.h:1310
SignalingClientStateChangedFunc stateChangeFn
Signaling client state change callback.
Definition: Include.h:1467
BOOL negotiated
Definition: Include.h:1509
UINT32 loggingLevel
Definition: Include.h:1302
UINT32 stateMachineRetryCountReadOnly
Definition: Include.h:1312
PCHAR pUserAgent
Combined user agent. Maximum length is defined by MAX_USER_AGENT_LEN+1.
Definition: Include.h:1344
UINT16 width
Only valid for video.
Definition: Include.h:1595
SIGNALING_CHANNEL_STATUS channelStatus
Current channel status as reported by the service.
Definition: Include.h:1478
BOOL useMediaStorage
use the feature of media storage.
Definition: Include.h:1378
SIGNALING_CHANNEL_TYPE channelType
Channel type as reported by the service.
Definition: Include.h:1479
SERVICE_CALL_RESULT statusCode
Response status code.
Definition: Include.h:1289
RtcRtpReceiver receiver
RtcRtpReceiver that has track specific information.
Definition: Include.h:1130
RtcMediaStreamTrack track
Track with details of codec, trackId, streamId and track kind.
Definition: Include.h:1119
UINT32 version
Structure version.
Definition: Include.h:1554
UINT64 ttl
TTL of the configuration is 100ns.
Definition: Include.h:1392
UINT64 creationTime
Timestamp of when the channel gets created.
Definition: Include.h:1484
UINT64 messageTtl
Definition: Include.h:1363
UINT32 version
Structure version.
Definition: Include.h:1544
BOOL asyncIceServerConfig
Definition: Include.h:1374
PeerConnectionStats peerConnectionStats
Peer connection metrics stats. Reference in Stats.h.
Definition: Include.h:1574
BOOL voiceActivity
Only valid for audio. TRUE if last audio packet contained voice.
Definition: Include.h:1599
SIGNALING_MESSAGE_TYPE messageType
Type of signaling message.
Definition: Include.h:1271
UINT32 version
Version of the structure.
Definition: Include.h:1300
PBYTE pCertificate
Certificate bits.
Definition: Include.h:1151
BOOL generateRSACertificate
Definition: Include.h:1189
UINT32 encodeTimeMsec
milliseconds spent encoding frames since last encoder update
Definition: Include.h:1598
UINT32 privateKeySize
Size of private key in bytes (optional)
Definition: Include.h:1156
RTC_STATS_TYPE requestedTypeOfStats
Type of stats requested. Set to RTC_ALL to get all supported stats.
Definition: Include.h:1583
UINT64 signalingStartTime
Definition: Include.h:1555
BOOL useTrickleIce
Indicates if an offer should set trickle ice.
Definition: Include.h:1248
UINT64 customData
Custom data passed by the caller.
Definition: Include.h:1464
BOOL disableSenderSideBandwidthEstimation
Definition: Include.h:1199
PCHAR cacheFilePath
Definition: Include.h:1305
PCHAR pControlPlaneUrl
Definition: Include.h:1334
SIGNALING_CHANNEL_ROLE_TYPE channelRoleType
Channel role type for the endpoint - master/viewer.
Definition: Include.h:1350
SIGNALING_API_CALL_CACHE_TYPE cachingPolicy
Backend API call caching policy.
Definition: Include.h:1372
UINT32 iceConnectionCheckTimeout
Definition: Include.h:1175
PBYTE pPrivateKey
Private key bit.
Definition: Include.h:1155
GetCurrentTimeFunc getCurrentTimeFn
callback to override system time, used for testing clock skew
Definition: Include.h:1468
UINT32 targetBitrate
Definition: Include.h:1591
NullableUint16 maxPacketLifeTime
Definition: Include.h:1504
UINT32 iceCandidateNominationTimeout
Definition: Include.h:1178
PCHAR pStorageStreamArn
Definition: Include.h:1328
UINT32 payloadLen
Optional payload length. If 0, the length will be calculated.
Definition: Include.h:1277
BOOL ordered
Decides the order in which data is sent. If true, data is sent in order.
Definition: Include.h:1503
UINT32 iceConnectionCheckPollingInterval
Definition: Include.h:1182
CHAR name[255+1]
Define name of data channel. Max length is 256 characters.
Definition: Include.h:1029
UINT32 version
Structure version.
Definition: Include.h:1565
PCHAR pChannelName
Name of the signaling channel name. Maximum length is defined by MAX_CHANNEL_NAME_LEN + 1.
Definition: Include.h:1324
SignalingMessage signalingMessage
Definition: Include.h:1286
UINT64 timestamp
Timestamp of request for stats.
Definition: Include.h:1582
PCHAR pCustomUserAgent
Optional custom user agent name. Maximum length is defined by MAX_USER_AGENT_LEN+1.
Definition: Include.h:1342
SIGNALING_CLIENT_HANDLE * PSIGNALING_CLIENT_HANDLE
Definition: Include.h:767
UINT32 version
Structure version.
Definition: Include.h:1530
UINT16 height
Only valid for video.
Definition: Include.h:1596
IceSetInterfaceFilterFunc iceSetInterfaceFilterFunc
Definition: Include.h:1196
INT32 generatedCertificateBits
Definition: Include.h:1185
UINT16 maximumTransmissionUnit
Definition: Include.h:1167
SignalingClientMessageReceivedFunc messageReceivedFn
Callback registration for received SDP.
Definition: Include.h:1465
BOOL reconnect
Flag determines if reconnection should be attempted on connection drop.
Definition: Include.h:1361
PCHAR pUserAgentPostfix
Definition: Include.h:1339
INT32 signalingClientCreationMaxRetryAttempts
Max attempts to create signaling client before returning error to the caller.
Definition: Include.h:1311
UINT32 version
Structure version.
Definition: Include.h:1573
RtcStatsObject rtcStatsObject
Object that is populated by the SDK on request.
Definition: Include.h:1584
RtcIceCandidateStats remoteRtcIceCandidateStats
Remote candidate stats. Reference in Stats.h.
Definition: Include.h:1533
DOMString encoderImplementation
encoder name eg "libvpx" or "x264"
Definition: Include.h:1600
Contains all signaling channel related information.
Definition: Include.h:1321
ICE configuration information struct.
Definition: Include.h:1390
KVS ICE Agent Collection of ICE agent related stats. Can be expanded in the future.
Definition: Include.h:1564
: IceAgent profiling Stats related to the KVS ICE Agent
Definition: Stats.h:261
Definition: Include.h:1166
Definition: Include.h:1399
Definition: NullableDefs.h:60
Custom data type to allow setting UINT16 data type to NULL since C does not support setting basic dat...
Definition: NullableDefs.h:87
SignalingStats Collection of signaling related stats. Can be expanded in the future.
Definition: Include.h:1572
Definition: Stats.h:638
Structure defining the signaling message to be received.
Definition: Include.h:1285
Specifies the certificate and the private key used by the certificate. The Certificates are in the fo...
Definition: Include.h:1149
The Configuration defines a set of parameters to configure how the peer-to-peer communication establi...
Definition: Include.h:1214
RtcDataChannelInit dictionary used to configure properties of the underlying channel such as data rel...
Definition: Include.h:1502
The stats object is populated by the application to include details about the encoder.
Definition: Include.h:1590
Rtc ICE candidate interface.
Definition: Include.h:1259
RtcIceCandidatePairStats Stats related to the local-remote ICE candidate pair.
Definition: Stats.h:203
: RtcIceCandidateStats Stats related to a specific candidate in a pair
Definition: Stats.h:280
Statistics relted to ICE candidates.
Definition: Include.h:1529
: RtcIceServerStats Stats related to the ICE Server
Definition: Stats.h:246
RtcIceServer is used to describe the STUN and TURN servers that can be used by the ICE Agent to estab...
Definition: Include.h:1139
Represents a single track in a MediaStream.
Definition: Include.h:1102
RtcOutboundRtpStreamStats Gathers stats for media stream from the embedded device Note: RTCOutboundRt...
Definition: Stats.h:357
An RtcPeerConnection instance allows an application to establish peer-to-peer communications with ano...
Definition: Include.h:1093
RTCRemoteInboundRtpStreamStats Represents the remote endpoint's measurement metrics for a particular ...
Definition: Stats.h:409
RTCRtpReceiver allows an application to inspect the receipt of a MediaStreamTrack.
Definition: Include.h:1118
RtcRtpTransceiverInit is used to configure a transceiver when creating it.
Definition: Include.h:1492
The RTCRtpTransceiver represents a combination of an RTCRtpSender and an RTCRtpReceiver that share a ...
Definition: Include.h:1128
SessionDescription is used by RtcPeerConnection to expose local and remote session descriptions.
Definition: Include.h:1246
RTCStatsObject Represents an object passed in by the application developer which will be populated in...
Definition: Stats.h:653
The stats object is populated based on RTCStatsType request.
Definition: Include.h:1581
Collection of RTP stream related stats Reference: https://www.w3.org/TR/webrtc-stats/#remoteinboundrt...
Definition: Include.h:1543
RtcTransportStats Represents the stats corresponding to an RTCDtlsTransport and its underlying RTCIce...
Definition: Stats.h:297
Signaling channel description returned from the service.
Definition: Include.h:1474
Register Signaling client callbacks.
Definition: Include.h:1462
Populate Signaling client with client ID and application log level.
Definition: Include.h:1299
SignalingStats Collection of signaling related stats. Can be expanded in the future.
Definition: Include.h:1553
SignalingClientMetrics Represent the stats related to the KVS WebRTC SDK signaling client.
Definition: Stats.h:585
Structure defining the basic signaling message.
Definition: Include.h:1268
RtcDataChannel represents a bi-directional data channel between two peers.
Definition: Include.h:1028