index.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Protocol Documentation</title>
  5. <meta charset="UTF-8">
  6. <link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>
  7. <style>
  8. body {
  9. width: 60em;
  10. margin: 1em auto;
  11. color: #222;
  12. font-family: "Ubuntu", sans-serif;
  13. padding-bottom: 4em;
  14. }
  15. h1 {
  16. font-weight: normal;
  17. border-bottom: 1px solid #aaa;
  18. padding-bottom: 0.5ex;
  19. }
  20. h2 {
  21. border-bottom: 1px solid #aaa;
  22. padding-bottom: 0.5ex;
  23. margin: 1.5em 0;
  24. }
  25. h3 {
  26. font-weight: normal;
  27. border-bottom: 1px solid #aaa;
  28. padding-bottom: 0.5ex;
  29. }
  30. a {
  31. text-decoration: none;
  32. color: #567e25;
  33. }
  34. table {
  35. width: 100%;
  36. font-size: 80%;
  37. border-collapse: collapse;
  38. }
  39. thead {
  40. font-weight: 700;
  41. background-color: #dcdcdc;
  42. }
  43. tbody tr:nth-child(even) {
  44. background-color: #fbfbfb;
  45. }
  46. td {
  47. border: 1px solid #ccc;
  48. padding: 0.5ex 2ex;
  49. }
  50. td p {
  51. text-indent: 1em;
  52. margin: 0;
  53. }
  54. td p:nth-child(1) {
  55. text-indent: 0;
  56. }
  57. .field-table td:nth-child(1) {
  58. width: 10em;
  59. }
  60. .field-table td:nth-child(2) {
  61. width: 10em;
  62. }
  63. .field-table td:nth-child(3) {
  64. width: 6em;
  65. }
  66. .field-table td:nth-child(4) {
  67. width: auto;
  68. }
  69. .extension-table td:nth-child(1) {
  70. width: 10em;
  71. }
  72. .extension-table td:nth-child(2) {
  73. width: 10em;
  74. }
  75. .extension-table td:nth-child(3) {
  76. width: 10em;
  77. }
  78. .extension-table td:nth-child(4) {
  79. width: 5em;
  80. }
  81. .extension-table td:nth-child(5) {
  82. width: auto;
  83. }
  84. .enum-table td:nth-child(1) {
  85. width: 10em;
  86. }
  87. .enum-table td:nth-child(2) {
  88. width: 10em;
  89. }
  90. .enum-table td:nth-child(3) {
  91. width: auto;
  92. }
  93. .scalar-value-types-table tr {
  94. height: 3em;
  95. }
  96. #toc-container ul {
  97. list-style-type: none;
  98. padding-left: 1em;
  99. line-height: 180%;
  100. margin: 0;
  101. }
  102. #toc > li > a {
  103. font-weight: bold;
  104. }
  105. .file-heading {
  106. width: 100%;
  107. display: table;
  108. border-bottom: 1px solid #aaa;
  109. margin: 4em 0 1.5em 0;
  110. }
  111. .file-heading h2 {
  112. border: none;
  113. display: table-cell;
  114. }
  115. .file-heading a {
  116. text-align: right;
  117. display: table-cell;
  118. }
  119. .badge {
  120. width: 1.6em;
  121. height: 1.6em;
  122. display: inline-block;
  123. line-height: 1.6em;
  124. text-align: center;
  125. font-weight: bold;
  126. font-size: 60%;
  127. color: #89ba48;
  128. background-color: #dff0c8;
  129. margin: 0.5ex 1em 0.5ex -1em;
  130. border: 1px solid #fbfbfb;
  131. border-radius: 1ex;
  132. }
  133. </style>
  134. <link rel="stylesheet" type="text/css" href="stylesheet.css"/>
  135. </head>
  136. <body>
  137. <h1 id="title">Protocol Documentation</h1>
  138. <h2>Table of Contents</h2>
  139. <div id="toc-container">
  140. <ul id="toc">
  141. <li>
  142. <a href="#proto%2fChannel.proto">proto/Channel.proto</a>
  143. <ul>
  144. <li>
  145. <a href="#.ChannelCategoryMetadata"><span class="badge">M</span>ChannelCategoryMetadata</a>
  146. </li>
  147. <li>
  148. <a href="#.ChannelMetadata"><span class="badge">M</span>ChannelMetadata</a>
  149. </li>
  150. </ul>
  151. </li>
  152. <li>
  153. <a href="#proto%2fPerson.proto">proto/Person.proto</a>
  154. <ul>
  155. <li>
  156. <a href="#.PersonMetadata"><span class="badge">M</span>PersonMetadata</a>
  157. </li>
  158. </ul>
  159. </li>
  160. <li>
  161. <a href="#proto%2fPlaylist.proto">proto/Playlist.proto</a>
  162. <ul>
  163. <li>
  164. <a href="#.PlaylistMetadata"><span class="badge">M</span>PlaylistMetadata</a>
  165. </li>
  166. </ul>
  167. </li>
  168. <li>
  169. <a href="#proto%2fSeries.proto">proto/Series.proto</a>
  170. <ul>
  171. <li>
  172. <a href="#.SeasonMetadata"><span class="badge">M</span>SeasonMetadata</a>
  173. </li>
  174. <li>
  175. <a href="#.SeriesMetadata"><span class="badge">M</span>SeriesMetadata</a>
  176. </li>
  177. </ul>
  178. </li>
  179. <li>
  180. <a href="#proto%2fVideo.proto">proto/Video.proto</a>
  181. <ul>
  182. <li>
  183. <a href="#.License"><span class="badge">M</span>License</a>
  184. </li>
  185. <li>
  186. <a href="#.MediaType"><span class="badge">M</span>MediaType</a>
  187. </li>
  188. <li>
  189. <a href="#.PublishedBeforeJoystream"><span class="badge">M</span>PublishedBeforeJoystream</a>
  190. </li>
  191. <li>
  192. <a href="#.VideoCategoryMetadata"><span class="badge">M</span>VideoCategoryMetadata</a>
  193. </li>
  194. <li>
  195. <a href="#.VideoMetadata"><span class="badge">M</span>VideoMetadata</a>
  196. </li>
  197. </ul>
  198. </li>
  199. <li><a href="#scalar-value-types">Scalar Value Types</a></li>
  200. </ul>
  201. </div>
  202. <div class="file-heading">
  203. <h2 id="proto/Channel.proto">proto/Channel.proto</h2><a href="#title">Top</a>
  204. </div>
  205. <p></p>
  206. <h3 id=".ChannelCategoryMetadata">ChannelCategoryMetadata</h3>
  207. <p></p>
  208. <table class="field-table">
  209. <thead>
  210. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  211. </thead>
  212. <tbody>
  213. <tr>
  214. <td>name</td>
  215. <td><a href="#string">string</a></td>
  216. <td>optional</td>
  217. <td><p>Category Name </p></td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <h3 id=".ChannelMetadata">ChannelMetadata</h3>
  222. <p></p>
  223. <table class="field-table">
  224. <thead>
  225. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  226. </thead>
  227. <tbody>
  228. <tr>
  229. <td>title</td>
  230. <td><a href="#string">string</a></td>
  231. <td>optional</td>
  232. <td><p>Channel Title </p></td>
  233. </tr>
  234. <tr>
  235. <td>description</td>
  236. <td><a href="#string">string</a></td>
  237. <td>optional</td>
  238. <td><p>Channel Description </p></td>
  239. </tr>
  240. <tr>
  241. <td>is_public</td>
  242. <td><a href="#bool">bool</a></td>
  243. <td>optional</td>
  244. <td><p>Wether to display channel to the public </p></td>
  245. </tr>
  246. <tr>
  247. <td>language</td>
  248. <td><a href="#string">string</a></td>
  249. <td>optional</td>
  250. <td><p>ISO_639-1 Language [Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) </p></td>
  251. </tr>
  252. <tr>
  253. <td>cover_photo</td>
  254. <td><a href="#uint32">uint32</a></td>
  255. <td>optional</td>
  256. <td><p>index into OOB array </p></td>
  257. </tr>
  258. <tr>
  259. <td>avatar_photo</td>
  260. <td><a href="#uint32">uint32</a></td>
  261. <td>optional</td>
  262. <td><p>index into OOB array </p></td>
  263. </tr>
  264. </tbody>
  265. </table>
  266. <div class="file-heading">
  267. <h2 id="proto/Person.proto">proto/Person.proto</h2><a href="#title">Top</a>
  268. </div>
  269. <p></p>
  270. <h3 id=".PersonMetadata">PersonMetadata</h3>
  271. <p></p>
  272. <table class="field-table">
  273. <thead>
  274. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  275. </thead>
  276. <tbody>
  277. <tr>
  278. <td>first_name</td>
  279. <td><a href="#string">string</a></td>
  280. <td>optional</td>
  281. <td><p> </p></td>
  282. </tr>
  283. <tr>
  284. <td>middle_name</td>
  285. <td><a href="#string">string</a></td>
  286. <td>optional</td>
  287. <td><p> </p></td>
  288. </tr>
  289. <tr>
  290. <td>last_name</td>
  291. <td><a href="#string">string</a></td>
  292. <td>optional</td>
  293. <td><p> </p></td>
  294. </tr>
  295. <tr>
  296. <td>about</td>
  297. <td><a href="#string">string</a></td>
  298. <td>optional</td>
  299. <td><p> </p></td>
  300. </tr>
  301. <tr>
  302. <td>cover_photo</td>
  303. <td><a href="#uint32">uint32</a></td>
  304. <td>optional</td>
  305. <td><p>index into OOB array </p></td>
  306. </tr>
  307. <tr>
  308. <td>avatar_photo</td>
  309. <td><a href="#uint32">uint32</a></td>
  310. <td>optional</td>
  311. <td><p>index into OOB array </p></td>
  312. </tr>
  313. </tbody>
  314. </table>
  315. <div class="file-heading">
  316. <h2 id="proto/Playlist.proto">proto/Playlist.proto</h2><a href="#title">Top</a>
  317. </div>
  318. <p></p>
  319. <h3 id=".PlaylistMetadata">PlaylistMetadata</h3>
  320. <p></p>
  321. <table class="field-table">
  322. <thead>
  323. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  324. </thead>
  325. <tbody>
  326. <tr>
  327. <td>title</td>
  328. <td><a href="#string">string</a></td>
  329. <td>optional</td>
  330. <td><p> </p></td>
  331. </tr>
  332. </tbody>
  333. </table>
  334. <div class="file-heading">
  335. <h2 id="proto/Series.proto">proto/Series.proto</h2><a href="#title">Top</a>
  336. </div>
  337. <p></p>
  338. <h3 id=".SeasonMetadata">SeasonMetadata</h3>
  339. <p></p>
  340. <table class="field-table">
  341. <thead>
  342. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  343. </thead>
  344. <tbody>
  345. <tr>
  346. <td>title</td>
  347. <td><a href="#string">string</a></td>
  348. <td>optional</td>
  349. <td><p> </p></td>
  350. </tr>
  351. <tr>
  352. <td>description</td>
  353. <td><a href="#string">string</a></td>
  354. <td>optional</td>
  355. <td><p> </p></td>
  356. </tr>
  357. </tbody>
  358. </table>
  359. <h3 id=".SeriesMetadata">SeriesMetadata</h3>
  360. <p></p>
  361. <table class="field-table">
  362. <thead>
  363. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  364. </thead>
  365. <tbody>
  366. <tr>
  367. <td>title</td>
  368. <td><a href="#string">string</a></td>
  369. <td>optional</td>
  370. <td><p> </p></td>
  371. </tr>
  372. <tr>
  373. <td>description</td>
  374. <td><a href="#string">string</a></td>
  375. <td>optional</td>
  376. <td><p> </p></td>
  377. </tr>
  378. <tr>
  379. <td>cover_photo</td>
  380. <td><a href="#uint32">uint32</a></td>
  381. <td>optional</td>
  382. <td><p>index into OOB array </p></td>
  383. </tr>
  384. </tbody>
  385. </table>
  386. <div class="file-heading">
  387. <h2 id="proto/Video.proto">proto/Video.proto</h2><a href="#title">Top</a>
  388. </div>
  389. <p></p>
  390. <h3 id=".License">License</h3>
  391. <p>License types defined by Joystream</p>
  392. <table class="field-table">
  393. <thead>
  394. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  395. </thead>
  396. <tbody>
  397. <tr>
  398. <td>code</td>
  399. <td><a href="#uint32">uint32</a></td>
  400. <td>optional</td>
  401. <td><p>License code defined by Joystream. [reference](../src/KnownLicenses.json) </p></td>
  402. </tr>
  403. <tr>
  404. <td>attribution</td>
  405. <td><a href="#string">string</a></td>
  406. <td>optional</td>
  407. <td><p>Text for licenses that require an attribution </p></td>
  408. </tr>
  409. <tr>
  410. <td>custom_text</td>
  411. <td><a href="#string">string</a></td>
  412. <td>optional</td>
  413. <td><p>Text for custom license type </p></td>
  414. </tr>
  415. </tbody>
  416. </table>
  417. <h3 id=".MediaType">MediaType</h3>
  418. <p>Codec, Container, MIME media-type information</p>
  419. <table class="field-table">
  420. <thead>
  421. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  422. </thead>
  423. <tbody>
  424. <tr>
  425. <td>codec_name</td>
  426. <td><a href="#string">string</a></td>
  427. <td>optional</td>
  428. <td><p>Codec corresponding to `name` field from [FFmpeg](https://github.com/FFmpeg/FFmpeg/blob/master/libavcodec/codec_desc.c) </p></td>
  429. </tr>
  430. <tr>
  431. <td>container</td>
  432. <td><a href="#string">string</a></td>
  433. <td>optional</td>
  434. <td><p>Video container format, eg. &#39;MP4&#39;, &#39;WebM&#39;, &#39;Ogg&#39; [ref](https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Video_codecs) </p></td>
  435. </tr>
  436. <tr>
  437. <td>mime_media_type</td>
  438. <td><a href="#string">string</a></td>
  439. <td>optional</td>
  440. <td><p>MIME Media Type, eg. &#39;video/mp4&#39; [ref](https://www.iana.org/assignments/media-types/media-types.xhtml#video) </p></td>
  441. </tr>
  442. </tbody>
  443. </table>
  444. <h3 id=".PublishedBeforeJoystream">PublishedBeforeJoystream</h3>
  445. <p>Publication status before joystream</p>
  446. <table class="field-table">
  447. <thead>
  448. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  449. </thead>
  450. <tbody>
  451. <tr>
  452. <td>is_published</td>
  453. <td><a href="#bool">bool</a></td>
  454. <td>optional</td>
  455. <td><p>Was video published before joystream platform </p></td>
  456. </tr>
  457. <tr>
  458. <td>timestamp</td>
  459. <td><a href="#uint32">uint32</a></td>
  460. <td>optional</td>
  461. <td><p>Unix timestamp in milli-seconds </p></td>
  462. </tr>
  463. </tbody>
  464. </table>
  465. <h3 id=".VideoCategoryMetadata">VideoCategoryMetadata</h3>
  466. <p></p>
  467. <table class="field-table">
  468. <thead>
  469. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  470. </thead>
  471. <tbody>
  472. <tr>
  473. <td>name</td>
  474. <td><a href="#string">string</a></td>
  475. <td>optional</td>
  476. <td><p>Category name </p></td>
  477. </tr>
  478. </tbody>
  479. </table>
  480. <h3 id=".VideoMetadata">VideoMetadata</h3>
  481. <p></p>
  482. <table class="field-table">
  483. <thead>
  484. <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
  485. </thead>
  486. <tbody>
  487. <tr>
  488. <td>title</td>
  489. <td><a href="#string">string</a></td>
  490. <td>optional</td>
  491. <td><p>Video Title </p></td>
  492. </tr>
  493. <tr>
  494. <td>description</td>
  495. <td><a href="#string">string</a></td>
  496. <td>optional</td>
  497. <td><p>Video Description </p></td>
  498. </tr>
  499. <tr>
  500. <td>video</td>
  501. <td><a href="#uint32">uint32</a></td>
  502. <td>optional</td>
  503. <td><p>Index into OOB array </p></td>
  504. </tr>
  505. <tr>
  506. <td>thumbnail_photo</td>
  507. <td><a href="#uint32">uint32</a></td>
  508. <td>optional</td>
  509. <td><p>Index into OOB array </p></td>
  510. </tr>
  511. <tr>
  512. <td>duration</td>
  513. <td><a href="#uint32">uint32</a></td>
  514. <td>optional</td>
  515. <td><p>Lengths of video in seconds </p></td>
  516. </tr>
  517. <tr>
  518. <td>media_pixel_height</td>
  519. <td><a href="#uint32">uint32</a></td>
  520. <td>optional</td>
  521. <td><p>Resolution of the video (Height) </p></td>
  522. </tr>
  523. <tr>
  524. <td>media_pixel_width</td>
  525. <td><a href="#uint32">uint32</a></td>
  526. <td>optional</td>
  527. <td><p>Resolution of the video (Width) </p></td>
  528. </tr>
  529. <tr>
  530. <td>media_type</td>
  531. <td><a href="#MediaType">MediaType</a></td>
  532. <td>optional</td>
  533. <td><p>Encoding and Container format used </p></td>
  534. </tr>
  535. <tr>
  536. <td>language</td>
  537. <td><a href="#string">string</a></td>
  538. <td>optional</td>
  539. <td><p>ISO_639-1 Language [Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) </p></td>
  540. </tr>
  541. <tr>
  542. <td>license</td>
  543. <td><a href="#License">License</a></td>
  544. <td>optional</td>
  545. <td><p>License type for the media </p></td>
  546. </tr>
  547. <tr>
  548. <td>published_before_joystream</td>
  549. <td><a href="#PublishedBeforeJoystream">PublishedBeforeJoystream</a></td>
  550. <td>optional</td>
  551. <td><p>Date of publication </p></td>
  552. </tr>
  553. <tr>
  554. <td>has_marketing</td>
  555. <td><a href="#bool">bool</a></td>
  556. <td>optional</td>
  557. <td><p>Does video have marketing or advertising in the stream </p></td>
  558. </tr>
  559. <tr>
  560. <td>is_public</td>
  561. <td><a href="#bool">bool</a></td>
  562. <td>optional</td>
  563. <td><p>Should video be publicy visible yet </p></td>
  564. </tr>
  565. <tr>
  566. <td>is_explicit</td>
  567. <td><a href="#bool">bool</a></td>
  568. <td>optional</td>
  569. <td><p>Does Video have explicit language or scenes </p></td>
  570. </tr>
  571. </tbody>
  572. </table>
  573. <h2 id="scalar-value-types">Scalar Value Types</h2>
  574. <table class="scalar-value-types-table">
  575. <thead>
  576. <tr><td>.proto Type</td><td>Notes</td><td>C++</td><td>Java</td><td>Python</td><td>Go</td><td>C#</td><td>PHP</td><td>Ruby</td></tr>
  577. </thead>
  578. <tbody>
  579. <tr id="double">
  580. <td>double</td>
  581. <td></td>
  582. <td>double</td>
  583. <td>double</td>
  584. <td>float</td>
  585. <td>float64</td>
  586. <td>double</td>
  587. <td>float</td>
  588. <td>Float</td>
  589. </tr>
  590. <tr id="float">
  591. <td>float</td>
  592. <td></td>
  593. <td>float</td>
  594. <td>float</td>
  595. <td>float</td>
  596. <td>float32</td>
  597. <td>float</td>
  598. <td>float</td>
  599. <td>Float</td>
  600. </tr>
  601. <tr id="int32">
  602. <td>int32</td>
  603. <td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.</td>
  604. <td>int32</td>
  605. <td>int</td>
  606. <td>int</td>
  607. <td>int32</td>
  608. <td>int</td>
  609. <td>integer</td>
  610. <td>Bignum or Fixnum (as required)</td>
  611. </tr>
  612. <tr id="int64">
  613. <td>int64</td>
  614. <td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.</td>
  615. <td>int64</td>
  616. <td>long</td>
  617. <td>int/long</td>
  618. <td>int64</td>
  619. <td>long</td>
  620. <td>integer/string</td>
  621. <td>Bignum</td>
  622. </tr>
  623. <tr id="uint32">
  624. <td>uint32</td>
  625. <td>Uses variable-length encoding.</td>
  626. <td>uint32</td>
  627. <td>int</td>
  628. <td>int/long</td>
  629. <td>uint32</td>
  630. <td>uint</td>
  631. <td>integer</td>
  632. <td>Bignum or Fixnum (as required)</td>
  633. </tr>
  634. <tr id="uint64">
  635. <td>uint64</td>
  636. <td>Uses variable-length encoding.</td>
  637. <td>uint64</td>
  638. <td>long</td>
  639. <td>int/long</td>
  640. <td>uint64</td>
  641. <td>ulong</td>
  642. <td>integer/string</td>
  643. <td>Bignum or Fixnum (as required)</td>
  644. </tr>
  645. <tr id="sint32">
  646. <td>sint32</td>
  647. <td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.</td>
  648. <td>int32</td>
  649. <td>int</td>
  650. <td>int</td>
  651. <td>int32</td>
  652. <td>int</td>
  653. <td>integer</td>
  654. <td>Bignum or Fixnum (as required)</td>
  655. </tr>
  656. <tr id="sint64">
  657. <td>sint64</td>
  658. <td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.</td>
  659. <td>int64</td>
  660. <td>long</td>
  661. <td>int/long</td>
  662. <td>int64</td>
  663. <td>long</td>
  664. <td>integer/string</td>
  665. <td>Bignum</td>
  666. </tr>
  667. <tr id="fixed32">
  668. <td>fixed32</td>
  669. <td>Always four bytes. More efficient than uint32 if values are often greater than 2^28.</td>
  670. <td>uint32</td>
  671. <td>int</td>
  672. <td>int</td>
  673. <td>uint32</td>
  674. <td>uint</td>
  675. <td>integer</td>
  676. <td>Bignum or Fixnum (as required)</td>
  677. </tr>
  678. <tr id="fixed64">
  679. <td>fixed64</td>
  680. <td>Always eight bytes. More efficient than uint64 if values are often greater than 2^56.</td>
  681. <td>uint64</td>
  682. <td>long</td>
  683. <td>int/long</td>
  684. <td>uint64</td>
  685. <td>ulong</td>
  686. <td>integer/string</td>
  687. <td>Bignum</td>
  688. </tr>
  689. <tr id="sfixed32">
  690. <td>sfixed32</td>
  691. <td>Always four bytes.</td>
  692. <td>int32</td>
  693. <td>int</td>
  694. <td>int</td>
  695. <td>int32</td>
  696. <td>int</td>
  697. <td>integer</td>
  698. <td>Bignum or Fixnum (as required)</td>
  699. </tr>
  700. <tr id="sfixed64">
  701. <td>sfixed64</td>
  702. <td>Always eight bytes.</td>
  703. <td>int64</td>
  704. <td>long</td>
  705. <td>int/long</td>
  706. <td>int64</td>
  707. <td>long</td>
  708. <td>integer/string</td>
  709. <td>Bignum</td>
  710. </tr>
  711. <tr id="bool">
  712. <td>bool</td>
  713. <td></td>
  714. <td>bool</td>
  715. <td>boolean</td>
  716. <td>boolean</td>
  717. <td>bool</td>
  718. <td>bool</td>
  719. <td>boolean</td>
  720. <td>TrueClass/FalseClass</td>
  721. </tr>
  722. <tr id="string">
  723. <td>string</td>
  724. <td>A string must always contain UTF-8 encoded or 7-bit ASCII text.</td>
  725. <td>string</td>
  726. <td>String</td>
  727. <td>str/unicode</td>
  728. <td>string</td>
  729. <td>string</td>
  730. <td>string</td>
  731. <td>String (UTF-8)</td>
  732. </tr>
  733. <tr id="bytes">
  734. <td>bytes</td>
  735. <td>May contain any arbitrary sequence of bytes.</td>
  736. <td>string</td>
  737. <td>ByteString</td>
  738. <td>str</td>
  739. <td>[]byte</td>
  740. <td>ByteString</td>
  741. <td>string</td>
  742. <td>String (ASCII-8BIT)</td>
  743. </tr>
  744. </tbody>
  745. </table>
  746. </body>
  747. </html>