This repo contains all code related to the Flaneer streaming technology, the low level capture and encoding as well as the application code.
The install requirements for the non-native code are in the file FlaneerStreamingApp.vsconfig. Simply install Visual Studio 2022 and import them into the installer app, full instructions here.
For the native code you must be using an NVidia graphics device with the latest drivers.
In general the following guidelines should be followed:
- Commented out sections of code should not be in master (that is what Git is for)
- There should be zero warnings
- Warnings that are decided to be acceptable should be commented using a pragma/resharper comment
For C# follow the MS standards, with some changes, importantly:
- Use camel casing ("camelCasing") when naming private or internal fields.
- All caps for enum names
For C++ follow the same style, however these additional rules apply for the C++ specific language features:
- Those listed here:
- Use
m_for members of a class, this is because the header is a seperate file. No other form of Hungarian notation should be used.
Branches should be named after linear tickets where possible to enable us to use the automatic status detection, however some branches may contain multiple tickets work, in which case just selecting one ticket and then mentioning the others in the relavent commits is fine. (If there is not a Linear ticket for the work you are about to undertake... there should be!)
There is no direct pushing to master, all work should go through the standard PR process.
- Initial research for streaming, there are some useful links on here (for the internal team only):
- Initial designs for the streaming app (this should be in date, but will likely lack relavence over time) (for the internal team only):
- This guide on the group of pictures from Amazon contains some really useful video basics:
- Raw video test footage: