11# API Documentation
22
33The following is generated from the [ swagger.json] ( swagger.json ) file via https://swagger-markdown-ui.netlify.app/
4-
54# mGBA-http
65An HTTP interface for mGBA scripting.
76
@@ -24,7 +23,7 @@ A custom convenience API that implements a key press and release. This is as opp
2423
2524| Name | Located in | Description | Required | Schema |
2625| ---- | ---------- | ----------- | -------- | ---- |
27- | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | string |
26+ | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | [ KeysEnum ] ( #KeysEnum ) |
2827
2928##### Responses
3029
@@ -70,7 +69,7 @@ A custom convenience API that implements a held down button for a given duration
7069
7170| Name | Located in | Description | Required | Schema |
7271| ---- | ---------- | ----------- | -------- | ---- |
73- | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | string |
72+ | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | [ KeysEnum ] ( #KeysEnum ) |
7473| duration | query | Duration in frames. | Yes | integer |
7574
7675##### Responses
@@ -187,7 +186,7 @@ Add a single key to the currently active key list. As if the key were held down.
187186
188187| Name | Located in | Description | Required | Schema |
189188| ---- | ---------- | ----------- | -------- | ---- |
190- | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | string |
189+ | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | [ KeysEnum ] ( #KeysEnum ) |
191190
192191##### Responses
193192
@@ -267,7 +266,7 @@ Remove a single key from the currently active key list. As if the key were relea
267266
268267| Name | Located in | Description | Required | Schema |
269268| ---- | ---------- | ----------- | -------- | ---- |
270- | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | string |
269+ | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | [ KeysEnum ] ( #KeysEnum ) |
271270
272271##### Responses
273272
@@ -398,7 +397,7 @@ Get the active state of a given key.
398397
399398| Name | Located in | Description | Required | Schema |
400399| ---- | ---------- | ----------- | -------- | ---- |
401- | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | string |
400+ | key | query | Key value of: A, B, Start, Select, Start, Right, Left, Up, Down, R, or L. | Yes | [ KeysEnum ] ( #KeysEnum ) |
402401
403402##### Responses
404403
@@ -637,7 +636,7 @@ Read byte range from the given offset.
637636
638637##### Description:
639638
640- Read byte range from the given offset.
639+ Read byte range from the given offset and returns an array of unsigned integers
641640
642641##### Parameters
643642
@@ -718,7 +717,7 @@ Save state and return as a buffer.
718717
719718##### Description:
720719
721- Save state and return as a buffer.
720+ Save state and returns an array of unsigned integers
722721
723722##### Parameters
724723
@@ -956,6 +955,23 @@ Reset the emulation and calls the reset callback.
956955| ---- | ----------- |
957956| 200 | OK |
958957
958+ ### /coreadapter/memory
959+
960+ #### GET
961+ ##### Summary:
962+
963+ Get the platform specific set of MemoryDomains.
964+
965+ ##### Description:
966+
967+ Gets the platform specific set of memory domains as an array of strings.
968+
969+ ##### Responses
970+
971+ | Code | Description |
972+ | ---- | ----------- |
973+ | 200 | OK |
974+
959975### /memorydomain/base
960976
961977#### GET
@@ -1106,7 +1122,7 @@ Read byte range from the given offset.
11061122
11071123##### Description:
11081124
1109- Read byte range from the given offset.
1125+ Read byte range from the given offset and returns an array of unsigned integers
11101126
11111127##### Parameters
11121128
0 commit comments