@nice2dev/ui 1.4.24 → 1.4.25
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/CHANGELOG.md +43 -0
- package/README.md +2 -4
- package/dist/NiceModuleLifecyclePanel-bsHwj1pO.cjs +1 -0
- package/dist/{NiceStreamDashboard.doc-74KUXya1.cjs → NiceStreamDashboard.doc-CdkHFf4Y.cjs} +2 -2
- package/dist/demo/docs/docPreviews.mjs +347 -373
- package/dist/demo/docs/docRegistry.mjs +4 -59
- package/dist/docs/NiceStreamDashboard.doc.json.mjs +1 -1
- package/dist/documentation/utils.mjs +1 -1
- package/dist/index.cjs +94 -113
- package/dist/index.d.ts +5 -45
- package/dist/index.mjs +778 -780
- package/dist/navigation/NiceDock.mjs +55 -48
- package/dist/navigation/NiceMenuTypes.mjs +197 -251
- package/dist/navigation.cjs +1 -1
- package/dist/navigation.d.ts +5 -16
- package/dist/navigation.mjs +53 -54
- package/dist/style.css +2 -2
- package/dist/tools/NiceShowcase.mjs +1 -2
- package/package.json +4 -4
- package/dist/NiceDiagram.doc-CASS0Tnj.cjs +0 -8
- package/dist/NiceModuleLifecyclePanel-jckyVqqt.cjs +0 -1
- package/dist/docs/NiceDiagram.doc.json.mjs +0 -32
- package/dist/tools/NiceChat.mjs +0 -98
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="https://nice2dev.com/schemas/component-doc-v1.json",t="NiceStreamDashboard",a="Live-production dashboard: scenes and their sources, preview and program with transitions, platform connections, chat, stats and quick actions. The dashboard manages the state; streaming, platform APIs and rendering are the host's — every control that needs them calls a callback, and is disabled with a reason when the callback is missing. Children can use `useStreamDashboard()`, e.g. to feed incoming chat with `receiveChatMessage`.",
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="https://nice2dev.com/schemas/component-doc-v1.json",t="NiceStreamDashboard",a="Live-production dashboard: scenes and their sources, preview and program with transitions, platform connections, chat, stats and quick actions. The dashboard manages the state; streaming, platform APIs and rendering are the host's — every control that needs them calls a callback, and is disabled with a reason when the callback is missing. Children can use `useStreamDashboard()`, e.g. to feed incoming chat with `receiveChatMessage`.",n="media",s="1.0.0",i="stable",o=[{name:"platforms",type:"PlatformConnection[]",description:"Connected streaming platforms"},{name:"scenes",type:"Scene[]",description:"Scenes with their sources"},{name:"config",type:"Partial<StreamConfig>",description:"Stream configuration (title, encoding, recording)"},{name:"maxChatMessages",type:"number",default:"500",description:"How many chat messages the panel keeps"},{name:"autoRecord",type:"boolean",default:"false",description:"Start recording when the stream starts"},{name:"onStreamStart",type:"() => void",description:"Called when the stream starts"},{name:"onStreamStop",type:"() => void",description:"Called when the stream stops"},{name:"onChatMessage",type:"(message: ChatMessage) => void",description:"Called for every message fed in with `receiveChatMessage`"},{name:"onSendChatMessage",type:"(platform: StreamPlatform, message: string) => void | Promise<void>",description:"Sends a chat message through the platform's API; without it the chat input is disabled"},{name:"onAddPlatform",type:"() => void",description:'Connects a new platform account; without it "Add platform" is disabled'},{name:"onTransition",type:"(sceneId: string, transition: string, durationMs: number) => void",description:"Called when the program switches scenes, with the chosen transition and its duration"},{name:"onAlert",type:"(config: AlertConfig, data: unknown) => void",description:"Called when an alert is triggered"},{name:"onAnalyticsUpdate",type:"(analytics: StreamAnalytics) => void",description:"Called whenever the stats change"},{name:"onVODCreated",type:"(vod: VOD) => void",description:"Called when a recording or clip is created"},{name:"onScreenshot",type:"() => void",description:'"Screenshot" quick action; disabled without it'},{name:"onOpenAudioMixer",type:"() => void",description:'"Audio Mixer" quick action; disabled without it'},{name:"onOpenSettings",type:"() => void",description:'"Settings" quick action; disabled without it'},{name:"renderPreview",type:"(scene: Scene | null) => ReactNode",description:"Renders the preview and program canvases"},{name:"renderChatMessage",type:"(message: ChatMessage) => ReactNode",description:"Custom chat message row"},{name:"children",type:"ReactNode",description:"Rendered inside the dashboard's context"}],r=[{title:"Stream Dashboard",description:"Platforms, scenes and chat wired to the host",code:`<NiceStreamDashboard
|
|
2
2
|
platforms={platforms}
|
|
3
3
|
scenes={scenes}
|
|
4
4
|
onSendChatMessage={(platform, text) => api.chat.send(platform, text)}
|
|
5
5
|
onTransition={(sceneId, transition, ms) => renderer.switchTo(sceneId, transition, ms)}
|
|
6
6
|
onStreamStart={startEncoder}
|
|
7
7
|
onStreamStop={stopEncoder}
|
|
8
|
-
/>`}],
|
|
8
|
+
/>`}],d={keyboard:["Tab through panels","Enter in the chat field sends the message"],aria:["Icon buttons are labelled","Disabled controls say in their title what is missing"]},c=["NiceVideoChat","NiceChatWindow"],h={$schema:e,name:t,description:a,category:n,since:s,status:i,props:o,examples:r,accessibility:d,seeAlso:c};exports.$schema=e;exports.accessibility=d;exports.category=n;exports.default=h;exports.description=a;exports.examples=r;exports.name=t;exports.props=o;exports.seeAlso=c;exports.since=s;exports.status=i;
|