Assets
An assets represents a fils in storage or a pease of content (e.g. an audio file, a translation text, etc)
TaskThis document is not meant to outline how to use the API endpoints, rather how to build it. We outline what it's capabilities should be, once you have built them, you can creat documentation on how to utilize them on the APIs tab.
- Status & Details
- User Stories, Flows & Personas
- Features & Functions
- Data
Status
These details are only updated with each release, for more acurate updates and keeping track of progress, see the task in GitHub.
| Owner | Lead | Doc Status | Product Status | Last Update | Version | Release | Phase |
|---|---|---|---|---|---|---|---|
| - | - | In Progress | Up Next | 04.03.2024 | 0.01 | Internal | Alpha |
Description
Add a detailed description
Reminders
- Keep code lean and clear
- follow the outlined arcetecture
- write commetes in your code
- update the staus in the docs and in GitHub
- try not to recreate functions we alredy have, rather update exsiting functions to support your needs
- Be sure to follow the release guidelines
- Update Documentation
- keep API docs up to date each time you update or add endpoints
Links & Resources
User Stories
Persona One
Update Coming Soon
As a busy user I don’t want to watch but rather listen to a podcast, however, when I hear a voice I don’t recognize, I want to take a glance at my phone to see a name and/or photo of who is talking or maybe ask the built-in “AI/assistant”.
User Flows
Personas
Features
Below is a list of features that will be utilized in order to deliver the best account features and functionalities. The details bellow are not comprehensive feature details but rather, describe how the features will be utilized within the account, for further details, please see the individual feature documentation.
You can find the Data Structure.
On the document we want to keep all the important data, the first fetch and fast to access.
- Data Structure
- Data model
To understand how collections and documents work, see Data Sctructure
Asset Data
- Asset
-
- asset1
-
-
- asset_type (UGA, Music, Shorts, Podcasts, Playlist, Radio')allow multiple
-
-
-
- sub_type (movie, show, TV channel, album, EP, Single, live, remix, auction, etc)allow multiple
-
-
-
- title
-
-
-
- project (ID)
-
-
-
- description
-
-
-
- portrait_img
-
-
-
- landscape_img` varchL,
-
-
-
- content_upload_type` 'server_video, external_url, youtube',
-
-
-
- source_type ('internal, external)
-
-
-
- source (youtube, kittok, etc)
-
-
-
- access (Public, permissions, link private')
-
-
-
- status`
-
-
-
- primary_language (id)
-
-
-
- category/genre (id)allow multiple for music
-
-
-
- sub_category (id)
-
-
-
- topics (IDs)
-
-
-
- supported_formats (audio, video, text) allow multiple
-
-
-
- supported _modes (read, listen, watch, chat, go) allow multiple
-
-
-
-
supported_features (comments, remix, like/dislike/votes, poles, download, translate, ent/transcribe, voiceover, etc) allow multiple
-
permissions
-
- access1
-
-
- user/org id
-
-
-
- access level
-
-
-
- expiration (never, date)
-
-
-
- inherited (false, org/project ID)
-
-
collaboration
-
- collab 1
-
-
- role (host, label, producer, author, etc.)
-
-
-
- profile_id
-
-
-
- account id
-
-
-
- royalties %
-
-
-
- Payout account id
-
-
tracks studio data
-
- track1
-
-
- name
-
-
-
- thumbnail
-
-
-
- id
-
-
assets
-
- asset1
-
-
- asset id
-
-
-
- start (timestamp)
-
-
-
- end (timestamp)
-
-
companiun_assets e.g. audio version
-
- asset1
-
-
- name
-
-
-
- image
-
-
-
- id
- audio
-
- langage1
-
-
- primary (true, false)
-
-
-
- langage
-
-
-
test
-
video
-
resolution
-
- #1
-
-
- primary (true, false)
-
-
metadata
-
-
- content_size` ,
-
-
-
- content_duration` ,
-
-
-
- total_view
-
-
-
- total_like`
-
-
-
- total_dislike`
-
-
- hashtags
-
-
- hashtag_id
-
-
log
-
- log1
-
-
- type (created, edit, studio edit, status change, delete, etc)
-
-
-
- time stamp
-
-
-
- by (users ID)
-
-
-
- user log / studio log (id)
-
-
cost
-
- cost 1
-
-
- cost type (rent, purchase, subscription)
-
-
-
- rent (true, false)
-
-
-
- price
-
-
-
- duration (x days, weeks, months)
-
-
-
- sub id (API ID)
-
-
-