@audd/sdk 1.5.10 → 1.5.12

package/README.md

@@ -1,5 +1,6 @@
 # audd-node
 
+[![Powered by AudD](https://img.shields.io/badge/Music_Recognition-AudD_API-2a4eef)](https://audd.io)
 [![CI](https://github.com/AudDMusic/audd-node/actions/workflows/ci.yml/badge.svg)](https://github.com/AudDMusic/audd-node/actions/workflows/ci.yml)
 [![Contract](https://github.com/AudDMusic/audd-node/actions/workflows/contract.yml/badge.svg)](https://github.com/AudDMusic/audd-node/actions/workflows/contract.yml)
 [![npm](https://img.shields.io/npm/v/@audd/sdk.svg)](https://www.npmjs.com/package/@audd/sdk)
@@ -52,7 +53,7 @@ found no match — distinct from an error, which throws.
 Pass the token literally:
 
 ```ts
-const audd = new AudD("d29ebb...");
+const audd = new AudD("your-api-token");
 ```
 
 Or set `AUDD_API_TOKEN` in the environment and construct without
@@ -145,10 +146,15 @@ for (const m of matches) {
 }
 ```
 
-`EnterpriseMatch` carries the same core tags plus `score`, `startOffset`,
-`endOffset`, `isrc`, `upc`. Access to `isrc`, `upc`, and `score` requires
-a Startup plan or higher — [contact us](mailto:api@audd.io) for enterprise
-features.
+`EnterpriseMatch` carries the same core tags plus `score`, `startSeconds`,
+`endSeconds`, `startOffset`, `endOffset`, `isrc`, `upc`. `startSeconds` and
+`endSeconds` are where this song plays in your file, in seconds (e.g. 64.2 to
+71.8) — feed straight to a player or ffmpeg; computed while parsing the chunked
+response, and `recognizeEnterprise` requests accurate offsets by default so
+they're precise. `startOffset`/`endOffset` are the raw millisecond positions
+within AudD's internal 12-second scan fragment behind them. Access to `isrc`,
+`upc`, and `score` requires a Startup plan or higher — [contact
+us](mailto:api@audd.io) for enterprise features.
 
 The default per-call timeout is **1 hour** for this endpoint (60s for
 standard recognition); override with `timeoutMs`.
@@ -268,7 +274,7 @@ app.use(express.json());
 app.post("/audd-callback", async (req, res) => {
   const { match, notification } = await handleCallback(req);
   if (match) {
-    console.log(`${match.song.artist} - ${match.song.title}  score=${match.song.score}`);
+    console.log(`${match.song?.artist ?? "?"} - ${match.song?.title ?? "?"}  score=${match.song?.score ?? "?"}`);
     for (const alt of match.alternatives) {
       // alternatives are variant catalog releases — different artist/title is possible
       console.log(`  alt: ${alt.artist} - ${alt.title}`);
@@ -298,7 +304,7 @@ import { handleCallback } from "@audd/sdk";
 const app = Fastify();
 app.post("/audd-callback", async (req, reply) => {
   const { match } = await handleCallback(req);
-  if (match) console.log(`${match.song.artist} — ${match.song.title}`);
+  if (match) console.log(`${match.song?.artist ?? "?"} — ${match.song?.title ?? "?"}`);
   return { ok: true };
 });
 ```
@@ -317,7 +323,7 @@ const router = new Router();
 app.use(bodyParser());
 router.post("/audd-callback", async (ctx) => {
   const { match } = await handleCallback(ctx.request);
-  if (match) console.log(`${match.song.artist} — ${match.song.title}`);
+  if (match) console.log(`${match.song?.artist ?? "?"} — ${match.song?.title ?? "?"}`);
   ctx.body = { ok: true };
 });
 app.use(router.routes());
@@ -331,7 +337,7 @@ import { handleCallback } from "@audd/sdk";
 
 export async function POST(req: NextRequest) {
   const { match } = await handleCallback(req);
-  if (match) console.log(`${match.song.artist} — ${match.song.title}`);
+  if (match) console.log(`${match.song?.artist ?? "?"} — ${match.song?.title ?? "?"}`);
   return NextResponse.json({ ok: true });
 }
 ```
@@ -353,7 +359,7 @@ const radioId = 1; // any integer you choose — your handle for this stream
 
 const poll = await audd.streams.longpoll({ radioId, timeout: 30 });
 for await (const m of poll.matches) {
-  console.log(m.song.artist, m.song.title);
+  console.log(m.song?.artist ?? "?", m.song?.title ?? "?");
 }
 ```
 
@@ -363,7 +369,7 @@ Consume matches and notifications concurrently:
 await Promise.all([
   (async () => {
     for await (const m of poll.matches) {
-      console.log("match:", m.song.artist, m.song.title);
+      console.log("match:", m.song?.artist ?? "?", m.song?.title ?? "?");
     }
   })(),
   (async () => {
@@ -396,7 +402,7 @@ import { LongpollConsumer } from "@audd/sdk/longpoll";
 const consumer = new LongpollConsumer("abc123def");
 const poll = consumer.iterate({ timeout: 30 });
 for await (const m of poll.matches) {
-  console.log(m.song.artist, m.song.title);
+  console.log(m.song?.artist ?? "?", m.song?.title ?? "?");
 }
 ```