search

microsoft / soundscape

An iOS application/service that aids navigation through spatialized audio
MIT License
109 stars 33 forks source link

File formats for import/export #17

Closed calistairforbes closed 1 year ago

calistairforbes commented 1 year ago

Users can save information in the app, and can import and export it - we understand that there are two file formats, JSON and a proprietary format. Is it possible to get documentation around the file formats with a view to being able to import from the proprietary files into a new version of the app?

AdamGlass commented 1 year ago

I don't recall any import or export functionality in the app. @mekne?

calistairforbes commented 1 year ago

Thanks @AdamGlass - maybe not explicitly import/export but the ability to save markers, etc ...

datsirul commented 1 year ago

I'm assuming you are referring to the user created Route objects which can be exported via files. Other data, such as Marker objects are exported via URLs.

Regarding the Route file format - it's a JSON file, where the route ID is the file name, and it has a custom extension .soundscape.

The file is an external representation of the RouteParameters object, which is responsible for representing Route objects when exporting and importing. As RouteParameters conforms to the Codable protocol, it can be serialized into JSON.