@pbvision/partner-sdk 0.1.6 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -108,7 +108,7 @@ import { PBVision } from '@pbvision/partner-sdk';
|
|
|
108
108
|
const pbv = new PBVision(YOUR_API_KEY, { useProdServer: false });
|
|
109
109
|
// you can omit this metadata, or provide some or all of this object—whatever you'd like!
|
|
110
110
|
const optionalMetadata = {
|
|
111
|
-
userEmails: [],
|
|
111
|
+
userEmails: [],
|
|
112
112
|
name: 'Dink Championship 2024',
|
|
113
113
|
desc: 'A longer description, if you want',
|
|
114
114
|
gameStartEpoch: 1711393200, // when the game was played
|
|
@@ -134,6 +134,7 @@ data is enabled for your API key, only some of these fields may be present):
|
|
|
134
134
|
"from_url": "https://example.com/my-video.mp4",
|
|
135
135
|
"webpage": "https://pb.vision/video/tvgz3pqij0ll",
|
|
136
136
|
"cutVideo": "https://storage.googleapis.com/pbv-pro/xyz/f50272db-69a8-49ed-9d92-3a4d067af87c/rallies.mp4",
|
|
137
|
+
"cv": CV_DATA,
|
|
137
138
|
"insights": INSIGHTS_DATA,
|
|
138
139
|
"stats": STATS_DATA,
|
|
139
140
|
"vid": STRING,
|
|
@@ -147,8 +148,9 @@ data is enabled for your API key, only some of these fields may be present):
|
|
|
147
148
|
- `from_url` is the video url you sent us in [step 3](#send-videos)
|
|
148
149
|
- `webpage` is a link to our web app where the stats can be explored
|
|
149
150
|
- `error` is only present if your video could not be processed
|
|
151
|
+
- `cv` contains low-level frame-by-frame data
|
|
150
152
|
- `insights` describes the pickleball game in a detailed, shot-by-shot format
|
|
151
|
-
- Explore the _insights_ schema at <https://pbv-public.github.io/insights
|
|
153
|
+
- Explore the _insights_ schema at <https://pbv-public.github.io/insights>
|
|
152
154
|
- Schema changes and diffs are in our [`pbv-public/insights` repo](https://github.com/pbv-public/insights/blob/dev/CHANGELOG.md)
|
|
153
155
|
- `stats` various stats about the game for advanced players
|
|
154
156
|
- Explore the _stats_ schema at <https://pbv-public.github.io/stats?s=~stats~game>
|