Project
DEFINITION: The highest level of segmentation/grouping for all RW data. One RW instance can run many projects simultaneously, governed by CPU, bandwidth and memory resources.
Fields
| Parameter | Format/Units | Definition | Notes |
|---|---|---|---|
| name | string | full name of project | |
| latitude/longitude | float | defines the central physical location of the project | used for things like centering a map display of all voices in a project |
| Date published | datetime | indicates when project was created in the database | |
| Audio format | string (mp3, ogg) | default audio format of streams generated for project | stream format can be changed on a case-by-case basis by the client including the ‘audio_format’ parameter for request_stream |
| Auto submit | boolean | default behavior for incoming assets | If Y, assets are assigned submitted=Y automatically, if N, submitted=N. This is related to geography so that if an asset is out of range, it will not be submitted automatically regardless of this setting. Also, the submitted parameter in add_asset_to_envelope will override this default |
| Max recording length | integer/seconds | max time participant can record for in single recording | typically fed to recording countdown display on client |
| Listen questions dynamic | boolean | whether or not Listen questions will change based on location of speaker | |
| Speak questions dynamic | boolean | whether or not Speak questions will change based on location of speaker | |
| Out of range url | string/url | mountpoint for static stream to be played by client if client is out of range | only applicable when geo_listen enabled |
| Recording radius | integer/meters | radius of circular area around asset lat/lon within which recording is active ie can be heard | eventually this will be over-ridden for individual assets by the ‘radius’ field in the asset table |
| Listen enabled | boolean | does project allow for clients to listen to streamed audio from server? | |
| Geo listen enabled | boolean | does audio stream from server change based on location of client? | |
| Speak enabled | boolean | does project allow for clients to capture audio from participants and upload to server? | |
| Geo speak enabled | boolean | does project require lat/lon values for each asset submitted? | |
| Reset tag defaults on startup | boolean | determines whether or not the client will reset all tag selections for the default values (received in get_tags) each time the app is started. If N, clients will store the most recent tag selections and re-present those upon startup | |
| Repeat mode | picklist | stop: after playing all available recordings (round robin) in audio stream, no more recordings will play continuous: after playing all available recordings, server will start over and randomly play all available recordings again (round robin) We will add more repeat modes in the future to give more options. | |
| Sharing message loc | string | localized versions of the message used by the social sharing mechanism on the clients. Typically, this message will end with the url to the asset sharing page and the client will append the asset_id of the asset being shared | |
| Out of range message loc | string | localized versions of the message sent to the client when a user tries to access the system from out of range. Typically will outline the differences in client behavior based on being out of range (ie. “you will hear a static stream of audio rather than a dynamic stream”) | |
| Legal agreement loc | string | localized version of the legal agreement participants must click through in order to make and upload assets to the system |