@ignitify-integrations/stream 0.1.0 → 0.1.2
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/NOTICE +2 -1
- package/README.md +9 -3
- package/dist/constants.d.ts +1 -2
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +1 -2
- package/dist/constants.js.map +1 -1
- package/dist/player-script.generated.d.ts +3 -0
- package/dist/player-script.generated.d.ts.map +1 -0
- package/dist/player-script.generated.js +5 -0
- package/dist/player-script.generated.js.map +1 -0
- package/dist/stream.d.ts.map +1 -1
- package/dist/stream.js +6 -6
- package/dist/stream.js.map +1 -1
- package/package.json +6 -4
package/NOTICE
CHANGED
|
@@ -3,7 +3,8 @@ Copyright 2026 The ignitify integrations authors
|
|
|
3
3
|
|
|
4
4
|
This product includes software developed by the ignitify integrations authors.
|
|
5
5
|
|
|
6
|
-
integrations/stream
|
|
6
|
+
integrations/stream includes hls.js (https://github.com/video-dev/hls.js), Copyright (c) 2017 Dailymotion, Apache-2.0:
|
|
7
|
+
its dist/hls.min.js is embedded in the published package at build time and served to viewers.
|
|
7
8
|
integrations/stream drives ffmpeg (https://ffmpeg.org) as a separate process. ffmpeg is not distributed by this project;
|
|
8
9
|
it is installed in the task image as a system package and keeps its own licence (LGPL-2.1-or-later, or GPL when
|
|
9
10
|
built with GPL components).
|
package/README.md
CHANGED
|
@@ -43,8 +43,8 @@ The result is `{ success: true, stage: 'streamed', cancelled, watch, streamed_s,
|
|
|
43
43
|
## Grow your task
|
|
44
44
|
|
|
45
45
|
- **A radio-style stream.** Use `profile: 'audio'`.
|
|
46
|
-
- **Give viewers time to join.** Use `startDelaySec`, and send the link first: `watchUrl(ctx)` returns it before the stream starts (for example,
|
|
47
|
-
- **Keep the recording.** Use `after: 'stop'`; the playlist and segments stay in `$HOME/hls` until the next stream starts. To return one playable link, upload each segment with [`s3-storage`](
|
|
46
|
+
- **Give viewers time to join.** Use `startDelaySec`, and send the link first: `watchUrl(ctx)` returns it before the stream starts (for example, in a chat message).
|
|
47
|
+
- **Keep the recording.** Use `after: 'stop'`; the playlist and segments stay in `$HOME/hls` until the next stream starts. To return one playable link, upload each segment with [`s3-storage`](https://github.com/ignitify-dev/ignitify-integrations/tree/master/integrations/s3-storage)'s `put` under one prefix, keeping its file name (`key: 'rec/<file>'`), then the playlist with `putAndLink` and the same prefix, and return that link. The player fetches the segments by plain URL, so the prefix must allow public read. With a private bucket, return one link per file.
|
|
48
48
|
- **Your own encoding.** Change bitrate, codec or filters with `ffmpegArgs`; the package still runs the server and the progress.
|
|
49
49
|
- **React to progress.** Use `onProgress`, for example to stop early on a condition with your own `AbortController` and `signal`.
|
|
50
50
|
|
|
@@ -55,6 +55,12 @@ The result is `{ success: true, stage: 'streamed', cancelled, watch, streamed_s,
|
|
|
55
55
|
- **One stream per task, for a small audience.** Many viewers need a CDN or a media server.
|
|
56
56
|
- The memory need of the `audio` profile is not measured; the minimum preset stays `std.medium`.
|
|
57
57
|
|
|
58
|
+
## On the VM
|
|
59
|
+
|
|
60
|
+
- **Call `stream()` early.** A bidirectional run must call `ctx.ready()` within 30 s (`ingress.ready_timeout_ms`). `stream()` calls it as soon as its server listens, before ffmpeg starts, so do slow work (a download, a lookup) after it or in `startDelaySec`, not before.
|
|
61
|
+
- **Write under `$HOME`.** The VM has no writable `/tmp`; `HOME` is the scratch disk (`/mnt/scratch`). The stream files go to `$HOME/hls`.
|
|
62
|
+
- **Bundled tasks work.** The platform bundles a task into one file and ships no `node_modules` for pure-JS packages, so hls.js is embedded in this package at build time; nothing is read from `node_modules` at run time.
|
|
63
|
+
|
|
58
64
|
## Licence of ffmpeg
|
|
59
65
|
|
|
60
|
-
FFmpeg is LGPL-2.1-or-later; builds with libx264 (as distribution builds are) are GPL. This package runs the OS package unmodified as a separate process and links none of it. hls.js (Apache-2.0) is
|
|
66
|
+
FFmpeg is LGPL-2.1-or-later; builds with libx264 (as distribution builds are) are GPL. This package runs the OS package unmodified as a separate process and links none of it. hls.js (Apache-2.0) is embedded in the published package at build time and served by the task; see NOTICE.
|
package/dist/constants.d.ts
CHANGED
|
@@ -17,9 +17,8 @@ export declare const FFMPEG_BIN = "ffmpeg";
|
|
|
17
17
|
export declare const SCRATCH_HOME_FALLBACK = "/mnt/scratch";
|
|
18
18
|
export declare const HLS_SUBDIR = "hls";
|
|
19
19
|
export declare const PLAYLIST_FILE = "index.m3u8";
|
|
20
|
-
/** hls.js is served
|
|
20
|
+
/** hls.js is embedded in the package and served by the task, so a viewer's browser needs no third-party CDN. */
|
|
21
21
|
export declare const PLAYER_SCRIPT_FILE = "hls.min.js";
|
|
22
|
-
export declare const HLS_JS_DIST = "hls.js/dist/hls.min.js";
|
|
23
22
|
/** ffmpeg writes MPEG-TS segments for both profiles (an audio-only HLS output is `.ts` too). */
|
|
24
23
|
export declare const MEDIA_TYPES: Readonly<Record<string, string>>;
|
|
25
24
|
export declare const HTML_TYPE = "text/html; charset=utf-8";
|
package/dist/constants.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAIA,kGAAkG;AAClG,eAAO,MAAM,aAAa,WAAW,CAAC;AACtC,eAAO,MAAM,YAAY,OAAO,CAAC;AACjC,eAAO,MAAM,cAAc,MAAM,CAAC;AAElC,eAAO,MAAM,QAAQ,6BAA8B,CAAC;AACpD,eAAO,MAAM,WAAW,6BAA8B,CAAC;AAEvD,oEAAoE;AACpE,eAAO,MAAM,UAAU,OAAO,CAAC;AAE/B;;;GAGG;AACH,eAAO,MAAM,aAAa,QAAmC,CAAC;AAE9D,eAAO,MAAM,KAAK,WAAW,CAAC;AAC9B,eAAO,MAAM,UAAU,WAAW,CAAC;AAEnC,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,iBAAiB,CAAC;AACpD,eAAO,MAAM,UAAU,QAAQ,CAAC;AAChC,eAAO,MAAM,aAAa,eAAe,CAAC;AAE1C,
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAIA,kGAAkG;AAClG,eAAO,MAAM,aAAa,WAAW,CAAC;AACtC,eAAO,MAAM,YAAY,OAAO,CAAC;AACjC,eAAO,MAAM,cAAc,MAAM,CAAC;AAElC,eAAO,MAAM,QAAQ,6BAA8B,CAAC;AACpD,eAAO,MAAM,WAAW,6BAA8B,CAAC;AAEvD,oEAAoE;AACpE,eAAO,MAAM,UAAU,OAAO,CAAC;AAE/B;;;GAGG;AACH,eAAO,MAAM,aAAa,QAAmC,CAAC;AAE9D,eAAO,MAAM,KAAK,WAAW,CAAC;AAC9B,eAAO,MAAM,UAAU,WAAW,CAAC;AAEnC,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,iBAAiB,CAAC;AACpD,eAAO,MAAM,UAAU,QAAQ,CAAC;AAChC,eAAO,MAAM,aAAa,eAAe,CAAC;AAE1C,gHAAgH;AAChH,eAAO,MAAM,kBAAkB,eAAe,CAAC;AAE/C,gGAAgG;AAChG,eAAO,MAAM,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAGxD,CAAC;AACF,eAAO,MAAM,SAAS,6BAA6B,CAAC;AACpD,eAAO,MAAM,WAAW,mCAAmC,CAAC;AAC5D,eAAO,MAAM,QAAQ,aAAa,CAAC;AACnC,kFAAkF;AAClF,eAAO,MAAM,kBAAkB,QAAqB,CAAC;AACrD,eAAO,MAAM,YAAY,EAAE,SAAS,MAAM,EAAoB,CAAC;AAE/D,gFAAgF;AAChF,eAAO,MAAM,iBAAiB,OAAO,CAAC;AACtC,sEAAsE;AACtE,eAAO,MAAM,cAAc,OAAO,CAAC;AACnC,eAAO,MAAM,iBAAiB,OAAO,CAAC;AACtC,eAAO,MAAM,uBAAuB,qBAAqB,CAAC;AAE1D,eAAO,MAAM,UAAU,OAAO,CAAC;AAC/B,eAAO,MAAM,UAAU,UAAY,CAAC;AACpC,mGAAmG;AACnG,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,eAAO,MAAM,MAAM;;;;;CAKT,CAAC;AAEX,eAAO,MAAM,QAAQ;4CACY,OAAO;iCAElB,OAAO;mCAEL,OAAO;+BACX,OAAO;iCACL,MAAM,SAAS,OAAO;oCACnB,MAAM,SAAS,OAAO;gCAC1B,OAAO;8BACT,OAAO;+BAEN,OAAO;iCAEL,MAAM;;;kCAGL,MAAM,GAAG,IAAI,QAAQ,MAAM;8BAC/B,MAAM,QAAQ,MAAM,SAAS,MAAM,GAAG,IAAI;4BAE5C,MAAM;kCACA,MAAM;;sCAEF,MAAM;CACvB,CAAC"}
|
package/dist/constants.js
CHANGED
|
@@ -19,9 +19,8 @@ export const FFMPEG_BIN = 'ffmpeg';
|
|
|
19
19
|
export const SCRATCH_HOME_FALLBACK = '/mnt/scratch';
|
|
20
20
|
export const HLS_SUBDIR = 'hls';
|
|
21
21
|
export const PLAYLIST_FILE = 'index.m3u8';
|
|
22
|
-
/** hls.js is served
|
|
22
|
+
/** hls.js is embedded in the package and served by the task, so a viewer's browser needs no third-party CDN. */
|
|
23
23
|
export const PLAYER_SCRIPT_FILE = 'hls.min.js';
|
|
24
|
-
export const HLS_JS_DIST = 'hls.js/dist/hls.min.js';
|
|
25
24
|
/** ffmpeg writes MPEG-TS segments for both profiles (an audio-only HLS output is `.ts` too). */
|
|
26
25
|
export const MEDIA_TYPES = {
|
|
27
26
|
'.m3u8': 'application/vnd.apple.mpegurl',
|
package/dist/constants.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,uGAAuG;AAEvG,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE1G,kGAAkG;AAClG,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC;AACtC,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC;AACjC,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,CAAC;AAElC,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,OAAO,EAAE,OAAO,CAAU,CAAC;AACpD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAU,CAAC;AAEvD,oEAAoE;AACpE,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC;AAE/B;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,oBAAoB,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC;AAC9B,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC;AAEnC,gGAAgG;AAChG,MAAM,CAAC,MAAM,qBAAqB,GAAG,cAAc,CAAC;AACpD,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,CAAC;AAChC,MAAM,CAAC,MAAM,aAAa,GAAG,YAAY,CAAC;AAE1C,
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,uGAAuG;AAEvG,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE1G,kGAAkG;AAClG,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC;AACtC,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC;AACjC,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,CAAC;AAElC,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,OAAO,EAAE,OAAO,CAAU,CAAC;AACpD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAU,CAAC;AAEvD,oEAAoE;AACpE,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC;AAE/B;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,oBAAoB,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC;AAC9B,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC;AAEnC,gGAAgG;AAChG,MAAM,CAAC,MAAM,qBAAqB,GAAG,cAAc,CAAC;AACpD,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,CAAC;AAChC,MAAM,CAAC,MAAM,aAAa,GAAG,YAAY,CAAC;AAE1C,gHAAgH;AAChH,MAAM,CAAC,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAE/C,gGAAgG;AAChG,MAAM,CAAC,MAAM,WAAW,GAAqC;IAC3D,OAAO,EAAE,+BAA+B;IACxC,KAAK,EAAE,YAAY;CACpB,CAAC;AACF,MAAM,CAAC,MAAM,SAAS,GAAG,0BAA0B,CAAC;AACpD,MAAM,CAAC,MAAM,WAAW,GAAG,gCAAgC,CAAC;AAC5D,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,CAAC;AACnC,kFAAkF;AAClF,MAAM,CAAC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC;AACrD,MAAM,CAAC,MAAM,YAAY,GAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAE/D,gFAAgF;AAChF,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AACtC,sEAAsE;AACtE,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC;AACnC,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AACtC,MAAM,CAAC,MAAM,uBAAuB,GAAG,kBAAkB,CAAC;AAE1D,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC;AAC/B,MAAM,CAAC,MAAM,UAAU,GAAG,SAAS,CAAC;AACpC,mGAAmG;AACnG,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAE/B,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;CACN,CAAC;AAEX,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,qBAAqB,EAAE,CAAC,KAAc,EAAE,EAAE,CACxC,yCAAyC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;IACnG,SAAS,EAAE,CAAC,MAAe,EAAE,EAAE,CAC7B,UAAU,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,yFAAyF;IAC3H,UAAU,EAAE,CAAC,OAAgB,EAAE,EAAE,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,mBAAmB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;IAC5G,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,mBAAmB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;IACvG,WAAW,EAAE,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,2BAA2B;IAC1G,cAAc,EAAE,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,gCAAgC;IAClH,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,iCAAiC,UAAU,EAAE;IAC3G,OAAO,EAAE,CAAC,KAAc,EAAE,EAAE,CAC1B,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,4BAA4B,gBAAgB,OAAO,gBAAgB,EAAE;IACpG,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE,CAC3B,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,iEAAiE,aAAa,EAAE;IAChH,WAAW,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,IAAI,qBAAqB;IAC3D,iBAAiB,EAAE,6CAA6C;IAChE,aAAa,EAAE,uEAAuE;IACtF,YAAY,EAAE,CAAC,IAAmB,EAAE,IAAY,EAAE,EAAE,CAAC,sBAAsB,IAAI,IAAI,UAAU,KAAK,IAAI,EAAE;IACxG,OAAO,EAAE,CAAC,KAAa,EAAE,IAAY,EAAE,KAAoB,EAAE,EAAE,CAC7D,WAAW,KAAK,QAAQ,IAAI,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,KAAK,EAAE,EAAE;IAC/E,OAAO,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,uBAAuB,GAAG,IAAI;IACxD,KAAK,EAAE,CAAC,WAAmB,EAAE,EAAE,CAAC,0CAA0C,WAAW,EAAE;IACvF,iBAAiB,EAAE,YAAY;IAC/B,iBAAiB,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI;CACtC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"player-script.generated.d.ts","sourceRoot":"","sources":["../src/player-script.generated.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,qBAAqB,EAAE,MAAgB,CAAC;AACrD,eAAO,MAAM,aAAa,EAAE,MAAk9ymB,CAAC"}
|