1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libkate: Encoding</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<h1>Encoding</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g0a7588d43b22fd5ef6e0a88ed7245210">kate_encode_init</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, <a class="el" href="structkate__info.html">kate_info</a> *ki)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#ge39c058d7bf07e5e8e65ca08925b01fe">kate_encode_text_raw_times</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int64_t t0, kate_int64_t t1, const char *text, size_t sz, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g83a014a63281d6b9a7e5f95b1ca0271b">kate_encode_text</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_float t0, kate_float t1, const char *text, size_t sz, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g9a4dd7d22ee2722a824d1ee27af0ff62">kate_encode_keepalive_raw_times</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int64_t t, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g78e91931f72e168c5abe7fda8c137836">kate_encode_keepalive</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_float t, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gc15014cb85607647d24ac93c5b546188">kate_encode_repeat_raw_times</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int64_t t, kate_int64_t threshold, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#ge3b9b3f260d5365745e4cdd888502683">kate_encode_repeat</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_float t, kate_float threshold, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g6caef54a4bfc81afa79dd729fa3198d9">kate_encode_finish_raw_times</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int64_t t, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gfad57b37a14cc49ede82fd198e9f0e66">kate_encode_finish</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_float t, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g045bae46c03407f5ceaf7e984e0a7684">kate_encode_headers</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, <a class="el" href="structkate__comment.html">kate_comment</a> *kc, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g7cbb758fd057c488beaf37c0c6ccd912">kate_encode_add_motion</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, <a class="el" href="structkate__motion.html">kate_motion</a> *km, int destroy)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gfba8f2ed4e051264c9dcd0061de804e1">kate_encode_add_motion_index</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, size_t motion)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g5db789c3c772f4a6f8c7c34cd8869d7b">kate_encode_add_bitmap</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, const <a class="el" href="structkate__bitmap.html">kate_bitmap</a> *kb)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g937f6aec52150f234e85a418ee88a786">kate_encode_add_bitmap_index</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, size_t bitmap)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gbac66b465caf6459d51dd09f9d6dfeea">kate_encode_set_region_index</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, size_t region)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#ge35b49debbf3c68d45aacd97f7c8fdb9">kate_encode_set_region</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, const <a class="el" href="structkate__region.html">kate_region</a> *kr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#ge7875690bad6ec827bada01a3ce17c32">kate_encode_set_style_index</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, size_t style)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g902487fd94c26ac32d0dd070ca1f26ca">kate_encode_set_style</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, const <a class="el" href="structkate__style.html">kate_style</a> *ks)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g5b0463369fbcb08665bdc2710403d4f7">kate_encode_set_secondary_style_index</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, size_t style)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gc93e0a6b5ed2d642469953c167fa5488">kate_encode_set_secondary_style</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, const <a class="el" href="structkate__style.html">kate_style</a> *ks)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g24eb4313c0098bca1596a05e4415ec8c">kate_encode_set_palette_index</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, size_t palette)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g7e2304d24e5429cdd3837940b42fc822">kate_encode_set_palette</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, const <a class="el" href="structkate__palette.html">kate_palette</a> *kp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g8327a9c6dcdfa674f5dca50a36bab26f">kate_encode_set_bitmap_index</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, size_t bitmap)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gfc520e8db13916e2979ce25284eb4376">kate_encode_set_bitmap</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, const <a class="el" href="structkate__bitmap.html">kate_bitmap</a> *kb)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g3c0382d56d6dd8ac288d6af6f8d2e793">kate_encode_set_font_mapping_index</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, size_t font_mapping)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gc628f2f5c33feba5efc4c779d25881bf">kate_encode_set_text_encoding</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, <a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> text_encoding)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gb7681e228b7e8f88a4f5f61e02a20fb9">kate_encode_set_text_directionality</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, <a class="el" href="kate_8h.html#ccb7b9d9ec6e956fa1096f2064a6321e">kate_text_directionality</a> text_directionality)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g3bd7e3119ea6e5ff3ea87bab95aaf124">kate_encode_set_id</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_int32_t id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#g51e0061b69affeb2d9e34094f23d0ca7">kate_encode_set_language</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, const char *language)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#gdbd29d259de9f5d1aa8a771de04543cd">kate_encode_set_markup_type</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, int text_markup_type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">kate_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__encoding.html#geac961ea211f8b5345e63c49a1e57625">kate_encode_get_granule</a> (const <a class="el" href="structkate__state.html">kate_state</a> *k)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g5db789c3c772f4a6f8c7c34cd8869d7b"></a><!-- doxytag: member="kate_encode.c::kate_encode_add_bitmap" ref="g5db789c3c772f4a6f8c7c34cd8869d7b" args="(kate_state *k, const kate_bitmap *kb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_add_bitmap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structkate__bitmap.html">kate_bitmap</a> * </td>
<td class="paramname"> <em>kb</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a bitmap to the currently encoded event. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to add the bitmap to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kb</em> </td><td>the bitmap to add </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g937f6aec52150f234e85a418ee88a786"></a><!-- doxytag: member="kate_encode.c::kate_encode_add_bitmap_index" ref="g937f6aec52150f234e85a418ee88a786" args="(kate_state *k, size_t bitmap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_add_bitmap_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>bitmap</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a bitmap to the currently encoded event by its index into the list of predefined bitmaps. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to add the bitmap to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bitmap</em> </td><td>the index of the bitmap to add </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g7cbb758fd057c488beaf37c0c6ccd912"></a><!-- doxytag: member="kate_encode.c::kate_encode_add_motion" ref="g7cbb758fd057c488beaf37c0c6ccd912" args="(kate_state *k, kate_motion *km, int destroy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_add_motion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__motion.html">kate_motion</a> * </td>
<td class="paramname"> <em>km</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>destroy</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a motion to the currently encoded event. If destroy is set, the motion will be automatically destroyed after the current event has been encoded. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to add the motion to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>km</em> </td><td>the motion to add </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destroy</em> </td><td>if true, the motion will be destroyed when the event is fully encoded </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfba8f2ed4e051264c9dcd0061de804e1"></a><!-- doxytag: member="kate_encode.c::kate_encode_add_motion_index" ref="gfba8f2ed4e051264c9dcd0061de804e1" args="(kate_state *k, size_t motion)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_add_motion_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>motion</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a motion to the currently encoded event by its index into the list of predefined motions. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to add the motion to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>motion</em> </td><td>the index of the motion to add </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfad57b37a14cc49ede82fd198e9f0e66"></a><!-- doxytag: member="kate_encode.c::kate_encode_finish" ref="gfad57b37a14cc49ede82fd198e9f0e66" args="(kate_state *k, kate_float t, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_finish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finalizes the currently encoded stream. No more events may be added after this is called. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the timestamp for the end (if negative, the end time of the last event will be used) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g6caef54a4bfc81afa79dd729fa3198d9"></a><!-- doxytag: member="kate_encode.c::kate_encode_finish_raw_times" ref="g6caef54a4bfc81afa79dd729fa3198d9" args="(kate_state *k, kate_int64_t t, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_finish_raw_times </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finalizes the currently encoded stream. No more events may be added after this is called. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the timestamp (in granule rate units) for the end (if negative, the end time of the last event will be used) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="geac961ea211f8b5345e63c49a1e57625"></a><!-- doxytag: member="kate_encode.c::kate_encode_get_granule" ref="geac961ea211f8b5345e63c49a1e57625" args="(const kate_state *k)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_int64_t kate_encode_get_granule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the current granulepos <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>>=0 the current granulepos (the one of the last encoded packet) <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g045bae46c03407f5ceaf7e984e0a7684"></a><!-- doxytag: member="kate_encode.c::kate_encode_headers" ref="g045bae46c03407f5ceaf7e984e0a7684" args="(kate_state *k, kate_comment *kc, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_headers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__comment.html">kate_comment</a> * </td>
<td class="paramname"> <em>kc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Encodes a header. This should be repeatedly called at the beginning of encoding, until a positive value is returned, marking the encoding of the last header. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kc</em> </td><td>the list of comments to add to the headers </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
1 success, and all headers have been encoded <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g0a7588d43b22fd5ef6e0a88ed7245210"></a><!-- doxytag: member="kate_encode.c::kate_encode_init" ref="g0a7588d43b22fd5ef6e0a88ed7245210" args="(kate_state *k, kate_info *ki)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"> <em>ki</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initializes a <a class="el" href="structkate__state.html">kate_state</a> structure for encoding using the supplied <a class="el" href="structkate__info.html">kate_info</a> structure. When done, the <a class="el" href="structkate__state.html">kate_state</a> structure should be cleared using kate_clear. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> structure to initialize for encoding </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ki</em> </td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure containing the encoding parameters </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g78e91931f72e168c5abe7fda8c137836"></a><!-- doxytag: member="kate_encode.c::kate_encode_keepalive" ref="g78e91931f72e168c5abe7fda8c137836" args="(kate_state *k, kate_float t, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_keepalive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emits a keepalive packet, to help with seeking. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the timestamp for the keepalive packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g9a4dd7d22ee2722a824d1ee27af0ff62"></a><!-- doxytag: member="kate_encode.c::kate_encode_keepalive_raw_times" ref="g9a4dd7d22ee2722a824d1ee27af0ff62" args="(kate_state *k, kate_int64_t t, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_keepalive_raw_times </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emits a keepalive packet, to help with seeking. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the timestamp (in granule rate units) for the keepalive packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge3b9b3f260d5365745e4cdd888502683"></a><!-- doxytag: member="kate_encode.c::kate_encode_repeat" ref="ge3b9b3f260d5365745e4cdd888502683" args="(kate_state *k, kate_float t, kate_float threshold, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_repeat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>threshold</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emits a repeat packet, to help with seeking. The first active event at time t, if it or its latest repeat (whichever is the latest) was emitted more than threshold ago, of if threshold is zero, will have a repeat packet emitted. kate_encode_repeat is designed to be called in a loop, as it will return a repeat packet for only one event even if more than one event needs a repeat. When the returned value is 0, no more events need repeating at time t. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the timestamp for the the packets, if any </td></tr>
<tr><td valign="top"></td><td valign="top"><em>threshold</em> </td><td>the time threshold at which to emit a repeat packets (zero to force a repeat) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success, and no repeat packet was encoded <p>
1 success, and a repeat packet was encoded <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc15014cb85607647d24ac93c5b546188"></a><!-- doxytag: member="kate_encode.c::kate_encode_repeat_raw_times" ref="gc15014cb85607647d24ac93c5b546188" args="(kate_state *k, kate_int64_t t, kate_int64_t threshold, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_repeat_raw_times </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>threshold</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emits a repeat packet, to help with seeking. The first active event at time t, if it or its latest repeat (whichever is the latest) was emitted more than threshold ago, of if threshold is zero, will have a repeat packet emitted. kate_encode_repeat is designed to be called in a loop, as it will return a repeat packet for only one event even if more than one event needs a repeat. When the returned value is 0, no more events need repeating at time t. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>the timestamp (in granule rate units) for the the packets, if any </td></tr>
<tr><td valign="top"></td><td valign="top"><em>threshold</em> </td><td>the time threshold (in granule rate units) at which to emit a repeat packets (zero to force a repeat) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success, and no repeat packet was encoded <p>
1 success, and a repeat packet was encoded <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfc520e8db13916e2979ce25284eb4376"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_bitmap" ref="gfc520e8db13916e2979ce25284eb4376" args="(kate_state *k, const kate_bitmap *kb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_bitmap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structkate__bitmap.html">kate_bitmap</a> * </td>
<td class="paramname"> <em>kb</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a bitmap to the currently encoded event. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to set the bitmap for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kb</em> </td><td>the bitmap to set </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g8327a9c6dcdfa674f5dca50a36bab26f"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_bitmap_index" ref="g8327a9c6dcdfa674f5dca50a36bab26f" args="(kate_state *k, size_t bitmap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_bitmap_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>bitmap</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the bitmap the event should use, by its index in the predefined bitmap list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bitmap</em> </td><td>the index of the predefined bitmap to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3c0382d56d6dd8ac288d6af6f8d2e793"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_font_mapping_index" ref="g3c0382d56d6dd8ac288d6af6f8d2e793" args="(kate_state *k, size_t font_mapping)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_font_mapping_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>font_mapping</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the font mapping this event's text should be displayed with, by its index into the predefined font mappings list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>font_mapping</em> </td><td>the font mapping to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3bd7e3119ea6e5ff3ea87bab95aaf124"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_id" ref="g3bd7e3119ea6e5ff3ea87bab95aaf124" args="(kate_state *k, kate_int32_t id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int32_t </td>
<td class="paramname"> <em>id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function is obsolete and should not be used. An event identifier is automatically generated for each event. It used to set a unique identifier for the currently encoded event, so it can be referred to later, but not does nothing. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>unused </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g51e0061b69affeb2d9e34094f23d0ca7"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_language" ref="g51e0061b69affeb2d9e34094f23d0ca7" args="(kate_state *k, const char *language)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_language </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>language</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the language used in this event's text, overriding the default language <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>language</em> </td><td>the language for this event's text - may be NULL (use the default language) </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gdbd29d259de9f5d1aa8a771de04543cd"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_markup_type" ref="gdbd29d259de9f5d1aa8a771de04543cd" args="(kate_state *k, int text_markup_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_markup_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>text_markup_type</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the markup type of this event <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text_markup_type</em> </td><td>the markup type of this event </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g7e2304d24e5429cdd3837940b42fc822"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_palette" ref="g7e2304d24e5429cdd3837940b42fc822" args="(kate_state *k, const kate_palette *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_palette </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structkate__palette.html">kate_palette</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a palette to the currently encoded event. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to set the palette for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the palette to set </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g24eb4313c0098bca1596a05e4415ec8c"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_palette_index" ref="g24eb4313c0098bca1596a05e4415ec8c" args="(kate_state *k, size_t palette)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_palette_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>palette</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the palette the event should use for its bitmap, by its index in the predefined palette list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>palette</em> </td><td>the index of the predefined palette to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge35b49debbf3c68d45aacd97f7c8fdb9"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_region" ref="ge35b49debbf3c68d45aacd97f7c8fdb9" args="(kate_state *k, const kate_region *kr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_region </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structkate__region.html">kate_region</a> * </td>
<td class="paramname"> <em>kr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the region the event should be displayed in. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kr</em> </td><td>the region to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gbac66b465caf6459d51dd09f9d6dfeea"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_region_index" ref="gbac66b465caf6459d51dd09f9d6dfeea" args="(kate_state *k, size_t region)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_region_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>region</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the region the event should be displayed in, by its index in the predefined regions list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>region</em> </td><td>the index of the predefined region to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc93e0a6b5ed2d642469953c167fa5488"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_secondary_style" ref="gc93e0a6b5ed2d642469953c167fa5488" args="(kate_state *k, const kate_style *ks)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_secondary_style </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structkate__style.html">kate_style</a> * </td>
<td class="paramname"> <em>ks</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the secondary style the event should be displayed with. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ks</em> </td><td>the style to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g5b0463369fbcb08665bdc2710403d4f7"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_secondary_style_index" ref="g5b0463369fbcb08665bdc2710403d4f7" args="(kate_state *k, size_t style)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_secondary_style_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>style</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the secondary style the event should be displayed with, by its index in the predefined styles list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>style</em> </td><td>the index of the predefined style to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g902487fd94c26ac32d0dd070ca1f26ca"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_style" ref="g902487fd94c26ac32d0dd070ca1f26ca" args="(kate_state *k, const kate_style *ks)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_style </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structkate__style.html">kate_style</a> * </td>
<td class="paramname"> <em>ks</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the style the event should be displayed with. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ks</em> </td><td>the style to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge7875690bad6ec827bada01a3ce17c32"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_style_index" ref="ge7875690bad6ec827bada01a3ce17c32" args="(kate_state *k, size_t style)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_style_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>style</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the style the event should be displayed with, by its index in the predefined styles list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>style</em> </td><td>the index of the predefined style to use </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gb7681e228b7e8f88a4f5f61e02a20fb9"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_text_directionality" ref="gb7681e228b7e8f88a4f5f61e02a20fb9" args="(kate_state *k, kate_text_directionality text_directionality)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_text_directionality </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="kate_8h.html#ccb7b9d9ec6e956fa1096f2064a6321e">kate_text_directionality</a> </td>
<td class="paramname"> <em>text_directionality</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the text directionality used in this event's text, overriding the default text directionality. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text_directionality</em> </td><td>the text directionality for this event's text </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc628f2f5c33feba5efc4c779d25881bf"></a><!-- doxytag: member="kate_encode.c::kate_encode_set_text_encoding" ref="gc628f2f5c33feba5efc4c779d25881bf" args="(kate_state *k, kate_text_encoding text_encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_set_text_encoding </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> </td>
<td class="paramname"> <em>text_encoding</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the character encoding used in this event's text, overriding the default character encoding. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to encode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text_encoding</em> </td><td>the text encoding for this event's text </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g83a014a63281d6b9a7e5f95b1ca0271b"></a><!-- doxytag: member="kate_encode.c::kate_encode_text" ref="g83a014a63281d6b9a7e5f95b1ca0271b" args="(kate_state *k, kate_float t0, kate_float t1, const char *text, size_t sz, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>t0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"> <em>t1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Encodes a text (which may be NULL) of the given size, starting at t0 and ending at t1. This should always be called when encoding an event, even if the text is NULL. After this is called, the event is fully encoded and cannot be added to anymore. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to add the text to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t0</em> </td><td>the start time in seconds of the text </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t1</em> </td><td>the end time in seconds of the text </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>the text to add (may be NULL) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sz</em> </td><td>the length in bytes of the text to add </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge39c058d7bf07e5e8e65ca08925b01fe"></a><!-- doxytag: member="kate_encode.c::kate_encode_text_raw_times" ref="ge39c058d7bf07e5e8e65ca08925b01fe" args="(kate_state *k, kate_int64_t t0, kate_int64_t t1, const char *text, size_t sz, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_encode_text_raw_times </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>t0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"> <em>t1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Encodes a text (which may be NULL) of the given size, starting at t0 and ending at t1. This should always be called when encoding an event, even if the text is NULL. After this is called, the event is fully encoded and cannot be added to anymore. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to add the text to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t0</em> </td><td>the start time in granule units of the text </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t1</em> </td><td>the end time in granule units of the text </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>the text to add (may be NULL) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sz</em> </td><td>the length in bytes of the text to add </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to encode to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Nov 15 17:26:07 2009 for libkate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
|
