vivox-sdk-node 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2255 @@
1
+ /* Copyright (c) 2019 Unity Technologies.
2
+ *
3
+ * This software is subject to, and made available under, the Unity Terms of Service (see Unity Terms of Service).
4
+ * Your use of this software constitutes your acceptance of such terms.
5
+
6
+ * Unless expressly provided otherwise, the software under this license is made available strictly on an "AS IS" BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED.
7
+ * Please review the Terms of Service for details on these and other terms and conditions.”
8
+ */
9
+ #pragma once
10
+
11
+ #include <Vxc.h>
12
+ #include <VxcRequests.h>
13
+
14
+ #pragma pack(push)
15
+ #pragma pack(8)
16
+
17
+ #ifdef __cplusplus
18
+ extern "C" {
19
+ #endif
20
+
21
+ /**
22
+ * The response for vx_req_connector_create
23
+ * \see vx_req_connector_create
24
+ * \ingroup connector
25
+ */
26
+ typedef struct vx_resp_connector_create {
27
+ /**
28
+ * The common properties for all responses.
29
+ */
30
+ vx_resp_base_t base;
31
+
32
+ /**
33
+ * Valid on success, handle value for this initialized connector instance.
34
+ */
35
+ VX_HANDLE connector_handle;
36
+
37
+ /**
38
+ * The version number of the SDK.
39
+ */
40
+ char *version_id;
41
+
42
+ /**
43
+ * The type of backend used, as defined in the `vx_backend_type` enum in `%VxcTypes.h`.
44
+ * For Vixox SDK version 5, this is always XMPP (`1`).
45
+ */
46
+ int backend_type;
47
+
48
+ /**
49
+ * Valid on success, default realm received by this initialized connector instance.
50
+ */
51
+ char *default_realm;
52
+ } vx_resp_connector_create_t;
53
+
54
+ /**
55
+ * The response for vx_req_connector_initiate_shutdown
56
+ * \see vx_req_connector_initiate_shutdown
57
+ * \ingroup connector
58
+ */
59
+ typedef struct vx_resp_connector_initiate_shutdown {
60
+ /**
61
+ * The common properties for all responses.
62
+ */
63
+ vx_resp_base_t base;
64
+
65
+ /**
66
+ * \deprecated This is deprecated and should not be used.
67
+ * @deprecated
68
+ */
69
+ char *client_name;
70
+ } vx_resp_connector_initiate_shutdown_t;
71
+
72
+ /**
73
+ * \deprecated This is deprecated and should not be used.
74
+ * The response for vx_req_account_login
75
+ * \see vx_req_account_login
76
+ * \ingroup login
77
+ * @deprecated
78
+ */
79
+ typedef struct vx_resp_account_login {
80
+ /**
81
+ * The common properties for all responses.
82
+ */
83
+ vx_resp_base_t base;
84
+
85
+ /**
86
+ * Valid on success, handle value for this initialized account login.
87
+ */
88
+ VX_HANDLE account_handle;
89
+
90
+ /**
91
+ * The ID of the account.
92
+ */
93
+ int account_id;
94
+
95
+ /**
96
+ * The display name of the account, if available.
97
+ */
98
+ char *display_name;
99
+
100
+ /**
101
+ * The URI of the user.
102
+ */
103
+ char *uri;
104
+
105
+ /**
106
+ * The number of aliases that are associated with this account.
107
+ */
108
+ int num_aliases;
109
+
110
+ /**
111
+ * The URI for list-based buddy presence.
112
+ * \note Available in select systems only.
113
+ */
114
+ char *buddy_list_uri;
115
+
116
+ /**
117
+ * The encoded URI for the user with the tag.
118
+ * This uniquely identifies users that might appear multiple times in a channel.
119
+ */
120
+ char *encoded_uri_with_tag;
121
+ } vx_resp_account_login_t;
122
+
123
+ /**
124
+ * \deprecated Use vx_req_account_anonymous_login instead.
125
+ * The response for vx_req_account_authtoken_login
126
+ * \see vx_req_account_authtoken_login
127
+ * \ingroup login
128
+ * @deprecated
129
+ */
130
+ typedef struct vx_resp_account_authtoken_login {
131
+ /**
132
+ * The common properties for all responses.
133
+ */
134
+ vx_resp_base_t base;
135
+
136
+ /**
137
+ * Valid on success, handle value for this initialized account login.
138
+ */
139
+ VX_HANDLE account_handle;
140
+
141
+ /**
142
+ * The ID of the account.
143
+ */
144
+ int account_id;
145
+
146
+ /**
147
+ * The user name of the account.
148
+ */
149
+ char *user_name;
150
+
151
+ /**
152
+ * The display name of the account, if available.
153
+ */
154
+ char *display_name;
155
+
156
+ /**
157
+ * The URI of the user.
158
+ */
159
+ char *uri;
160
+
161
+ /**
162
+ * The number of aliases that are associated with this account.
163
+ */
164
+ int num_aliases;
165
+
166
+ /**
167
+ * The URI for list-based buddy presence.
168
+ * \note Available in select systems only.
169
+ */
170
+ char *buddy_list_uri;
171
+
172
+ /**
173
+ * The encoded URI for the user with the tag.
174
+ * This uniquely identifies users that might appear multiple times in a channel.
175
+ */
176
+ char *encoded_uri_with_tag;
177
+ } vx_resp_account_authtoken_login_t;
178
+
179
+ /**
180
+ * The response for vx_req_account_anonymous_login
181
+ * \see vx_req_account_anonymous_login
182
+ * \ingroup login
183
+ */
184
+ typedef struct vx_resp_account_anonymous_login {
185
+ /**
186
+ * The common properties for all responses.
187
+ */
188
+ vx_resp_base_t base;
189
+
190
+ /**
191
+ * Valid on success, handle value for this initialized account login.
192
+ */
193
+ VX_HANDLE account_handle;
194
+
195
+ /**
196
+ * The ID of the account.
197
+ */
198
+ int account_id;
199
+
200
+ /**
201
+ * The display name of the account, if available.
202
+ */
203
+ char *displayname;
204
+
205
+ /**
206
+ * The URI of the user.
207
+ */
208
+ char *uri;
209
+
210
+ /**
211
+ * The encoded URI for the user with the tag.
212
+ * This uniquely identifies users that might appear multiple times in a channel.
213
+ */
214
+ char *encoded_uri_with_tag;
215
+ } vx_resp_account_anonymous_login_t;
216
+
217
+ /**
218
+ * The response for vx_req_account_logout
219
+ * \see vx_req_account_logout
220
+ * \ingroup login
221
+ */
222
+ typedef struct vx_resp_account_logout {
223
+ /**
224
+ * The common properties for all responses.
225
+ */
226
+ vx_resp_base_t base;
227
+ } vx_resp_account_logout_t;
228
+
229
+ /**
230
+ * \deprecated This is deprecated and should not be used.
231
+ * The response for vx_req_account_set_login_properties
232
+ * \see vx_req_account_set_login_properties
233
+ * \ingroup obsolete
234
+ * @deprecated
235
+ */
236
+ typedef struct vx_resp_account_set_login_properties {
237
+ /**
238
+ * The common properties for all responses.
239
+ */
240
+ vx_resp_base_t base;
241
+ } vx_resp_account_set_login_properties_t;
242
+
243
+ /**
244
+ * \deprecated This is deprecated and should not be used.
245
+ * The response for vx_req_sessiongroup_create
246
+ * \see vx_req_sessiongroup_create
247
+ * \ingroup sessiongroup
248
+ * @deprecated
249
+ */
250
+ typedef struct vx_resp_sessiongroup_create {
251
+ /**
252
+ * The common properties for all responses.
253
+ */
254
+ vx_resp_base_t base;
255
+
256
+ /**
257
+ * Valid on success, handle value for this created session.
258
+ */
259
+ VX_HANDLE sessiongroup_handle;
260
+ } vx_resp_sessiongroup_create_t;
261
+
262
+ /**
263
+ * \deprecated This is deprecated and should not be used.
264
+ * The response for vx_req_sessiongroup_terminate
265
+ * \see vx_req_sessiongroup_terminate
266
+ * \ingroup sessiongroup
267
+ * @deprecated
268
+ */
269
+ typedef struct vx_resp_sessiongroup_terminate {
270
+ /**
271
+ * The common properties for all responses.
272
+ */
273
+ vx_resp_base_t base;
274
+ } vx_resp_sessiongroup_terminate_t;
275
+
276
+ /**
277
+ * The response for vx_req_sessiongroup_add_session
278
+ * \see vx_req_sessiongroup_add_session
279
+ * \ingroup sessiongroup
280
+ */
281
+ typedef struct vx_resp_sessiongroup_add_session {
282
+ /**
283
+ * The common properties for all responses.
284
+ */
285
+ vx_resp_base_t base;
286
+
287
+ /**
288
+ * Valid on success, handle value for this created session.
289
+ */
290
+ VX_HANDLE session_handle;
291
+ } vx_resp_sessiongroup_add_session_t;
292
+
293
+ /**
294
+ * The response for vx_req_sessiongroup_remove_session
295
+ * \see vx_req_sessiongroup_remove_session
296
+ * \ingroup sessiongroup
297
+ */
298
+ typedef struct vx_resp_sessiongroup_remove_session {
299
+ /**
300
+ * The common properties for all responses.
301
+ */
302
+ vx_resp_base_t base;
303
+ } vx_resp_sessiongroup_remove_session_t;
304
+
305
+ /**
306
+ * The response for vx_req_sessiongroup_set_focus
307
+ * \see vx_req_sessiongroup_set_focus
308
+ * \ingroup sessiongroup
309
+ */
310
+ typedef struct vx_resp_sessiongroup_set_focus {
311
+ /**
312
+ * The common properties for all responses.
313
+ */
314
+ vx_resp_base_t base;
315
+ } vx_resp_sessiongroup_set_focus_t;
316
+
317
+ /**
318
+ * The response for vx_req_sessiongroup_unset_focus
319
+ * \see vx_req_sessiongroup_unset_focus
320
+ * \ingroup sessiongroup
321
+ */
322
+ typedef struct vx_resp_sessiongroup_unset_focus {
323
+ /**
324
+ * The common properties for all responses.
325
+ */
326
+ vx_resp_base_t base;
327
+ } vx_resp_sessiongroup_unset_focus_t;
328
+
329
+ /**
330
+ * The response for vx_req_sessiongroup_reset_focus
331
+ * \see vx_req_sessiongroup_reset_focus
332
+ * \ingroup sessiongroup
333
+ */
334
+ typedef struct vx_resp_sessiongroup_reset_focus {
335
+ /**
336
+ * The common properties for all responses.
337
+ */
338
+ vx_resp_base_t base;
339
+ } vx_resp_sessiongroup_reset_focus_t;
340
+
341
+ /**
342
+ * The response for vx_req_sessiongroup_set_tx_session
343
+ * \see vx_req_sessiongroup_set_tx_session
344
+ * \ingroup sessiongroup
345
+ */
346
+ typedef struct vx_resp_sessiongroup_set_tx_session {
347
+ /**
348
+ * The common properties for all responses.
349
+ */
350
+ vx_resp_base_t base;
351
+ } vx_resp_sessiongroup_set_tx_session_t;
352
+
353
+ /**
354
+ * The response for vx_req_sessiongroup_set_tx_all_sessions
355
+ * \see vx_req_sessiongroup_set_tx_all_sessions
356
+ * \ingroup sessiongroup
357
+ */
358
+ typedef struct vx_resp_sessiongroup_set_tx_all_sessions {
359
+ /**
360
+ * The common properties for all responses.
361
+ */
362
+ vx_resp_base_t base;
363
+ } vx_resp_sessiongroup_set_tx_all_sessions_t;
364
+
365
+ /**
366
+ * The response for vx_req_sessiongroup_set_tx_no_session
367
+ * \see vx_req_sessiongroup_set_tx_no_session
368
+ * \ingroup sessiongroup
369
+ */
370
+ typedef struct vx_resp_sessiongroup_set_tx_no_session {
371
+ /**
372
+ * The common properties for all responses.
373
+ */
374
+ vx_resp_base_t base;
375
+ } vx_resp_sessiongroup_set_tx_no_session_t;
376
+
377
+ /**
378
+ * The response for vx_req_sessiongroup_set_session_3d_position
379
+ * \see vx_req_sessiongroup_set_session_3d_position
380
+ * \ingroup sessiongroup
381
+ */
382
+ typedef struct vx_resp_sessiongroup_set_session_3d_position {
383
+ /**
384
+ * The common properties for all responses.
385
+ */
386
+ vx_resp_base_t base;
387
+ } vx_resp_sessiongroup_set_session_3d_position_t;
388
+
389
+ /**
390
+ * The response for vx_req_sessiongroup_control_audio_injection
391
+ * \see vx_req_sessiongroup_control_audio_injection
392
+ * \ingroup adi
393
+ */
394
+ typedef struct vx_resp_sessiongroup_control_audio_injection {
395
+ /**
396
+ * The common properties for all responses.
397
+ */
398
+ vx_resp_base_t base;
399
+ } vx_resp_sessiongroup_control_audio_injection_t;
400
+
401
+ /**
402
+ * \deprecated This is deprecated and should not be used.
403
+ * The response for vx_req_session_create
404
+ * \see vx_req_session_create
405
+ * @deprecated
406
+ */
407
+ typedef struct vx_resp_session_create {
408
+ /**
409
+ * The common properties for all responses.
410
+ */
411
+ vx_resp_base_t base;
412
+
413
+ /**
414
+ * Valid on success, handle value for this created session group.
415
+ */
416
+ VX_HANDLE sessiongroup_handle;
417
+
418
+ /**
419
+ * Valid on success, handle value for this created session.
420
+ */
421
+ VX_HANDLE session_handle;
422
+ } vx_resp_session_create_t;
423
+
424
+ /**
425
+ * The response for vx_req_session_media_connect
426
+ * \see vx_req_session_media_connect
427
+ * \ingroup session
428
+ */
429
+ typedef struct vx_resp_session_media_connect {
430
+ /**
431
+ * The common properties for all responses.
432
+ */
433
+ vx_resp_base_t base;
434
+ } vx_resp_session_media_connect_t;
435
+
436
+ /**
437
+ * The response for vx_req_session_media_disconnect
438
+ * \see vx_req_session_media_disconnect
439
+ * \ingroup session
440
+ */
441
+ typedef struct vx_resp_session_media_disconnect {
442
+ /**
443
+ * The common properties for all responses.
444
+ */
445
+ vx_resp_base_t base;
446
+ } vx_resp_session_media_disconnect_t;
447
+
448
+ /**
449
+ * The response for vx_req_session_text_connect
450
+ * \see vx_req_session_text_connect
451
+ * \ingroup session
452
+ */
453
+ typedef struct vx_resp_session_text_connect {
454
+ /**
455
+ * The common properties for all responses.
456
+ */
457
+ vx_resp_base_t base;
458
+ } vx_resp_session_text_connect_t;
459
+
460
+ /**
461
+ * The response for vx_req_session_text_disconnect
462
+ * \see vx_req_session_text_disconnect
463
+ * \ingroup session
464
+ */
465
+ typedef struct vx_resp_session_text_disconnect {
466
+ /**
467
+ * The common properties for all responses.
468
+ */
469
+ vx_resp_base_t base;
470
+ } vx_resp_session_text_disconnect_t;
471
+
472
+ /**
473
+ * The response for vx_req_session_terminate
474
+ * \see vx_req_session_terminate
475
+ * \ingroup session
476
+ */
477
+ typedef struct vx_resp_session_terminate {
478
+ /**
479
+ * The common properties for all responses.
480
+ */
481
+ vx_resp_base_t base;
482
+ } vx_resp_session_terminate_t;
483
+
484
+ /**
485
+ * The response for vx_req_session_mute_local_speaker
486
+ * \see vx_req_session_mute_local_speaker
487
+ * \ingroup session
488
+ */
489
+ typedef struct vx_resp_session_mute_local_speaker {
490
+ /**
491
+ * The common properties for all responses.
492
+ */
493
+ vx_resp_base_t base;
494
+ } vx_resp_session_mute_local_speaker_t;
495
+
496
+ /**
497
+ * \deprecated Use vx_req_aux_set_speaker_level_t instead.
498
+ * The response for vx_req_session_set_local_speaker_volume_t
499
+ * \see vx_req_session_set_local_speaker_volume
500
+ * \ingroup obsolete
501
+ * @deprecated
502
+ */
503
+ typedef struct vx_resp_session_set_local_speaker_volume {
504
+ /**
505
+ * The common properties for all responses.
506
+ */
507
+ vx_resp_base_t base;
508
+ } vx_resp_session_set_local_speaker_volume_t;
509
+
510
+ /**
511
+ * The response for vx_req_session_set_local_render_volume
512
+ * \see vx_req_session_set_local_render_volume
513
+ * \ingroup session
514
+ */
515
+ typedef struct vx_resp_session_set_local_render_volume {
516
+ /**
517
+ * The common properties for all responses.
518
+ */
519
+ vx_resp_base_t base;
520
+ } vx_resp_session_set_local_render_volume_t;
521
+
522
+ /**
523
+ * The response for vx_req_session_channel_invite_user
524
+ * \see vx_req_session_channel_invite_user
525
+ * \ingroup session
526
+ */
527
+ typedef struct vx_resp_session_channel_invite_user {
528
+ vx_resp_base_t base;
529
+ } vx_resp_session_channel_invite_user_t;
530
+
531
+ /**
532
+ * The response for vx_req_session_set_participant_volume_for_me
533
+ * \see vx_req_session_set_participant_volume_for_me
534
+ * \ingroup session
535
+ */
536
+ typedef struct vx_resp_session_set_participant_volume_for_me {
537
+ /**
538
+ * The common properties for all responses.
539
+ */
540
+ vx_resp_base_t base;
541
+ } vx_resp_session_set_participant_volume_for_me_t;
542
+
543
+ /**
544
+ * The response for vx_req_session_set_participant_mute_for_me
545
+ * \see vx_req_session_set_participant_mute_for_me
546
+ * \ingroup session
547
+ */
548
+ typedef struct vx_resp_session_set_participant_mute_for_me {
549
+ vx_resp_base_t base;
550
+ } vx_resp_session_set_participant_mute_for_me_t;
551
+
552
+ /**
553
+ * The response for vx_req_session_set_3d_position
554
+ * \see vx_req_session_set_3d_position
555
+ * \ingroup session
556
+ */
557
+ typedef struct vx_resp_session_set_3d_position {
558
+ /**
559
+ * The common properties for all responses.
560
+ */
561
+ vx_resp_base_t base;
562
+ } vx_resp_session_set_3d_position_t;
563
+
564
+ /**
565
+ * The response for vx_req_session_set_voice_font
566
+ * \see vx_req_session_set_voice_font
567
+ * \ingroup voicefonts
568
+ */
569
+ typedef struct vx_resp_session_set_voice_font {
570
+ /**
571
+ * The common properties for all responses.
572
+ */
573
+ vx_resp_base_t base;
574
+ } vx_resp_session_set_voice_font_t;
575
+
576
+ /**
577
+ * The response for vx_req_account_channel_change_owner
578
+ * \see vx_req_account_channel_change_owner_t
579
+ */
580
+ typedef struct vx_resp_account_channel_change_owner {
581
+ /**
582
+ * The common properties for all responses.
583
+ */
584
+ vx_resp_base_t base;
585
+ } vx_resp_account_channel_change_owner_t;
586
+
587
+ /**
588
+ * The response for vx_req_account_send_user_app_data
589
+ * \see vx_req_account_send_user_app_data_t
590
+ */
591
+ typedef struct vx_resp_account_send_user_app_data {
592
+ /**
593
+ * The common properties for all responses.
594
+ */
595
+ vx_resp_base_t base;
596
+ } vx_resp_account_send_user_app_data_t;
597
+
598
+ /**
599
+ * \deprecated This is deprecated and should not be used.
600
+ * The response for vx_req_account_channel_add_acl
601
+ * \see vx_req_account_channel_add_acl
602
+ * \ingroup obsolete
603
+ * @deprecated
604
+ */
605
+ typedef struct vx_resp_account_channel_add_acl {
606
+ /**
607
+ * The common properties for all responses.
608
+ */
609
+ vx_resp_base_t base;
610
+ } vx_resp_account_channel_add_acl_t;
611
+
612
+ /**
613
+ * \deprecated This is deprecated and should not be used.
614
+ * The response for vx_req_account_channel_remove_acl
615
+ * \see vx_req_account_channel_remove_acl
616
+ * \ingroup obsolete
617
+ * @deprecated
618
+ */
619
+ typedef struct vx_resp_account_channel_remove_acl {
620
+ vx_resp_base_t base;
621
+ } vx_resp_account_channel_remove_acl_t;
622
+
623
+ /**
624
+ * \deprecated This is deprecated and should not be used.
625
+ * The response for vx_req_account_channel_get_acl
626
+ * \see vx_req_account_channel_get_acl
627
+ * \ingroup obsolete
628
+ * @deprecated
629
+ */
630
+ typedef struct vx_resp_account_channel_get_acl {
631
+ /**
632
+ * The common properties for all responses.
633
+ */
634
+ vx_resp_base_t base;
635
+
636
+ /**
637
+ * The number of entries in the "participants" array.
638
+ */
639
+ int participants_size;
640
+
641
+ /**
642
+ * A list of users in the channel's Access Control List.
643
+ * \note Only the URI field on the participant structures is guaranteed to be present.
644
+ */
645
+ vx_participant_t **participants;
646
+ } vx_resp_account_channel_get_acl_t;
647
+
648
+ /**
649
+ * The response for vx_req_channel_mute_user
650
+ * \see vx_req_channel_mute_user
651
+ * \ingroup channel
652
+ */
653
+ typedef struct vx_resp_channel_mute_user {
654
+ /**
655
+ * The common properties for all responses.
656
+ */
657
+ vx_resp_base_t base;
658
+ } vx_resp_channel_mute_user_t;
659
+
660
+ /**
661
+ * \deprecated This is deprecated and should not be used.
662
+ * The response for vx_req_channel_ban_user
663
+ * \see vx_req_channel_ban_user
664
+ * \ingroup obsolete
665
+ * @deprecated
666
+ */
667
+ typedef struct vx_resp_channel_ban_user {
668
+ vx_resp_base_t base;
669
+ } vx_resp_channel_ban_user_t;
670
+
671
+ /**
672
+ * \deprecated This is deprecated and should not be used.
673
+ * The response for vx_req_channel_get_banned_users
674
+ * \see vx_req_channel_get_banned_users
675
+ * \ingroup obsolete
676
+ * @deprecated
677
+ */
678
+ typedef struct vx_resp_channel_get_banned_users {
679
+ /**
680
+ * The common properties for all responses.
681
+ */
682
+ vx_resp_base_t base;
683
+
684
+ /**
685
+ * The number of entries in the "banned_users" array.
686
+ */
687
+ int banned_users_count;
688
+
689
+ /**
690
+ * A list of users banned from the specified channel.
691
+ */
692
+ vx_participant_t **banned_users;
693
+ } vx_resp_channel_get_banned_users_t;
694
+
695
+ /**
696
+ * The response for vx_req_channel_kick_user
697
+ * \see vx_req_channel_kick_user
698
+ * \ingroup channel
699
+ */
700
+ typedef struct vx_resp_channel_kick_user {
701
+ vx_resp_base_t base;
702
+ } vx_resp_channel_kick_user_t;
703
+
704
+ /**
705
+ * The response for vx_req_channel_mute_all_users
706
+ * \see vx_req_channel_mute_all_users
707
+ * \ingroup channel
708
+ */
709
+ typedef struct vx_resp_channel_mute_all_users {
710
+ vx_resp_base_t base;
711
+ } vx_resp_channel_mute_all_users_t;
712
+
713
+ /**
714
+ * \deprecated This is deprecated and should not be used.
715
+ * The response for vx_req_channel_set_lock_mode
716
+ * \see vx_req_channel_set_lock_mode
717
+ * \ingroup obsolete
718
+ * @deprecated
719
+ */
720
+ typedef struct vx_resp_channel_set_lock_mode {
721
+ vx_resp_base_t base;
722
+ } vx_resp_channel_set_lock_mode_t;
723
+
724
+ /**
725
+ * The response for vx_req_connector_mute_local_mic
726
+ * \see vx_req_connector_mute_local_mic
727
+ * \ingroup devices
728
+ */
729
+ typedef struct vx_resp_connector_mute_local_mic {
730
+ /**
731
+ * The common properties for all responses.
732
+ */
733
+ vx_resp_base_t base;
734
+ } vx_resp_connector_mute_local_mic_t;
735
+
736
+ /**
737
+ * The response for vx_req_connector_mute_local_speaker
738
+ * \see vx_req_connector_mute_local_speaker
739
+ * \ingroup devices
740
+ */
741
+ typedef struct vx_resp_connector_mute_local_speaker {
742
+ /**
743
+ * The common properties for all responses.
744
+ */
745
+ vx_resp_base_t base;
746
+ } vx_resp_connector_mute_local_speaker_t;
747
+
748
+ /**
749
+ * \deprecated Use vx_resp_aux_set_mic_level instead.
750
+ * The response for vx_req_connector_set_local_mic_volume
751
+ * \see vx_req_connector_set_local_mic_volume
752
+ * \ingroup obsolete
753
+ * @deprecated
754
+ */
755
+ typedef struct vx_resp_connector_set_local_mic_volume {
756
+ /**
757
+ * The common properties for all responses.
758
+ */
759
+ vx_resp_base_t base;
760
+ } vx_resp_connector_set_local_mic_volume_t;
761
+
762
+ /**
763
+ * \deprecated Use vx_resp_aux_set_speaker_level instead.
764
+ * The response for vx_req_connector_set_local_speaker_volume
765
+ * \see vx_req_connector_set_local_speaker_volume
766
+ * \ingroup obsolete
767
+ * @deprecated
768
+ */
769
+ typedef struct vx_resp_connector_set_local_speaker_volume {
770
+ vx_resp_base_t base;
771
+ } vx_resp_connector_set_local_speaker_volume_t;
772
+
773
+ /**
774
+ * The response for vx_req_connector_get_local_audio_info
775
+ * \see vx_req_connector_get_local_audio_info
776
+ * \ingroup devices
777
+ */
778
+ typedef struct vx_resp_connector_get_local_audio_info {
779
+ /**
780
+ * The common properties for all responses.
781
+ */
782
+ vx_resp_base_t base;
783
+
784
+ /**
785
+ * The level of the speaker audio.
786
+ * This is a non-negative integer value between 0 and 100 (inclusive).
787
+ * The default value is 50, in which no gain is applied to the audio.
788
+ * When this value is 0, no speaker audio is rendered.
789
+ */
790
+ int speaker_volume;
791
+
792
+ /**
793
+ * A number, which is either true (mute) or false (unmute).
794
+ */
795
+ int is_speaker_muted;
796
+
797
+ /**
798
+ * The level of the microphone audio.
799
+ * This is a non-negative integer value between 0 and 100 (inclusive).
800
+ * The default value is 50, in which no gain is applied to the audio.
801
+ * When this value is 0, no microphone audio is rendered.
802
+ */
803
+ int mic_volume;
804
+
805
+ /**
806
+ * A number, which is either 1 (mute) or 0 (unmute).
807
+ */
808
+ int is_mic_muted;
809
+ } vx_resp_connector_get_local_audio_info_t;
810
+
811
+ /**
812
+ * The response for vx_req_account_buddy_set
813
+ * \see vx_req_account_buddy_set
814
+ * \ingroup buddy
815
+ */
816
+ typedef struct vx_resp_account_buddy_set {
817
+ /**
818
+ * The common properties for all responses.
819
+ */
820
+ vx_resp_base_t base;
821
+
822
+ /**
823
+ * The account ID of the buddy.
824
+ */
825
+ int account_id;
826
+ } vx_resp_account_buddy_set_t;
827
+
828
+ /**
829
+ * The response for vx_req_account_buddy_delete
830
+ * \see vx_req_account_buddy_delete
831
+ * \ingroup buddy
832
+ */
833
+ typedef struct vx_resp_account_buddy_delete {
834
+ /**
835
+ * The common properties for all responses.
836
+ */
837
+ vx_resp_base_t base;
838
+ } vx_resp_account_buddy_delete_t;
839
+
840
+ /**
841
+ * \deprecated This is deprecated and should not be used.
842
+ * The response for vx_req_account_list_buddies_and_groups
843
+ * \see vx_req_account_list_buddies_and_groups
844
+ * \ingroup buddy
845
+ * @deprecated
846
+ */
847
+ typedef struct vx_resp_account_list_buddies_and_groups {
848
+ /**
849
+ * The common properties for all responses.
850
+ */
851
+ vx_resp_base_t base;
852
+
853
+ /**
854
+ * The number of buddies found in the list.
855
+ */
856
+ int buddy_count;
857
+
858
+ /**
859
+ * The number of groups found in the list.
860
+ */
861
+ int group_count;
862
+
863
+ /**
864
+ * A collection of buddy structures.
865
+ */
866
+ vx_buddy_t **buddies;
867
+
868
+ /**
869
+ * A collection of group structures.
870
+ */
871
+ vx_group_t **groups;
872
+ } vx_resp_account_list_buddies_and_groups_t;
873
+
874
+ /**
875
+ * The response for vx_req_session_send_message
876
+ * \see vx_req_session_send_message
877
+ * \ingroup buddy
878
+ */
879
+ typedef struct vx_resp_session_send_message {
880
+ /**
881
+ * The common properties for all responses.
882
+ */
883
+ vx_resp_base_t base;
884
+ } vx_resp_session_send_message_t;
885
+
886
+ /**
887
+ * The response for vx_req_session_delete_message
888
+ * \see vx_req_session_delete_message
889
+ * \ingroup session
890
+ */
891
+ typedef struct vx_resp_session_delete_message {
892
+ /**
893
+ * The common properties for all responses.
894
+ */
895
+ vx_resp_base_t base;
896
+
897
+ /**
898
+ * The message_id for the old message to edit.
899
+ */
900
+ char *message_id;
901
+
902
+ /**
903
+ * The timestamp of the deleted message.
904
+ */
905
+ long long delete_time;
906
+
907
+ /**
908
+ * The URI of the sender.
909
+ */
910
+ char *from_uri;
911
+ } vx_resp_session_delete_message_t;
912
+
913
+ /**
914
+ * The response for vx_req_session_edit_message
915
+ * \see vx_req_session_edit_message
916
+ * \ingroup session
917
+ */
918
+ typedef struct vx_resp_session_edit_message {
919
+ /**
920
+ * The common properties for all responses.
921
+ */
922
+ vx_resp_base_t base;
923
+
924
+ /**
925
+ * The message_id for the old message to edit.
926
+ */
927
+ char *message_id;
928
+
929
+ /**
930
+ * The new message to replace existing message.
931
+ */
932
+ char *new_message;
933
+
934
+ /**
935
+ * The timestamp of the edited message.
936
+ */
937
+ long long edit_time;
938
+
939
+ /**
940
+ * The URI of the sender.
941
+ */
942
+ char *from_uri;
943
+ } vx_resp_session_edit_message_t;
944
+
945
+ #ifndef DOXYGEN_MAM_SKIP
946
+ /**
947
+ * The response for vx_req_session_archive_query
948
+ * \see vx_req_session_archive_query
949
+ * \ingroup session
950
+ */
951
+ typedef struct vx_resp_session_archive_query {
952
+ /**
953
+ * The common properties for all responses.
954
+ */
955
+ vx_resp_base_t base;
956
+
957
+ /**
958
+ * The ID of the started query.
959
+ * Use this ID to identify relevant vx_evt_session_archive_message and vx_evt_session_archive_query_end events.
960
+ */
961
+ char *query_id;
962
+ } vx_resp_session_archive_query_t;
963
+ #endif
964
+
965
+ /**
966
+ * The response for vx_req_session_chat_history_query
967
+ * \see vx_req_session_chat_history_query
968
+ * \ingroup session
969
+ */
970
+ typedef struct vx_resp_session_chat_history_query {
971
+ /**
972
+ * The common properties for all responses.
973
+ */
974
+ vx_resp_base_t base;
975
+
976
+ /**
977
+ * The ID of the started query.
978
+ * Use this ID to identify relevant vx_evt_session_chat_history_message and vx_evt_session_archive_query_end events.
979
+ */
980
+ char *query_id;
981
+ } vx_resp_session_chat_history_query_t;
982
+
983
+ /**
984
+ * The response for vx_req_account_chat_history_set_marker
985
+ * \see vx_req_account_chat_history_set_marker
986
+ * \ingroup chat_history
987
+ */
988
+ typedef struct vx_resp_account_chat_history_set_marker {
989
+ /**
990
+ * The common properties for all responses.
991
+ */
992
+ vx_resp_base_t base;
993
+ } vx_resp_account_chat_history_set_marker_t;
994
+
995
+ /**
996
+ * The response for vx_req_account_chat_history_get_last_read
997
+ * \see vx_req_account_chat_history_get_last_read
998
+ * \ingroup account
999
+ */
1000
+ typedef struct vx_resp_account_chat_history_get_last_read {
1001
+ /**
1002
+ * The common properties for all responses.
1003
+ */
1004
+ vx_resp_base_t base;
1005
+
1006
+ /**
1007
+ * The ID of the last read message
1008
+ */
1009
+ char *message_id;
1010
+
1011
+ /**
1012
+ * The timestamp of the last read message
1013
+ */
1014
+ long long read_at;
1015
+
1016
+ /**
1017
+ * The count of unread messages
1018
+ */
1019
+ int unread_messages_count;
1020
+ } vx_resp_account_chat_history_get_last_read_t;
1021
+
1022
+ /**
1023
+ * The response for vx_req_account_set_presence
1024
+ * \see vx_req_account_set_presence
1025
+ * \ingroup buddy
1026
+ */
1027
+ typedef struct vx_resp_account_set_presence {
1028
+ /**
1029
+ * The common properties for all responses.
1030
+ */
1031
+ vx_resp_base_t base;
1032
+ } vx_resp_account_set_presence_t;
1033
+
1034
+ /**
1035
+ * The response for vx_req_account_send_subscription_reply
1036
+ * \see vx_req_account_send_subscription_reply
1037
+ * \ingroup buddy
1038
+ */
1039
+ typedef struct vx_resp_account_send_subscription_reply {
1040
+ /**
1041
+ * The common properties for all responses.
1042
+ */
1043
+ vx_resp_base_t base;
1044
+ } vx_resp_account_send_subscription_reply_t;
1045
+
1046
+ /**
1047
+ * The response for vx_req_session_send_notification
1048
+ * \see vx_req_session_send_notification
1049
+ * \ingroup session
1050
+ */
1051
+ typedef struct vx_resp_session_send_notification {
1052
+ /**
1053
+ * The common properties for all responses.
1054
+ */
1055
+ vx_resp_base_t base;
1056
+ } vx_resp_session_send_notification_t;
1057
+
1058
+ /**
1059
+ * \deprecated This is deprecated and should not be used.
1060
+ * The response for vx_req_session_send_dtmf
1061
+ * \see vx_req_session_send_dtmf
1062
+ * \ingroup obsolete
1063
+ * @deprecated
1064
+ */
1065
+ typedef struct vx_resp_session_send_dtmf {
1066
+ /**
1067
+ * The common properties for all responses.
1068
+ */
1069
+ vx_resp_base_t base;
1070
+ } vx_resp_session_send_dtmf_t;
1071
+
1072
+ /**
1073
+ * The response for vx_req_account_create_block_rule
1074
+ * \see vx_req_account_create_block_rule
1075
+ * \ingroup buddy
1076
+ */
1077
+ typedef struct vx_resp_account_create_block_rule {
1078
+ /**
1079
+ * The common properties for all responses.
1080
+ */
1081
+ vx_resp_base_t base;
1082
+ } vx_resp_account_create_block_rule_t;
1083
+
1084
+ /**
1085
+ * The response for vx_req_account_delete_block_rule
1086
+ * \see vx_req_account_delete_block_rule
1087
+ * \ingroup buddy
1088
+ */
1089
+ typedef struct vx_resp_account_delete_block_rule {
1090
+ /**
1091
+ * The common properties for all responses.
1092
+ */
1093
+ vx_resp_base_t base;
1094
+ } vx_resp_account_delete_block_rule_t;
1095
+
1096
+ /**
1097
+ * The response for vx_req_account_list_block_rules
1098
+ * \see vx_req_account_list_block_rules
1099
+ * \ingroup buddy
1100
+ */
1101
+ typedef struct vx_resp_account_list_block_rules {
1102
+ /**
1103
+ * The common properties for all responses.
1104
+ */
1105
+ vx_resp_base_t base;
1106
+
1107
+ /**
1108
+ * The number of block rules returned in the list.
1109
+ */
1110
+ int rule_count;
1111
+
1112
+ /**
1113
+ * A list of block rules for the given account.
1114
+ */
1115
+ vx_block_rule_t **block_rules;
1116
+ } vx_resp_account_list_block_rules_t;
1117
+
1118
+ /**
1119
+ * The response for vx_req_account_create_auto_accept_rule
1120
+ * \see vx_req_account_create_auto_accept_rule
1121
+ * \ingroup buddy
1122
+ */
1123
+ typedef struct vx_resp_account_create_auto_accept_rule {
1124
+ /**
1125
+ * The common properties for all responses.
1126
+ */
1127
+ vx_resp_base_t base;
1128
+ } vx_resp_account_create_auto_accept_rule_t;
1129
+
1130
+ /**
1131
+ * The response for vx_req_account_delete_auto_accept_rule
1132
+ * \see vx_req_account_delete_auto_accept_rule
1133
+ * \ingroup buddy
1134
+ */
1135
+ typedef struct vx_resp_account_delete_auto_accept_rule {
1136
+ vx_resp_base_t base;
1137
+ } vx_resp_account_delete_auto_accept_rule_t;
1138
+
1139
+ /**
1140
+ * The response for vx_req_account_list_auto_accept_rules
1141
+ * \see vx_req_account_list_auto_accept_rules
1142
+ * \ingroup buddy
1143
+ */
1144
+ typedef struct vx_resp_account_list_auto_accept_rules {
1145
+ /**
1146
+ * The common properties for all responses.
1147
+ */
1148
+ vx_resp_base_t base;
1149
+
1150
+ /**
1151
+ * The number of block rules returned in the list.
1152
+ */
1153
+ int rule_count;
1154
+
1155
+ /**
1156
+ * A list of block rules for the given account.
1157
+ */
1158
+ vx_auto_accept_rule_t **auto_accept_rules;
1159
+ } vx_resp_account_list_auto_accept_rules_t;
1160
+
1161
+ /**
1162
+ * \deprecated This is deprecated and should not be used.
1163
+ * The response for vx_req_account_update_account
1164
+ * \see vx_req_account_update_account
1165
+ * @deprecated
1166
+ */
1167
+ typedef struct vx_resp_account_update_account {
1168
+ /**
1169
+ * The common properties for all responses.
1170
+ */
1171
+ vx_resp_base_t base;
1172
+ } vx_resp_account_update_account_t;
1173
+
1174
+ /**
1175
+ * \deprecated This is deprecated and should not be used.
1176
+ * The response for vx_req_account_get_account
1177
+ * \see vx_req_account_get_account
1178
+ * @deprecated
1179
+ */
1180
+ typedef struct vx_resp_account_get_account {
1181
+ /**
1182
+ * The common properties for all responses.
1183
+ */
1184
+ vx_resp_base_t base;
1185
+
1186
+ /**
1187
+ * A pointer to a 'vx_account_t' struct which contains information about the account.
1188
+ */
1189
+ vx_account_t *account;
1190
+ } vx_resp_account_get_account_t;
1191
+
1192
+ /**
1193
+ * The response for vx_req_account_send_sms
1194
+ * \see vx_req_account_send_sms
1195
+ */
1196
+ typedef struct vx_resp_account_send_sms {
1197
+ /**
1198
+ * The common properties for all responses.
1199
+ */
1200
+ vx_resp_base_t base;
1201
+ } vx_resp_account_send_sms_t;
1202
+
1203
+ /**
1204
+ * The response for vx_req_aux_connectivity_info
1205
+ * \see vx_req_aux_connectivity_info
1206
+ * \ingroup diagnostics
1207
+ */
1208
+ typedef struct vx_resp_aux_connectivity_info {
1209
+ /**
1210
+ * The common properties for all responses.
1211
+ */
1212
+ vx_resp_base_t base;
1213
+
1214
+ int count;
1215
+
1216
+ /**
1217
+ * A list of the test results for each test.
1218
+ */
1219
+ vx_connectivity_test_result_t **test_results;
1220
+
1221
+ /**
1222
+ * The well known IP address used.
1223
+ */
1224
+ char *well_known_ip;
1225
+
1226
+ /**
1227
+ * The stun server used.
1228
+ */
1229
+ char *stun_server;
1230
+
1231
+ /**
1232
+ * The echo server used.
1233
+ */
1234
+ char *echo_server;
1235
+
1236
+ /**
1237
+ * The echo port used.
1238
+ */
1239
+ int echo_port;
1240
+
1241
+ /**
1242
+ * The timeout used.
1243
+ */
1244
+ int timeout;
1245
+
1246
+ /**
1247
+ * The first (primary) simulated port for SIP testing.
1248
+ */
1249
+ int first_sip_port;
1250
+
1251
+ /**
1252
+ * The second (fallback) simulated port for SIP testing.
1253
+ */
1254
+ int second_sip_port;
1255
+
1256
+ /**
1257
+ * The simulated RTP port.
1258
+ */
1259
+ int rtp_port;
1260
+
1261
+ /**
1262
+ * The simulated RTCP port.
1263
+ */
1264
+ int rtcp_port;
1265
+ } vx_resp_aux_connectivity_info_t;
1266
+
1267
+ /**
1268
+ * The response for vx_req_aux_get_render_devices
1269
+ * \see vx_req_aux_get_render_devices
1270
+ * \ingroup devices
1271
+ */
1272
+ typedef struct vx_resp_aux_get_render_devices {
1273
+ /**
1274
+ * The common properties for all responses.
1275
+ */
1276
+ vx_resp_base_t base;
1277
+
1278
+ /**
1279
+ * The number of render devices found.
1280
+ */
1281
+ int count;
1282
+
1283
+ /**
1284
+ * An array of pointers to 'vx_device_t' structs.
1285
+ */
1286
+ vx_device_t **render_devices;
1287
+
1288
+ /**
1289
+ * The render device currently in use by the Vivox SDK for the requested user.
1290
+ */
1291
+ vx_device_t *current_render_device;
1292
+
1293
+ /**
1294
+ * The effective render device of the requested user.
1295
+ */
1296
+ vx_device_t *effective_render_device;
1297
+
1298
+ /**
1299
+ * The default system render device of the requested user.
1300
+ */
1301
+ vx_device_t *default_render_device;
1302
+
1303
+ /**
1304
+ * The default communication render device of the requested user.
1305
+ */
1306
+ vx_device_t *default_communication_render_device;
1307
+ } vx_resp_aux_get_render_devices_t;
1308
+
1309
+ /**
1310
+ * The response for vx_req_aux_get_capture_devices
1311
+ * \see vx_req_aux_get_capture_devices
1312
+ * \ingroup devices
1313
+ */
1314
+ typedef struct vx_resp_aux_get_capture_devices {
1315
+ /**
1316
+ * The common properties for all responses.
1317
+ */
1318
+ vx_resp_base_t base;
1319
+
1320
+ /**
1321
+ * The number of capture devices found.
1322
+ */
1323
+ int count;
1324
+
1325
+ /**
1326
+ * A list of capture devices.
1327
+ */
1328
+ vx_device_t **capture_devices;
1329
+
1330
+ /**
1331
+ * The current capture device of the requested user.
1332
+ */
1333
+ vx_device_t *current_capture_device;
1334
+
1335
+ /**
1336
+ * The effective capture device of the requested user.
1337
+ */
1338
+ vx_device_t *effective_capture_device;
1339
+
1340
+ /**
1341
+ * The default system capture device of the requested user.
1342
+ */
1343
+ vx_device_t *default_capture_device;
1344
+
1345
+ /**
1346
+ * The default communication capture device of the requested user.
1347
+ */
1348
+ vx_device_t *default_communication_capture_device;
1349
+ } vx_resp_aux_get_capture_devices_t;
1350
+
1351
+ /**
1352
+ * The response for vx_req_aux_set_render_device
1353
+ * \see vx_req_aux_set_render_device
1354
+ * \ingroup devices
1355
+ */
1356
+ typedef struct vx_resp_aux_set_render_device {
1357
+ /**
1358
+ * The common properties for all responses.
1359
+ */
1360
+ vx_resp_base_t base;
1361
+
1362
+ /**
1363
+ * The globally unique ID assigned to the open instance of the current render device (after the set).
1364
+ * Empty if no device is open for this user.
1365
+ * This is useful for differentiating between discrete instances of "No Device".
1366
+ */
1367
+ char *open_render_device_guid;
1368
+ } vx_resp_aux_set_render_device_t;
1369
+
1370
+ /**
1371
+ * The response for vx_req_aux_set_capture_device
1372
+ * \see vx_req_aux_set_capture_device
1373
+ * \ingroup devices
1374
+ */
1375
+ typedef struct vx_resp_aux_set_capture_device {
1376
+ /**
1377
+ * The common properties for all responses.
1378
+ */
1379
+ vx_resp_base_t base;
1380
+
1381
+ /**
1382
+ * The globally unique ID assigned to the open instance of the current capture device (after the set).
1383
+ * Empty if no device is open for this user.
1384
+ * This is useful for differentiating between discrete instances of "No Device".
1385
+ */
1386
+ char *open_capture_device_guid;
1387
+ } vx_resp_aux_set_capture_device_t;
1388
+
1389
+ /**
1390
+ * The response for vx_req_aux_get_mic_level
1391
+ * \see vx_req_aux_get_mic_level
1392
+ * \ingroup devices
1393
+ */
1394
+ typedef struct vx_resp_aux_get_mic_level {
1395
+ /**
1396
+ * The common properties for all responses.
1397
+ */
1398
+ vx_resp_base_t base;
1399
+
1400
+ /**
1401
+ * The master "microphone" level.
1402
+ * This is a non-negative integer value between 0 and 100 (inclusive). The default value is 50.
1403
+ * A +6 increase represents a doubling of energy, and a +20 increase represents a tenfold increase in energy.
1404
+ */
1405
+ int level;
1406
+ } vx_resp_aux_get_mic_level_t;
1407
+
1408
+ /**
1409
+ * The response for vx_req_aux_get_speaker_level
1410
+ * \see vx_req_aux_get_speaker_level
1411
+ * \ingroup devices
1412
+ */
1413
+ typedef struct vx_resp_aux_get_speaker_level {
1414
+ /**
1415
+ * The common properties for all responses.
1416
+ */
1417
+ vx_resp_base_t base;
1418
+
1419
+ /**
1420
+ * The master "speaker" level.
1421
+ * This is a non-negative integer value between 0 and 100 (inclusive). The default value is 50.
1422
+ * A +6 increase represents a doubling of energy, and a +20 increase represents a tenfold increase in energy.
1423
+ */
1424
+ int level;
1425
+ } vx_resp_aux_get_speaker_level_t;
1426
+
1427
+ /**
1428
+ * The response for vx_req_aux_set_mic_level
1429
+ * \see vx_req_aux_set_mic_level
1430
+ * \ingroup devices
1431
+ */
1432
+ typedef struct vx_resp_aux_set_mic_level {
1433
+ /**
1434
+ * The common properties for all responses.
1435
+ */
1436
+ vx_resp_base_t base;
1437
+ } vx_resp_aux_set_mic_level_t;
1438
+
1439
+ /**
1440
+ * The response for vx_req_aux_set_speaker_level
1441
+ * \see vx_req_aux_set_speaker_level_t
1442
+ * \ingroup devices
1443
+ */
1444
+ typedef struct vx_resp_aux_set_speaker_level {
1445
+ /**
1446
+ * The common properties for all responses.
1447
+ */
1448
+ vx_resp_base_t base;
1449
+ } vx_resp_aux_set_speaker_level_t;
1450
+
1451
+ /**
1452
+ * The response for vx_req_aux_render_audio_start
1453
+ * \see vx_req_aux_render_audio_start
1454
+ * \ingroup devices
1455
+ */
1456
+ typedef struct vx_resp_aux_render_audio_start {
1457
+ /**
1458
+ * The common properties for all responses.
1459
+ */
1460
+ vx_resp_base_t base;
1461
+ } vx_resp_aux_render_audio_start_t;
1462
+
1463
+ /**
1464
+ * The response for vx_req_aux_render_audio_modify
1465
+ */
1466
+ typedef struct vx_resp_aux_render_audio_modify {
1467
+ /**
1468
+ * The common properties for all responses.
1469
+ */
1470
+ vx_resp_base_t base;
1471
+ } vx_resp_aux_render_audio_modify_t;
1472
+
1473
+ /**
1474
+ * The response for vx_req_aux_get_vad_properties
1475
+ * \see vx_req_aux_set_vad_properties
1476
+ * \ingroup devices
1477
+ */
1478
+ typedef struct vx_resp_aux_get_vad_properties {
1479
+ /**
1480
+ * The common properties for all responses.
1481
+ */
1482
+ vx_resp_base_t base;
1483
+
1484
+ /**
1485
+ * The "Hangover time" - the time (in milliseconds) that it takes for the VAD to switch back to silence
1486
+ * from speech mode after the last speech frame has been detected.
1487
+ */
1488
+ int vad_hangover;
1489
+
1490
+ /**
1491
+ * A non-negative integer value between 0 and 100 (inclusive) which indicates the sensitivity of the VAD.
1492
+ * The default value is 50. Increasing this value corresponds to decreasing the sensitivity of the VAD,
1493
+ * where 0 is the most sensitive, and 100 is the least sensitive.
1494
+ */
1495
+ int vad_sensitivity;
1496
+
1497
+ /**
1498
+ * A dimensionless value between 0 and 20000 (default 576) which controls how the VAD separates speech from background noise.
1499
+ */
1500
+ int vad_noise_floor;
1501
+
1502
+ /**
1503
+ * VAD Automatic Parameter Selection - If this mode is 1 (enabled), then vad_hangover, vad_sensitivity, and vad_noise_floor
1504
+ * are ignored and the VAD automatically optimizes parameters.
1505
+ */
1506
+ int vad_auto;
1507
+ } vx_resp_aux_get_vad_properties_t;
1508
+
1509
+ /**
1510
+ * The response for vx_req_aux_set_vad_properties
1511
+ * \see vx_req_aux_set_vad_properties
1512
+ * \ingroup devices
1513
+ */
1514
+ typedef struct vx_resp_aux_set_vad_properties {
1515
+ /**
1516
+ * The common properties for all responses.
1517
+ */
1518
+ vx_resp_base_t base;
1519
+ } vx_resp_aux_set_vad_properties_t;
1520
+
1521
+ /**
1522
+ * The response for vx_req_aux_get_derumbler_properties
1523
+ * \see vx_req_aux_set_derumbler_properties
1524
+ * \ingroup devices
1525
+ */
1526
+ typedef struct vx_resp_aux_get_derumbler_properties {
1527
+ /**
1528
+ * The common properties for all responses.
1529
+ */
1530
+ vx_resp_base_t base;
1531
+
1532
+ /**
1533
+ * Indicates whether the derumbler should be enabled (default=1) or disabled (0).
1534
+ */
1535
+ int enabled;
1536
+
1537
+ /**
1538
+ * The frequency where the derumbler high-pass filter enters into full attenuation.
1539
+ * All frequencies at and below this corner frequency are greatly reduced in amplitude.
1540
+ * Frequencies above this corner frequency remain at their original amplitude,
1541
+ * aside from the frequencies that are just above the corner frequency.
1542
+ * Valid values are: 15, 60 (default), 100.
1543
+ */
1544
+ int stopband_corner_frequency;
1545
+ } vx_resp_aux_get_derumbler_properties_t;
1546
+
1547
+ /**
1548
+ * The response for vx_req_aux_set_derumbler_properties
1549
+ * \see vx_req_aux_set_derumbler_properties
1550
+ * \ingroup devices
1551
+ */
1552
+ typedef struct vx_resp_aux_set_derumbler_properties {
1553
+ /**
1554
+ * The common properties for all responses.
1555
+ */
1556
+ vx_resp_base_t base;
1557
+ } vx_resp_aux_set_derumbler_properties_t;
1558
+
1559
+ /**
1560
+ * The response for vx_req_aux_render_audio_stop
1561
+ * \see vx_req_aux_render_audio_stop
1562
+ * \ingroup devices
1563
+ */
1564
+ typedef struct vx_resp_aux_render_audio_stop {
1565
+ /**
1566
+ * The common properties for all responses.
1567
+ */
1568
+ vx_resp_base_t base;
1569
+ } vx_resp_aux_render_audio_stop_t;
1570
+
1571
+ /**
1572
+ * The response for vx_req_aux_capture_audio_start
1573
+ * \see vx_req_aux_capture_audio_start
1574
+ * \ingroup devices
1575
+ */
1576
+ typedef struct vx_resp_aux_capture_audio_start {
1577
+ /**
1578
+ * The common properties for all responses.
1579
+ */
1580
+ vx_resp_base_t base;
1581
+ } vx_resp_aux_capture_audio_start_t;
1582
+
1583
+ /**
1584
+ * The response for vx_req_aux_capture_audio_stop
1585
+ * \see vx_req_aux_capture_audio_stop
1586
+ * \ingroup devices
1587
+ */
1588
+ typedef struct vx_resp_aux_capture_audio_stop {
1589
+ /**
1590
+ * The common properties for all responses.
1591
+ */
1592
+ vx_resp_base_t base;
1593
+
1594
+ /**
1595
+ * An opaque pointer to the captured audio buffer.
1596
+ * \note This pointer is not marshalled when working with the VivoxVoiceService.
1597
+ */
1598
+ void *audioBufferPtr;
1599
+ } vx_resp_aux_capture_audio_stop_t;
1600
+
1601
+ /**
1602
+ * The response for vx_req_aux_global_monitor_keyboard_mouse
1603
+ * \see vx_req_aux_global_monitor_keyboard_mouse
1604
+ * \ingroup devices
1605
+ */
1606
+ typedef struct vx_resp_aux_global_monitor_keyboard_mouse {
1607
+ /**
1608
+ * The common properties for all responses.
1609
+ */
1610
+ vx_resp_base_t base;
1611
+ } vx_resp_aux_global_monitor_keyboard_mouse_t;
1612
+
1613
+ /**
1614
+ * The response for vx_req_aux_set_idle_timeout
1615
+ * \see vx_req_aux_set_idle_timeout
1616
+ * \ingroup devices
1617
+ */
1618
+ typedef struct vx_resp_aux_set_idle_timeout {
1619
+ /**
1620
+ * The common properties for all responses.
1621
+ */
1622
+ vx_resp_base_t base;
1623
+ } vx_resp_aux_set_idle_timeout_t;
1624
+
1625
+ /**
1626
+ * The response for vx_req_aux_create_account
1627
+ * \see vx_req_aux_create_account
1628
+ */
1629
+ typedef struct vx_resp_aux_create_account {
1630
+ /**
1631
+ * The common properties for all responses.
1632
+ */
1633
+ vx_resp_base_t base;
1634
+ } vx_resp_aux_create_account_t;
1635
+
1636
+ /**
1637
+ * The response for vx_req_aux_reactivate_account
1638
+ * \see vx_req_aux_reactivate_account
1639
+ */
1640
+ typedef struct vx_resp_aux_reactivate_account {
1641
+ /**
1642
+ * The common properties for all responses.
1643
+ */
1644
+ vx_resp_base_t base;
1645
+ } vx_resp_aux_reactivate_account_t;
1646
+
1647
+ /**
1648
+ * The response for vx_req_aux_deactivate_account
1649
+ * \see vx_req_aux_deactivate_account
1650
+ */
1651
+ typedef struct vx_resp_aux_deactivate_account {
1652
+ /**
1653
+ * The common properties for all responses.
1654
+ */
1655
+ vx_resp_base_t base;
1656
+ } vx_resp_aux_deactivate_account_t;
1657
+
1658
+ /**
1659
+ * The response for vx_req_account_post_crash_dump
1660
+ * \note This response is not applicable to the XML interface.
1661
+ * \see vx_req_account_post_crash_dump
1662
+ * \ingroup diagnostics
1663
+ */
1664
+ typedef struct vx_resp_account_post_crash_dump {
1665
+ /**
1666
+ * The common properties for all responses.
1667
+ */
1668
+ vx_resp_base_t base;
1669
+ } vx_resp_account_post_crash_dump_t;
1670
+
1671
+ /**
1672
+ * The response for vx_req_aux_reset_password
1673
+ * \see vx_req_aux_reset_password
1674
+ */
1675
+ typedef struct vx_resp_aux_reset_password {
1676
+ /**
1677
+ * The common properties for all responses.
1678
+ */
1679
+ vx_resp_base_t base;
1680
+ } vx_resp_aux_reset_password_t;
1681
+
1682
+ /**
1683
+ * The response for vx_req_account_get_session_fonts
1684
+ * \see vx_req_account_get_session_fonts
1685
+ * \ingroup voicefonts
1686
+ */
1687
+ typedef struct vx_resp_account_get_session_fonts {
1688
+ /**
1689
+ * The common properties for all responses.
1690
+ */
1691
+ vx_resp_base_t base;
1692
+
1693
+ /**
1694
+ * A list of session fonts.
1695
+ */
1696
+ vx_voice_font_t **session_fonts;
1697
+
1698
+ /**
1699
+ * The number of session fonts.
1700
+ */
1701
+ int session_font_count;
1702
+ } vx_resp_account_get_session_fonts_t;
1703
+
1704
+ /**
1705
+ * The response for vx_req_account_get_template_fonts
1706
+ * \see vx_req_account_get_template_fonts
1707
+ * \ingroup voicefonts
1708
+ */
1709
+ typedef struct vx_resp_account_get_template_fonts {
1710
+ /**
1711
+ * The common properties for all responses.
1712
+ */
1713
+ vx_resp_base_t base;
1714
+ /**
1715
+ * A list of session fonts.
1716
+ */
1717
+ vx_voice_font_t **template_fonts;
1718
+ /**
1719
+ * The number of session fonts.
1720
+ */
1721
+ int template_font_count;
1722
+ } vx_resp_account_get_template_fonts_t;
1723
+
1724
+ /**
1725
+ * The response for vx_req_aux_start_buffer_capture
1726
+ * \see vx_req_aux_start_buffer_capture
1727
+ * \ingroup adi
1728
+ */
1729
+ typedef struct vx_resp_aux_start_buffer_capture {
1730
+ /**
1731
+ * The common properties for all responses.
1732
+ */
1733
+ vx_resp_base_t base;
1734
+ } vx_resp_aux_start_buffer_capture_t;
1735
+
1736
+ /**
1737
+ * The response for vx_req_aux_play_audio_buffer
1738
+ * \see vx_req_aux_play_audio_buffer
1739
+ * \ingroup adi
1740
+ */
1741
+ typedef struct vx_resp_aux_play_audio_buffer {
1742
+ /**
1743
+ * The common properties for all responses.
1744
+ */
1745
+ vx_resp_base_t base;
1746
+ } vx_resp_aux_play_audio_buffer_t;
1747
+
1748
+ /**
1749
+ * The response for vx_req_aux_diagnostic_state_dump
1750
+ * \see vx_req_aux_diagnostic_state_dump
1751
+ */
1752
+ typedef struct vx_resp_aux_diagnostic_state_dump {
1753
+ /**
1754
+ * The common properties for all responses.
1755
+ */
1756
+ vx_resp_base_t base;
1757
+
1758
+ /**
1759
+ * The number of connector objects in the state dump.
1760
+ */
1761
+ int state_connector_count;
1762
+
1763
+ /**
1764
+ * A collection of connector objects in the state dump.
1765
+ */
1766
+ vx_state_connector_t **state_connectors;
1767
+
1768
+ /**
1769
+ * The render device currently in use by the Vivox SDK.
1770
+ */
1771
+ vx_device_t *current_render_device;
1772
+
1773
+ /**
1774
+ * The effective render device.
1775
+ */
1776
+ vx_device_t *effective_render_device;
1777
+
1778
+ /**
1779
+ * The current capture device.
1780
+ */
1781
+ vx_device_t *current_capture_device;
1782
+
1783
+ /**
1784
+ * The effective capture device.
1785
+ */
1786
+ vx_device_t *effective_capture_device;
1787
+ } vx_resp_aux_diagnostic_state_dump_t;
1788
+
1789
+ /**
1790
+ * \deprecated This is deprecated and should not be used.
1791
+ * The response for vx_req_account_web_call
1792
+ * \see vx_req_account_web_call
1793
+ * @deprecated
1794
+ */
1795
+ typedef struct vx_resp_account_web_call {
1796
+ /**
1797
+ * The common properties for all responses.
1798
+ */
1799
+ vx_resp_base_t base;
1800
+
1801
+ /**
1802
+ * The HTTP content type
1803
+ */
1804
+ char *content_type;
1805
+
1806
+ /**
1807
+ * The content length
1808
+ */
1809
+ int content_length;
1810
+
1811
+ /**
1812
+ * The content
1813
+ */
1814
+ char *content;
1815
+ } vx_resp_account_web_call_t;
1816
+
1817
+ /**
1818
+ * Get the network statistics associated with a particular session group.
1819
+ * \see vx_req_sessiongroup_get_stats
1820
+ */
1821
+ typedef struct vx_resp_sessiongroup_get_stats {
1822
+ /**
1823
+ * The common properties for all responses.
1824
+ */
1825
+ vx_resp_base_t base;
1826
+
1827
+ /**
1828
+ * RESERVED FOR FUTURE USE
1829
+ */
1830
+ int insufficient_bandwidth;
1831
+
1832
+ /**
1833
+ * RESERVED FOR FUTURE USE
1834
+ */
1835
+ int min_bars;
1836
+
1837
+ /**
1838
+ * RESERVED FOR FUTURE USE
1839
+ */
1840
+ int max_bars;
1841
+
1842
+ /**
1843
+ * \deprecated This is deprecated and should not be used.
1844
+ * An indication of the network quality in the range of 1-5, with 5 indicating the best quality.
1845
+ * @deprecated
1846
+ */
1847
+ int current_bars;
1848
+
1849
+ /**
1850
+ * RESERVED FOR FUTURE USE
1851
+ */
1852
+ int pk_loss;
1853
+
1854
+ /**
1855
+ * The number of packets received.
1856
+ */
1857
+ int incoming_received;
1858
+
1859
+ /**
1860
+ * The number of incoming packets expected.
1861
+ */
1862
+ int incoming_expected;
1863
+
1864
+ /**
1865
+ * The number of packets lost in the network.
1866
+ */
1867
+ int incoming_packetloss;
1868
+
1869
+ /**
1870
+ * The number of packets received too late to be useful and discarded.
1871
+ */
1872
+ int incoming_out_of_time;
1873
+
1874
+ /**
1875
+ * The number of packets received but discarded because the local queue overflowed.
1876
+ */
1877
+ int incoming_discarded;
1878
+
1879
+ /**
1880
+ * The number of packets sent.
1881
+ */
1882
+ int outgoing_sent;
1883
+
1884
+ /**
1885
+ * The number of render device underruns.
1886
+ * \note Applicable to mobile platforms only.
1887
+ */
1888
+ int render_device_underruns;
1889
+
1890
+ /**
1891
+ * The number of render device overruns.
1892
+ * \note Applicable to mobile platforms only.
1893
+ */
1894
+ int render_device_overruns;
1895
+
1896
+ /**
1897
+ * The number of render device errors.
1898
+ * \note Applicable to mobile platforms only.
1899
+ */
1900
+ int render_device_errors;
1901
+
1902
+ /**
1903
+ * The SIP call ID.
1904
+ */
1905
+ char *call_id;
1906
+
1907
+ /**
1908
+ * A flag which indicates whether Packet Loss Concealment (error correction) has occurred.
1909
+ */
1910
+ int plc_on;
1911
+
1912
+ /**
1913
+ * The number of 10ms synthetic frames generated by Packet Loss Concealment.
1914
+ */
1915
+ int plc_synthetic_frames;
1916
+
1917
+ /**
1918
+ * A codec negotiated in the current call.
1919
+ */
1920
+ char *codec_name;
1921
+
1922
+ /**
1923
+ * \deprecated This is deprecated and should not be used.
1924
+ * @deprecated
1925
+ */
1926
+ int codec_mode;
1927
+
1928
+ /**
1929
+ * The minimum network latency, which is detected in seconds.
1930
+ * This is zero if no latency measurements are made.
1931
+ */
1932
+ double min_latency;
1933
+
1934
+ /**
1935
+ * The maximum network latency, which is detected in seconds.
1936
+ * This is zero if no latency measurements are made.
1937
+ */
1938
+ double max_latency;
1939
+
1940
+ /**
1941
+ * The number of times that latency was measured.
1942
+ */
1943
+ int latency_measurement_count;
1944
+
1945
+ /**
1946
+ * The total number of seconds of measured network latency.
1947
+ */
1948
+ double latency_sum;
1949
+
1950
+ /**
1951
+ * The last latency that was measured.
1952
+ */
1953
+ double last_latency_measured;
1954
+
1955
+ /**
1956
+ * The number of latency measurement packets lost.
1957
+ * This counter is reset to 0 every time vx_req_sessiongroup_get_stats is called.
1958
+ */
1959
+ int latency_packets_lost;
1960
+
1961
+ /**
1962
+ * A computation of quality.
1963
+ */
1964
+ double r_factor;
1965
+
1966
+ /**
1967
+ * The number of latency measurement request packets sent.
1968
+ */
1969
+ int latency_packets_sent;
1970
+
1971
+ /**
1972
+ * The number of latency measurement response packets dropped.
1973
+ */
1974
+ int latency_packets_dropped;
1975
+
1976
+ /**
1977
+ * The number of latency measurement packets that were too short or otherwise malformed.
1978
+ */
1979
+ int latency_packets_malformed;
1980
+
1981
+ /**
1982
+ * The number of latency measurement packets that arrived before they were sent.
1983
+ * \note This can occur if there are clock adjustments.
1984
+ */
1985
+ int latency_packets_negative_latency;
1986
+
1987
+ /**
1988
+ * The beginning of the sample period in fractional seconds since midnight on January 1, 1970 GMT.
1989
+ */
1990
+ double sample_interval_begin;
1991
+
1992
+ /**
1993
+ * The end of the sample period in fractional seconds since midnight on January 1, 1970 GMT.
1994
+ */
1995
+ double sample_interval_end;
1996
+
1997
+ /**
1998
+ * The number of intervals where 0, 1, 2, 3, or 4 or greater audio frames were read from the capture device.
1999
+ */
2000
+ int capture_device_consecutively_read_count[5];
2001
+
2002
+ /**
2003
+ * The OPUS bit rate that was used for encoding the last transmitted OPUS packet.
2004
+ * If no OPUS packets were transmitted, this value is -1.
2005
+ */
2006
+ int current_opus_bit_rate;
2007
+
2008
+ /**
2009
+ * The OPUS complexity that was used for encoding the last transmitted OPUS packet.
2010
+ * If no OPUS packets were transmitted, this value is -1.
2011
+ */
2012
+ int current_opus_complexity;
2013
+
2014
+ /**
2015
+ * The OPUS VBR mode (vx_opus_vbr_mode) that was used for encoding the last transmitted OPUS packet.
2016
+ * If no OPUS packets were transmitted, this value is -1 .
2017
+ */
2018
+ int current_opus_vbr_mode;
2019
+
2020
+ /**
2021
+ * The OPUS bandwith (vx_opus_bandwidth) that was used for encoding the last transmitted OPUS packet.
2022
+ * If no OPUS packets were transmitted, this value is -1.
2023
+ */
2024
+ int current_opus_bandwidth;
2025
+
2026
+ /**
2027
+ * The OPUS max packet size limit that was used for encoding the last transmitted OPUS packet.
2028
+ * If no OPUS packets were transmitted, this value is -1.
2029
+ */
2030
+ int current_opus_max_packet_size;
2031
+
2032
+ /**
2033
+ * Signals whether transport is secure (1) or not secure (0).
2034
+ * \note V5 only. In V4, this value is always equal to 0.
2035
+ */
2036
+ int signal_secure;
2037
+ } vx_resp_sessiongroup_get_stats_t;
2038
+
2039
+ /**
2040
+ * The response for vx_req_account_send_message
2041
+ * \see vx_req_account_send_message
2042
+ * \ingroup buddy
2043
+ */
2044
+ typedef struct vx_resp_account_send_message {
2045
+ /**
2046
+ * The common properties for all responses.
2047
+ */
2048
+ vx_resp_base_t base;
2049
+
2050
+ /**
2051
+ * The request ID assigned to the message sent.
2052
+ * This is non-NULL if the message is sent to a server.
2053
+ * If the message send failure will be reported by the server,
2054
+ * the SDK raises the evt_resp_account_send_message_failed event with this request ID.
2055
+ * \see vx_evt_resp_account_send_message_failed
2056
+ * \note V5 only. In V4, this is always equal to NULL.
2057
+ */
2058
+ char *request_id;
2059
+ } vx_resp_account_send_message_t;
2060
+
2061
+ /**
2062
+ * The response for vx_req_account_delete_message
2063
+ * \see vx_req_account_send_message
2064
+ */
2065
+ typedef struct vx_resp_account_delete_message {
2066
+ /**
2067
+ * The common properties for all responses.
2068
+ */
2069
+ vx_resp_base_t base;
2070
+
2071
+ /**
2072
+ * The message_id of the message to be deleted.
2073
+ */
2074
+ char *message_id;
2075
+
2076
+ /**
2077
+ * The timestamp of the deleted message.
2078
+ */
2079
+ long long delete_time;
2080
+
2081
+ /**
2082
+ * The sender URI.
2083
+ */
2084
+ char *from_user;
2085
+ } vx_resp_account_delete_message_t;
2086
+
2087
+ /**
2088
+ * The response for vx_req_account_edit_message
2089
+ * \see vx_req_account_edit_message
2090
+ */
2091
+ typedef struct vx_resp_account_edit_message {
2092
+ /**
2093
+ * The common properties for all responses.
2094
+ */
2095
+ vx_resp_base_t base;
2096
+
2097
+ /**
2098
+ * The message_id of the message to be edited.
2099
+ */
2100
+ char *message_id;
2101
+
2102
+ /**
2103
+ * The new message to replace existing one.
2104
+ */
2105
+ char *new_message;
2106
+
2107
+ /**
2108
+ * The timestamp of the edited message.
2109
+ */
2110
+ long long edit_time;
2111
+
2112
+ /**
2113
+ * The sender URI.
2114
+ */
2115
+ char *from_user;
2116
+ } vx_resp_account_edit_message_t;
2117
+
2118
+ #ifndef DOXYGEN_MAM_SKIP
2119
+ /**
2120
+ * The response for vx_req_account_archive_query
2121
+ * \see vx_req_account_archive_query
2122
+ * \ingroup account
2123
+ */
2124
+ typedef struct vx_resp_account_archive_query {
2125
+ /**
2126
+ * The common properties for all responses.
2127
+ */
2128
+
2129
+ vx_resp_base_t base;
2130
+ /**
2131
+ * The ID of the started query.
2132
+ * Use this ID to identify relevant vx_evt_account_archive_message and vx_evt_account_archive_query_end events.
2133
+ */
2134
+ char *query_id;
2135
+ } vx_resp_account_archive_query_t;
2136
+ #endif
2137
+ /**
2138
+ * The response for vx_req_account_chat_history_query
2139
+ * \see vx_req_account_chat_history_query
2140
+ * \ingroup account
2141
+ */
2142
+ typedef struct vx_resp_account_chat_history_query {
2143
+ /**
2144
+ * The common properties for all responses.
2145
+ */
2146
+
2147
+ vx_resp_base_t base;
2148
+ /**
2149
+ * The ID of the started query.
2150
+ * Use this ID to identify relevant vx_evt_account_chat_history_message and vx_evt_account_archive_query_end events.
2151
+ */
2152
+ char *query_id;
2153
+ } vx_resp_account_chat_history_query_t;
2154
+ typedef struct vx_resp_account_get_conversations {
2155
+ /**
2156
+ * The common properties for all responses.
2157
+ */
2158
+ vx_resp_base_t base;
2159
+ /**
2160
+ * Number of conversations returned in the response
2161
+ */
2162
+ int conversations_size;
2163
+ /**
2164
+ * Cursor to the next page, 0-indexed if this is -1 then you have reached the last page
2165
+ */
2166
+ int next_cursor;
2167
+ /**
2168
+ * List representing the current page of conversations
2169
+ */
2170
+ vx_conversation_list_t conversations;
2171
+ } vx_resp_account_get_conversations_t;
2172
+ /**
2173
+ * The response for vx_req_aux_notify_application_state_change
2174
+ * \see vx_req_aux_notify_application_state_change
2175
+ */
2176
+ typedef struct vx_resp_aux_notify_application_state_change {
2177
+ /**
2178
+ * The common properties for all responses.
2179
+ */
2180
+ vx_resp_base_t base;
2181
+ } vx_resp_aux_notify_application_state_change_t;
2182
+
2183
+ /**
2184
+ * The response for vx_req_account_control_communications
2185
+ * \see vx_req_account_control_communications
2186
+ */
2187
+ typedef struct vx_resp_account_control_communications {
2188
+ /**
2189
+ * The common properties for all responses.
2190
+ */
2191
+
2192
+ vx_resp_base_t base;
2193
+ /**
2194
+ * A line feed separated list of blocked or muted URIs.
2195
+ * This can be null for clear list operations or if no one was muted or blocked.
2196
+ */
2197
+ char *blocked_uris;
2198
+ } vx_resp_account_control_communications_t;
2199
+
2200
+ /**
2201
+ *
2202
+ */
2203
+ typedef struct vx_resp_account_safe_voice_update_consent {
2204
+ /**
2205
+ * The common properties for all responses.
2206
+ */
2207
+ vx_resp_base_t base;
2208
+
2209
+ /*
2210
+ * The Safe Voice consent status of the user after updating.
2211
+ */
2212
+ bool consent_status;
2213
+ } vx_resp_account_safe_voice_update_consent_t;
2214
+
2215
+ /**
2216
+ *
2217
+ */
2218
+ typedef struct vx_resp_account_safe_voice_get_consent {
2219
+ /**
2220
+ * The common properties for all responses.
2221
+ */
2222
+ vx_resp_base_t base;
2223
+
2224
+ /*
2225
+ * The current Safe Voice consent status of the user.
2226
+ */
2227
+ bool consent_status;
2228
+ } vx_resp_account_safe_voice_get_consent_t;
2229
+
2230
+
2231
+ /**
2232
+ * The response for vx_req_session_transcription_control
2233
+ * \see vx_req_session_transcription_control
2234
+ * \ingroup session
2235
+ */
2236
+ typedef struct vx_resp_session_transcription_control {
2237
+ /**
2238
+ * The common properties for all responses.
2239
+ */
2240
+ vx_resp_base_t base;
2241
+ } vx_resp_session_transcription_control_t;
2242
+
2243
+ #ifndef VIVOX_TYPES_ONLY
2244
+ /**
2245
+ * Deallocate a response object of any type.
2246
+ * \ingroup memorymanagement
2247
+ */
2248
+ VIVOXSDK_DLLEXPORT int destroy_resp(vx_resp_base_t *pCmd);
2249
+ #endif
2250
+
2251
+ #ifdef __cplusplus
2252
+ }
2253
+ #endif
2254
+
2255
+ #pragma pack(pop)