Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ts-sdk] Update create-live-compositor-templates, general cleanups #812

Merged
merged 7 commits into from
Oct 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ts/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20.18.0
2 changes: 1 addition & 1 deletion ts/create-live-compositor/src/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export async function resolveBrowserOptions(): Promise<BrowserOptions> {
export async function resolveNodeOptions(): Promise<NodeOptions> {
const templateName = await selectPrompt('Select project template: ', [
{ title: 'Minimal example', value: 'node-minimal' },
{ title: 'Express.js + Redux', value: 'node-express-redux' },
{ title: 'Express.js + Zustand', value: 'node-express-zustand' },
] as const);
return {
type: 'node',
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "template-node-express-redux",
"name": "template-node-express-zustand",
"private": true,
"description": "Live Compositor app",
"version": "1.0.0",
Expand All @@ -11,16 +11,15 @@
},
"dependencies": {
"@live-compositor/node": "^0.1.0",
"@reduxjs/toolkit": "^2.2.7",
"express": "^4.21.0",
"live-compositor": "^0.1.0",
"react": "^18.3.1",
"react-redux": "^9.1.2"
"zustand": "4.5.5"
},
"devDependencies": {
"@types/express": "^4.17.21",
"@types/node": "^20.14.10",
"@types/react": "^18.2.25",
"@types/react": "^18.3.3",
"typescript": "^5.5.3"
}
}
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
import { View, Text, useInputStreams, InputStream, Tiles } from 'live-compositor';
import { Provider, useSelector } from "react-redux"

import { showInstructionsSlice, store } from "./store"
import { store } from './store';
import { useStore } from 'zustand';

export default function App() {
return (
<Provider store={store}>
<OutputScene />
</Provider>
)
return <OutputScene />;
}

function OutputScene() {
const inputs = useInputStreams();
const showInstructions = useSelector(showInstructionsSlice.selectors.shouldShow)
const showInstructions = useStore(store, state => state.shouldShowInstructions);

return (
<View>
{showInstructions ? <Instructions /> : undefined}
<Tiles>
{Object.values(inputs).map((input) => (
{Object.values(inputs).map(input => (
<InputStream key={input.inputId} inputId={input.inputId} />
))}
</Tiles>
</View >
</View>
);
}

Expand All @@ -33,8 +30,8 @@ function Instructions() {
<Text fontSize={50}>Open index.ts and get started.</Text>
<View height={20} />
<Text width={960} fontSize={30} wrap="word">
This example renders static text and sends the output stream via RTP to local port
8001. Generated code includes helpers in liveCompositorFfplayHelper.ts that display the output
This example renders static text and sends the output stream via RTP to local port 8001.
Generated code includes helpers in liveCompositorFfplayHelper.ts that display the output
stream using ffplay, make sure to remove them for any real production use.
</Text>
<View height={20} />
Expand All @@ -46,12 +43,14 @@ function Instructions() {
- ./src/routes.ts controls HTTP API that can be used to interact with this example.
</Text>
<Text width={960} fontSize={30} wrap="word">
- ./compositor.tsx exposes LiveCompositor instance that can be used to add/remove new streams/images/shader.
- ./compositor.tsx exposes LiveCompositor instance that can be used to add/remove new
streams/images/shader.
</Text>
<Text width={960} fontSize={30} wrap="word">
- ./store.ts implements Redux store that is used for storing global state and sharing it between express API and React.
- ./store.ts implements global store using Zustand, enabling express API and React to share
common settings.
</Text>
<View />
</View>
)
);
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import express, { json } from 'express';
import { Compositor } from './compositor';
import { showInstructionsSlice, store } from './store';
import { store } from './store';

export const app = express();

Expand All @@ -17,6 +17,6 @@ app.post('/add-stream', async (req, res) => {

// curl -XPOST 'http://localhost:3000/toggle-instructions'
app.post('/toggle-instructions', async (_req, res) => {
store.dispatch(showInstructionsSlice.actions.toggle());
store.getState().toggleInstructions();
res.send({});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { createStore } from 'zustand';

export type State = {
shouldShowInstructions: boolean;
toggleInstructions: () => void;
};

export const store = createStore<State>(set => ({
shouldShowInstructions: true,
toggleInstructions: () =>
set(state => ({ shouldShowInstructions: !state.shouldShowInstructions })),
}));
2 changes: 1 addition & 1 deletion ts/live-compositor/src/api.generated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ export type VideoEncoderOptions = {
/**
* (**default=`"fast"`**) Preset for an encoder. See `FFmpeg` [docs](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset) to learn more.
*/
preset: H264EncoderPreset;
preset?: H264EncoderPreset | null;
/**
* Raw FFmpeg encoder options. See [docs](https://ffmpeg.org/ffmpeg-codecs.html) for more.
*/
Expand Down
Loading
Loading